Skip to content

Commit 4ca54a3

Browse files
committed
update title and xrefs
1 parent 69e08f0 commit 4ca54a3

10 files changed

+13
-18
lines changed

docs/enterprise/installing-existing-cluster-automation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ import PushKotsImages from "../partials/install/_push-kotsadm-images.mdx"
1313
import KotsVersionMatch from "../partials/install/_kots-airgap-version-match.mdx"
1414
import PlaceholderRoCreds from "../partials/install/_placeholder-ro-creds.mdx"
1515

16-
# Installing with the CLI
16+
# Installing from the Command Line
1717

1818
This topic describes how to install an application with Replicated KOTS, Replicated Embedded Cluster, or Replicated kURL from the command line.
1919

2020
## Overview
2121

22-
You can use the command line to install an application with Replicated KOTS, Replicated Embedded Cluster, or Replicated kURL. A common use case for installing with the CLI is to automate installation, such as performing headless installations as part of CI/CD pipelines.
22+
You can use the command line to install an application with Replicated KOTS, Replicated Embedded Cluster, or Replicated kURL. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
2323

24-
To install with the CLI, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during CLI installations rather than being displayed in the Admin Console.
24+
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
2525

2626
## Prerequisite
2727

docs/enterprise/installing-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For information about image registry requirements, see [Private Registry Require
4848

4949
You can automate application installation in online, air gap, existing cluster, and embedded cluster environments using the KOTS CLI. In an automated installation, you provide all the information required to install and deploy the application with the `kots install` command, rather than providing this information in the Replicated Admin Console.
5050

51-
For more information, see [Installing with Automation](/enterprise/installing-existing-cluster-automation).
51+
For more information, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).
5252

5353
### KOTS Installations Without Object Storage
5454

docs/intro-kots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ The kots command-line interface (CLI) is a kubectl plugin. Customers can run com
7070

7171
For information about getting started with the KOTS CLI, see [Installing the KOTS CLI](/reference/kots-cli-getting-started).
7272

73-
The KOTS CLI can also be used to install an application without needing to access the Admin Console. This can be useful for automating installations and upgrades. For information about how to run automated installations with the KOTS CLI, see [Installing with the CLI](/enterprise/installing-existing-cluster-automation).
73+
The KOTS CLI can also be used to install an application without needing to access the Admin Console. This can be useful for automating installations and upgrades, such as in CI/CD pipelines. For information about how to perform headless installations from the command line, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).

docs/reference/kots-cli-install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ This command supports all [global flags](kots-cli-global-flags) and also:
5757
<tr>
5858
<td><code>--config-values</code></td>
5959
<td>string</td>
60-
<td>Path to a manifest file containing configuration values. This manifest must be <code>apiVersion: kots.io/v1beta1</code> and <code>kind: ConfigValues</code>. For more information, see <a href="/enterprise/installing-existing-cluster-automation">Installing with the CLI</a>.</td>
60+
<td>Path to a manifest file containing configuration values. This manifest must be <code>apiVersion: kots.io/v1beta1</code> and <code>kind: ConfigValues</code>. For more information, see <a href="/enterprise/installing-existing-cluster-automation">Installing from the Command Line</a>.</td>
6161
</tr>
6262
<tr>
6363
<td><code>--copy-proxy-env</code></td>

docs/vendor/embedded-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Embedded Cluster has the following limitations:
5555

5656
* **Changing node hostnames is not supported**: After a host is added to a Kubernetes cluster, Kubernetes assumes that the hostname and IP address of the host will not change. If you need to change the hostname or IP address of a node, you must first remove the node from the cluster. For more information about the requirements for naming nodes, see [Node name uniqueness](https://kubernetes.io/docs/concepts/architecture/nodes/#node-name-uniqueness) in the Kubernetes documentation.
5757

58-
* **Automated installations not supported**: Users cannot do automated (headless) Embedded Cluster installations because it is not possible to configure the application by passing the [ConfigValues](/vendor/releases-configvalues) file with the installation command. Embedded Cluster installations require that the application is configured from the Admin Console config screen. For more information about automating existing cluster or kURL installations with the KOTS CLI, see [Installing with the CLI](/enterprise/installing-existing-cluster-automation).
58+
* **Automated installations not supported**: Users cannot do automated (headless) Embedded Cluster installations because it is not possible to configure the application by passing the [ConfigValues](/vendor/releases-configvalues) file with the installation command. Embedded Cluster installations require that the application is configured from the Admin Console config screen. For more information about automating existing cluster or kURL installations with the KOTS CLI, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).
5959

6060
* **Automatic updates not supported**: Configuring automatic updates from the Admin Console so that new versions are automatically deployed is not supported for Embedded Cluster installations. For more information, see [Configuring Automatic Updates](/enterprise/updating-apps).
6161

docs/vendor/packaging-rbac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The following limitations apply when using the `requireMinimalRBACPrivileges` or
108108

109109
In non-headless installations in air gap environments, KOTS does not have access to the application's `.airgap` package during installation. This means that KOTS does not have the information required to determine whether namespace-scoped access is needed, so it defaults to the more permissive, default cluster-scoped RBAC policy.
110110

111-
For more information about how to do headless installations in air gap environments, see [Air Gap Existing Cluster](/enterprise/installing-existing-cluster-automation#air-gap-existing-cluster) in _Installing with the CLI_.
111+
For more information about how to do headless installations in air gap environments, see [Air Gap Install](/enterprise/installing-existing-cluster-automation#air-gap-install) in _Installing from the Command Line_.
112112

113113
* **Changing RBAC permissions for installed instances**: The RBAC permissions for KOTS are set during its initial installation. KOTS runs using the assumed identity and cannot change its own authorization. When you update your application to add or remove the `requireMinimalRBACPrivileges` and `supportMinimalRBACPrivileges` flags in the Application custom resource, the RBAC permissions for KOTS are affected only for new installations. Existing KOTS installations continue to run with their current RBAC permissions.
114114

docs/vendor/releases-configvalues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The KOTS ConfigValues file includes the fields that are defined in the KOTS Conf
1818

1919
The ConfigValues file allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. This supports automated or _headless_ installations, such as when installing an application as part of CI/CD pipelines.
2020

21-
For more information about installing from the command line, see [Installing with the CLI](/enterprise/installing-existing-cluster-automation).
21+
For more information about installing from the command line, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).
2222

2323
## Get the ConfigValues File
2424

docs/vendor/replicated-sdk-airgap.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,4 @@ Replicated does not provide air gap bundles for applications installed with the
3939

4040
### KOTS
4141

42-
When the SDK is installed by KOTS in an air gap environment, KOTS automatically sets `isAirGap: true` in the SDK Helm chart values to enable air gap mode. No additional configuration is required.
43-
44-
KOTS automatically enables air gap mode for the SDK when the user follows any of these procedures to do an air gap installation:
45-
* [Air Gap Installation in Existing Clusters](/enterprise/installing-existing-cluster-airgapped)
46-
* [Air Gap Installation with kURL](/enterprise/installing-kurl-airgap)
47-
* [Air Gap Existing Cluster](/enterprise/installing-existing-cluster-automation#air-gap-existing-cluster) or [Air Gap kURL Cluster](/enterprise/installing-existing-cluster-automation#air-gap-kurl-cluster) in _Installing with the CLI_
42+
When the SDK is installed by KOTS in an air gap environment, KOTS automatically sets `isAirGap: true` in the SDK Helm chart values to enable air gap mode. No additional configuration is required.

docs/vendor/replicated-sdk-customizing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ replicated:
117117
```
118118

119119
:::note
120-
If the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables are configured with the [kots install](/enterprise/installing-existing-cluster-automation) command, these variables will also be set automatically in the Replicated SDK.
120+
If the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables are configured with the [kots install](/reference/kots-cli-install) command, these variables will also be set automatically in the Replicated SDK.
121121
:::
122122

123123
**Example**:
@@ -152,7 +152,7 @@ To use a CA stored in a ConfigMap:
152152
```
153153
154154
:::note
155-
If the `--private-ca-configmap` flag is used with the [kots install](/enterprise/installing-existing-cluster-automation) command, this value will be populated in the Replicated SDK automatically.
155+
If the `--private-ca-configmap` flag is used with the [kots install](/reference/kots-cli-install) command, this value will be populated in the Replicated SDK automatically.
156156
:::
157157

158158
### Using a Secret

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ const sidebars = {
369369
},
370370
{
371371
type: 'category',
372-
label: 'Installing with the CLI',
372+
label: 'Installing from the Command Line',
373373
items: [
374374
'enterprise/installing-existing-cluster-automation',
375375
'vendor/releases-configvalues',

0 commit comments

Comments
 (0)