Skip to content

Commit 55a7a6c

Browse files
paigecalvertpaigecalvert
authored
Merge pull request #3429 from replicatedhq/127558
add embedded cluster cli docs reference
2 parents 0ad4273 + a3af4a6 commit 55a7a6c

19 files changed

+568
-16
lines changed

‎docs/enterprise/installing-embedded-air-gap.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ To install with Embedded Cluster in an air gap environment:
8787
Where `APP_SLUG` is the unique application slug.
8888

8989
:::note
90-
Embedded Cluster supports installation options such as installing behind a proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
90+
Embedded Cluster supports installation options such as installing behind a proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [install](/reference/embedded-cluster-install).
9191
:::
9292

9393
1. When prompted, enter a password for accessing the KOTS Admin Console.

‎docs/enterprise/installing-embedded.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To install an application with Embedded Cluster:
4949
* `LICENSE_FILE` is the customer license.
5050
<br/>
5151
:::note
52-
Embedded Cluster supports installation options such as installing behind a proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
52+
Embedded Cluster supports installation options such as installing behind a proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [install](/reference/embedded-cluster-install).
5353
:::
5454

5555
1. When prompted, enter a password for accessing the KOTS Admin Console.

‎docs/partials/embedded-cluster/_port-reqs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ The KOTS Admin Console requires that port 30000/TCP is open and available. Creat
3434

3535
Additionally, port 30000 must be accessible by nodes joining the cluster.
3636

37-
If port 30000 is occupied, you can select a different port for the Admin Console during installation. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
37+
If port 30000 is occupied, you can select a different port for the Admin Console during installation. For more information, see [install](/reference/embedded-cluster-install).
3838

3939
#### LAM Port
4040

4141
The Local Artifact Mirror (LAM) requires that port 50000/TCP is open and available.
4242

43-
If port 50000 is occupied, you can select a different port for the LAM during installation. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
43+
If port 50000 is occupied, you can select a different port for the LAM during installation. For more information, see [install](/reference/embedded-cluster-install).

‎docs/partials/embedded-cluster/_requirements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
* The disk on the host must have a maximum P99 write latency of 10 ms. This supports etcd performance and stability. For more information about the disk write latency requirements for etcd, see [Disks](https://etcd.io/docs/latest/op-guide/hardware/#disks) in _Hardware recommendations_ and [What does the etcd warning “failed to send out heartbeat on time” mean?](https://etcd.io/docs/latest/faq/) in the etcd documentation.
1010

11-
* The data directory used by Embedded Cluster must have 40Gi or more of total space and be less than 80% full. By default, the data directory is `/var/lib/embedded-cluster`. The directory can be changed by passing the `--data-dir` flag with the Embedded Cluster `install` command. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
11+
* The data directory used by Embedded Cluster must have 40Gi or more of total space and be less than 80% full. By default, the data directory is `/var/lib/embedded-cluster`. The directory can be changed by passing the `--data-dir` flag with the Embedded Cluster `install` command. For more information, see [install](/reference/embedded-cluster-install).
1212

1313
Note that in addition to the primary data directory, Embedded Cluster creates directories and files in the following locations:
1414

‎docs/reference/embedded-cluster-admin-console.mdx

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# admin-console
2+
3+
This topic describes the options available with the Embedded Cluster `admin-console` command.
4+
5+
## Usage
6+
7+
```bash
8+
sudo ./<app-slug> admin-console reset-password [flags]
9+
```
10+
11+
## Subcommands
12+
13+
<table>
14+
<tr>
15+
<th width="35%">Command</th>
16+
<th width="65%">Description</th>
17+
</tr>
18+
<tr>
19+
<td>reset-password</td>
20+
<td>
21+
<p>Reset the Admin Console password. If no password is provided, you will be prompted to enter a new one.</p>
22+
</td>
23+
</tr>
24+
</table>
25+
26+
## Flags
27+
28+
<table>
29+
<tr>
30+
<th width="30%">Flag</th>
31+
<th width="20%">Type</th>
32+
<th width="50%">Description</th>
33+
</tr>
34+
<tr>
35+
<td>`-h, --help`</td>
36+
<td></td>
37+
<td>
38+
<p>help for reset-password</p>
39+
</td>
40+
</tr>
41+
</table>

‎docs/reference/embedded-cluster-completion.mdx

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# completion
2+
3+
This topic describes the options available with the Embedded Cluster `completion` command.
4+
5+
## Usage
6+
7+
```bash
8+
sudo ./<app-slug> completion [command]
9+
```
10+
11+
## Subcommands
12+
13+
<table>
14+
<tr>
15+
<th width="35%">Command</th>
16+
<th width="65%">Description</th>
17+
</tr>
18+
<tr>
19+
<td>bash</td>
20+
<td>
21+
<p>Generate the autocompletion script for bash</p>
22+
</td>
23+
</tr>
24+
<tr>
25+
<td>fish</td>
26+
<td>
27+
<p>Generate the autocompletion script for fish</p>
28+
</td>
29+
</tr>
30+
<tr>
31+
<td>powershell</td>
32+
<td>
33+
<p>Generate the autocompletion script for powershell</p>
34+
</td>
35+
</tr>
36+
<tr>
37+
<td>zsh</td>
38+
<td>
39+
<p>Generate the autocompletion script for zsh</p>
40+
</td>
41+
</tr>
42+
</table>
43+
44+
## Flags
45+
46+
<table>
47+
<tr>
48+
<th width="30%">Flag</th>
49+
<th width="20%">Type</th>
50+
<th width="50%">Description</th>
51+
</tr>
52+
<tr>
53+
<td>`-h, --help`</td>
54+
<td></td>
55+
<td>
56+
<p>help for completion</p>
57+
</td>
58+
</tr>
59+
</table>
60+

‎docs/reference/embedded-cluster-enable-ha.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# enable-ha
2+
3+
This topic describes the options available with the Embedded Cluster `enable-ha` command.
4+
5+
## Usage
6+
7+
```bash
8+
sudo ./<app-slug> enable-ha [flags]
9+
```
10+
11+
## Flags
12+
13+
<table>
14+
<tr>
15+
<th width="30%">Flag</th>
16+
<th width="20%">Type</th>
17+
<th width="50%">Description</th>
18+
</tr>
19+
<tr>
20+
<td>`-h, --help`</td>
21+
<td></td>
22+
<td>
23+
<p>help for enable-ha</p>
24+
</td>
25+
</tr>
26+
</table>

‎docs/reference/embedded-cluster-install.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@ import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.
33
import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx"
44
import DeprecatedPrivateCa from "../partials/embedded-cluster/_deprecated-private-ca.mdx"
55

6-
# Embedded Cluster Install Command Options
6+
# install
77

88
This topic describes the options available with the Embedded Cluster install command. For more information about how to install with Embedded Cluster, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded).
99

1010
## Usage
1111

1212
```bash
13-
sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags]
13+
sudo ./<app-slug> install --license <path-to-license> [flags]
1414
```
15-
* `APP_SLUG` is the unique application slug
16-
* `PATH_TO_LICENSE` is the path to the customer license
1715

1816
## Flags
1917

‎docs/reference/embedded-cluster-join-print-command.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# join print-command
2+
3+
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).
4+
5+
## Usage
6+
7+
```bash
8+
sudo ./<app-slug> join print-command [flags]
9+
```
10+
11+
## Flags
12+
13+
<table>
14+
<tr>
15+
<th width="30%">Flag</th>
16+
<th width="20%">Type</th>
17+
<th width="50%">Description</th>
18+
</tr>
19+
<tr>
20+
<td>`-h, --help`</td>
21+
<td></td>
22+
<td>
23+
<p>help for print-command</p>
24+
</td>
25+
</tr>
26+
</table>
27+

‎docs/reference/embedded-cluster-join.mdx

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# join
2+
3+
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).
4+
5+
## Usage
6+
7+
```bash
8+
sudo ./<app-slug> join <url> <token> [flags]
9+
```
10+
11+
```bash
12+
sudo ./<app-slug> join [command]
13+
```
14+
15+
## Subcommands
16+
17+
<table>
18+
<tr>
19+
<th width="35%">Command</th>
20+
<th width="65%">Description</th>
21+
</tr>
22+
<tr>
23+
<td>run-preflights</td>
24+
<td>
25+
<p>Run join host preflights for the application.</p>
26+
</td>
27+
</tr>
28+
</table>
29+
30+
## Flags
31+
32+
<table>
33+
<tr>
34+
<th width="30%">Flag</th>
35+
<th width="20%">Description</th>
36+
<th width="50%">Description</th>
37+
</tr>
38+
<tr>
39+
<td>`--airgap-bundle`</td>
40+
<td>string</td>
41+
<td>
42+
<p>Path to the air gap bundle. If set, the installation will complete without internet access.</p>
43+
</td>
44+
</tr>
45+
<tr>
46+
<td>`-h, --help`</td>
47+
<td></td>
48+
<td>
49+
<p>help for join</p>
50+
</td>
51+
</tr>
52+
<tr>
53+
<td>`--ignore-host-preflights`</td>
54+
<td></td>
55+
<td>
56+
<p>Run host preflight checks, but prompt the user to continue if they fail instead of exiting.</p>
57+
</td>
58+
</tr>
59+
<tr>
60+
<td>`--network-interface`</td>
61+
<td>string</td>
62+
<td>
63+
<p>The network interface to use for the cluster.</p>
64+
</td>
65+
</tr>
66+
<tr>
67+
<td>`--no-ha`</td>
68+
<td></td>
69+
<td>
70+
<p>Do not prompt for or enable high availability.</p>
71+
</td>
72+
</tr>
73+
<tr>
74+
<td>`-y, --yes`</td>
75+
<td></td>
76+
<td>
77+
<p>Assume yes to all prompts.</p>
78+
</td>
79+
</tr>
80+
</table>
81+
82+
## Examples
83+
84+
```bash
85+
sudo ./slackernews join 10.128.0.55:30000 dCH2tsK9xvucAIbME0RBs7z7
86+
```

0 commit comments

Comments
 (0)