Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/enterprise/updating-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Admin Console only deploys new versions automatically if preflight checks pa

Automatic updates have the following limitations:

* Automatic updates are not supported for [Replicated Embedded Cluster](/vendor/embedded-overview) installations.
* Automatic updates are not supported for [Replicated Embedded Cluster](/installer/embedded-overview) installations.

* Automatic updates are not supported for applications installed in air gap environments with no outbound internet access.

Expand Down
8 changes: 4 additions & 4 deletions docs/intro-replicated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following diagram demonstrates the process of using the Replicated Platform

The diagram above shows an application that is packaged with the [**Replicated SDK**](/vendor/replicated-sdk-overview). The application is tested in clusters provisioned with the [**Replicated Compatibility Matrix (CMX)**](/vendor/testing-about), then added to a new release in the [**Vendor Portal**](/vendor/releases-about) using an automated CI/CD pipeline.

The application is then installed by a customer ("Big Bank") on a VM. To install, the customer downloads their license, which grants proxy access to the application images through the [**Replicated proxy registry**](/vendor/private-images-about). They also download the installation assets for the [**Replicated Embedded Cluster**](/vendor/embedded-overview) installer.
The application is then installed by a customer ("Big Bank") on a VM. To install, the customer downloads their license, which grants proxy access to the application images through the [**Replicated proxy registry**](/vendor/private-images-about). They also download the installation assets for the [**Replicated Embedded Cluster**](/installer/embedded-overview) installer.

Embedded Cluster runs [**preflight checks**](/vendor/preflight-support-bundle-about) to verify that the environment meets the installation requirements, provisions a cluster on the VM, and installs [**Replicated KOTS**](intro-kots) in the cluster. KOTS provides an [**Admin Console**](intro-kots#kots-admin-console) where the customer enters application-specific configurations, runs application preflight checks, optionally joins nodes to the cluster, and then deploys the application. After installation, customers can manage both the application and the cluster from the Admin Console.

Expand All @@ -45,7 +45,7 @@ Replicated Embedded Cluster is a Kubernetes installer based on the open source K

Additionally, each version of Embedded Cluster includes a specific version of [Replicated KOTS](#kots) that is installed in the cluster during installation. KOTS is used by Embedded Cluster to deploy the application and also provides the Admin Console UI where users can manage both the application and the cluster.

For more information, see [Embedded Cluster Overview](/vendor/embedded-overview).
For more information, see [Embedded Cluster Overview](/installer/embedded-overview).

### KOTS (Admin Console) {#kots}

Expand Down Expand Up @@ -169,9 +169,9 @@ Additionally, the Replicated proxy registry grants proxy access to private appli

Applications distributed with the Replicated Platform can support multiple different installation methods from the same application release, helping you to meet your customers where they are. For example:

* Customers who are not experienced with Kubernetes or who prefer to deploy to a dedicated cluster in their environment can install on a VM or bare metal server with the Replicated Embedded Cluster installer. For more information, see [Embedded Cluster Overview](/vendor/embedded-overview).
* Customers who are not experienced with Kubernetes or who prefer to deploy to a dedicated cluster in their environment can install on a VM or bare metal server with the Replicated Embedded Cluster installer. For more information, see [Embedded Cluster Overview](/installer/embedded-overview).
* Customers familiar with Kubernetes and Helm can install in their own existing cluster using the Helm CLI. For more information, see [Installing with Helm](/vendor/install-with-helm).
* Customers installing into environments with limited or no outbound internet access (often referred to as air-gapped environments) can securely access and push images to their own internal registry, then install using Helm or a Replicated installer. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) and [Installing and Updating with Helm in Air Gap Environments](/vendor/helm-install-airgap).
* Customers installing into environments with limited or no outbound internet access (often referred to as air-gapped environments) can securely access and push images to their own internal registry, then install using Helm or a Replicated installer. For more information, see [Air Gap Installation with Embedded Cluster](/installer/installing-embedded-air-gap) and [Installing and Updating with Helm in Air Gap Environments](/vendor/helm-install-airgap).

Additionally, to enhance the installation experience, the Enterprise Portal provides a customizable, web-based portal where your customers can view application install and update instructions, upload support bundles, view insights about their active and inactive instances, and more. For more information, see [About the Enteprise Portal](/vendor/enterprise-portal-about).

Expand Down
2 changes: 1 addition & 1 deletion docs/partials/configValues/_config-values-procedure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ During installation, KOTS automatically generates a ConfigValues file and saves

To get the ConfigValues file from an installed application instance:

1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster).
1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/installer/installing-embedded) or [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster).

1. Depending on the installer that you used, do one of the following to get the ConfigValues for the installed instance:

Expand Down
2 changes: 1 addition & 1 deletion docs/partials/embedded-cluster/_multi-node-ha-arch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ As shown in the diagram above, in HA installations with Embedded Cluster:
* For installations that include disaster recovery, the Velero pod is deployed on one node. The Velero Node Agent runs on each node in the cluster. The Node Agent is a Kubernetes DaemonSet that performs backup and restore tasks such as creating snapshots and transferring data during restores.
* For air gap installations, two replicas of the air gap image registry are deployed.

Any Helm [`extensions`](/reference/embedded-config#extensions) that you include in the Embedded Cluster Config are installed in the cluster depending on the given chart and whether or not it is configured to be deployed with high availability.
Any Helm [`extensions`](/installer/embedded-config#extensions) that you include in the Embedded Cluster Config are installed in the cluster depending on the given chart and whether or not it is configured to be deployed with high availability.
4 changes: 2 additions & 2 deletions docs/partials/embedded-cluster/_port-reqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 [install](/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](/installer/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 [install](/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](/installer/embedded-cluster-install).
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
**Limitations:**

* If any of your [Helm extensions](/reference/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.
* If any of your [Helm extensions](/installer/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.

* Proxy settings cannot be changed after installation or during upgrade.
2 changes: 1 addition & 1 deletion docs/partials/embedded-cluster/_requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

* The user performing the installation must have root access to the machine, such as with `sudo`.

* 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).
* 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](/installer/embedded-cluster-install).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```bash
curl -f https://replicated.app/embedded/APP_SLUG/CHANNEL_SLUG?airgap=true -H "Authorization: LICENSE_ID" -o APP_SLUG-CHANNEL_SLUG.tgz
```
For more information, see [Install](/enterprise/installing-embedded-air-gap#install).
For more information, see [Install](/installer/installing-embedded-air-gap#install).

1. Untar the tarball. For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/partials/embedded-cluster/_update-air-gap-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
curl -f https://replicated.app/embedded/APP_SLUG/CHANNEL_SLUG?airgap=true -H "Authorization: LICENSE_ID" -o APP_SLUG-CHANNEL_SLUG.tgz
```

For more information, see [Install](/enterprise/installing-embedded-air-gap#install).
For more information, see [Install](/installer/installing-embedded-air-gap#install).

1. Untar the tarball. For example:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
:::important
Do not downgrade the Embedded Cluster version, downgrade the Kubernetes version, nor upgrade Kubernetes by more than one minor version at a time. These actions are not prevented by the Admin Console and can lead to unexpected behavior. For more information, see [Limitations](/vendor/embedded-overview#limitations) in _Embedded Cluster Overview_.
Do not downgrade the Embedded Cluster version, downgrade the Kubernetes version, nor upgrade Kubernetes by more than one minor version at a time. These actions are not prevented by the Admin Console and can lead to unexpected behavior. For more information, see [Limitations](/installer/embedded-overview#limitations) in _Embedded Cluster Overview_.
:::
2 changes: 1 addition & 1 deletion docs/partials/getting-started/_test-your-changes.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Install the release to test your changes. For Embedded Cluster installations, see [Performing Udpates in Embedded Clusters](/enterprise/updating-embedded). For existing cluster installations with KOTS, see [Perform Updates in Existing Clusters](/enterprise/updating-app-manager).
Install the release to test your changes. For Embedded Cluster installations, see [Performing Udpates in Embedded Clusters](/installer/updating-embedded). For existing cluster installations with KOTS, see [Perform Updates in Existing Clusters](/enterprise/updating-app-manager).
2 changes: 1 addition & 1 deletion docs/partials/install/_config-values-procedure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
To get the ConfigValues file from an installed application instance:

1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster).
1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/installer/installing-embedded) or [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster).

1. Depending on the installer that you used, do one of the following to get the ConfigValues for the installed instance:

Expand Down
4 changes: 2 additions & 2 deletions docs/partials/install/_ec-prereqs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
* Ensure that your installation environment meets the Embedded Cluster requirements. See [Embedded Cluster Requirements](/enterprise/installing-embedded-requirements).
* Ensure that your installation environment meets the Embedded Cluster requirements. See [Embedded Cluster Requirements](/installer/installing-embedded-requirements).

* The application release that you want to install must include an [Embedded Cluster Config](/reference/embedded-config).
* The application release that you want to install must include an [Embedded Cluster Config](/installer/embedded-config).

* The license used to install must have the **Embedded Cluster Enabled** license field enabled. See [Create and Manage Customers](/vendor/releases-creating-customer).
2 changes: 1 addition & 1 deletion docs/partials/kurl/_kurl-availability.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::note
Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see [Use Embedded Cluster](/vendor/embedded-overview).
Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see [Use Embedded Cluster](/installer/embedded-overview).

kURL is a Generally Available (GA) product for existing customers. For more information about the Replicated product lifecycle phases, see [Support Lifecycle Policy](/vendor/policies-support-lifecycle).
:::
2 changes: 1 addition & 1 deletion docs/partials/monitoring/_limitation-ec.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Monitoring applications with Prometheus is not supported for installations with [Replicated Embedded Cluster](/vendor/embedded-overview).
Monitoring applications with Prometheus is not supported for installations with [Replicated Embedded Cluster](/installer/embedded-overview).
2 changes: 1 addition & 1 deletion docs/partials/snapshots/_limitation-no-ec-support.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The KOTS Snapshots feature is supported for existing cluster installations with KOTS and Replicated kURL installations only. Snapshots is not supported for Replicated Embedded Cluster installations. For more information about configuring backup and restore for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).
The KOTS Snapshots feature is supported for existing cluster installations with KOTS and Replicated kURL installations only. Snapshots is not supported for Replicated Embedded Cluster installations. For more information about configuring backup and restore for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/installer/embedded-disaster-recovery).
2 changes: 1 addition & 1 deletion docs/partials/template-functions/_ne-comparison.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
In the example below, the `ingress_type` field is displayed on the **Config** page only when the distribution of the cluster is _not_ [Replicated Embedded Cluster](/vendor/embedded-overview). This ensures that only users deploying to their own existing cluster are able to select the method for ingress.
In the example below, the `ingress_type` field is displayed on the **Config** page only when the distribution of the cluster is _not_ [Replicated Embedded Cluster](/installer/embedded-overview). This ensures that only users deploying to their own existing cluster are able to select the method for ingress.

The following example uses:
* KOTS [Distribution](/reference/template-functions-static-context#distribution) template function to return the Kubernetes distribution of the cluster where KOTS is running
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/custom-resource-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following custom resources can be used in releases distributed with Replicat
</tr>
<tr>
<td>embeddedcluster.replicated.com/v1beta1</td>
<td>[Config](/reference/embedded-config)</td>
<td>[Config](/installer/embedded-config)</td>
<td>Defines a Replicated Embedded Cluster distribution</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/custom-resource-application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ spec:
</tr>
<tr>
<th>Supported for <a href="/vendor/embedded-overview">Embedded Cluster</a>?</th>
<td>Embedded Cluster 1.17.0 and later supports partial rollbacks of the application version. Partial rollbacks are supported only when rolling back to a version where there is no change to the [Embedded Cluster Config](/reference/embedded-config) compared to the currently-installed version. For example, users can roll back to release version 1.0.0 after upgrading to 1.1.0 only if both 1.0.0 and 1.1.0 use the same Embedded Cluster Config.</td>
<td>Embedded Cluster 1.17.0 and later supports partial rollbacks of the application version. Partial rollbacks are supported only when rolling back to a version where there is no change to the [Embedded Cluster Config](/installer/embedded-config) compared to the currently-installed version. For example, users can roll back to release version 1.0.0 after upgrading to 1.1.0 only if both 1.0.0 and 1.1.0 use the same Embedded Cluster Config.</td>
</tr>
</table>

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/custom-resource-configvalues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For information about the Replicated KOTS Config custom resource, which is used

The ConfigValues resource lists the values and defaults for each application configuration item defined in the Replicated KOTS [Config](custom-resource-config) resource in the release.

In automated or headless installations, end users provide a ConfigValues resource with the install command to set the application configuration values from the command line rather than through the Admin Console UI. For more information about performing headless installations with Replicated Embedded Cluster, see [Automate Embedded Cluster Installations](/enterprise/installing-embedded-automation). For information about performing headless installations with KOTS in an existing cluster, see [Install with the KOTS CLI](/enterprise/installing-existing-cluster-automation).
In automated or headless installations, end users provide a ConfigValues resource with the install command to set the application configuration values from the command line rather than through the Admin Console UI. For more information about performing headless installations with Replicated Embedded Cluster, see [Automate Embedded Cluster Installations](/installer/installing-embedded-automation). For information about performing headless installations with KOTS in an existing cluster, see [Install with the KOTS CLI](/enterprise/installing-existing-cluster-automation).

Additionally, for each installation, the Admin Console automatically generates a ConfigValues resource and makes it available for download in the Admin Console **View files** tab or with the [`kots get config`](/reference/kots-cli-get-config) command. For more information, see [Download the ConfigValues for an Installation](#download) below.

Expand Down
Loading