diff --git a/docs/enterprise/installing-embedded-air-gap.mdx b/docs/enterprise/installing-embedded-air-gap.mdx index 3db3bda12e..161fda6a4a 100644 --- a/docs/enterprise/installing-embedded-air-gap.mdx +++ b/docs/enterprise/installing-embedded-air-gap.mdx @@ -87,7 +87,7 @@ To install with Embedded Cluster in an air gap environment: Where `APP_SLUG` is the unique application slug. :::note - 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). + 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). ::: 1. When prompted, enter a password for accessing the KOTS Admin Console. diff --git a/docs/enterprise/installing-embedded.mdx b/docs/enterprise/installing-embedded.mdx index 370883fb1e..043c19a302 100644 --- a/docs/enterprise/installing-embedded.mdx +++ b/docs/enterprise/installing-embedded.mdx @@ -49,7 +49,7 @@ To install an application with Embedded Cluster: * `LICENSE_FILE` is the customer license.
:::note - 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). + 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). ::: 1. When prompted, enter a password for accessing the KOTS Admin Console. diff --git a/docs/partials/embedded-cluster/_port-reqs.mdx b/docs/partials/embedded-cluster/_port-reqs.mdx index 131f4b19d0..c973b4c086 100644 --- a/docs/partials/embedded-cluster/_port-reqs.mdx +++ b/docs/partials/embedded-cluster/_port-reqs.mdx @@ -34,10 +34,10 @@ The KOTS Admin Console requires that port 30000/TCP is open and available. Creat Additionally, port 30000 must be accessible by nodes joining the cluster. -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). +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). #### LAM Port The Local Artifact Mirror (LAM) requires that port 50000/TCP is open and available. -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). +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). diff --git a/docs/partials/embedded-cluster/_requirements.mdx b/docs/partials/embedded-cluster/_requirements.mdx index 7dc9213acd..ff53f5683b 100644 --- a/docs/partials/embedded-cluster/_requirements.mdx +++ b/docs/partials/embedded-cluster/_requirements.mdx @@ -8,7 +8,7 @@ * 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. -* 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). +* 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). Note that in addition to the primary data directory, Embedded Cluster creates directories and files in the following locations: diff --git a/docs/reference/embedded-cluster-admin-console.mdx b/docs/reference/embedded-cluster-admin-console.mdx new file mode 100644 index 0000000000..4ab53d9271 --- /dev/null +++ b/docs/reference/embedded-cluster-admin-console.mdx @@ -0,0 +1,41 @@ +# admin-console + +This topic describes the options available with the Embedded Cluster `admin-console` command. + +## Usage + +```bash +sudo ./ admin-console reset-password [flags] +``` + +## Subcommands + + + + + + + + + + +
CommandDescription
reset-password +

Reset the Admin Console password. If no password is provided, you will be prompted to enter a new one.

+
+ +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for reset-password

+
\ No newline at end of file diff --git a/docs/reference/embedded-cluster-completion.mdx b/docs/reference/embedded-cluster-completion.mdx new file mode 100644 index 0000000000..de2338598a --- /dev/null +++ b/docs/reference/embedded-cluster-completion.mdx @@ -0,0 +1,60 @@ +# completion + +This topic describes the options available with the Embedded Cluster `completion` command. + +## Usage + +```bash +sudo ./ completion [command] +``` + +## Subcommands + + + + + + + + + + + + + + + + + + + + + + +
CommandDescription
bash +

Generate the autocompletion script for bash

+
fish +

Generate the autocompletion script for fish

+
powershell +

Generate the autocompletion script for powershell

+
zsh +

Generate the autocompletion script for zsh

+
+ +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for completion

+
+ diff --git a/docs/reference/embedded-cluster-enable-ha.mdx b/docs/reference/embedded-cluster-enable-ha.mdx new file mode 100644 index 0000000000..6fdabe3f08 --- /dev/null +++ b/docs/reference/embedded-cluster-enable-ha.mdx @@ -0,0 +1,26 @@ +# enable-ha + +This topic describes the options available with the Embedded Cluster `enable-ha` command. + +## Usage + +```bash +sudo ./ enable-ha [flags] +``` + +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for enable-ha

+
\ No newline at end of file diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 65df2a0903..a641ad89a2 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -3,17 +3,15 @@ import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs. import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx" import DeprecatedPrivateCa from "../partials/embedded-cluster/_deprecated-private-ca.mdx" -# Embedded Cluster Install Command Options +# install 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). ## Usage ```bash -sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags] +sudo ./ install --license [flags] ``` -* `APP_SLUG` is the unique application slug -* `PATH_TO_LICENSE` is the path to the customer license ## Flags diff --git a/docs/reference/embedded-cluster-join-print-command.mdx b/docs/reference/embedded-cluster-join-print-command.mdx new file mode 100644 index 0000000000..fbf003489b --- /dev/null +++ b/docs/reference/embedded-cluster-join-print-command.mdx @@ -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 ./ join print-command [flags] +``` + +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for print-command

+
+ diff --git a/docs/reference/embedded-cluster-join.mdx b/docs/reference/embedded-cluster-join.mdx new file mode 100644 index 0000000000..354a5c9826 --- /dev/null +++ b/docs/reference/embedded-cluster-join.mdx @@ -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 ./ join [flags] +``` + +```bash +sudo ./ join [command] +``` + +## Subcommands + + + + + + + + + + +
CommandDescription
run-preflights +

Run join host preflights for the application.

+
+ +## Flags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagDescriptionDescription
`--airgap-bundle`string +

Path to the air gap bundle. If set, the installation will complete without internet access.

+
`-h, --help` +

help for join

+
`--ignore-host-preflights` +

Run host preflight checks, but prompt the user to continue if they fail instead of exiting.

+
`--network-interface`string +

The network interface to use for the cluster.

+
`--no-ha` +

Do not prompt for or enable high availability.

+
`-y, --yes` +

Assume yes to all prompts.

+
+ +## Examples + +```bash +sudo ./slackernews join 10.128.0.55:30000 dCH2tsK9xvucAIbME0RBs7z7 +``` \ No newline at end of file diff --git a/docs/reference/embedded-cluster-reset.mdx b/docs/reference/embedded-cluster-reset.mdx new file mode 100644 index 0000000000..7dd6264e0f --- /dev/null +++ b/docs/reference/embedded-cluster-reset.mdx @@ -0,0 +1,41 @@ +# reset + +This topic describes the options available with the Embedded Cluster `reset` command. + +## Usage + +```bash +sudo ./ reset [flags] +``` + +## Flags + + + + + + + + + + + + + + + + + + + + + + +
FlagTypeDescription
`--force` +

Ignore errors encountered when resetting the node (implies --yes)

+
`-h, --help` +

help for reset

+
`-y, --yes` +

Assume yes to all prompts.

+
+ diff --git a/docs/reference/embedded-cluster-restore.mdx b/docs/reference/embedded-cluster-restore.mdx new file mode 100644 index 0000000000..588faaa111 --- /dev/null +++ b/docs/reference/embedded-cluster-restore.mdx @@ -0,0 +1,110 @@ +# restore + +This topic describes the options available with the Embedded Cluster `restore` command. + +## Usage + +```bash +sudo ./ restore [flags] +``` + +## Flags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagTypeDescription
`--airgap-bundle`string +

Path to the air gap bundle. If set, the installation will complete without internet access.

+
`--cidr`string +

CIDR block of available private IP addresses (/16 or larger) (default "10.244.0.0/16")

+
`--data-dir`string +

Path to the data directory (default "/var/lib/embedded-cluster")

+
`-h, --help` +

help for restore

+
`--http-proxy`string +

HTTP proxy to use for the installation

+
`--https-proxy`string +

HTTPS proxy to use for the installation

+
`--ignore-host-preflights` +

Allow bypassing host preflight failures

+
`--local-artifact-mirror-port`int +

Port on which the Local Artifact Mirror will be served (default 50000)

+
`--network-interface`string +

The network interface to use for the cluster

+
`--no-proxy`string +

Comma-separated list of hosts for which not to use a proxy

+
`--private-ca`strings +

Path to a trusted private CA certificate file

+
`--skip-store-validation` +

Skip validation of the backup storage location

+
`-y, --yes` +

Assume yes to all prompts.

+
\ No newline at end of file diff --git a/docs/reference/embedded-cluster-shell.mdx b/docs/reference/embedded-cluster-shell.mdx new file mode 100644 index 0000000000..9276a6de04 --- /dev/null +++ b/docs/reference/embedded-cluster-shell.mdx @@ -0,0 +1,27 @@ +# shell + +This topic describes the options available with the Embedded Cluster `shell` command. + +## Usage + +```bash +sudo ./ shell [flags] +``` + +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for shell

+
+ diff --git a/docs/reference/embedded-cluster-support-bundle.mdx b/docs/reference/embedded-cluster-support-bundle.mdx new file mode 100644 index 0000000000..5eba094dc4 --- /dev/null +++ b/docs/reference/embedded-cluster-support-bundle.mdx @@ -0,0 +1,27 @@ +# support-bundle + +This topic describes the options available with the Embedded Cluster `support-bundle` command. For more information about generating support bundles for Embedded Cluster installations, see [Troubleshoot Embedded Cluster](/vendor/embedded-troubleshooting). + +## Usage + +```bash +sudo ./ support-bundle [flags] +``` + +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for support-bundle

+
+ diff --git a/docs/reference/embedded-cluster-update.mdx b/docs/reference/embedded-cluster-update.mdx new file mode 100644 index 0000000000..6fc8474972 --- /dev/null +++ b/docs/reference/embedded-cluster-update.mdx @@ -0,0 +1,34 @@ +# update + +This topic describes the options available with the Embedded Cluster `update` command. The `update` command allows you to update an instance with a new air gap bundle. This is part of the process for performing updates in air-gapped environments. For more information, see [Update in Air Gap Clusters](/enterprise/updating-embedded#update-in-air-gap-clusters) in _Perform Updates in Embedded Clusters_. + +## Usage + +```bash +sudo ./ update. --airgap-bundle [flags] +``` + +## Flags + + + + + + + + + + + + + + + + + +
FlagTypeDescription
`--airgap-bundle`string +

Path to the air gap bundle. If set, the installation will complete without internet access.

+
`-h, --help` +

help for update

+
+ diff --git a/docs/reference/embedded-cluster-version.mdx b/docs/reference/embedded-cluster-version.mdx new file mode 100644 index 0000000000..d1019f33ba --- /dev/null +++ b/docs/reference/embedded-cluster-version.mdx @@ -0,0 +1,58 @@ +# version + +This topic describes the options available with the Embedded Cluster `version` command. + +## Usage + +```bash +sudo ./ version [flags] +``` + +```bash +sudo ./ version [command] +``` + +## Subcommands + + + + + + + + + + + + + + + + + + +
CommandDescription
embedded-data +

Read the application data embedded in the cluster

+
list-images +

List images embedded in the cluster

+
metadata +

Print metadata about this release

+
+ +## Flags + + + + + + + + + + + + +
FlagTypeDescription
`-h, --help` +

help for version

+
+ diff --git a/docs/release-notes/rn-embedded-cluster.md b/docs/release-notes/rn-embedded-cluster.md index 7d831ea7b0..ec61afbc31 100644 --- a/docs/release-notes/rn-embedded-cluster.md +++ b/docs/release-notes/rn-embedded-cluster.md @@ -659,9 +659,9 @@ Released on October 23, 2024 ### New Features {#new-features-1-16-0} * Adds support for Kubernetes 1.30 and removes support for 1.28. -* Adds a `--data-dir` flag to the `install` and `restore` commands so the data directory can be specified. By default, the data directory is `/var/lib/embedded-cluster`. If the `--data-dir` flag was provided at install time, then the same data directory must be provided when restoring. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install) and [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery). +* Adds a `--data-dir` flag to the `install` and `restore` commands so the data directory can be specified. By default, the data directory is `/var/lib/embedded-cluster`. If the `--data-dir` flag was provided at install time, then the same data directory must be provided when restoring. For more information, see [install](/reference/embedded-cluster-install) and [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery). * Adds an `admin-console reset-password` command that allows resetting the password for the Admin Console. -* Adds a `--cidr` flag to the `install` command that replaces the `--pod-cidr` and `--service-cidr` flags. The CIDR range specified with the `--cidr` flag is split and used for both the Pod and Service CIDRs. See [Embedded Cluster Install Command Options](/reference/embedded-cluster-install). +* Adds a `--cidr` flag to the `install` command that replaces the `--pod-cidr` and `--service-cidr` flags. The CIDR range specified with the `--cidr` flag is split and used for both the Pod and Service CIDRs. See [install](/reference/embedded-cluster-install). :::note The `--pod-cidr` and `--service-cidr` flags are hidden, but still functional. Replicated recommends that you update any automation that uses the `--pod-cidr` and `--service-cidr` flags to use the `--cidr` flag instead. diff --git a/docs/vendor/embedded-disaster-recovery.mdx b/docs/vendor/embedded-disaster-recovery.mdx index db9dbb4019..8e6565af46 100644 --- a/docs/vendor/embedded-disaster-recovery.mdx +++ b/docs/vendor/embedded-disaster-recovery.mdx @@ -44,7 +44,7 @@ Embedded Cluster disaster recovery has the following limitations and known issue * Velero is installed only during the initial installation process. Enabling the disaster recovery license field for customers after they have already installed will not do anything. -* If the `--admin-console-port` flag was used during install to change the port for the Admin Console, note that during a restore the Admin Console port will be used from the backup and cannot be changed. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install). +* If the `--admin-console-port` flag was used during install to change the port for the Admin Console, note that during a restore the Admin Console port will be used from the backup and cannot be changed. For more information, see [install](/reference/embedded-cluster-install). ## Configure Disaster Recovery @@ -223,11 +223,11 @@ To restore from a backup: Note the following requirements and guidance for the `restore` command: - * If the installation is behind a proxy, the same proxy settings provided during install must be provided to the restore command using `--http-proxy`, `--https-proxy`, and `--no-proxy`. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install). + * If the installation is behind a proxy, the same proxy settings provided during install must be provided to the restore command using `--http-proxy`, `--https-proxy`, and `--no-proxy`. For more information, see [install](/reference/embedded-cluster-install). - * If the `--cidr` flag was used during install to the set IP address ranges for Pods and Services, this flag must be provided with the same CIDR during the restore. If this flag is not provided or is provided with a different CIDR, the restore will fail with an error message telling you to rerun with the appropriate value. However, it will take some time before that error occurs. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install). + * If the `--cidr` flag was used during install to the set IP address ranges for Pods and Services, this flag must be provided with the same CIDR during the restore. If this flag is not provided or is provided with a different CIDR, the restore will fail with an error message telling you to rerun with the appropriate value. However, it will take some time before that error occurs. For more information, see [install](/reference/embedded-cluster-install). - * If the `--local-artifact-mirror-port` flag was used during install to change the port for the Local Artifact Mirror (LAM), you can optionally use the `--local-artifact-mirror-port` flag to choose a different LAM port during restore. For example, `restore --local-artifact-mirror-port=50000`. If no LAM port is provided during restore, the LAM port that was supplied during installation will be used. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install). + * If the `--local-artifact-mirror-port` flag was used during install to change the port for the Local Artifact Mirror (LAM), you can optionally use the `--local-artifact-mirror-port` flag to choose a different LAM port during restore. For example, `restore --local-artifact-mirror-port=50000`. If no LAM port is provided during restore, the LAM port that was supplied during installation will be used. For more information, see [install](/reference/embedded-cluster-install). You will be guided through the process of restoring from a backup. diff --git a/sidebars.js b/sidebars.js index 233c57fa5f..50308fa4c8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -251,7 +251,6 @@ const sidebars = { 'enterprise/installing-embedded', 'enterprise/installing-embedded-air-gap', 'enterprise/installing-embedded-automation', - 'reference/embedded-cluster-install', ], }, 'enterprise/embedded-manage-nodes', @@ -259,6 +258,24 @@ const sidebars = { 'vendor/embedded-troubleshooting', 'enterprise/embedded-tls-certs', 'vendor/embedded-disaster-recovery', + { + type: 'category', + label: 'Embedded Cluster Commands', + items: [ + 'reference/embedded-cluster-admin-console', + 'reference/embedded-cluster-completion', + 'reference/embedded-cluster-enable-ha', + 'reference/embedded-cluster-install', + 'reference/embedded-cluster-join', + 'reference/embedded-cluster-join-print-command', + 'reference/embedded-cluster-reset', + 'reference/embedded-cluster-restore', + 'reference/embedded-cluster-shell', + 'reference/embedded-cluster-support-bundle', + 'reference/embedded-cluster-update', + 'reference/embedded-cluster-version', + ], + }, ], }, {