add embedded cluster cli docs reference #3429
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # admin-console | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `admin-console` command. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> admin-console reset-password [flags] | ||
| ``` | ||
|
|
||
| ## Subcommands | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="35%">Command</th> | ||
| <th width="65%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>reset-password</td> | ||
| <td> | ||
| <p>Reset the Admin Console password. If no password is provided, you will be prompted to enter a new one.</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Type</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for reset-password</p> | ||
| </td> | ||
| </tr> | ||
| </table> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # completion | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `completion` command. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> completion [command] | ||
| ``` | ||
|
|
||
| ## Subcommands | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="35%">Command</th> | ||
| <th width="65%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>bash</td> | ||
| <td> | ||
| <p>Generate the autocompletion script for bash</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>fish</td> | ||
| <td> | ||
| <p>Generate the autocompletion script for fish</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>powershell</td> | ||
| <td> | ||
| <p>Generate the autocompletion script for powershell</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>zsh</td> | ||
| <td> | ||
| <p>Generate the autocompletion script for zsh</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Type</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for completion</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # enable-ha | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `enable-ha` command. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> enable-ha [flags] | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Type</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for enable-ha</p> | ||
| </td> | ||
| </tr> | ||
| </table> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # join print-command | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `join print-command` command. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> join print-command [flags] | ||
|
There was a problem hiding this comment. this is a subcommand of join, so given the pattern elsewhere, this shouldn't be its own page but should be listed as a subcommand of join. but then note that if we go that route, join is itself a command but it has subcommands. so it's not like There was a problem hiding this comment. Right, I was thinking print-command might benefit from its own page since it has it's own use case (which does break the pattern). I think if we do want to stick to the pattern and nest it under join, it'll still be fine since it can be described as a subcommand. However, if it has unique flags or something that you'd rather keep separate so as to not introduce confusion, we can leave it as its own page |
||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Type</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for print-command</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # join | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `join` command. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> join <url> <token> [flags] | ||
| ``` | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> join [command] | ||
| ``` | ||
|
|
||
| ## Subcommands | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="35%">Command</th> | ||
| <th width="65%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>run-preflights</td> | ||
| <td> | ||
| <p>Run join host preflights for the application.</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Description</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`--airgap-bundle`</td> | ||
| <td>string</td> | ||
| <td> | ||
| <p>Path to the air gap bundle. If set, the installation will complete without internet access.</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for join</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`--ignore-host-preflights`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>Run host preflight checks, but prompt the user to continue if they fail instead of exiting.</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`--network-interface`</td> | ||
| <td>string</td> | ||
| <td> | ||
| <p>The network interface to use for the cluster.</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`--no-ha`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>Do not prompt for or enable high availability.</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`-y, --yes`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>Assume yes to all prompts.</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Examples | ||
|
|
||
| ```bash | ||
| sudo ./slackernews join 10.128.0.55:30000 dCH2tsK9xvucAIbME0RBs7z7 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # reset | ||
|
|
||
| This topic describes the options available with the Embedded Cluster `reset` command. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| sudo ./<app-slug> reset [flags] | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th width="30%">Flag</th> | ||
| <th width="20%">Type</th> | ||
| <th width="50%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>`--force`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>Ignore errors encountered when resetting the node (implies --yes)</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`-h, --help`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>help for reset</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>`-y, --yes`</td> | ||
| <td></td> | ||
| <td> | ||
| <p>Assume yes to all prompts.</p> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.