Skip to content

Commit

Permalink
add check_only template for publishing platform integrations (#18596)
Browse files Browse the repository at this point in the history
* add agent_check template for publishing platform integrations

* add option to skip manifest checks

* add changelog entry

* remove unused import

---------

Co-authored-by: HadhemiDD <[email protected]> d4157fc
  • Loading branch information
HadhemiDD committed Sep 25, 2024
1 parent a60779f commit 494218a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion ddev/cli/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-config-set>ddev config set<a class=headerlink href=#ddev-config-set title="Permanent link">&para;</a></h3> <p>Assign values to config file entries. If the value is omitted, you will be prompted, with the input hidden if it is sensitive.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev config set [OPTIONS] KEY [VALUE]
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-config-show>ddev config show<a class=headerlink href=#ddev-config-show title="Permanent link">&para;</a></h3> <p>Show the contents of the config file.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev config show [OPTIONS]
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--all</code>, <code>-a</code></td> <td>boolean</td> <td>Do not scrub secret fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-create>ddev create<a class=headerlink href=#ddev-create title="Permanent link">&para;</a></h2> <p>Create scaffolding for a new integration.</p> <p>NAME: The display name of the integration that will appear in documentation.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev create [OPTIONS] NAME
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--type</code>, <code>-t</code></td> <td>choice (<code>check</code> &#x7C; <code>jmx</code> &#x7C; <code>logs</code> &#x7C; <code>metrics_crawler</code> &#x7C; <code>snmp_tile</code> &#x7C; <code>tile</code>)</td> <td>The type of integration to create. See below for more details.</td> <td><code>check</code></td> </tr> <tr> <td><code>--location</code>, <code>-l</code></td> <td>text</td> <td>The directory where files will be written</td> <td>None</td> </tr> <tr> <td><code>--non-interactive</code>, <code>-ni</code></td> <td>boolean</td> <td>Disable prompting for fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--quiet</code>, <code>-q</code></td> <td>boolean</td> <td>Show less output</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code>, <code>-n</code></td> <td>boolean</td> <td>Only show what would be created</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-dep>ddev dep<a class=headerlink href=#ddev-dep title="Permanent link">&para;</a></h2> <p>Manage dependencies</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep [OPTIONS] COMMAND [ARGS]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--type</code>, <code>-t</code></td> <td>choice (<code>check</code> &#x7C; <code>check_only</code> &#x7C; <code>jmx</code> &#x7C; <code>logs</code> &#x7C; <code>metrics_crawler</code> &#x7C; <code>snmp_tile</code> &#x7C; <code>tile</code>)</td> <td>The type of integration to create. See below for more details.</td> <td><code>check</code></td> </tr> <tr> <td><code>--location</code>, <code>-l</code></td> <td>text</td> <td>The directory where files will be written</td> <td>None</td> </tr> <tr> <td><code>--non-interactive</code>, <code>-ni</code></td> <td>boolean</td> <td>Disable prompting for fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--quiet</code>, <code>-q</code></td> <td>boolean</td> <td>Show less output</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code>, <code>-n</code></td> <td>boolean</td> <td>Only show what would be created</td> <td><code>False</code></td> </tr> <tr> <td><code>--skip-manifest</code></td> <td>boolean</td> <td>Prevents validating the manfiest for check_only</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-dep>ddev dep<a class=headerlink href=#ddev-dep title="Permanent link">&para;</a></h2> <p>Manage dependencies</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep [OPTIONS] COMMAND [ARGS]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-freeze>ddev dep freeze<a class=headerlink href=#ddev-dep-freeze title="Permanent link">&para;</a></h3> <p>Combine all dependencies for the Agent's static environment.</p> <p>This reads and merges the dependency specs from individual integrations and writes them to agent_requirements.in</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep freeze [OPTIONS]
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-pin>ddev dep pin<a class=headerlink href=#ddev-dep-pin title="Permanent link">&para;</a></h3> <p>Pin a dependency for all checks that require it.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep pin [OPTIONS] DEFINITION
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-sync>ddev dep sync<a class=headerlink href=#ddev-dep-sync title="Permanent link">&para;</a></h3> <p>Synchronize integration dependency spec with that of the agent as a whole.</p> <p>Reads dependency spec from agent_requirements.in and propagates it to all integrations. For each integration we propagate only the relevant parts (i.e. its direct dependencies).</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep sync [OPTIONS]
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 494218a

Please sign in to comment.