From 067c127fa0d561b3baf200ee7805689f341de51d Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 26 Jan 2026 11:19:39 -0700 Subject: [PATCH 1/4] add separate installer instance --- docs/enterprise/updating-apps.mdx | 2 +- docs/intro-replicated.mdx | 8 +-- .../configValues/_config-values-procedure.mdx | 2 +- .../embedded-cluster/_multi-node-ha-arch.mdx | 2 +- docs/partials/embedded-cluster/_port-reqs.mdx | 4 +- .../_proxy-install-limitations.mdx | 2 +- .../embedded-cluster/_requirements.mdx | 2 +- .../_update-air-gap-admin-console.mdx | 2 +- .../embedded-cluster/_update-air-gap-cli.mdx | 2 +- .../_warning-do-not-downgrade.mdx | 2 +- .../getting-started/_test-your-changes.mdx | 2 +- .../install/_config-values-procedure.mdx | 2 +- docs/partials/install/_ec-prereqs.mdx | 4 +- docs/partials/kurl/_kurl-availability.mdx | 2 +- docs/partials/monitoring/_limitation-ec.mdx | 2 +- .../snapshots/_limitation-no-ec-support.mdx | 2 +- .../template-functions/_ne-comparison.mdx | 2 +- docs/reference/custom-resource-about.md | 2 +- .../reference/custom-resource-application.mdx | 2 +- .../custom-resource-configvalues.mdx | 2 +- docs/reference/template-functions-about.mdx | 2 +- .../reference/template-functions-examples.mdx | 2 +- docs/release-notes/rn-app-manager.md | 4 +- docs/release-notes/rn-embedded-cluster.md | 28 ++++----- docs/release-notes/rn-kubernetes-installer.md | 2 +- docs/release-notes/rn-vendor-platform.md | 4 +- .../admin-console-adding-buttons-links.mdx | 2 +- docs/vendor/admin-console-port-forward.mdx | 2 +- docs/vendor/config-screen-conditional.mdx | 2 +- docs/vendor/custom-domains-using.md | 6 +- docs/vendor/custom-domains.md | 2 +- docs/vendor/environment-setup.mdx | 2 +- docs/vendor/helm-native-v2-using.md | 2 +- docs/vendor/helm-packaging-airgap-bundles.mdx | 2 +- docs/vendor/kots-faq.mdx | 10 +-- docs/vendor/kurl-nodeport-services.mdx | 4 +- docs/vendor/licenses-about.mdx | 2 +- docs/vendor/licenses-install-types.mdx | 2 +- docs/vendor/licenses-using-builtin-fields.mdx | 4 +- docs/vendor/packaging-kots-versions.md | 2 +- docs/vendor/preflight-host-preflights.md | 2 +- .../vendor/preflight-support-bundle-about.mdx | 6 +- docs/vendor/quick-start.mdx | 2 +- docs/vendor/releases-about.mdx | 2 +- ...eleases-sharing-license-install-script.mdx | 2 +- .../replicated-onboarding-helm-only.mdx | 2 +- docs/vendor/replicated-onboarding.mdx | 16 ++--- docs/vendor/replicated-sdk-installing.mdx | 4 +- docs/vendor/support-bundle-embedded.mdx | 2 +- docs/vendor/testing-network-policy.md | 2 +- docs/vendor/testing-supported-clusters.md | 2 +- .../tutorial-embedded-cluster-automation.mdx | 4 +- docusaurus.config.js | 63 +++++++++++-------- .../embedded-cluster-admin-console.mdx | 0 .../embedded-cluster-completion.mdx | 0 .../embedded-cluster-enable-ha.mdx | 0 .../embedded-cluster-install.mdx | 18 +++--- .../embedded-cluster-join-print-command.mdx | 2 +- .../embedded-cluster-join.mdx | 2 +- .../embedded-cluster-reset.mdx | 0 .../embedded-cluster-restore.mdx | 0 .../embedded-cluster-shell.mdx | 0 .../embedded-cluster-support-bundle.mdx | 2 +- .../embedded-cluster-update.mdx | 0 .../embedded-cluster-version.mdx | 0 .../embedded-config.mdx | 8 +-- .../embedded-disaster-recovery.mdx | 12 ++-- .../embedded-manage-nodes.mdx | 8 +-- .../embedded-overview.mdx | 18 +++--- .../embedded-tls-certs.mdx | 0 .../embedded-troubleshooting.mdx | 10 +-- {docs/vendor => installer}/embedded-using.mdx | 18 +++--- .../installing-embedded-air-gap.mdx | 14 ++--- .../installing-embedded-automation.mdx | 16 ++--- .../installing-embedded-requirements.mdx | 6 +- .../installing-embedded.mdx | 8 +-- .../updating-embedded.mdx | 12 ++-- .../version-2.0.0/ec-v3-overview.md | 1 + .../version-2.0.0-sidebars.json | 5 ++ installer_versions.json | 3 + sidebars.js | 42 ------------- sidebarsInstaller.js | 40 ++++++++++++ 82 files changed, 255 insertions(+), 235 deletions(-) rename {docs/reference => installer}/embedded-cluster-admin-console.mdx (100%) rename {docs/reference => installer}/embedded-cluster-completion.mdx (100%) rename {docs/reference => installer}/embedded-cluster-enable-ha.mdx (100%) rename {docs/reference => installer}/embedded-cluster-install.mdx (92%) rename {docs/reference => installer}/embedded-cluster-join-print-command.mdx (93%) rename {docs/reference => installer}/embedded-cluster-join.mdx (94%) rename {docs/reference => installer}/embedded-cluster-reset.mdx (100%) rename {docs/reference => installer}/embedded-cluster-restore.mdx (100%) rename {docs/reference => installer}/embedded-cluster-shell.mdx (100%) rename {docs/reference => installer}/embedded-cluster-support-bundle.mdx (89%) rename {docs/reference => installer}/embedded-cluster-update.mdx (100%) rename {docs/reference => installer}/embedded-cluster-version.mdx (100%) rename {docs/reference => installer}/embedded-config.mdx (98%) rename {docs/vendor => installer}/embedded-disaster-recovery.mdx (97%) rename {docs/enterprise => installer}/embedded-manage-nodes.mdx (94%) rename {docs/vendor => installer}/embedded-overview.mdx (90%) rename {docs/enterprise => installer}/embedded-tls-certs.mdx (100%) rename {docs/vendor => installer}/embedded-troubleshooting.mdx (95%) rename {docs/vendor => installer}/embedded-using.mdx (94%) rename {docs/enterprise => installer}/installing-embedded-air-gap.mdx (93%) rename {docs/enterprise => installer}/installing-embedded-automation.mdx (89%) rename {docs/enterprise => installer}/installing-embedded-requirements.mdx (92%) rename {docs/enterprise => installer}/installing-embedded.mdx (94%) rename {docs/enterprise => installer}/updating-embedded.mdx (85%) create mode 100644 installer_versioned_docs/version-2.0.0/ec-v3-overview.md create mode 100644 installer_versioned_sidebars/version-2.0.0-sidebars.json create mode 100644 installer_versions.json create mode 100644 sidebarsInstaller.js diff --git a/docs/enterprise/updating-apps.mdx b/docs/enterprise/updating-apps.mdx index 71737b123e..69b4acbe93 100644 --- a/docs/enterprise/updating-apps.mdx +++ b/docs/enterprise/updating-apps.mdx @@ -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. diff --git a/docs/intro-replicated.mdx b/docs/intro-replicated.mdx index 111a4409b5..8efd369b12 100644 --- a/docs/intro-replicated.mdx +++ b/docs/intro-replicated.mdx @@ -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. @@ -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} @@ -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). diff --git a/docs/partials/configValues/_config-values-procedure.mdx b/docs/partials/configValues/_config-values-procedure.mdx index 339a5ba4da..7072e038ea 100644 --- a/docs/partials/configValues/_config-values-procedure.mdx +++ b/docs/partials/configValues/_config-values-procedure.mdx @@ -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: diff --git a/docs/partials/embedded-cluster/_multi-node-ha-arch.mdx b/docs/partials/embedded-cluster/_multi-node-ha-arch.mdx index d17db84bac..c83fb6ca30 100644 --- a/docs/partials/embedded-cluster/_multi-node-ha-arch.mdx +++ b/docs/partials/embedded-cluster/_multi-node-ha-arch.mdx @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/partials/embedded-cluster/_port-reqs.mdx b/docs/partials/embedded-cluster/_port-reqs.mdx index c973b4c086..9b0d67d291 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 [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). diff --git a/docs/partials/embedded-cluster/_proxy-install-limitations.mdx b/docs/partials/embedded-cluster/_proxy-install-limitations.mdx index c34a5ebc2b..3d607d8952 100644 --- a/docs/partials/embedded-cluster/_proxy-install-limitations.mdx +++ b/docs/partials/embedded-cluster/_proxy-install-limitations.mdx @@ -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. \ No newline at end of file diff --git a/docs/partials/embedded-cluster/_requirements.mdx b/docs/partials/embedded-cluster/_requirements.mdx index d5581cac1a..2847f91178 100644 --- a/docs/partials/embedded-cluster/_requirements.mdx +++ b/docs/partials/embedded-cluster/_requirements.mdx @@ -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: diff --git a/docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx b/docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx index dab72c9f0d..bb65215d08 100644 --- a/docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx +++ b/docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx @@ -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: diff --git a/docs/partials/embedded-cluster/_update-air-gap-cli.mdx b/docs/partials/embedded-cluster/_update-air-gap-cli.mdx index ac96fab4c3..55102e642f 100644 --- a/docs/partials/embedded-cluster/_update-air-gap-cli.mdx +++ b/docs/partials/embedded-cluster/_update-air-gap-cli.mdx @@ -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: diff --git a/docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx b/docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx index 1c20bd4878..ff24d9ae90 100644 --- a/docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx +++ b/docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx @@ -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_. ::: \ No newline at end of file diff --git a/docs/partials/getting-started/_test-your-changes.mdx b/docs/partials/getting-started/_test-your-changes.mdx index 4bb8b32fe6..f9559ff298 100644 --- a/docs/partials/getting-started/_test-your-changes.mdx +++ b/docs/partials/getting-started/_test-your-changes.mdx @@ -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/partials/install/_config-values-procedure.mdx b/docs/partials/install/_config-values-procedure.mdx index d9ba7a2026..5fcad201c3 100644 --- a/docs/partials/install/_config-values-procedure.mdx +++ b/docs/partials/install/_config-values-procedure.mdx @@ -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: diff --git a/docs/partials/install/_ec-prereqs.mdx b/docs/partials/install/_ec-prereqs.mdx index 33e12fa8a1..fea4f1bb05 100644 --- a/docs/partials/install/_ec-prereqs.mdx +++ b/docs/partials/install/_ec-prereqs.mdx @@ -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). \ No newline at end of file diff --git a/docs/partials/kurl/_kurl-availability.mdx b/docs/partials/kurl/_kurl-availability.mdx index 9944080fe6..72a8c12e36 100644 --- a/docs/partials/kurl/_kurl-availability.mdx +++ b/docs/partials/kurl/_kurl-availability.mdx @@ -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). ::: \ No newline at end of file diff --git a/docs/partials/monitoring/_limitation-ec.mdx b/docs/partials/monitoring/_limitation-ec.mdx index 62b32af924..e7624c430b 100644 --- a/docs/partials/monitoring/_limitation-ec.mdx +++ b/docs/partials/monitoring/_limitation-ec.mdx @@ -1 +1 @@ -Monitoring applications with Prometheus is not supported for installations with [Replicated Embedded Cluster](/vendor/embedded-overview). \ No newline at end of file +Monitoring applications with Prometheus is not supported for installations with [Replicated Embedded Cluster](/installer/embedded-overview). \ No newline at end of file diff --git a/docs/partials/snapshots/_limitation-no-ec-support.mdx b/docs/partials/snapshots/_limitation-no-ec-support.mdx index 8a419e0155..dd00ee938f 100644 --- a/docs/partials/snapshots/_limitation-no-ec-support.mdx +++ b/docs/partials/snapshots/_limitation-no-ec-support.mdx @@ -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/partials/template-functions/_ne-comparison.mdx b/docs/partials/template-functions/_ne-comparison.mdx index 66b7df17c7..1adf277f76 100644 --- a/docs/partials/template-functions/_ne-comparison.mdx +++ b/docs/partials/template-functions/_ne-comparison.mdx @@ -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 diff --git a/docs/reference/custom-resource-about.md b/docs/reference/custom-resource-about.md index 923b712462..4e6450bb0a 100644 --- a/docs/reference/custom-resource-about.md +++ b/docs/reference/custom-resource-about.md @@ -21,7 +21,7 @@ The following custom resources can be used in releases distributed with Replicat embeddedcluster.replicated.com/v1beta1 - [Config](/reference/embedded-config) + [Config](/installer/embedded-config) Defines a Replicated Embedded Cluster distribution diff --git a/docs/reference/custom-resource-application.mdx b/docs/reference/custom-resource-application.mdx index da58b5340d..838ec4594b 100644 --- a/docs/reference/custom-resource-application.mdx +++ b/docs/reference/custom-resource-application.mdx @@ -151,7 +151,7 @@ spec: Supported for Embedded Cluster? - 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. + 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. diff --git a/docs/reference/custom-resource-configvalues.mdx b/docs/reference/custom-resource-configvalues.mdx index 1c863dfe62..b36338c3f3 100644 --- a/docs/reference/custom-resource-configvalues.mdx +++ b/docs/reference/custom-resource-configvalues.mdx @@ -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. diff --git a/docs/reference/template-functions-about.mdx b/docs/reference/template-functions-about.mdx index d826674e23..a7ef0f4969 100644 --- a/docs/reference/template-functions-about.mdx +++ b/docs/reference/template-functions-about.mdx @@ -30,7 +30,7 @@ You can use Replicated template functions in Kubernetes manifest files for appli * Not all fields in the Config and Application custom resources support templating. For more information, see [Application](/reference/custom-resource-application) and [Item Properties](/reference/custom-resource-config#item-properties) in _Config_. -* Templating is not supported in the [Embedded Cluster Config](/reference/embedded-config) resource. +* Templating is not supported in the [Embedded Cluster Config](/installer/embedded-config) resource. * Replicated template functions are not directly supported in Helm charts. For more information, see [Helm Charts](#helm-charts) below. diff --git a/docs/reference/template-functions-examples.mdx b/docs/reference/template-functions-examples.mdx index de0e6f1e80..9c327841da 100644 --- a/docs/reference/template-functions-examples.mdx +++ b/docs/reference/template-functions-examples.mdx @@ -81,7 +81,7 @@ A common use case for string comparison is to compare the rendered value of a Re ### Not Equal To Comparison -It can be useful to compare the rendered value of a Replicated template function against another value to check if the two values are different. For example, you can conditionally show fields on the KOTS Admin Console **Config** page only when the Kubernetes distribution of the cluster where the application is deployed is _not_ [Replicated embedded cluster](/vendor/embedded-overview). +It can be useful to compare the rendered value of a Replicated template function against another value to check if the two values are different. For example, you can conditionally show fields on the KOTS Admin Console **Config** page only when the Kubernetes distribution of the cluster where the application is deployed is _not_ [Replicated embedded cluster](/installer/embedded-overview). diff --git a/docs/release-notes/rn-app-manager.md b/docs/release-notes/rn-app-manager.md index 3188fe7fd8..06e948e2cd 100644 --- a/docs/release-notes/rn-app-manager.md +++ b/docs/release-notes/rn-app-manager.md @@ -991,7 +991,7 @@ Support for Kubernetes: 1.26, 1.27, 1.28, and 1.29 * Adds the ability to update the config values for any app version using the admin console. ### Improvements {#improvements-1-108-0} -* Hides the **Application** and **Cluster Management** tabs on the admin console navbar during the initial installation flow with Replicated embedded cluster (Beta). For more information, see [Using Embedded Cluster](/vendor/embedded-overview). +* Hides the **Application** and **Cluster Management** tabs on the admin console navbar during the initial installation flow with Replicated embedded cluster (Beta). For more information, see [Using Embedded Cluster](/installer/embedded-overview). ### Bug Fixes {#bug-fixes-1-108-0} * Fixes an issue where the license upload page flashed briefly before being redirected to the login page. @@ -2476,7 +2476,7 @@ Released on March 21, 2022 Support for Kubernetes: 1.21, 1.22, and 1.23 ### New Features -* Adds support for installing a specific application version. For more information about installing a specific application version, see [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster and [Online Installation with the Kubernetes Installer](/enterprise/installing-embedded-cluster). +* Adds support for installing a specific application version. For more information about installing a specific application version, see [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster and [Online Installation with the Kubernetes Installer](/installer/installing-embedded-cluster). * Extends the ability of status informers to detect if the application is being updated. * Adds the ability to provide a strict preflight, which cannot be skipped and must not have any failure outcomes. Any failure outcomes will prevent the user from deploying the application. For more information on strict preflights, see [Define KOTS Preflight Checks​](/vendor/preflight-kots-defining). * New versions can automatically be deployed in the admin console, regardless of whether the vendor uses semantic versioning. For more information about automatically deploying new versions, see [Configure Automatic Updates​](/enterprise/updating-apps#configure-automatic-updates) in Updating an Application. diff --git a/docs/release-notes/rn-embedded-cluster.md b/docs/release-notes/rn-embedded-cluster.md index 21dee31ec4..57c86294f8 100644 --- a/docs/release-notes/rn-embedded-cluster.md +++ b/docs/release-notes/rn-embedded-cluster.md @@ -6,7 +6,7 @@ pagination_prev: null # Embedded Cluster Release Notes -This topic contains release notes for the [Replicated Embedded Cluster](/vendor/embedded-overview) installer. The release notes list new features, improvements, bug fixes, known issues, and breaking changes. +This topic contains release notes for the [Replicated Embedded Cluster](/installer/embedded-overview) installer. The release notes list new features, improvements, bug fixes, known issues, and breaking changes. Additionally, these release notes list the versions of Kubernetes and Replicated KOTS that are available with each version of Embedded Cluster. @@ -36,7 +36,7 @@ Released on January 14, 2026 ### New Features {#new-features-2-13-3} -* Adds the ability to override CPU and memory requests and limits for kotsadm and rqlite through [unsupportedOverrides](/reference/embedded-config#unsupportedoverrides) in the Embedded Cluster config. +* Adds the ability to override CPU and memory requests and limits for kotsadm and rqlite through [unsupportedOverrides](/installer/embedded-config#unsupportedoverrides) in the Embedded Cluster config. ### Bug Fixes {#bug-fixes-2-13-3} * Fixes an issue introduced in 2.13.1 and 2.13.2 where application upgrades could fail due to Helm v4’s default server-side apply by pinning to Helm v3 for compatibility. @@ -459,7 +459,7 @@ Released on July 2, 2025 ### Improvements {#improvements-2-7-1} -* Improves the default host support bundle generated by `./APP_SLUG support-bundle` with better diagnostics for different installation scenarios (such as air gap or proxy installations) and additional network diagnostics collecion. For more information, see [About the Default Embedded Cluster Support Bundle Spec](/vendor/embedded-troubleshooting#about-the-default-embedded-cluster-support-bundle-spec). +* Improves the default host support bundle generated by `./APP_SLUG support-bundle` with better diagnostics for different installation scenarios (such as air gap or proxy installations) and additional network diagnostics collecion. For more information, see [About the Default Embedded Cluster Support Bundle Spec](/installer/embedded-troubleshooting#about-the-default-embedded-cluster-support-bundle-spec). * Updates the Embedded Cluster CLI help menu to use the applciation name instead of the binary name (for example, "Manage the Wordpress Enterprise Admin Console" instead of "Manage the wordpress-enterprise Admin Console"). * Adds a preflight check to block XFS filesystems with `ftype=0` (`d_type` disabled), which are incompatible with the container runtime. @@ -521,7 +521,7 @@ Released on May 6, 2025 :::note Configuring node roles with the `roles` key is still beta. ::: -* Adds the `join print-command` command, which prints the commands that can be run on nodes to join them to the cluster. This command allows users to access the required join commands from the CLI, rather than needing to go to the Admin Console UI. This is particularly useful for CLI-based and automated creation of multi-node clusters. For more information, see [Automate Controller Node Joins](/enterprise/embedded-manage-nodes#automate-node-joins) in _Manage Multi-Node Clusters with Embedded Cluster_. +* Adds the `join print-command` command, which prints the commands that can be run on nodes to join them to the cluster. This command allows users to access the required join commands from the CLI, rather than needing to go to the Admin Console UI. This is particularly useful for CLI-based and automated creation of multi-node clusters. For more information, see [Automate Controller Node Joins](/installer/embedded-manage-nodes#automate-node-joins) in _Manage Multi-Node Clusters with Embedded Cluster_. * Adds support for the **Multi-node Cluster** license field, which allows you to choose whether a customer can install multi-node Embedded Clusters. If this license option is disabled, customers are not prompted to join nodes during the installation, and the **Add node** button is not present on the **Nodes** page. For more information, see [Built-In License Fields](/vendor/licenses-using-builtin-fields). ### Improvements {#improvements-2-4-0} @@ -531,17 +531,17 @@ Released on May 6, 2025 * Ensures that the version of the binary used to join a node is the same version that is currently installed on other nodes. * When prompted to enable high availability while joining a third or more controller node, the default response is yes to encourage users to enable high availability. - For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes#automate-node-joins). + For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/installer/embedded-manage-nodes#automate-node-joins). * Adds support for configuring `--http-proxy`, `--https-proxy`, and `--no-proxy` for the `install` command through environment variables. The following environment variables can be used instead of the command line flags: * `http_proxy` or `HTTP_PROXY` * `https_proxy` or `HTTPS_PROXY` * `no_proxy` or `NO_PROXY` - For more information, see [Embedded Cluster Install Options](/reference/embedded-cluster-install). + For more information, see [Embedded Cluster Install Options](/installer/embedded-cluster-install). ### Bug Fixes {#bug-fixes-2-4-0} * Fixes an issue that prevented a successful upgrade when a Helm extension was manually deleted or corrupted before the upgrade was attempted. -* Fixes an issue that prevented joining nodes after upgrading to a version that added [`workerProfiles`](/reference/embedded-config#configure-the-kubelet) in its `unsupportedOverrides` configuration. +* Fixes an issue that prevented joining nodes after upgrading to a version that added [`workerProfiles`](/installer/embedded-config#configure-the-kubelet) in its `unsupportedOverrides` configuration. * Fixes an issue where the `reset` command appeared to fail when parts of the installation were already cleaned up or were never successfully installed. ## 2.3.1 @@ -575,7 +575,7 @@ Released on April 8, 2025 ## 2.3.0 - Removed :::important -Embedded Cluster 2.3.0 has been removed because new installations do not work unless a worker profile is specified in the Embedded Cluster Config under `unsupportedOverrides`. For more information, see [Configure the Kubelet with k0s Worker Profiles](/reference/embedded-config#configure-the-kubelet). Upgrades to 2.3.0 were not affected because worker profiles are not used on upgrades. New upgrades to 2.3.0 are not available. Any users that already upgraded can continue to use 2.3.0. +Embedded Cluster 2.3.0 has been removed because new installations do not work unless a worker profile is specified in the Embedded Cluster Config under `unsupportedOverrides`. For more information, see [Configure the Kubelet with k0s Worker Profiles](/installer/embedded-config#configure-the-kubelet). Upgrades to 2.3.0 were not affected because worker profiles are not used on upgrades. New upgrades to 2.3.0 are not available. Any users that already upgraded can continue to use 2.3.0. ::: Released on April 3, 2025 @@ -809,7 +809,7 @@ Released on January 24, 2025 ### New Features {#new-features-1-22-0} -* Updates the disaster recovery alpha feature so that rather than having to apply specific labels to all the resources you want backed up, you now have full control over how your application is backed up and restored. Specifically, you now provide a Velero Backup resource and a Restore resource in your application release. These resources are used to back up and restore your application, separate from the Embedded Cluster infrastructure. For more information, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery). +* Updates the disaster recovery alpha feature so that rather than having to apply specific labels to all the resources you want backed up, you now have full control over how your application is backed up and restored. Specifically, you now provide a Velero Backup resource and a Restore resource in your application release. These resources are used to back up and restore your application, separate from the Embedded Cluster infrastructure. For more information, see [Disaster Recovery for Embedded Cluster](/installer/embedded-disaster-recovery). ## 1.21.0 @@ -938,7 +938,7 @@ Released on November 4, 2024 ### New Features {#new-features-1-17-0} -* Adds support for partial rollbacks. Partial rollbacks are supported only when rolling back to a version where there is no change to the Embedded Cluster 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](/reference/embedded-config). For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. +* Adds support for partial rollbacks. Partial rollbacks are supported only when rolling back to a version where there is no change to the Embedded Cluster 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](/installer/embedded-config). For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. * Introduces a new landing page and guided installation workflow for the Admin Console. ### Improvements {#improvements-1-17-0} @@ -974,9 +974,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 [install](/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](/installer/embedded-cluster-install) and [Disaster Recovery for Embedded Cluster](/installer/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 [install](/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](/installer/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. @@ -1095,7 +1095,7 @@ Released on September 26, 2024 ### New Features {#new-features-1-14-1} -* Adds host preflight checks to ensure that the required ports are open and available. For more information, see [Port Requirements](/vendor/embedded-overview#port-requirements). +* Adds host preflight checks to ensure that the required ports are open and available. For more information, see [Port Requirements](/installer/embedded-overview#port-requirements). ### Improvements {#improvements-1-14-1} @@ -1307,7 +1307,7 @@ Released on August 23, 2024 ### Improvements {#improvements-1-11-0} -* The default range available for NodePorts is now 80-32767 instead of 30000-32767. Many customers used [`unsupportedOverrides`](/reference/embedded-config#unsupportedoverrides) to configure this wider range for use with things like an ingress controller, so we have adjusted the default range accordingly. Changes to this range are not applied on upgrades, so existing installations will not be changed. +* The default range available for NodePorts is now 80-32767 instead of 30000-32767. Many customers used [`unsupportedOverrides`](/installer/embedded-config#unsupportedoverrides) to configure this wider range for use with things like an ingress controller, so we have adjusted the default range accordingly. Changes to this range are not applied on upgrades, so existing installations will not be changed. * Adds host preflight checks for connecting to replicated.app and proxy.replicated.com. If you use a custom domain for replicated.app, the custom domain will be used in the preflight check. * Adds a host preflight check to ensure that neither `nameserver localhost` nor `nameserver 127.0.0.1` is present in `resolv.conf`. diff --git a/docs/release-notes/rn-kubernetes-installer.md b/docs/release-notes/rn-kubernetes-installer.md index 0975f7243b..b96462a7ad 100644 --- a/docs/release-notes/rn-kubernetes-installer.md +++ b/docs/release-notes/rn-kubernetes-installer.md @@ -2151,7 +2151,7 @@ Released on March 21, 2022 ### Improvements - Adds [KOTS add-on](https://kurl.sh/docs/add-ons/kotsadm) version 1.67.0. -- Adds the [`app-version-label` flag](https://kurl.sh/docs/install-with-kurl/advanced-options#reference), which takes a version label as an argument and tells KOTS to install that particular version of an application. If this flag is not passed, the latest version of the application is installed. See [Online Installation with the Kubernetes Installer​](/enterprise/installing-embedded-cluster). +- Adds the [`app-version-label` flag](https://kurl.sh/docs/install-with-kurl/advanced-options#reference), which takes a version label as an argument and tells KOTS to install that particular version of an application. If this flag is not passed, the latest version of the application is installed. See [Online Installation with the Kubernetes Installer​](/installer/installing-embedded-cluster). ## Release v2022.03.11-0 diff --git a/docs/release-notes/rn-vendor-platform.md b/docs/release-notes/rn-vendor-platform.md index e2e6211369..1283345f50 100644 --- a/docs/release-notes/rn-vendor-platform.md +++ b/docs/release-notes/rn-vendor-platform.md @@ -1670,7 +1670,7 @@ Released on March 7, 2024 Released on March 7, 2024 ### New Features {#new-features-v2024-03-07-0} -* Adds the Replicated embedded cluster (Beta) distribution to the compatibility matrix. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). +* Adds the Replicated embedded cluster (Beta) distribution to the compatibility matrix. For more information, see [Using Embedded Cluster](/installer/embedded-overview). ## v2024.03.06-3 @@ -1691,7 +1691,7 @@ Released on February 29, 2024 Released on February 29, 2024 ### New Features {#new-features-v2024-02-29-0} -* Enables the Embedded Cluster option on the customer license page. For more information, see [Using Embedded Cluster](/vendor/embedded-overview). +* Enables the Embedded Cluster option on the customer license page. For more information, see [Using Embedded Cluster](/installer/embedded-overview). ## v2024.02.27-1 diff --git a/docs/vendor/admin-console-adding-buttons-links.mdx b/docs/vendor/admin-console-adding-buttons-links.mdx index 1f55aad2a6..3b82ed7a97 100644 --- a/docs/vendor/admin-console-adding-buttons-links.mdx +++ b/docs/vendor/admin-console-adding-buttons-links.mdx @@ -69,7 +69,7 @@ The following examples show how to use the KOTS [ConfigOption](/reference/templa - description: Open App url: 'http://{{repl ConfigOption "ingress_host" }}' ``` -* In the example below, both the URL hostname and a node port are user-supplied values. It might be necessary to include a user-provided node port if you are exposing NodePort services for installations on VMs or bare metal servers with [Replicated Embedded Cluster](/vendor/embedded-overview) or [Replicated kURL](/vendor/kurl-about). +* In the example below, both the URL hostname and a node port are user-supplied values. It might be necessary to include a user-provided node port if you are exposing NodePort services for installations on VMs or bare metal servers with [Replicated Embedded Cluster](/installer/embedded-overview) or [Replicated kURL](/vendor/kurl-about). ```yaml apiVersion: app.k8s.io/v1beta1 diff --git a/docs/vendor/admin-console-port-forward.mdx b/docs/vendor/admin-console-port-forward.mdx index 171c68eb90..1a195e660b 100644 --- a/docs/vendor/admin-console-port-forward.mdx +++ b/docs/vendor/admin-console-port-forward.mdx @@ -204,7 +204,7 @@ To test this example: 1. Install the release into an existing cluster and confirm that the service was port-forwarded successfully by clicking **Open App** on the Admin Console dashboard. For more information, see [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster). -1. Install the release on a VM and confirm that you can open the application by clicking **Open App** on the Admin Console dashboard. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Online Installation with kURL](/enterprise/installing-kurl). +1. Install the release on a VM and confirm that you can open the application by clicking **Open App** on the Admin Console dashboard. For more information, see [Online Installation with Embedded Cluster](/installer/installing-embedded) or [Online Installation with kURL](/enterprise/installing-kurl). :::note Ensure that the VM where you install allows HTTP traffic. diff --git a/docs/vendor/config-screen-conditional.mdx b/docs/vendor/config-screen-conditional.mdx index e56263457e..e6d57030c0 100644 --- a/docs/vendor/config-screen-conditional.mdx +++ b/docs/vendor/config-screen-conditional.mdx @@ -31,7 +31,7 @@ In the following example, the `when` properties use the [Distribution](/referenc ### Embedded Cluster Distribution Check -It can be useful to show or hide configuration fields if the distribution of the cluster is [Replicated Embedded Cluster](/vendor/embedded-overview) because you can include extensions in embedded cluster distributions to manage functionality such as ingress and storage. This means that embedded clusters frequently have fewer configuration options for the user. +It can be useful to show or hide configuration fields if the distribution of the cluster is [Replicated Embedded Cluster](/installer/embedded-overview) because you can include extensions in embedded cluster distributions to manage functionality such as ingress and storage. This means that embedded clusters frequently have fewer configuration options for the user. diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 69952ef708..b3dac45793 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -71,11 +71,11 @@ After you add one or more custom domains in the Vendor Portal, you can configure ### Configure Embedded Cluster to Use Custom Domains {#ec} -You can configure Replicated Embedded Cluster to use your custom domains for the Replicated proxy registry and Replicated app service. For more information about Embedded Cluster, see [Embedded Cluster Overview](/vendor/embedded-overview). +You can configure Replicated Embedded Cluster to use your custom domains for the Replicated proxy registry and Replicated app service. For more information about Embedded Cluster, see [Embedded Cluster Overview](/installer/embedded-overview). To configure Embedded Cluster to use your custom domains for the proxy registry and app service: -1. In the [Embedded Cluster Config](/reference/embedded-config) spec for your application, add `domains.proxyRegistryDomain` and `domains.replicatedAppDomain`. Set each field to your custom domain for the given service. +1. In the [Embedded Cluster Config](/installer/embedded-config) spec for your application, add `domains.proxyRegistryDomain` and `domains.replicatedAppDomain`. Set each field to your custom domain for the given service. **Example:** @@ -89,7 +89,7 @@ To configure Embedded Cluster to use your custom domains for the proxy registry # Your app service custom domain replicatedAppDomain: updates.yourcompany.com ``` - For more information, see [domains](/reference/embedded-config#domains) in _Embedded Cluster Config_. + For more information, see [domains](/installer/embedded-config#domains) in _Embedded Cluster Config_. 1. Add the Embedded Cluster Config to a new release. Promote the release to a channel that your team uses for testing, and install with Embedded Cluster in a development environment to test your changes. diff --git a/docs/vendor/custom-domains.md b/docs/vendor/custom-domains.md index 310c1f48e2..c943f9a51c 100644 --- a/docs/vendor/custom-domains.md +++ b/docs/vendor/custom-domains.md @@ -38,7 +38,7 @@ Using custom domains has the following limitations: - Each custom domain can only be used by one team. -- For [Replicated Embedded Cluster](/vendor/embedded-overview) installations, any Helm [`extensions`](/reference/embedded-config) that you add in the Embedded Cluster Config do not use custom domains. During deployment, Embedded Cluster pulls both the repo for the given chart and any images in the chart as written. Embedded Cluster does not rewrite image names to use custom domains. +- For [Replicated Embedded Cluster](/installer/embedded-overview) installations, any Helm [`extensions`](/installer/embedded-config) that you add in the Embedded Cluster Config do not use custom domains. During deployment, Embedded Cluster pulls both the repo for the given chart and any images in the chart as written. Embedded Cluster does not rewrite image names to use custom domains. ## Known Issue diff --git a/docs/vendor/environment-setup.mdx b/docs/vendor/environment-setup.mdx index c0de6b750d..5b821f14f2 100644 --- a/docs/vendor/environment-setup.mdx +++ b/docs/vendor/environment-setup.mdx @@ -269,7 +269,7 @@ Testing your releases is an important part of the commercial software distributi ### About Creating a VM -You need access to a VM to test installations and updates with the [Replicated Embedded Cluster](/vendor/embedded-overview) installer: +You need access to a VM to test installations and updates with the [Replicated Embedded Cluster](/installer/embedded-overview) installer: * **Option 1: Use Compatibility Matrix.** You can use Replicated Compatibility Matrix to create and SSH onto Linux VMs. For more information, see [Create a VM](/vendor/testing-vm-create). diff --git a/docs/vendor/helm-native-v2-using.md b/docs/vendor/helm-native-v2-using.md index b85765e58c..01838632b4 100644 --- a/docs/vendor/helm-native-v2-using.md +++ b/docs/vendor/helm-native-v2-using.md @@ -88,7 +88,7 @@ To support KOTS existing cluster or kURL installations with HelmChart v2, comple 1. For each HelmChart v2 resource in the release, configure the [optionalValues](/reference/custom-resource-helmchart-v2#optionalvalues) key to add the `kots.io/backup: velero` label and `kots.io/app-slug: APP_SLUG` annotation to all resources that you want to be included in backups with Replicated snapshots. Use a `when` statement so that these are added to resources only when the customer has the [`isSnapshotSupported`](/vendor/licenses-using-builtin-fields#admin-console-feature-options) field enabled for their license. :::note - The Replicated [snapshots](snapshots-overview) feature for backup and restore is supported only for KOTS existing cluster and kURL installations. Snapshots are not supported for installations with Embedded Cluster. For more information about disaster recovery for Embedded Cluster installations, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery.mdx). + The Replicated [snapshots](snapshots-overview) feature for backup and restore is supported only for KOTS existing cluster and kURL installations. Snapshots are not supported for installations with Embedded Cluster. For more information about disaster recovery for Embedded Cluster installations, see [Disaster Recovery for Embedded Cluster](/installer/embedded-disaster-recovery). ::: **Example**: diff --git a/docs/vendor/helm-packaging-airgap-bundles.mdx b/docs/vendor/helm-packaging-airgap-bundles.mdx index bc8eaf73ed..41e8df0404 100644 --- a/docs/vendor/helm-packaging-airgap-bundles.mdx +++ b/docs/vendor/helm-packaging-airgap-bundles.mdx @@ -74,5 +74,5 @@ Many applications have images that are included or excluded based on a given con ## Related Topics * [builder](/reference/custom-resource-helmchart-v2#builder) -* [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) +* [Air Gap Installation with Embedded Cluster](/installer/installing-embedded-air-gap) * [Air Gap Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster-airgapped) diff --git a/docs/vendor/kots-faq.mdx b/docs/vendor/kots-faq.mdx index d62544127b..1f22c03ce6 100644 --- a/docs/vendor/kots-faq.mdx +++ b/docs/vendor/kots-faq.mdx @@ -41,7 +41,7 @@ It is also possible to use _virtual_ or _logical_ air gaps, in which security co Replicated supports installations into air-gapped environments. In an air gap installation, users first download the images and other assets required for installation on an internet-connected device. These installation assets are usually provided in an _air gap bundle_ that ISVs can build in the Replicated Vendor Portal. Then, users transfer the installation assets to their air-gapped machine where they can push the images to an internal private registry and install. For more information, see: -* [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) +* [Air Gap Installation with Embedded Cluster](/installer/installing-embedded-air-gap) * [Installing and Updating with Helm in Air Gap Environments](/vendor/helm-install-airgap) ### What is the Commercial Sotware Distribution Lifecycle? @@ -103,7 +103,7 @@ To install with Embedded Cluster, users first download and extract the Embedded After the installation command finishes, users log in to the Admin Console to provide application configuration values, optionally join more nodes to the cluster, run preflight checks, and deploy the application. -Customer-specific Embedded Cluster installation instructions are provided in the Replicated Vendor Portal. For more information, see [Install with Embedded Cluster](/enterprise/installing-embedded). +Customer-specific Embedded Cluster installation instructions are provided in the Replicated Vendor Portal. For more information, see [Install with Embedded Cluster](/installer/installing-embedded). ### Does Replicated support installations into air gap environments? @@ -111,7 +111,7 @@ Yes. The Embedded Cluster and KOTS installers support installation in _air gap_ To support air gap installations, vendors can build air gap bundles for their application in the Vendor Portal that contain all the required assets for a specific release of the application. Additionally, Replicated provides bundles that contain the assets for the Replicated installers. -For more information about how to install with Embedded Cluster and KOTS in air gap environments, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) and [Air Gap Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster-airgapped). +For more information about how to install with Embedded Cluster and KOTS in air gap environments, see [Air Gap Installation with Embedded Cluster](/installer/installing-embedded-air-gap) and [Air Gap Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster-airgapped). ### Can I deploy Helm charts with KOTS? @@ -125,7 +125,7 @@ Replicated Embedded Cluster is a successor to Replicated kURL. Compared to kURL, -For more information, see [Embedded Cluster Overview](/vendor/embedded-overview). +For more information, see [Embedded Cluster Overview](/installer/embedded-overview). ### How do I enable Embedded Cluster and KOTS installations for my application? @@ -133,7 +133,7 @@ Releases that support installation with KOTS include the manifests required by K In addition to the KOTS manifests, releases that support installation with Embedded Cluster also include the Embedded Cluster Config. The Embedded Cluster Config defines aspects of the cluster that will be provisioned and also sets the version of KOTS that will be installed. -For more information, see [Embedded Cluster Overview](/vendor/embedded-overview). +For more information, see [Embedded Cluster Overview](/installer/embedded-overview). ### Can I use my own branding? diff --git a/docs/vendor/kurl-nodeport-services.mdx b/docs/vendor/kurl-nodeport-services.mdx index acb7dffdb2..15a9e4fe16 100644 --- a/docs/vendor/kurl-nodeport-services.mdx +++ b/docs/vendor/kurl-nodeport-services.mdx @@ -4,13 +4,13 @@ import KurlAvailability from "../partials/kurl/_kurl-availability.mdx" -This topic describes how to expose NodePort services in [Replicated Embedded Cluster](/vendor/embedded-overview) or [Replicated kURL](/vendor/kurl-about) installations on VMs or bare metal servers. +This topic describes how to expose NodePort services in [Replicated Embedded Cluster](/installer/embedded-overview) or [Replicated kURL](/vendor/kurl-about) installations on VMs or bare metal servers. ## Overview For installations into existing clusters, KOTS automatically creates a port forward tunnel to expose the Admin Console. Unlike installations into existing clusters, KOTS does _not_ automatically open the port forward tunnel for installations in embedded clusters provisioned on virtual machines (VMs) or bare metal servers. This is because it cannot be verified that the ports are secure and authenticated. For more information about the KOTS port forward tunnel, see [Port Forwarding Services with KOTS](/vendor/admin-console-port-forward). -Instead, to expose the Admin Console in installations with [Embedded Cluster](/vendor/embedded-overview) or [kURL](/vendor/kurl-about), KOTS creates the Admin Console as a NodePort service so it can be accessed at the node's IP address on a node port (port 8800 for kURL installations and port 30000 for Embedded Cluster installations). Additionally, for kURL installations, the UIs of Prometheus, Grafana, and Alertmanager are also exposed using NodePorts. +Instead, to expose the Admin Console in installations with [Embedded Cluster](/installer/embedded-overview) or [kURL](/vendor/kurl-about), KOTS creates the Admin Console as a NodePort service so it can be accessed at the node's IP address on a node port (port 8800 for kURL installations and port 30000 for Embedded Cluster installations). Additionally, for kURL installations, the UIs of Prometheus, Grafana, and Alertmanager are also exposed using NodePorts. For installations on VMs or bare metal servers where your application must be accessible from the user's local machine rather than from inside the cluster, you can expose application services as NodePorts to provide access to the application after installation. diff --git a/docs/vendor/licenses-about.mdx b/docs/vendor/licenses-about.mdx index 46af590632..b70da86947 100644 --- a/docs/vendor/licenses-about.mdx +++ b/docs/vendor/licenses-about.mdx @@ -146,7 +146,7 @@ When you edit customer licenses for an application installed with a Replicated i For online instances, KOTS pulls license details from the Vendor Portal when: * A customer clicks **Sync license** in the Admin Console. * An automatic or manual update check is performed by KOTS. -* An update is performed with Replicated Embedded Cluster. See [Perform Updates with Embedded Cluster](/enterprise/updating-embedded). +* An update is performed with Replicated Embedded Cluster. See [Perform Updates with Embedded Cluster](/installer/updating-embedded). * An application status changes. See [Current State](instance-insights-details#current-state) in _Instance Details_. For more information, see [Update Licenses in the Admin Console](/enterprise/updating-licenses). diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index ef5f293ccd..3560ae2f4a 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -15,7 +15,7 @@ The following shows an example of the **Install types** field in a license: [View a larger version of this image](/images/license-install-types.png) The installation types that are enabled or disabled for a license determine the following: -* The Replicated installers ([Replicated KOTS](../intro-kots), [Replicated Embedded Cluster](/vendor/embedded-overview), [Replicated kURL](/vendor/kurl-about)) that the customer's license entitles them to use +* The Replicated installers ([Replicated KOTS](../intro-kots), [Replicated Embedded Cluster](/installer/embedded-overview), [Replicated kURL](/vendor/kurl-about)) that the customer's license entitles them to use * The installation assets and/or instructions provided in the Replicated Enterprise Portal for the customer * The customer's KOTS Admin Console experience diff --git a/docs/vendor/licenses-using-builtin-fields.mdx b/docs/vendor/licenses-using-builtin-fields.mdx index c91f5af647..95a4f10256 100644 --- a/docs/vendor/licenses-using-builtin-fields.mdx +++ b/docs/vendor/licenses-using-builtin-fields.mdx @@ -127,7 +127,7 @@ The table below describes the built-in license fields related to the supported i `isEmbeddedClusterDownloadEnabled` -

If a license supports installation with Replicated Embedded Cluster, this field is set to `true` or missing. If Embedded Cluster installations are not supported, this field is `false`.

This field requires that the vendor has the Embedded Cluster entitlement and that the release at the head of the channel includes an [Embedded Cluster Config](/reference/embedded-config) custom resource. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.

+

If a license supports installation with Replicated Embedded Cluster, this field is set to `true` or missing. If Embedded Cluster installations are not supported, this field is `false`.

This field requires that the vendor has the Embedded Cluster entitlement and that the release at the head of the channel includes an [Embedded Cluster Config](/installer/embedded-config) custom resource. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.

`isHelmInstallEnabled` @@ -180,7 +180,7 @@ The table below describes the built-in license fields related to the Admin Conso `isDisasterRecoverySupported` - If a license supports the Embedded Cluster disaster recovery feature, this field is set to `true`. If a license does not support disaster recovery for Embedded Cluster, this field is either missing or `false`. **Note**: Embedded Cluster Disaster Recovery is in Alpha. To get access to this feature, reach out to Alex Parker at [alexp@replicated.com](mailto:alexp@replicated.com). For more information, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery). + If a license supports the Embedded Cluster disaster recovery feature, this field is set to `true`. If a license does not support disaster recovery for Embedded Cluster, this field is either missing or `false`. **Note**: Embedded Cluster Disaster Recovery is in Alpha. To get access to this feature, reach out to Alex Parker at [alexp@replicated.com](mailto:alexp@replicated.com). For more information, see [Disaster Recovery for Embedded Cluster](/installer/embedded-disaster-recovery). `isGeoaxisSupported` diff --git a/docs/vendor/packaging-kots-versions.md b/docs/vendor/packaging-kots-versions.md index 40d9232372..690c35ac00 100644 --- a/docs/vendor/packaging-kots-versions.md +++ b/docs/vendor/packaging-kots-versions.md @@ -4,7 +4,7 @@ This topic describes how to set minimum and target version for Replicated KOTS i ## Limitation -Setting minimum and target versions for KOTS is not supported for installations with [Replicated Embedded Cluster](/vendor/embedded-overview). +Setting minimum and target versions for KOTS is not supported for installations with [Replicated Embedded Cluster](/installer/embedded-overview). This is because each version of Embedded Cluster includes a particular version of KOTS. Setting `targetKotsVersion` or `minKotsVersion` to a version of KOTS that does not coincide with the version that is included in the specified version of Embedded Cluster will cause Embedded Cluster installations to fail with an error message like: `Error: This version of App Name requires a different version of KOTS from what you currently have installed.`. diff --git a/docs/vendor/preflight-host-preflights.md b/docs/vendor/preflight-host-preflights.md index 5a61cf2e9f..c94d9ba6bb 100644 --- a/docs/vendor/preflight-host-preflights.md +++ b/docs/vendor/preflight-host-preflights.md @@ -1,6 +1,6 @@ # Customize Host Preflight Checks for kURL -This topic provides information about how to customize host preflight checks for installations with Replicated kURL. For information about the default host preflight checks that run for installations with Replicated Embedded Cluster, see [About Host Preflight Checks](/vendor/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_. +This topic provides information about how to customize host preflight checks for installations with Replicated kURL. For information about the default host preflight checks that run for installations with Replicated Embedded Cluster, see [About Host Preflight Checks](/installer/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_. ## About Host Preflight Checks You can include host preflight checks with kURL to verify that infrastructure requirements are met for: diff --git a/docs/vendor/preflight-support-bundle-about.mdx b/docs/vendor/preflight-support-bundle-about.mdx index dcca369031..7c82dfc9c8 100644 --- a/docs/vendor/preflight-support-bundle-about.mdx +++ b/docs/vendor/preflight-support-bundle-about.mdx @@ -61,11 +61,11 @@ Thorough preflight checks provide increased confidence that an installation or u ### About Host Preflights {#host-preflights} -_Host preflight checks_ automatically run during [Replicated Embedded Cluster](/vendor/embedded-overview) and [Replicated kURL](/vendor/kurl-about) installations on a VM or bare metal server. The purpose of host preflight checks is to verify that the user's installation environment meets the requirements of the Embedded Cluster or kURL installer, such as checking the number of CPU cores in the system, available disk space, and memory usage. If any of the host preflight checks fail, installation is blocked and a message describing the failure is displayed. +_Host preflight checks_ automatically run during [Replicated Embedded Cluster](/installer/embedded-overview) and [Replicated kURL](/vendor/kurl-about) installations on a VM or bare metal server. The purpose of host preflight checks is to verify that the user's installation environment meets the requirements of the Embedded Cluster or kURL installer, such as checking the number of CPU cores in the system, available disk space, and memory usage. If any of the host preflight checks fail, installation is blocked and a message describing the failure is displayed. Host preflight checks are separate from any application-specific preflight checks that are defined in the release, which run in the Admin Console before the application is deployed with KOTS. Both Embedded Cluster and kURL have default host preflight checks that are specific to the requirements of the given installer. For kURL installations, it is possible to customize the default host preflight checks. -For more information about the default Embedded Cluster host preflight checks, see [Host Preflight Checks](/vendor/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_. +For more information about the default Embedded Cluster host preflight checks, see [Host Preflight Checks](/installer/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_. For more information about kURL host preflight checks, including information about how to customize the defaults, see [Customize Host Preflight Checks for kURL](/vendor/preflight-host-preflights). @@ -135,7 +135,7 @@ The following diagram demonstrates how end customers can generate support bundle ### About Host Support Bundles -For installations on VMs or bare metal servers with [Replicated Embedded Cluster](/vendor/embedded-overview) or [Replicated kURL](/vendor/kurl-about), it is possible to generate a support bundle that includes host-level information to help troubleshoot failures related to host configuration like DNS, networking, or storage problems. +For installations on VMs or bare metal servers with [Replicated Embedded Cluster](/installer/embedded-overview) or [Replicated kURL](/vendor/kurl-about), it is possible to generate a support bundle that includes host-level information to help troubleshoot failures related to host configuration like DNS, networking, or storage problems. For Embedded Cluster installations, a default spec can be used to generate support bundles that include cluster- and host-level information. See [Generate Host Bundles for Embedded Cluster](/vendor/support-bundle-embedded). diff --git a/docs/vendor/quick-start.mdx b/docs/vendor/quick-start.mdx index 5b111d70bb..f685ff29fa 100644 --- a/docs/vendor/quick-start.mdx +++ b/docs/vendor/quick-start.mdx @@ -617,7 +617,7 @@ To get started, see [Onboard to the Replicated Platform](replicated-onboarding). For more information about the Replicated Platform features mentioned in this quick start, see: -* [Embedded Cluster Overview](/vendor/embedded-overview) +* [Embedded Cluster Overview](/installer/embedded-overview) * [About CMX](/vendor/testing-about) * [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about) * [About the Replicated SDK](/vendor/replicated-sdk-overview) diff --git a/docs/vendor/releases-about.mdx b/docs/vendor/releases-about.mdx index d7321c9595..d6b36be730 100644 --- a/docs/vendor/releases-about.mdx +++ b/docs/vendor/releases-about.mdx @@ -62,7 +62,7 @@ This section provides additional information about releases, including details a ### Release Files -A release contains your application files as well as the manifests required to install the application with the Replicated installers ([Replicated Embedded Cluster](/vendor/embedded-overview) and [Replicated KOTS](../intro-kots)). +A release contains your application files as well as the manifests required to install the application with the Replicated installers ([Replicated Embedded Cluster](/installer/embedded-overview) and [Replicated KOTS](../intro-kots)). The application files in releases can be Helm charts and/or Kubernetes manifests. Replicated strongly recommends that all applications are packaged as Helm charts because many enterprise customers will expect to be able to install with Helm. diff --git a/docs/vendor/releases-sharing-license-install-script.mdx b/docs/vendor/releases-sharing-license-install-script.mdx index c977502945..1047eea114 100644 --- a/docs/vendor/releases-sharing-license-install-script.mdx +++ b/docs/vendor/releases-sharing-license-install-script.mdx @@ -129,7 +129,7 @@ To get customer-specific Helm or Embedded Cluster installation instructions: [View a larger version of this image](/images/helm-install-instructions-dialog.png) -

View the customer-specific Embedded Cluster installation instructions. For more information about installing with Embedded Cluster, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).

+

View the customer-specific Embedded Cluster installation instructions. For more information about installing with Embedded Cluster, see [Online Installation with Embedded Cluster](/installer/installing-embedded).

Embedded cluster install instructions [View a larger version of this image](/images/embedded-cluster-install-dialog-latest.png) diff --git a/docs/vendor/replicated-onboarding-helm-only.mdx b/docs/vendor/replicated-onboarding-helm-only.mdx index e23c50e575..c96e52a1c4 100644 --- a/docs/vendor/replicated-onboarding-helm-only.mdx +++ b/docs/vendor/replicated-onboarding-helm-only.mdx @@ -250,6 +250,6 @@ For more information, see [Configure Custom Metrics](/vendor/custom-metrics). ### Add Support for Replicated Embedded Cluster Installations on a VM -Replicated Embedded Cluster is a UI-based installer that supports installations on VMs or bare metal servers. Embedded Cluster allows you to distribute a Kubernetes cluster and your application together as a single appliance, making it easy for enterprise users to install, update, and manage the application and the cluster in tandem. For more information, see [Embedded Cluster Overview](/vendor/embedded-overview). +Replicated Embedded Cluster is a UI-based installer that supports installations on VMs or bare metal servers. Embedded Cluster allows you to distribute a Kubernetes cluster and your application together as a single appliance, making it easy for enterprise users to install, update, and manage the application and the cluster in tandem. For more information, see [Embedded Cluster Overview](/installer/embedded-overview). Teams with the Business or Enterprise pricing plan can modify existing releases to support Embedded Cluster installations; it is not necessary to create and manage separate releases or channels for each installation method. For more information about how to get access to Embedded Cluster, reach out to your Replicated account representative. \ No newline at end of file diff --git a/docs/vendor/replicated-onboarding.mdx b/docs/vendor/replicated-onboarding.mdx index ef81f8593d..f0211dc0de 100644 --- a/docs/vendor/replicated-onboarding.mdx +++ b/docs/vendor/replicated-onboarding.mdx @@ -111,7 +111,7 @@ To package your Helm chart with the Replicated SDK: After packaging your Helm chart, you can create a release. The initial release for your application will include the minimum files required to install a Helm chart with the Embedded Cluster installer: * The Helm chart `.tgz` archive * [HelmChart custom resource](/reference/custom-resource-helmchart-v2) -* [Embedded Cluster Config](/reference/embedded-config) +* [Embedded Cluster Config](/installer/embedded-config) If you have multiple charts, you will add each chart archive to the release, plus a corresponding HelmChart custom resource for each archive. @@ -137,7 +137,7 @@ To create the first release for your application: An Embedded Cluster Config must be included in the release to install with Embedded Cluster. The Embedded Cluster Config lets you define several aspects of the Kubernetes cluster that is created. - For more information, see [Use Embedded Cluster](/vendor/embedded-overview). + For more information, see [Use Embedded Cluster](/installer/embedded-overview). 1. Create a new YAML file named `YOUR_CHART_NAME.yaml`. For example, `samplechart.yaml`. In the file, add the following YAML to create a HelmChart custom resource. Update the values to match the name and version of your Helm chart. @@ -170,9 +170,9 @@ To create the first release for your application: This is a temporary measure to ensure the values get passed to the Helm chart during installation until you configure the Admin Console Config screen in a later onboarding task. If your default Helm values are sufficient for installation, you can skip this step. - 1. If your application requires that certain components are deployed before the application and as part of the Embedded Cluster itself, then update the Embedded Cluster Config to add [extensions](/reference/embedded-config#extensions). Extensions allow you to provide Helm charts that are deployed before your application. For example, one situation where this is useful is if you want to ship an ingress controller because Embedded Cluster does not include one. + 1. If your application requires that certain components are deployed before the application and as part of the Embedded Cluster itself, then update the Embedded Cluster Config to add [extensions](/installer/embedded-config#extensions). Extensions allow you to provide Helm charts that are deployed before your application. For example, one situation where this is useful is if you want to ship an ingress controller because Embedded Cluster does not include one. - For more information, see [extensions](/reference/embedded-config#extensions) in _Embedded Cluster Config_. + For more information, see [extensions](/installer/embedded-config#extensions) in _Embedded Cluster Config_. 1. From the `manifests` directory, create a release and promote it to the Unstable channel. For more information, see [Manage Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli). @@ -182,7 +182,7 @@ To create the first release for your application: 1. Install the release in your development environment to test: - 1. Install with Embedded Cluster on a VM. See [Online Installation with Embedded Cluster](/enterprise/installing-embedded). + 1. Install with Embedded Cluster on a VM. See [Online Installation with Embedded Cluster](/installer/installing-embedded). 1. (Optional) Install in an existing cluster with KOTS. See [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster). @@ -451,7 +451,7 @@ To add support for air gap installations: 1. Create or edit a customer with the **Airgap Download Enabled** entitlement enabled so that you can test air gap installations. See [Create and Manage Customers](/vendor/releases-creating-customer). -1. Download the Embedded Cluster air gap installation assets, then install with Embedded Cluster on an air-gapped VM to test. See [Install in Air Gap Environments with Embedded Cluster](/enterprise/installing-embedded-air-gap). +1. Download the Embedded Cluster air gap installation assets, then install with Embedded Cluster on an air-gapped VM to test. See [Install in Air Gap Environments with Embedded Cluster](/installer/installing-embedded-air-gap). 1. Follow the steps in [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap) to access the Enterprise Portal for the customer and test air gap installation in a cluster with Helm. @@ -461,7 +461,7 @@ To add support for air gap installations: The Embedded Cluster Config supports roles for multi-node clusters. One or more roles can be selected and assigned to a node when it is joined to the cluster. Node roles can be used to determine which nodes run the Kubernetes control plane, and to assign application workloads to particular nodes. -For more information, see [roles](/reference/embedded-config#roles-beta) in _Embedded Cluster Config_. +For more information, see [roles](/installer/embedded-config#roles-beta) in _Embedded Cluster Config_. ### Add and Map License Entitlements @@ -515,7 +515,7 @@ You can also view common examples of collectors and analyzers used in preflight Enable backup and restore with Velero for your application so that users can back up and restore their KOTS Admin Console and application data. There are different steps to configure backup and restore for Embedded Cluster and for existing cluster installations with KOTS: -* To configure the disaster recovery feature for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery) +* To configure the disaster recovery feature for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/installer/embedded-disaster-recovery) * To configure the snapshots feature for existing cluster KOTS installations, see [Configure Snapshots](snapshots-configuring-backups). ### Add Custom Metrics diff --git a/docs/vendor/replicated-sdk-installing.mdx b/docs/vendor/replicated-sdk-installing.mdx index 1beef6f34d..4646378cdb 100644 --- a/docs/vendor/replicated-sdk-installing.mdx +++ b/docs/vendor/replicated-sdk-installing.mdx @@ -47,7 +47,7 @@ To install the SDK as a subchart: 1. Save and promote the release to an internal-only channel used for testing, such as the default Unstable channel. 1. Install the release using Helm or a Replicated installer. For more information, see: - * [Online Installation with Embedded Cluster](/enterprise/installing-embedded) + * [Online Installation with Embedded Cluster](/installer/installing-embedded) * [Installing with Helm](/vendor/install-with-helm) * [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster) * [Online Installation with kURL](/enterprise/installing-kurl) @@ -129,7 +129,7 @@ To add the SDK Helm chart to a release for a Kubernetes manifest-based applicati 1. Save and promote the release to an internal-only channel used for testing, such as the default Unstable channel. 1. Install the release using a Replicated installer. For more information, see: - * [Online Installation with Embedded Cluster](/enterprise/installing-embedded) + * [Online Installation with Embedded Cluster](/installer/installing-embedded) * [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster) * [Online Installation with kURL](/enterprise/installing-kurl) diff --git a/docs/vendor/support-bundle-embedded.mdx b/docs/vendor/support-bundle-embedded.mdx index 469bb8ca58..7a1702c8b8 100644 --- a/docs/vendor/support-bundle-embedded.mdx +++ b/docs/vendor/support-bundle-embedded.mdx @@ -3,7 +3,7 @@ import SupportBundleIntro from "../partials/support-bundles/_ec-support-bundle-i # Generate Support Bundles for Embedded Cluster -This topic describes how to generate a support bundle that includes cluster- and host-level information for [Replicated Embedded Cluster](/vendor/embedded-overview) installations. +This topic describes how to generate a support bundle that includes cluster- and host-level information for [Replicated Embedded Cluster](/installer/embedded-overview) installations. For information about generating host support bundles for Replicated kURL installations, see [Generate Host Bundles for kURL](/vendor/support-host-support-bundles). diff --git a/docs/vendor/testing-network-policy.md b/docs/vendor/testing-network-policy.md index 9fc76d2033..9d524171ed 100644 --- a/docs/vendor/testing-network-policy.md +++ b/docs/vendor/testing-network-policy.md @@ -200,5 +200,5 @@ To collect and view a network report from the CLI: ## Related Topics -* [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) +* [Air Gap Installation with Embedded Cluster](/installer/installing-embedded-air-gap) * [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap). \ No newline at end of file diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index ac3df44972..45347e3427 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -213,7 +213,7 @@ By default, kubeconfig context is set to the `kubeadmin` user. To switch to the ### Embedded Cluster -CMX supports creating clusters with Replicated Embedded Cluster. For more information, see [Embedded Cluster Overview](/vendor/embedded-overview). +CMX supports creating clusters with Replicated Embedded Cluster. For more information, see [Embedded Cluster Overview](/installer/embedded-overview). diff --git a/docs/vendor/tutorial-embedded-cluster-automation.mdx b/docs/vendor/tutorial-embedded-cluster-automation.mdx index 0dbbcc90a8..d46ca4e3f8 100644 --- a/docs/vendor/tutorial-embedded-cluster-automation.mdx +++ b/docs/vendor/tutorial-embedded-cluster-automation.mdx @@ -8,7 +8,7 @@ This tutorial demonstrates how to perform an automated or _headless_ installatio ## Introduction -This tutorial shows how to install a Helm chart with Embedded Cluster from the command line without interacting with the Admin Console UI. This is also known as a _headless_ installation. Headless installations are often used for automating application deployment as part of CI/CD pipelines. For more information about headless installs with Embedded Cluster, see [Automating Installation with Embedded Cluster](/enterprise/installing-embedded-automation). +This tutorial shows how to install a Helm chart with Embedded Cluster from the command line without interacting with the Admin Console UI. This is also known as a _headless_ installation. Headless installations are often used for automating application deployment as part of CI/CD pipelines. For more information about headless installs with Embedded Cluster, see [Automating Installation with Embedded Cluster](/installer/installing-embedded-automation). In this tutorial, you will: @@ -370,4 +370,4 @@ Congratulations! As part of this tutorial, you: * Created a ConfigValues file * Performed a headless install of the release on a VM with Embedded Cluster -For more information about headless installs with Embedded Cluster, see [Automating Installation with Embedded Cluster](/enterprise/installing-embedded-automation). \ No newline at end of file +For more information about headless installs with Embedded Cluster, see [Automating Installation with Embedded Cluster](/installer/installing-embedded-automation). \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index e8584c6b95..3d72aceff3 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -51,6 +51,33 @@ const config = { ], ], + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + id: 'installer', + path: 'installer', + routeBasePath: 'installer', + sidebarPath: './sidebarsInstaller.js', + // Versioning configuration + lastVersion: 'current', // Make 3.0.0 the default version + includeCurrentVersion: true, // Include the "next" version from installer/ folder + versions: { + current: { + label: 'Embedded Cluster v3', + path: 'v3', + banner: 'none', + }, + '2.0.0': { + label: 'Embedded Cluster v2', + path: 'v2', + banner: 'none', + }, + }, + }, + ], + ], + scripts: [ { src: @@ -124,20 +151,20 @@ const config = { }, ], }, + { + type: 'docsVersionDropdown', + docsPluginId: 'installer', + label: 'Embedded Cluster', + }, { type: 'dropdown', - label: 'Product Docs', + label: 'Replicated Platform Docs', position: 'left', items: [ { type: 'doc', - docId: 'vendor/testing-about', - label: 'Compatibility Matrix', - }, - { - type: 'doc', - docId: 'vendor/embedded-overview', - label: 'Embedded Cluster', + docId: 'vendor/vendor-portal-creating-account', + label: 'Vendor Portal', }, { type: 'doc', @@ -146,29 +173,15 @@ const config = { }, { type: 'doc', - docId: 'intro-kots', - label: 'KOTS', - }, - { - type: 'doc', - docId: 'vendor/kurl-about', - label: 'kURL', - }, - { - type: 'doc', - docId: 'vendor/private-images-about', - label: 'Replicated Proxy Registry', + docId: 'vendor/testing-about', + label: 'Compatibility Matrix', }, { type: 'doc', docId: 'vendor/replicated-sdk-overview', label: 'Replicated SDK', }, - { - type: 'doc', - docId: 'vendor/vendor-portal-creating-account', - label: 'Vendor Portal', - }, + ], }, { diff --git a/docs/reference/embedded-cluster-admin-console.mdx b/installer/embedded-cluster-admin-console.mdx similarity index 100% rename from docs/reference/embedded-cluster-admin-console.mdx rename to installer/embedded-cluster-admin-console.mdx diff --git a/docs/reference/embedded-cluster-completion.mdx b/installer/embedded-cluster-completion.mdx similarity index 100% rename from docs/reference/embedded-cluster-completion.mdx rename to installer/embedded-cluster-completion.mdx diff --git a/docs/reference/embedded-cluster-enable-ha.mdx b/installer/embedded-cluster-enable-ha.mdx similarity index 100% rename from docs/reference/embedded-cluster-enable-ha.mdx rename to installer/embedded-cluster-enable-ha.mdx diff --git a/docs/reference/embedded-cluster-install.mdx b/installer/embedded-cluster-install.mdx similarity index 92% rename from docs/reference/embedded-cluster-install.mdx rename to installer/embedded-cluster-install.mdx index cc01a9ed3c..ef5343e4d7 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/installer/embedded-cluster-install.mdx @@ -1,11 +1,11 @@ -import ProxyLimitations from "../partials/embedded-cluster/_proxy-install-limitations.mdx" -import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.mdx" -import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx" -import DeprecatedPrivateCa from "../partials/embedded-cluster/_deprecated-private-ca.mdx" +import ProxyLimitations from "../docs/partials/embedded-cluster/_proxy-install-limitations.mdx" +import ProxyRequirements from "../docs/partials/embedded-cluster/_proxy-install-reqs.mdx" +import ProxyEnvVars from "../docs/partials/embedded-cluster/_proxy-env-vars.mdx" +import DeprecatedPrivateCa from "../docs/partials/embedded-cluster/_deprecated-private-ca.mdx" # 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). +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](installing-embedded) or [Air Gap Installation with Embedded Cluster](installing-embedded). ## Usage @@ -30,12 +30,12 @@ sudo ./ install --license [flags] - + @@ -47,7 +47,7 @@ sudo ./ install --license [flags] @@ -60,7 +60,7 @@ sudo ./ install --license [flags]
  • The data directory for Embedded Cluster cannot be changed after the cluster is installed.
  • For multi-node installations, the same data directory that is supplied at installation is used for all nodes joined to the cluster. You cannot choose a different data directory when joining nodes with the Embedded Cluster `join` command. For more information about joining nodes, see [Add Nodes to a Cluster](/enterprise/embedded-manage-nodes#add-nodes) in _Managing Multi-Node Clusters with Embedded Cluster_.
    • -
  • If you use the `--data-dir` flag to change the data directory during installation, then you must use the same location when restoring in a disaster recovery scenario. For more information about disaster recovery with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).
    • +
  • If you use the `--data-dir` flag to change the data directory during installation, then you must use the same location when restoring in a disaster recovery scenario. For more information about disaster recovery with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](embedded-disaster-recovery).
  • Replicated does not support using symlinks for the Embedded Cluster data directory. Use the `--data-dir` flag instead of symlinking `/var/lib/embedded-cluster`.
diff --git a/docs/reference/embedded-cluster-join-print-command.mdx b/installer/embedded-cluster-join-print-command.mdx similarity index 93% rename from docs/reference/embedded-cluster-join-print-command.mdx rename to installer/embedded-cluster-join-print-command.mdx index fbf003489b..1ebeaaf4db 100644 --- a/docs/reference/embedded-cluster-join-print-command.mdx +++ b/installer/embedded-cluster-join-print-command.mdx @@ -1,6 +1,6 @@ # 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). +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](embedded-manage-nodes). ## Usage diff --git a/docs/reference/embedded-cluster-join.mdx b/installer/embedded-cluster-join.mdx similarity index 94% rename from docs/reference/embedded-cluster-join.mdx rename to installer/embedded-cluster-join.mdx index 354a5c9826..364d13c178 100644 --- a/docs/reference/embedded-cluster-join.mdx +++ b/installer/embedded-cluster-join.mdx @@ -1,6 +1,6 @@ # 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). +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](embedded-manage-nodes). ## Usage diff --git a/docs/reference/embedded-cluster-reset.mdx b/installer/embedded-cluster-reset.mdx similarity index 100% rename from docs/reference/embedded-cluster-reset.mdx rename to installer/embedded-cluster-reset.mdx diff --git a/docs/reference/embedded-cluster-restore.mdx b/installer/embedded-cluster-restore.mdx similarity index 100% rename from docs/reference/embedded-cluster-restore.mdx rename to installer/embedded-cluster-restore.mdx diff --git a/docs/reference/embedded-cluster-shell.mdx b/installer/embedded-cluster-shell.mdx similarity index 100% rename from docs/reference/embedded-cluster-shell.mdx rename to installer/embedded-cluster-shell.mdx diff --git a/docs/reference/embedded-cluster-support-bundle.mdx b/installer/embedded-cluster-support-bundle.mdx similarity index 89% rename from docs/reference/embedded-cluster-support-bundle.mdx rename to installer/embedded-cluster-support-bundle.mdx index 5eba094dc4..ef4f9331d7 100644 --- a/docs/reference/embedded-cluster-support-bundle.mdx +++ b/installer/embedded-cluster-support-bundle.mdx @@ -1,6 +1,6 @@ # 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). +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](embedded-troubleshooting). ## Usage diff --git a/docs/reference/embedded-cluster-update.mdx b/installer/embedded-cluster-update.mdx similarity index 100% rename from docs/reference/embedded-cluster-update.mdx rename to installer/embedded-cluster-update.mdx diff --git a/docs/reference/embedded-cluster-version.mdx b/installer/embedded-cluster-version.mdx similarity index 100% rename from docs/reference/embedded-cluster-version.mdx rename to installer/embedded-cluster-version.mdx diff --git a/docs/reference/embedded-config.mdx b/installer/embedded-config.mdx similarity index 98% rename from docs/reference/embedded-config.mdx rename to installer/embedded-config.mdx index 5f6f3f7818..3d59c6ff05 100644 --- a/docs/reference/embedded-config.mdx +++ b/installer/embedded-config.mdx @@ -1,8 +1,8 @@ -import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx" +import DoNotDowngrade from "../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx" # Embedded Cluster Config -This topic is a reference for the Replicated Embedded Cluster Config custom resource. For more information about Embedded Cluster, see [Use Embedded Cluster](/vendor/embedded-overview). +This topic is a reference for the Replicated Embedded Cluster Config custom resource. For more information about Embedded Cluster, see [Use Embedded Cluster](embedded-overview). ## Overview @@ -83,7 +83,7 @@ You can optionally customize node roles in the Embedded Cluster Config using the A common use case for customizing node roles is to assign workloads to specific nodes. For example, if your application has graphics processing unit (GPU) workloads, you could create a `custom` role that will add a `gpu=true` label to any node that is assigned the role. This allows you to then schedule GPU workloads on nodes labled `gpu=true`. -When the `roles` key is configured, users select one or more roles to assign to a node when it is joined to the cluster. For more information, see [Managing Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). +When the `roles` key is configured, users select one or more roles to assign to a node when it is joined to the cluster. For more information, see [Managing Multi-Node Clusters with Embedded Cluster](embedded-manage-nodes). If the `roles` key is _not_ configured, all nodes joined to the cluster are assigned the `controller` role. The `controller` role designates nodes that run the Kubernetes control plane. Controller nodes can also run other workloads, such as application or Replicated KOTS workloads. @@ -276,7 +276,7 @@ Each plugin that you add to the `extensions.velero.plugins` key must have a name #### Requirements * The image for the Velero plugin must be available publicly. Images behind authentication are not supported. -* The **Allow Disaster Recovery (Alpha)** option must be enabled in the license for Velero plugins to work. For more information about how to enable the Embedded Cluster disaster recovery feature, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery). +* The **Allow Disaster Recovery (Alpha)** option must be enabled in the license for Velero plugins to work. For more information about how to enable the Embedded Cluster disaster recovery feature, see [Disaster Recovery for Embedded Cluster (Alpha)](embedded-disaster-recovery). #### Example diff --git a/docs/vendor/embedded-disaster-recovery.mdx b/installer/embedded-disaster-recovery.mdx similarity index 97% rename from docs/vendor/embedded-disaster-recovery.mdx rename to installer/embedded-disaster-recovery.mdx index 8192befbfb..b5e5251a3f 100644 --- a/docs/vendor/embedded-disaster-recovery.mdx +++ b/installer/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 [install](/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](embedded-cluster-install). ## Configure Disaster Recovery @@ -216,7 +216,7 @@ To restore from a backup: 1. SSH onto a new machine where you want to restore from a backup. -1. Download the Embedded Cluster installation assets for the version of the application that was included in the backup. You can find the command for downloading Embedded Cluster installation assets in the **Embedded Cluster install instructions dialog** for the customer. For more information, [Online Installation with Embedded Cluster](/enterprise/installing-embedded). +1. Download the Embedded Cluster installation assets for the version of the application that was included in the backup. You can find the command for downloading Embedded Cluster installation assets in the **Embedded Cluster install instructions dialog** for the customer. For more information, [Online Installation with Embedded Cluster](installing-embedded). :::note The version of the Embedded Cluster installation assets must match the version that is in the backup. For more information, see [Limitations and Known Issues](#limitations-and-known-issues). @@ -231,11 +231,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 [install](/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](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 `--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](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). + * 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](embedded-cluster-install). You will be guided through the process of restoring from a backup. @@ -254,7 +254,7 @@ To restore from a backup: ![Restore from detected backup prompt on the command line](/images/dr-restore-admin-console-url.png) [View a larger version of this image](/images/dr-restore-admin-console-url.png) -1. (Optional) If the cluster should have multiple nodes, go to the Admin Console to get a join command and join additional nodes to the cluster. For more information, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). +1. (Optional) If the cluster should have multiple nodes, go to the Admin Console to get a join command and join additional nodes to the cluster. For more information, see [Manage Multi-Node Clusters with Embedded Cluster](embedded-manage-nodes). 1. Type `continue` when you are ready to proceed with the restore process. diff --git a/docs/enterprise/embedded-manage-nodes.mdx b/installer/embedded-manage-nodes.mdx similarity index 94% rename from docs/enterprise/embedded-manage-nodes.mdx rename to installer/embedded-manage-nodes.mdx index c13e212d4a..825966416f 100644 --- a/docs/enterprise/embedded-manage-nodes.mdx +++ b/installer/embedded-manage-nodes.mdx @@ -1,4 +1,4 @@ -import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx" +import HaArchitecture from "../docs/partials/embedded-cluster/_multi-node-ha-arch.mdx" # Manage Multi-Node Clusters with Embedded Cluster @@ -32,13 +32,13 @@ To add a node to a cluster with Embedded Cluster: 1. Do one of the following: - 1. Follow the steps in [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap)to install. When you see the **Nodes** screen as part of the installation flow in the Admin Console, continue to the next step. + 1. Follow the steps in [Online Installation with Embedded Cluster](installing-embedded) or [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap)to install. When you see the **Nodes** screen as part of the installation flow in the Admin Console, continue to the next step. 1. Otherwise, to add a node to an existing cluster: 1. Log in to the Admin Console. - 1. If you promoted a new release that configures the `roles` key in the Embedded Cluster Config, update the instance to the new version. See [Perform Updates in Embedded Clusters](/enterprise/updating-embedded). + 1. If you promoted a new release that configures the `roles` key in the Embedded Cluster Config, update the instance to the new version. See [Perform Updates in Embedded Clusters](updating-embedded). 1. Go to **Cluster Management > Add node** at the top of the page. @@ -127,7 +127,7 @@ You can enable high availability for a multi-node cluster when joining the third To create a multi-node HA cluster: -1. Set up a cluster with at least two controller nodes. You can do an online (internet-connected) or air gap installation. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap). +1. Set up a cluster with at least two controller nodes. You can do an online (internet-connected) or air gap installation. For more information, see [Online Installation with Embedded Cluster](installing-embedded) or [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap). 1. Get the commands for downloading the Embedded Cluster binary, extracting the binary, and joining the third controller node either in the Admin Console **Cluster Management** tab or by running the following command on an existing node: diff --git a/docs/vendor/embedded-overview.mdx b/installer/embedded-overview.mdx similarity index 90% rename from docs/vendor/embedded-overview.mdx rename to installer/embedded-overview.mdx index b7b2948c59..54110e2342 100644 --- a/docs/vendor/embedded-overview.mdx +++ b/installer/embedded-overview.mdx @@ -1,7 +1,7 @@ -import EmbeddedCluster from "../partials/embedded-cluster/_definition.mdx" -import Requirements from "../partials/embedded-cluster/_requirements.mdx" -import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx" -import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx" +import EmbeddedCluster from "../docs/partials/embedded-cluster/_definition.mdx" +import Requirements from "../docs/partials/embedded-cluster/_requirements.mdx" +import EmbeddedClusterPortRequirements from "../docs/partials/embedded-cluster/_port-reqs.mdx" +import HaArchitecture from "../docs/partials/embedded-cluster/_multi-node-ha-arch.mdx" # Embedded Cluster Overview @@ -67,9 +67,9 @@ The built-in extensions installed by Embedded Cluster include: * **OpenEBS:** Embedded Cluster uses OpenEBS to provide local PersistentVolume (PV) storage, including the PV storage for rqlite used by KOTS. For more information, see the [OpenEBS](https://openebs.io/docs/) documentation. -* **(Disaster Recovery Only) Velero:** If the installation uses the Embedded Cluster disaster recovery feature, Embedded Cluster installs Velero, which is an open-source tool that provides backup and restore functionality. For more information about Velero, see the [Velero](https://velero.io/docs/latest/) documentation. For more information about the disaster recovery feature, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery). +* **(Disaster Recovery Only) Velero:** If the installation uses the Embedded Cluster disaster recovery feature, Embedded Cluster installs Velero, which is an open-source tool that provides backup and restore functionality. For more information about Velero, see the [Velero](https://velero.io/docs/latest/) documentation. For more information about the disaster recovery feature, see [Disaster Recovery for Embedded Cluster (Alpha)](embedded-disaster-recovery). -* **(Air Gap Only) Image registry:** For air gap installations in environments with limited or no outbound internet access, Embedded Cluster installs an image registry where the images required to install and run the application are pushed. For more information about installing in air-gapped environments, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap). +* **(Air Gap Only) Image registry:** For air gap installations in environments with limited or no outbound internet access, Embedded Cluster installs an image registry where the images required to install and run the application are pushed. For more information about installing in air-gapped environments, see [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap). ## Comparison to kURL @@ -112,9 +112,9 @@ Embedded Cluster has the following limitations: * **Migration from kURL**: We are helping several customers migrate from kURL to Embedded Cluster. For more information about migrating from kURL to Embedded Cluster, including key considerations before migrating and an example step-by-step migration process, see [Replicated kURL to Embedded Cluster Migration](https://docs.google.com/document/d/1Qw9owCK4xNXHRRmxDgAq_NJdxQ4O-6w2rWk_luzBD7A/edit?tab=t.0). For additional questions and to begin the migration process for your application, reach out to Alex Parker at alexp@replicated.com. -* **Disaster recovery is in alpha**: Disaster Recovery for Embedded Cluster installations is in alpha. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery). +* **Disaster recovery is in alpha**: Disaster Recovery for Embedded Cluster installations is in alpha. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](embedded-disaster-recovery). -* **Partial rollback support**: In Embedded Cluster 1.17.0 and later, 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. For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. +* **Partial rollback support**: In Embedded Cluster 1.17.0 and later, rollbacks are supported only when rolling back to a version where there is no change to the [Embedded Cluster Config](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. For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. * **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. @@ -132,7 +132,7 @@ Embedded Cluster has the following limitations: * **Upgrading by more than one Kubernetes version at a time not supported**: Kubernetes does not support upgrading by more than one minor version at a time. However, the Admin Console does not prevent end-users from attempting to upgrade to a release that specifies a Kubernetes version more than one minor version later than what is currently installed. To avoid issues that could be caused by skipping a minor version of Kubernetes, Replicated recommends that you select **Prevent this release from being skipped during upgrades** when you promote a new application release that increases the Kubernetes version. For more information about required releases, see [Release Properties](/vendor/releases-about#release-properties) in _About Channels and Releases_. -* **Templating not supported in Embedded Cluster Config**: The [Embedded Cluster Config](/reference/embedded-config) resource does not support the use of Go template functions, including [Replicated template functions](/reference/template-functions-about). This only applies to the Embedded Cluster Config. You can still use template functions in the rest of your release as usual. +* **Templating not supported in Embedded Cluster Config**: The [Embedded Cluster Config](embedded-config) resource does not support the use of Go template functions, including [Replicated template functions](/reference/template-functions-about). This only applies to the Embedded Cluster Config. You can still use template functions in the rest of your release as usual. * **Policy enforcement on Embedded Cluster workloads is not supported**: The Embedded Cluster runs workloads that require higher levels of privilege. If your application installs a policy enforcement engine such as Gatekeeper or Kyverno, ensure that its policies are not enforced in the namespaces used by Embedded Cluster. diff --git a/docs/enterprise/embedded-tls-certs.mdx b/installer/embedded-tls-certs.mdx similarity index 100% rename from docs/enterprise/embedded-tls-certs.mdx rename to installer/embedded-tls-certs.mdx diff --git a/docs/vendor/embedded-troubleshooting.mdx b/installer/embedded-troubleshooting.mdx similarity index 95% rename from docs/vendor/embedded-troubleshooting.mdx rename to installer/embedded-troubleshooting.mdx index 1635f3fc07..b5bf7b809a 100644 --- a/docs/vendor/embedded-troubleshooting.mdx +++ b/installer/embedded-troubleshooting.mdx @@ -1,12 +1,12 @@ -import SupportBundleIntro from "../partials/support-bundles/_ec-support-bundle-intro.mdx" -import EmbeddedClusterSupportBundle from "../partials/support-bundles/_generate-bundle-ec.mdx" -import ShellCommand from "../partials/embedded-cluster/_shell-command.mdx" +import SupportBundleIntro from "../docs/partials/support-bundles/_ec-support-bundle-intro.mdx" +import EmbeddedClusterSupportBundle from "../docs/partials/support-bundles/_generate-bundle-ec.mdx" +import ShellCommand from "../docs/partials/embedded-cluster/_shell-command.mdx" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Troubleshoot Embedded Cluster -This topic provides information about troubleshooting Replicated Embedded Cluster installations. For more information about Embedded Cluster, including built-in extensions and architecture, see [Embedded Cluster Overview](/vendor/embedded-overview). +This topic provides information about troubleshooting Replicated Embedded Cluster installations. For more information about Embedded Cluster, including built-in extensions and architecture, see [Embedded Cluster Overview](embedded-overview). ## Troubleshoot with Support Bundles @@ -160,7 +160,7 @@ Reasons can include: sudo ./APP_SLUG install --license license.yaml --cidr 172.16.136.0/16 ``` - For more information, see [Embedded Cluster Install Options](/reference/embedded-cluster-install). + For more information, see [Embedded Cluster Install Options](embedded-cluster-install). Embedded Cluster 1.19.0 and later automatically sets the `net.ipv4.conf.default.arp_filter`, `net.ipv4.conf.default.arp_ignore`, and `net.ipv4.ip_forward` kernel parameters. Additionally, host preflight checks automatically run during installation to verify that the kernel parameters were set correctly. For more information about the Embedded Cluster preflight checks, see [About Host Preflight Checks](/vendor/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_. diff --git a/docs/vendor/embedded-using.mdx b/installer/embedded-using.mdx similarity index 94% rename from docs/vendor/embedded-using.mdx rename to installer/embedded-using.mdx index 7d1b1d9900..0549159947 100644 --- a/docs/vendor/embedded-using.mdx +++ b/installer/embedded-using.mdx @@ -1,6 +1,6 @@ -import UpdateOverview from "../partials/embedded-cluster/_update-overview.mdx" -import EcConfig from "../partials/embedded-cluster/_ec-config.mdx" -import ShellCommand from "../partials/embedded-cluster/_shell-command.mdx" +import UpdateOverview from "../docs/partials/embedded-cluster/_update-overview.mdx" +import EcConfig from "../docs/partials/embedded-cluster/_ec-config.mdx" +import ShellCommand from "../docs/partials/embedded-cluster/_shell-command.mdx" # Use Embedded Cluster @@ -40,7 +40,7 @@ You can use the following steps to get started quickly with Embedded Cluster. Mo To install an application with Embedded Cluster, an Embedded Cluster Config must be present in the application release. The Embedded Cluster Config lets you define several characteristics about the cluster that will be created. -For more information, see [Embedded Cluster Config](/reference/embedded-config). +For more information, see [Embedded Cluster Config](embedded-config). ## About Installing with Embedded Cluster @@ -63,8 +63,8 @@ Embedded Cluster supports installations in online (internet-connected) environme For online installations, Embedded Cluster also supports installing behind a proxy server. For more information about how to install with Embedded Cluster, see: -* [Online Installation wtih Embedded Cluster](/enterprise/installing-embedded) -* [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) +* [Online Installation wtih Embedded Cluster](installing-embedded) +* [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap) ### Customer-Specific Installation Instructions @@ -97,7 +97,7 @@ During installation, Embedded Cluster automatically runs a default set of _host * The system has at least 2G of memory and 2 CPU cores * The system clock is synchronized -For Embedded Cluster requirements, see [Embedded Cluster Installation Requirements](/enterprise/installing-embedded-requirements). For the full default host preflight spec for Embedded Cluster, see [`host-preflight.yaml`](https://github.com/replicatedhq/embedded-cluster/blob/main/pkg/preflights/host-preflight.yaml) in the `embedded-cluster` repository in GitHub. +For Embedded Cluster requirements, see [Embedded Cluster Installation Requirements](installing-embedded-requirements). For the full default host preflight spec for Embedded Cluster, see [`host-preflight.yaml`](https://github.com/replicatedhq/embedded-cluster/blob/main/pkg/preflights/host-preflight.yaml) in the `embedded-cluster` repository in GitHub. If any of the host preflight checks fail, installation is blocked and a message describing the failure is displayed. For more information about host preflight checks for installations on VMs or bare metal servers, see [About Host Preflights](preflight-support-bundle-about#host-preflights). @@ -151,7 +151,7 @@ For more information, see [roles](/reference/embedded-config#roles-beta) in _Emb Users can add nodes to a cluster with Embedded Cluster from the Admin Console. The Admin Console provides the join command used to add nodes to the cluster. -For more information, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). +For more information, see [Manage Multi-Node Clusters with Embedded Cluster](embedded-manage-nodes). ### High Availability for Multi-Node Clusters @@ -163,7 +163,7 @@ For more information about creating HA multi-node clusters with Embedded Cluster -For more information about updating, see [Perform Updates with Embedded Cluster](/enterprise/updating-embedded). +For more information about updating, see [Perform Updates with Embedded Cluster](updating-embedded). ## Access the Cluster diff --git a/docs/enterprise/installing-embedded-air-gap.mdx b/installer/installing-embedded-air-gap.mdx similarity index 93% rename from docs/enterprise/installing-embedded-air-gap.mdx rename to installer/installing-embedded-air-gap.mdx index 161fda6a4a..80e03f7550 100644 --- a/docs/enterprise/installing-embedded-air-gap.mdx +++ b/installer/installing-embedded-air-gap.mdx @@ -1,8 +1,8 @@ -import UpdateAirGapAdm from "../partials/embedded-cluster/_update-air-gap-admin-console.mdx" -import UpdateAirGapCli from "../partials/embedded-cluster/_update-air-gap-cli.mdx" -import UpdateAirGapOverview from "../partials/embedded-cluster/_update-air-gap-overview.mdx" -import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx" -import Prerequisites from "../partials/install/_ec-prereqs.mdx" +import UpdateAirGapAdm from "../docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx" +import UpdateAirGapCli from "../docs/partials/embedded-cluster/_update-air-gap-cli.mdx" +import UpdateAirGapOverview from "../docs/partials/embedded-cluster/_update-air-gap-overview.mdx" +import DoNotDowngrade from "../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx" +import Prerequisites from "../docs/partials/install/_ec-prereqs.mdx" # Air Gap Installation with Embedded Cluster @@ -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 [install](/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](embedded-cluster-install). ::: 1. When prompted, enter a password for accessing the KOTS Admin Console. @@ -125,7 +125,7 @@ To install with Embedded Cluster in an air gap environment: 1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. - Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**. + Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](embedded-manage-nodes). Click **Continue**. 1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**. diff --git a/docs/enterprise/installing-embedded-automation.mdx b/installer/installing-embedded-automation.mdx similarity index 89% rename from docs/enterprise/installing-embedded-automation.mdx rename to installer/installing-embedded-automation.mdx index 98e556ec05..3bd2b7e693 100644 --- a/docs/enterprise/installing-embedded-automation.mdx +++ b/installer/installing-embedded-automation.mdx @@ -1,6 +1,6 @@ -import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx" -import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx" -import ConfigValuesRequirements from "../partials/configValues/_requirements.mdx" +import ConfigValuesExample from "../docs/partials/configValues/_configValuesExample.mdx" +import ConfigValuesProcedure from "../docs/partials/configValues/_config-values-procedure.mdx" +import ConfigValuesRequirements from "../docs/partials/configValues/_requirements.mdx" # Automate Installation with Embedded Cluster @@ -28,13 +28,13 @@ For more information, see [ConfigValues](/reference/custom-resource-configvalues ## Limitation -Automating deployment with Embedded Cluster is supported only for the initial installation. Performing automated (headless) updates of existing installations with Embedded Cluster is not supported. For information about how to update an existing installation through the Admin Console UI, see [Perform Updates in Embedded Clusters](/enterprise/updating-embedded). +Automating deployment with Embedded Cluster is supported only for the initial installation. Performing automated (headless) updates of existing installations with Embedded Cluster is not supported. For information about how to update an existing installation through the Admin Console UI, see [Perform Updates in Embedded Clusters](updating-embedded). ## Online (Internet-Connected) Installation To install with Embedded Cluster in an online environment: -1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded). +1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see [Online Installation with Embedded Cluster](installing-embedded). 1. Run the following command to install: @@ -56,13 +56,13 @@ To install with Embedded Cluster in an online environment: * (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console. * (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate. - For more information about the `install` command options, see [install](/reference/embedded-cluster-install). + For more information about the `install` command options, see [install](embedded-cluster-install). ## Air Gap Installation To install with Embedded Cluster in an air-gapped environment: -1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap). +1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap). 1. Ensure that the Embedded Cluster installation assets are available on the air-gapped machine, then run the following command to install: @@ -86,4 +86,4 @@ To install with Embedded Cluster in an air-gapped environment: * (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console. * (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate. - For more information about the `install` command options, see [install](/reference/embedded-cluster-install). + For more information about the `install` command options, see [install](embedded-cluster-install). diff --git a/docs/enterprise/installing-embedded-requirements.mdx b/installer/installing-embedded-requirements.mdx similarity index 92% rename from docs/enterprise/installing-embedded-requirements.mdx rename to installer/installing-embedded-requirements.mdx index 60bc2d735b..875232d227 100644 --- a/docs/enterprise/installing-embedded-requirements.mdx +++ b/installer/installing-embedded-requirements.mdx @@ -1,6 +1,6 @@ -import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx" -import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx" -import FirewallOpeningsIntro from "../partials/install/_firewall-openings-intro.mdx" +import EmbeddedClusterRequirements from "../docs/partials/embedded-cluster/_requirements.mdx" +import EmbeddedClusterPortRequirements from "../docs/partials/embedded-cluster/_port-reqs.mdx" +import FirewallOpeningsIntro from "../docs/partials/install/_firewall-openings-intro.mdx" # Embedded Cluster Installation Requirements diff --git a/docs/enterprise/installing-embedded.mdx b/installer/installing-embedded.mdx similarity index 94% rename from docs/enterprise/installing-embedded.mdx rename to installer/installing-embedded.mdx index 043c19a302..2045a5ef47 100644 --- a/docs/enterprise/installing-embedded.mdx +++ b/installer/installing-embedded.mdx @@ -1,8 +1,8 @@ -import Prerequisites from "../partials/install/_ec-prereqs.mdx" +import Prerequisites from "../docs/partials/install/_ec-prereqs.mdx" # Online Installation with Embedded Cluster -This topic describes how to install an application in an online (internet-connected) environment with the Replicated Embedded Cluster installer. For information about air gap installations with Embedded Cluster, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap). +This topic describes how to install an application in an online (internet-connected) environment with the Replicated Embedded Cluster installer. For information about air gap installations with Embedded Cluster, see [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap). ## Prerequisites @@ -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 [install](/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](embedded-cluster-install). ::: 1. When prompted, enter a password for accessing the KOTS Admin Console. @@ -87,7 +87,7 @@ To install an application with Embedded Cluster: 1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. - Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](/enterprise/embedded-manage-nodes). Click **Continue**. + Optionally, add nodes to the cluster before deploying the application. For more information about joining nodes, see [Manage Multi-Node Clusters with Embedded Cluster](embedded-manage-nodes). Click **Continue**. 1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**. diff --git a/docs/enterprise/updating-embedded.mdx b/installer/updating-embedded.mdx similarity index 85% rename from docs/enterprise/updating-embedded.mdx rename to installer/updating-embedded.mdx index 43e1fe8b05..7059bb61dc 100644 --- a/docs/enterprise/updating-embedded.mdx +++ b/installer/updating-embedded.mdx @@ -1,12 +1,12 @@ -import UpdateAirGapAdm from "../partials/embedded-cluster/_update-air-gap-admin-console.mdx" -import UpdateAirGapCli from "../partials/embedded-cluster/_update-air-gap-cli.mdx" -import UpdateAirGapOverview from "../partials/embedded-cluster/_update-air-gap-overview.mdx" -import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx" -import Overview from "../partials/embedded-cluster/_update-overview.mdx" +import UpdateAirGapAdm from "../docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx" +import UpdateAirGapCli from "../docs/partials/embedded-cluster/_update-air-gap-cli.mdx" +import UpdateAirGapOverview from "../docs/partials/embedded-cluster/_update-air-gap-overview.mdx" +import DoNotDowngrade from "../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx" +import Overview from "../docs/partials/embedded-cluster/_update-overview.mdx" # Perform Updates in Embedded Clusters -This topic describes how to perform updates for [Replicated Embedded Cluster](/vendor/embedded-overview) installations. +This topic describes how to perform updates for [Replicated Embedded Cluster](embedded-overview) installations. :::note If you are instead looking for information about Replicated kURL, see [Perform Updates in kURL Clusters](updating-kurl). diff --git a/installer_versioned_docs/version-2.0.0/ec-v3-overview.md b/installer_versioned_docs/version-2.0.0/ec-v3-overview.md new file mode 100644 index 0000000000..04e685dcb5 --- /dev/null +++ b/installer_versioned_docs/version-2.0.0/ec-v3-overview.md @@ -0,0 +1 @@ +# About Embedded Cluster \ No newline at end of file diff --git a/installer_versioned_sidebars/version-2.0.0-sidebars.json b/installer_versioned_sidebars/version-2.0.0-sidebars.json new file mode 100644 index 0000000000..ca9ceecb13 --- /dev/null +++ b/installer_versioned_sidebars/version-2.0.0-sidebars.json @@ -0,0 +1,5 @@ +{ + "installerSidebar": [ + "ec-v3-overview" + ] +} diff --git a/installer_versions.json b/installer_versions.json new file mode 100644 index 0000000000..3aea0349a8 --- /dev/null +++ b/installer_versions.json @@ -0,0 +1,3 @@ +[ + "2.0.0" +] diff --git a/sidebars.js b/sidebars.js index 7d9917e0de..00df42304d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -234,48 +234,6 @@ const sidebars = { }, ], }, - { - type: "category", - label: "Embedded Cluster", - items: [ - "vendor/embedded-overview", - "vendor/embedded-using", - "reference/embedded-config", - { - type: "category", - label: "Install with Embedded Cluster", - items: [ - "enterprise/installing-embedded-requirements", - "enterprise/installing-embedded", - "enterprise/installing-embedded-air-gap", - "enterprise/installing-embedded-automation", - ], - }, - "enterprise/embedded-manage-nodes", - "enterprise/updating-embedded", - "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", - ], - }, - ], - }, { type: "category", label: "KOTS", diff --git a/sidebarsInstaller.js b/sidebarsInstaller.js new file mode 100644 index 0000000000..1177b3e179 --- /dev/null +++ b/sidebarsInstaller.js @@ -0,0 +1,40 @@ +export default { + installerSidebar: [ + "embedded-overview", + "embedded-using", + "embedded-config", + { + type: "category", + label: "Install with Embedded Cluster", + items: [ + "installing-embedded-requirements", + "installing-embedded", + "installing-embedded-air-gap", + "installing-embedded-automation", + ], + }, + "embedded-manage-nodes", + "updating-embedded", + "embedded-troubleshooting", + "embedded-tls-certs", + "embedded-disaster-recovery", + { + type: "category", + label: "Embedded Cluster Commands", + items: [ + "embedded-cluster-admin-console", + "embedded-cluster-completion", + "embedded-cluster-enable-ha", + "embedded-cluster-install", + "embedded-cluster-join", + "embedded-cluster-join-print-command", + "embedded-cluster-reset", + "embedded-cluster-restore", + "embedded-cluster-shell", + "embedded-cluster-support-bundle", + "embedded-cluster-update", + "embedded-cluster-version", + ], + }, + ], +}; \ No newline at end of file From c05d7bad94c0858d9af5ffc572d937067404163a Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 26 Jan 2026 11:58:54 -0700 Subject: [PATCH 2/4] added separate sidebars per product --- docusaurus.config.js | 9 +- sidebars.js | 514 +++++++------------------------------------ sidebarsInstaller.js | 4 +- 3 files changed, 85 insertions(+), 442 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 3d72aceff3..14f4d207f8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { docs: { routeBasePath: '/', // Serve the docs at the site's root sidebarPath: require.resolve('./sidebars.js'), - breadcrumbs: false, + breadcrumbs: true, editUrl: 'https://github.com/replicatedhq/replicated-docs/edit/main/', admonitions: { keywords: ['note','important', 'tip', 'info', 'caution', 'danger'], @@ -59,17 +59,18 @@ const config = { path: 'installer', routeBasePath: 'installer', sidebarPath: './sidebarsInstaller.js', + breadcrumbs: true, // Versioning configuration lastVersion: 'current', // Make 3.0.0 the default version includeCurrentVersion: true, // Include the "next" version from installer/ folder versions: { current: { - label: 'Embedded Cluster v3', + label: 'Embedded Cluster 3.0', path: 'v3', banner: 'none', }, '2.0.0': { - label: 'Embedded Cluster v2', + label: 'Embedded Cluster 2.13.3', path: 'v2', banner: 'none', }, @@ -158,7 +159,7 @@ const config = { }, { type: 'dropdown', - label: 'Replicated Platform Docs', + label: 'Product Docs', position: 'left', items: [ { diff --git a/sidebars.js b/sidebars.js index 00df42304d..dbc9ee7b9d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -11,6 +11,17 @@ // @ts-check +// Import modular sidebars +const vendorPlatformSidebar = require('./sidebarVendorPlatform'); +const enterprisePortalSidebar = require('./sidebarEnterprisePortal'); +const securityCenterSidebar = require('./sidebarSecurityCenter'); +const compatibilityMatrixSidebar = require('./sidebarCompatibilityMatrix'); +const kotsSidebar = require('./sidebarKOTS'); +const kurlSidebar = require('./sidebarKURL'); +const helmInstallationsSidebar = require('./sidebarHelmInstallations'); +const replicatedSdkSidebar = require('./sidebarReplicatedSDK'); +const preflightSupportSidebar = require('./sidebarPreflightSupport'); + // @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure @@ -91,461 +102,81 @@ const sidebars = { // PRODUCT DOCS { type: "html", value: "
Product docs
", defaultStyle: true }, { - type: "category", - label: "Vendor Portal", - items: [ - { - type: "category", - label: "Vendor Portal Teams and Accounts", - items: [ - "vendor/vendor-portal-creating-account", - "vendor/team-management", - "vendor/team-management-github-username", - { - type: "category", - label: "Configure Role-based Access Control", - items: [ - "vendor/team-management-rbac-configuring", - "vendor/team-management-rbac-resource-names", - ], - }, - { - type: "category", - label: "Configure Authentication", - items: [ - "vendor/team-management-two-factor-auth", - "vendor/team-management-google-auth", - "vendor/team-management-saml-auth", - "vendor/team-management-scim-provisioning", - ], - }, - "vendor/team-management-slack-config", - "vendor/replicated-api-tokens", - ], - }, - { - type: "category", - label: "Applications", - items: [ - "vendor/vendor-portal-manage-app", - "vendor/vendor-portal-application-settings", - ], - }, - { - type: "category", - label: "Channels and Releases", - items: [ - "vendor/releases-about", - "vendor/releases-creating-channels", - "vendor/releases-creating-releases", - "vendor/releases-creating-cli", - "vendor/helm-install-release", - "vendor/releases-sharing-license-install-script", - "reference/linter", - ], - }, - { - type: "category", - label: "Customers and Licenses", - items: [ - "vendor/licenses-about", - "vendor/releases-creating-customer", - "vendor/licenses-adding-custom-fields", - "vendor/licenses-install-types", - "vendor/releases-share-download-portal", - "vendor/licenses-about-types", - "vendor/licenses-download", - { - type: "category", - label: "Query License Entitlements", - items: [ - "vendor/licenses-using-builtin-fields", - "vendor/licenses-reference-sdk", - "vendor/licenses-reference-helm", - "vendor/licenses-referencing-fields", - "vendor/licenses-reference-kots-runtime", - "vendor/licenses-verify-fields-sdk-api", - ], - }, - ], - }, - { - type: "category", - label: "Custom Domains", - items: ["vendor/custom-domains", "vendor/custom-domains-using"], - }, - { - type: "category", - label: "Insights and Telemetry", - items: [ - "vendor/instance-insights-event-data", - "vendor/insights-app-status", - "vendor/telemetry-air-gap", - "vendor/customer-adoption", - "vendor/customer-reporting", - "vendor/instance-insights-details", - "vendor/instance-notifications-config", - "vendor/custom-metrics", - "vendor/instance-data-export", - ], - }, - "vendor/support-submit-request", - ], + type: "ref", + id: "vendor/vendor-portal-creating-account", + label: "Vendor Platform", + customProps: { + sidebar: "vendorPlatformSidebar" + } }, { - type: "category", + type: "ref", + id: "vendor/enterprise-portal-about", label: "Enterprise Portal", - items: [ - "vendor/enterprise-portal-about", - "vendor/enterprise-portal-configure", - "vendor/enterprise-portal-invite", - "vendor/enterprise-portal-self-serve-signup", - "vendor/enterprise-portal-access", - "vendor/enterprise-portal-use", - ], + customProps: { + sidebar: "enterprisePortalSidebar" + } }, { - type: "category", + type: "ref", + id: "vendor/security-center-about", label: "Security Center (Alpha)", - items: ["vendor/security-center-about"], + customProps: { + sidebar: "securityCenterSidebar" + } }, { - type: "category", + type: "ref", + id: "vendor/testing-about", label: "Compatibility Matrix", - items: [ - "vendor/testing-about", - "vendor/testing-supported-clusters", - "vendor/testing-how-to", - "vendor/testing-ingress", - "vendor/testing-cluster-addons", - "vendor/testing-vm-about", - "vendor/testing-vm-create", - "vendor/testing-vm-transfer-files", - "vendor/testing-vm-networking", - "vendor/testing-network-policy", - "vendor/testing-ci-cd", - { - type: "category", - label: "Managing Cost with CMX", - items: [ - "vendor/testing-pricing", - "vendor/compatibility-matrix-usage", - ], - }, - ], + customProps: { + sidebar: "compatibilityMatrixSidebar" + } }, - { - type: "category", - label: "KOTS", - items: [ - "intro-kots", - { - type: "category", - label: "Configure KOTS", - items: [ - { - type: "category", - label: "Configure the HelmChart Custom Resource", - items: [ - "vendor/helm-native-about", - "vendor/helm-native-v2-using", - "vendor/helm-packaging-airgap-bundles", - "vendor/helm-optional-value-keys", - "vendor/helm-v2-migrate", - ], - }, - { - type: "category", - label: "Customize the Admin Console and Download Portal", - items: [ - "vendor/admin-console-customize-app-icon", - "vendor/admin-console-adding-buttons-links", - "vendor/admin-console-port-forward", - "vendor/admin-console-prometheus-monitoring", - ], - }, - { - type: "category", - label: "Configure the Admin Console Config Screen", - items: [ - "vendor/config-screen-about", - "vendor/admin-console-customize-config-screen", - "vendor/config-screen-map-inputs", - "vendor/config-screen-conditional", - ], - }, - { - type: "category", - label: "Manage Resources and Objects", - items: [ - "vendor/admin-console-display-app-status", - { - type: "category", - label: "Conditionally Deploy Resources", - items: [ - "vendor/packaging-include-resources", - "vendor/tutorial-adding-db-config", - ], - }, - "vendor/resources-annotations-templating", - "vendor/orchestrating-resource-deployment", - "vendor/database-config-adding-options", - "vendor/packaging-cleaning-up-jobs", - "vendor/packaging-ingress", - ], - }, - { - type: "category", - label: "Manage KOTS", - items: [ - "vendor/packaging-kots-versions", - "vendor/packaging-rbac", - "vendor/packaging-air-gap-excluding-minio", - ], - }, - { - type: "category", - label: "Distribute Kubernetes Operators with KOTS", - items: [ - "vendor/operator-packaging-about", - "vendor/operator-defining-additional-images", - "vendor/operator-referencing-images", - "vendor/operator-defining-additional-namespaces", - ], - }, - ], - }, - { - type: "category", - label: "Install in Existing Clusters with KOTS", - items: [ - "enterprise/installing-overview", - "enterprise/installing-general-requirements", - "enterprise/installing-existing-cluster", - "enterprise/installing-existing-cluster-airgapped", - "enterprise/installing-existing-cluster-automation", - "enterprise/installing-stateful-component-requirements", - ], - }, - { - type: "category", - label: "Perform Updates in Existing Cluster KOTS Installations", - items: [ - "enterprise/updating-app-manager", - "enterprise/updating-apps", - "enterprise/updating-patching-with-kustomize", - ], - }, - { - type: "category", - label: "Configure Local Image Registries", - items: [ - "enterprise/image-registry-settings", - "enterprise/image-registry-rate-limits", - ], - }, - "enterprise/updating-licenses", - { - type: "category", - label: "Perform Backup and Restore with Snapshots", - items: [ - "vendor/snapshots-overview", - { - type: "category", - label: "Enable and Configure Snapshots", - items: [ - "vendor/snapshots-configuring-backups", - "reference/custom-resource-backup", - "vendor/snapshots-hooks", - ], - }, - { - type: "category", - label: "Configure Backup Storage for Snaphots", - items: [ - "enterprise/snapshots-velero-cli-installing", - "enterprise/snapshots-configuring-hostpath", - "enterprise/snapshots-configuring-nfs", - "enterprise/snapshots-storage-destinations", - "enterprise/snapshots-velero-installing-config", - ], - }, - "enterprise/snapshots-creating", - "enterprise/snapshots-restoring-full", - "enterprise/snapshots-updating-with-admin-console", - "enterprise/snapshots-troubleshooting-backup-restore", - ], - }, - { - type: "category", - label: "Manage Admin Console User Access", - items: [ - "enterprise/auth-changing-passwords", - "enterprise/auth-identity-provider", - "enterprise/auth-configuring-rbac", - ], - }, - { - type: "category", - label: "Monitor Applications with Prometheus", - items: [ - "enterprise/monitoring-applications", - "enterprise/monitoring-access-dashboards", - ], - }, - "enterprise/status-viewing-details", - "enterprise/delete-admin-console", - { - type: "category", - label: "Use a GitOps Workflow", - items: [ - "enterprise/gitops-workflow", - "enterprise/gitops-managing-secrets", - ], - }, - ], - }, - { - type: "category", - label: "kURL", - items: [ - "vendor/kurl-about", - { - type: "category", - label: "Configure kURL Installers", - items: [ - "vendor/packaging-embedded-kubernetes", - "vendor/packaging-installer-storage", - "vendor/installer-history", - "vendor/kurl-nodeport-services", - ], - }, - { - type: "category", - label: "Install with kURL", - items: [ - "enterprise/installing-kurl-requirements", - "enterprise/installing-kurl", - "enterprise/installing-kurl-airgap", - "enterprise/installing-kurl-automation", - ], - }, - "enterprise/cluster-management-add-nodes", - { - type: "category", - label: "Perform Updates with kURL", - items: [ - "enterprise/updating-kurl-about", - "enterprise/updating-kurl", - ], - }, - "vendor/packaging-using-tls-certs", - "enterprise/updating-tls-cert", - "enterprise/image-registry-kurl", - "enterprise/monitoring-external-prometheus", - "vendor/kurl-reset", - ], - }, { - type: "category", - label: "Helm Installations with Replicated", - items: [ - "vendor/helm-install-overview", - "vendor/helm-install-values-schema", - "vendor/install-with-helm", - "vendor/helm-install-airgap", - "vendor/using-third-party-registry-proxy", - "vendor/helm-install-troubleshooting", - ], + type: "link", + href: "/installer/v3/embedded-overview", + label: "Embedded Cluster", }, { - type: "category", - label: "Replicated SDK", - items: [ - "vendor/replicated-sdk-overview", - "vendor/replicated-sdk-installing", - "vendor/replicated-sdk-airgap", - "vendor/replicated-sdk-development", - "vendor/replicated-sdk-customizing", - ], + type: "ref", + id: "intro-kots", + label: "KOTS", + customProps: { + sidebar: "kotsSidebar" + } }, { - type: "category", - label: "Preflight Checks and Support Bundles", - items: [ - "vendor/preflight-support-bundle-about", - { - type: "category", - label: "Preflight Checks", - items: [ - "vendor/preflight-defining", - "vendor/preflight-examples", - "vendor/preflight-running", - "vendor/preflight-host-preflights", - ], - }, - { - type: "category", - label: "Support Bundles", - items: [ - "vendor/support-bundle-customizing", - "vendor/support-bundle-examples", - "vendor/support-online-support-bundle-specs", - "vendor/support-modular-support-bundle-specs", - { - type: "category", - label: "Generate Support Bundles", - items: [ - "vendor/support-bundle-generating", - "vendor/support-bundle-embedded", - "enterprise/troubleshooting-an-app", - "vendor/support-host-support-bundles", - ], - }, - "vendor/support-inspecting-support-bundles", - "vendor/support-enabling-direct-bundle-uploads", - ], - }, - "vendor/preflight-sb-helm-templates-about", - { - type: "category", - label: "Troubleshoot Custom Resources", - items: [ - "reference/custom-resource-preflight", - "reference/custom-resource-redactor", - ], - }, - ], + type: "ref", + id: "vendor/kurl-about", + label: "kURL", + customProps: { + sidebar: "kurlSidebar" + } }, { - type: "category", - label: "Replicated Proxy Registry", - items: [ - "vendor/private-images-about", - "vendor/packaging-private-images", - "vendor/helm-image-registry", - "vendor/private-images-kots", - "vendor/private-images-tags-digests", - { - type: "category", - label: "Replicated Private Registry", - items: [ - "vendor/private-images-replicated", - "vendor/packaging-private-registry-security", - ], - }, - "vendor/packaging-public-images", - "vendor/tutorial-ecr-private-images", - ], + type: "ref", + id: "vendor/helm-install-overview", + label: "Helm Installations with Replicated", + customProps: { + sidebar: "helmInstallationsSidebar" + } }, { - type: "category", - label: "Add Replicated to CI/CD Workflows", - items: [ - "vendor/ci-overview", - "vendor/ci-workflows", - "vendor/ci-workflows-github-actions", - ], + type: "ref", + id: "vendor/replicated-sdk-overview", + label: "Replicated SDK", + customProps: { + sidebar: "replicatedSdkSidebar" + } + }, + { + type: "ref", + id: "vendor/preflight-support-bundle-about", + label: "Preflight Checks and Support Bundles", + customProps: { + sidebar: "preflightSupportSidebar" + } }, // Reference @@ -878,6 +509,17 @@ const sidebars = { ], }, ], + + // Product-specific sidebars + ...vendorPlatformSidebar, + ...enterprisePortalSidebar, + ...securityCenterSidebar, + ...compatibilityMatrixSidebar, + ...kotsSidebar, + ...kurlSidebar, + ...helmInstallationsSidebar, + ...replicatedSdkSidebar, + ...preflightSupportSidebar, }; module.exports = sidebars; diff --git a/sidebarsInstaller.js b/sidebarsInstaller.js index 1177b3e179..a42e29c384 100644 --- a/sidebarsInstaller.js +++ b/sidebarsInstaller.js @@ -1,5 +1,5 @@ -export default { - installerSidebar: [ +module.exports = { + installerSidebar: [ "embedded-overview", "embedded-using", "embedded-config", From 7101bef731d483fb842e9b4a2443088da523b34a Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 26 Jan 2026 11:59:17 -0700 Subject: [PATCH 3/4] add separate sidebars per product --- sidebarCompatibilityMatrix.js | 23 +++++ sidebarEnterprisePortal.js | 10 ++ sidebarHelmInstallations.js | 10 ++ sidebarKOTS.js | 169 ++++++++++++++++++++++++++++++++++ sidebarKURL.js | 39 ++++++++ sidebarPreflightSupport.js | 46 +++++++++ sidebarReplicatedSDK.js | 9 ++ sidebarSecurityCenter.js | 5 + sidebarVendorPlatform.js | 136 +++++++++++++++++++++++++++ 9 files changed, 447 insertions(+) create mode 100644 sidebarCompatibilityMatrix.js create mode 100644 sidebarEnterprisePortal.js create mode 100644 sidebarHelmInstallations.js create mode 100644 sidebarKOTS.js create mode 100644 sidebarKURL.js create mode 100644 sidebarPreflightSupport.js create mode 100644 sidebarReplicatedSDK.js create mode 100644 sidebarSecurityCenter.js create mode 100644 sidebarVendorPlatform.js diff --git a/sidebarCompatibilityMatrix.js b/sidebarCompatibilityMatrix.js new file mode 100644 index 0000000000..da212c4cdf --- /dev/null +++ b/sidebarCompatibilityMatrix.js @@ -0,0 +1,23 @@ +module.exports = { + compatibilityMatrixSidebar: [ + "vendor/testing-about", + "vendor/testing-supported-clusters", + "vendor/testing-how-to", + "vendor/testing-ingress", + "vendor/testing-cluster-addons", + "vendor/testing-vm-about", + "vendor/testing-vm-create", + "vendor/testing-vm-transfer-files", + "vendor/testing-vm-networking", + "vendor/testing-network-policy", + "vendor/testing-ci-cd", + { + type: "category", + label: "Managing Cost with CMX", + items: [ + "vendor/testing-pricing", + "vendor/compatibility-matrix-usage", + ], + }, + ], +}; diff --git a/sidebarEnterprisePortal.js b/sidebarEnterprisePortal.js new file mode 100644 index 0000000000..fa1a5e1228 --- /dev/null +++ b/sidebarEnterprisePortal.js @@ -0,0 +1,10 @@ +module.exports = { + enterprisePortalSidebar: [ + "vendor/enterprise-portal-about", + "vendor/enterprise-portal-configure", + "vendor/enterprise-portal-invite", + "vendor/enterprise-portal-self-serve-signup", + "vendor/enterprise-portal-access", + "vendor/enterprise-portal-use", + ], +}; diff --git a/sidebarHelmInstallations.js b/sidebarHelmInstallations.js new file mode 100644 index 0000000000..311cf60d43 --- /dev/null +++ b/sidebarHelmInstallations.js @@ -0,0 +1,10 @@ +module.exports = { + helmInstallationsSidebar: [ + "vendor/helm-install-overview", + "vendor/helm-install-values-schema", + "vendor/install-with-helm", + "vendor/helm-install-airgap", + "vendor/using-third-party-registry-proxy", + "vendor/helm-install-troubleshooting", + ], +}; diff --git a/sidebarKOTS.js b/sidebarKOTS.js new file mode 100644 index 0000000000..da5651ee6f --- /dev/null +++ b/sidebarKOTS.js @@ -0,0 +1,169 @@ +module.exports = { + kotsSidebar: [ + "intro-kots", + { + type: "category", + label: "Configure KOTS", + items: [ + { + type: "category", + label: "Configure the HelmChart Custom Resource", + items: [ + "vendor/helm-native-about", + "vendor/helm-native-v2-using", + "vendor/helm-packaging-airgap-bundles", + "vendor/helm-optional-value-keys", + "vendor/helm-v2-migrate", + ], + }, + { + type: "category", + label: "Customize the Admin Console and Download Portal", + items: [ + "vendor/admin-console-customize-app-icon", + "vendor/admin-console-adding-buttons-links", + "vendor/admin-console-port-forward", + "vendor/admin-console-prometheus-monitoring", + ], + }, + { + type: "category", + label: "Configure the Admin Console Config Screen", + items: [ + "vendor/config-screen-about", + "vendor/admin-console-customize-config-screen", + "vendor/config-screen-map-inputs", + "vendor/config-screen-conditional", + ], + }, + { + type: "category", + label: "Manage Resources and Objects", + items: [ + "vendor/admin-console-display-app-status", + { + type: "category", + label: "Conditionally Deploy Resources", + items: [ + "vendor/packaging-include-resources", + "vendor/tutorial-adding-db-config", + ], + }, + "vendor/resources-annotations-templating", + "vendor/orchestrating-resource-deployment", + "vendor/database-config-adding-options", + "vendor/packaging-cleaning-up-jobs", + "vendor/packaging-ingress", + ], + }, + { + type: "category", + label: "Manage KOTS", + items: [ + "vendor/packaging-kots-versions", + "vendor/packaging-rbac", + "vendor/packaging-air-gap-excluding-minio", + ], + }, + { + type: "category", + label: "Distribute Kubernetes Operators with KOTS", + items: [ + "vendor/operator-packaging-about", + "vendor/operator-defining-additional-images", + "vendor/operator-referencing-images", + "vendor/operator-defining-additional-namespaces", + ], + }, + ], + }, + { + type: "category", + label: "Install in Existing Clusters with KOTS", + items: [ + "enterprise/installing-overview", + "enterprise/installing-general-requirements", + "enterprise/installing-existing-cluster", + "enterprise/installing-existing-cluster-airgapped", + "enterprise/installing-existing-cluster-automation", + "enterprise/installing-stateful-component-requirements", + ], + }, + { + type: "category", + label: "Perform Updates in Existing Cluster KOTS Installations", + items: [ + "enterprise/updating-app-manager", + "enterprise/updating-apps", + "enterprise/updating-patching-with-kustomize", + ], + }, + { + type: "category", + label: "Configure Local Image Registries", + items: [ + "enterprise/image-registry-settings", + "enterprise/image-registry-rate-limits", + ], + }, + "enterprise/updating-licenses", + { + type: "category", + label: "Perform Backup and Restore with Snapshots", + items: [ + "vendor/snapshots-overview", + { + type: "category", + label: "Enable and Configure Snapshots", + items: [ + "vendor/snapshots-configuring-backups", + "reference/custom-resource-backup", + "vendor/snapshots-hooks", + ], + }, + { + type: "category", + label: "Configure Backup Storage for Snaphots", + items: [ + "enterprise/snapshots-velero-cli-installing", + "enterprise/snapshots-configuring-hostpath", + "enterprise/snapshots-configuring-nfs", + "enterprise/snapshots-storage-destinations", + "enterprise/snapshots-velero-installing-config", + ], + }, + "enterprise/snapshots-creating", + "enterprise/snapshots-restoring-full", + "enterprise/snapshots-updating-with-admin-console", + "enterprise/snapshots-troubleshooting-backup-restore", + ], + }, + { + type: "category", + label: "Manage Admin Console User Access", + items: [ + "enterprise/auth-changing-passwords", + "enterprise/auth-identity-provider", + "enterprise/auth-configuring-rbac", + ], + }, + { + type: "category", + label: "Monitor Applications with Prometheus", + items: [ + "enterprise/monitoring-applications", + "enterprise/monitoring-access-dashboards", + ], + }, + "enterprise/status-viewing-details", + "enterprise/delete-admin-console", + { + type: "category", + label: "Use a GitOps Workflow", + items: [ + "enterprise/gitops-workflow", + "enterprise/gitops-managing-secrets", + ], + }, + ], +}; diff --git a/sidebarKURL.js b/sidebarKURL.js new file mode 100644 index 0000000000..8407f06bba --- /dev/null +++ b/sidebarKURL.js @@ -0,0 +1,39 @@ +module.exports = { + kurlSidebar: [ + "vendor/kurl-about", + { + type: "category", + label: "Configure kURL Installers", + items: [ + "vendor/packaging-embedded-kubernetes", + "vendor/packaging-installer-storage", + "vendor/installer-history", + "vendor/kurl-nodeport-services", + ], + }, + { + type: "category", + label: "Install with kURL", + items: [ + "enterprise/installing-kurl-requirements", + "enterprise/installing-kurl", + "enterprise/installing-kurl-airgap", + "enterprise/installing-kurl-automation", + ], + }, + "enterprise/cluster-management-add-nodes", + { + type: "category", + label: "Perform Updates with kURL", + items: [ + "enterprise/updating-kurl-about", + "enterprise/updating-kurl", + ], + }, + "vendor/packaging-using-tls-certs", + "enterprise/updating-tls-cert", + "enterprise/image-registry-kurl", + "enterprise/monitoring-external-prometheus", + "vendor/kurl-reset", + ], +}; diff --git a/sidebarPreflightSupport.js b/sidebarPreflightSupport.js new file mode 100644 index 0000000000..b40ef7fdb7 --- /dev/null +++ b/sidebarPreflightSupport.js @@ -0,0 +1,46 @@ +module.exports = { + preflightSupportSidebar: [ + "vendor/preflight-support-bundle-about", + { + type: "category", + label: "Preflight Checks", + items: [ + "vendor/preflight-defining", + "vendor/preflight-examples", + "vendor/preflight-running", + "vendor/preflight-host-preflights", + ], + }, + { + type: "category", + label: "Support Bundles", + items: [ + "vendor/support-bundle-customizing", + "vendor/support-bundle-examples", + "vendor/support-online-support-bundle-specs", + "vendor/support-modular-support-bundle-specs", + { + type: "category", + label: "Generate Support Bundles", + items: [ + "vendor/support-bundle-generating", + "vendor/support-bundle-embedded", + "enterprise/troubleshooting-an-app", + "vendor/support-host-support-bundles", + ], + }, + "vendor/support-inspecting-support-bundles", + "vendor/support-enabling-direct-bundle-uploads", + ], + }, + "vendor/preflight-sb-helm-templates-about", + { + type: "category", + label: "Troubleshoot Custom Resources", + items: [ + "reference/custom-resource-preflight", + "reference/custom-resource-redactor", + ], + }, + ], +}; diff --git a/sidebarReplicatedSDK.js b/sidebarReplicatedSDK.js new file mode 100644 index 0000000000..dff1493414 --- /dev/null +++ b/sidebarReplicatedSDK.js @@ -0,0 +1,9 @@ +module.exports = { + replicatedSdkSidebar: [ + "vendor/replicated-sdk-overview", + "vendor/replicated-sdk-installing", + "vendor/replicated-sdk-airgap", + "vendor/replicated-sdk-development", + "vendor/replicated-sdk-customizing", + ], +}; diff --git a/sidebarSecurityCenter.js b/sidebarSecurityCenter.js new file mode 100644 index 0000000000..085e503a99 --- /dev/null +++ b/sidebarSecurityCenter.js @@ -0,0 +1,5 @@ +module.exports = { + securityCenterSidebar: [ + "vendor/security-center-about", + ], +}; diff --git a/sidebarVendorPlatform.js b/sidebarVendorPlatform.js new file mode 100644 index 0000000000..3bf9416936 --- /dev/null +++ b/sidebarVendorPlatform.js @@ -0,0 +1,136 @@ +module.exports = { + vendorPlatformSidebar: [ + { + type: "category", + label: "Vendor Portal", + items: [ + { + type: "category", + label: "Vendor Portal Teams and Accounts", + items: [ + "vendor/vendor-portal-creating-account", + "vendor/team-management", + "vendor/team-management-github-username", + { + type: "category", + label: "Configure Role-based Access Control", + items: [ + "vendor/team-management-rbac-configuring", + "vendor/team-management-rbac-resource-names", + ], + }, + { + type: "category", + label: "Configure Authentication", + items: [ + "vendor/team-management-two-factor-auth", + "vendor/team-management-google-auth", + "vendor/team-management-saml-auth", + "vendor/team-management-scim-provisioning", + ], + }, + "vendor/team-management-slack-config", + "vendor/replicated-api-tokens", + ], + }, + { + type: "category", + label: "Applications", + items: [ + "vendor/vendor-portal-manage-app", + "vendor/vendor-portal-application-settings", + ], + }, + { + type: "category", + label: "Channels and Releases", + items: [ + "vendor/releases-about", + "vendor/releases-creating-channels", + "vendor/releases-creating-releases", + "vendor/releases-creating-cli", + "vendor/helm-install-release", + "vendor/releases-sharing-license-install-script", + "reference/linter", + ], + }, + { + type: "category", + label: "Customers and Licenses", + items: [ + "vendor/licenses-about", + "vendor/releases-creating-customer", + "vendor/licenses-adding-custom-fields", + "vendor/licenses-install-types", + "vendor/releases-share-download-portal", + "vendor/licenses-about-types", + "vendor/licenses-download", + { + type: "category", + label: "Query License Entitlements", + items: [ + "vendor/licenses-using-builtin-fields", + "vendor/licenses-reference-sdk", + "vendor/licenses-reference-helm", + "vendor/licenses-referencing-fields", + "vendor/licenses-reference-kots-runtime", + "vendor/licenses-verify-fields-sdk-api", + ], + }, + ], + }, + { + type: "category", + label: "Custom Domains", + items: ["vendor/custom-domains", "vendor/custom-domains-using"], + }, + { + type: "category", + label: "Insights and Telemetry", + items: [ + "vendor/instance-insights-event-data", + "vendor/insights-app-status", + "vendor/telemetry-air-gap", + "vendor/customer-adoption", + "vendor/customer-reporting", + "vendor/instance-insights-details", + "vendor/instance-notifications-config", + "vendor/custom-metrics", + "vendor/instance-data-export", + ], + }, + "vendor/support-submit-request", + ], + }, + { + type: "category", + label: "Replicated Proxy Registry", + items: [ + "vendor/private-images-about", + "vendor/packaging-private-images", + "vendor/helm-image-registry", + "vendor/private-images-kots", + "vendor/private-images-tags-digests", + { + type: "category", + label: "Replicated Private Registry", + items: [ + "vendor/private-images-replicated", + "vendor/packaging-private-registry-security", + ], + }, + "vendor/packaging-public-images", + "vendor/tutorial-ecr-private-images", + ], + }, + { + type: "category", + label: "Add Replicated to CI/CD Workflows", + items: [ + "vendor/ci-overview", + "vendor/ci-workflows", + "vendor/ci-workflows-github-actions", + ], + }, + ], +}; From 9b2941e996b207f708b9083086a9ebdafb1dd73b Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 26 Jan 2026 13:01:21 -0700 Subject: [PATCH 4/4] edit navbar --- docusaurus.config.js | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 14f4d207f8..f78326e166 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -155,7 +155,6 @@ const config = { { type: 'docsVersionDropdown', docsPluginId: 'installer', - label: 'Embedded Cluster', }, { type: 'dropdown', @@ -172,11 +171,27 @@ const config = { docId: 'vendor/enterprise-portal-about', label: 'Enterprise Portal', }, + { + type: 'doc', + docId: 'vendor/security-center-about', + label: 'Security Center', + }, { type: 'doc', docId: 'vendor/testing-about', label: 'Compatibility Matrix', }, + { + type: 'doc', + docId: 'vendor/private-images-about', + label: 'Proxy Registry', + }, + { + type: 'doc', + docId: 'vendor/preflight-support-bundle-about', + label: 'Preflight Checks and Support Bundles', + }, + { type: 'doc', docId: 'vendor/replicated-sdk-overview', @@ -187,9 +202,19 @@ const config = { }, { type: 'dropdown', - label: 'Developer Tools', + label: 'Reference', position: 'left', items: [ + { + type: 'doc', + docId: 'reference/custom-resource-about', + label: 'Custom Resources', + }, + { + type: 'doc', + docId: 'reference/template-functions-about', + label: 'Template Functions', + }, { type: 'doc', docId: 'reference/kots-cli-getting-started',
`--admin-console-port`

Port on which to run the KOTS Admin Console. **Default**: By default, the Admin Console runs on port 30000.

-

**Limitation:** It is not possible to change the port for the Admin Console during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).

+

**Limitation:** It is not possible to change the port for the Admin Console during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](embedded-disaster-recovery).
`--airgap-bundle`The Embedded Cluster air gap bundle used for installations in air-gapped environments with no outbound internet access. For information about how to install in an air-gapped environment, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap).The Embedded Cluster air gap bundle used for installations in air-gapped environments with no outbound internet access. For information about how to install in an air-gapped environment, see [Air Gap Installation with Embedded Cluster](installing-embedded-air-gap).
`--cidr`
`--config-values` -

Path to the ConfigValues file for the application. The ConfigValues file can be used to pass the application configuration values from the command line during installation, such as when performing automated installations as part of CI/CD pipelines. For more information, see [Automate Installation with Embedded Cluster](/enterprise/installing-embedded-automation).

+

Path to the ConfigValues file for the application. The ConfigValues file can be used to pass the application configuration values from the command line during installation, such as when performing automated installations as part of CI/CD pipelines. For more information, see [Automate Installation with Embedded Cluster](installing-embedded-automation).

Requirement: Embedded Cluster 1.18.0 and later.