Skip to content

Commit 075e8a1

Browse files
authored
Merge pull request #2654 from replicatedhq/broken-links
Fix broken links
2 parents 79643e4 + 603498d commit 075e8a1

10 files changed

+22
-22
lines changed

docs/enterprise/gitops-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you have more than one application installed, you can selectively enable Auto
1313

1414
After enabling the Auto-GitOps workflow for an application, the Admin Console makes your first commit with the latest available version in the Admin Console. The latest available version is often the current version that is deployed. Subsequently, the Admin Console makes separate commits with any available updates.
1515

16-
If you configure automatic updates for the application, any updates from your vendor are automatically committed to your Git repository. For more information about configuring automatic updates, see [Configure Automatic Updates](updating-apps#configure-automatic-updates) in _Updating an Application_.
16+
If you configure automatic updates for the application, any updates from your vendor are automatically committed to your Git repository. For more information about configuring automatic updates, see [Configuring Automatic Updates](/enterprise/updating-apps).
1717

1818
You can change your GitOps settings or disable Auto-GitOps at any time from the **GitOps** tab in the Admin Console.
1919

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Embedded Cluster installations in air gap environments is a beta feature. This f
1616

1717
When an air gap bundle is built for a release containing an Embedded Cluster Config, both an application air gap bundle and an Embedded Cluster air gap bundle are built. The application air gap bundle can be used for air gap installations with Replicated kURL or with Replicated KOTS in an existing cluster. The Embedded Cluster air gap bundle is used for air gap installations with Embedded Cluster.
1818

19-
The Embedded Cluster air gap bundle not only contains the assets normally contained in an application air gap bundle (`airgap.yaml`, `app.tar.gz`, and an images directory), but it also contains an `embedded-cluster` directory with the assets needed to install the infrastructure (Embedded Cluster/k0s and [Helm extensions](/reference/embedded-config#helm-extensions)).
19+
The Embedded Cluster air gap bundle not only contains the assets normally contained in an application air gap bundle (`airgap.yaml`, `app.tar.gz`, and an images directory), but it also contains an `embedded-cluster` directory with the assets needed to install the infrastructure (Embedded Cluster/k0s and [extensions](/reference/embedded-config#extensions).
2020

2121
During installation with Embedded Cluster in air gap environments, a Docker registry is deployed to the cluster to store application images. Infrastructure images (for Embedded Cluster and Helm extensions) and the Helm charts are preloaded on each node at installation time.
2222

@@ -30,7 +30,7 @@ Embedded Cluster installations in air gap environments have the following limita
3030

3131
* If you pass `?airgap=true` to the `replicated.app` endpoint but an air gap bundle is not built for the latest release, the API will not return a 404. Instead it will return the tarball without the air gap bundle (as in, with the installer and the license in it, like for online installations).
3232

33-
* Images used by Helm extensions must not refer to a multi-architecture image by digest. Only x64 images are included in air gap bundles, and the digest for the x64 image will be different from the digest for the multi-architecture image, preventing the image from being discovered in the bundle. An example of a chart that does this is ingress-nginx/ingress-nginx chart. For an example of how the digests should be set to empty string to pull by tag only, see [Helm Extensions](/reference/embedded-config#helm-extensions) in _Embedded Cluster Config_.
33+
* Images used by Helm extensions must not refer to a multi-architecture image by digest. Only x64 images are included in air gap bundles, and the digest for the x64 image will be different from the digest for the multi-architecture image, preventing the image from being discovered in the bundle. An example of a chart that does this is ingress-nginx/ingress-nginx chart. For an example of how the digests should be set to empty string to pull by tag only, see [extensions](/reference/embedded-config#extensions) in _Embedded Cluster Config_.
3434

3535
* Images for Helm extensions are loaded directly into containerd so that they are available without internet access. But if an image used by a Helm extension has **Always** set as the image pull policy, Kubernetes will try to pull the image from the internet. If necessary, use the Helm values to set `IfNotPresent` as the image pull policy to ensure the extension works in air gap environments.
3636

docs/enterprise/installing-existing-cluster.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Complete the following prerequisites:
2020

2121
To install KOTS and the application in an existing cluster:
2222

23-
1. Run one of these commands to install the Replicated KOTS CLI and KOTS. As part of the command, you also specify a name and version for the application that you will install as part of the [Install and Deploy the Application](#install-app) procedure that follows.
23+
1. Run one of these commands to install the Replicated KOTS CLI and KOTS. As part of the command, you also specify a name and version for the application that you will install.
2424

2525
* **For the latest application version**:
2626

docs/partials/install/_ec-prereqs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

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

7-
* The license used to install must have the **Embedded Cluster Enabled** license field enabled. See [Creating and Managing Customers](/vendor/releases-creating-customers).
7+
* The license used to install must have the **Embedded Cluster Enabled** license field enabled. See [Creating and Managing Customers](/vendor/releases-creating-customer).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
(Kubernetes Upgrades Only) If a Kubernetes upgrade is required, the script automatically prints a `Drain local node and apply upgrade?` prompt. Confirm the prompt to drain the local primary node and apply the Kubernetes upgrade to the control plane.
22

3-
The script continues to drain and upgrade nodes sequentially. For each node, the script prints a command that you must run on the node to upgrade Kubernetes. For more information, see [Kubernetes Updates](#kubernetes) above.
3+
The script continues to drain and upgrade nodes sequentially. For each node, the script prints a command that you must run on the node to upgrade Kubernetes. For more information, see [About Kubernetes Updates](/enterprise/updating-kurl-about#kubernetes) in _About kURL Cluster Updates_.

docs/vendor/embedded-disaster-recovery.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Enabling disaster recovery for Embedded Cluster has the following requirements:
2828

2929
Embedded Cluster disaster recovery has the following limitations and known issues:
3030

31-
* During a restore, the binary version used must match the version of the application in the backup. So if version 0.1.97 of your application was backed up, the Embedded Cluster binary for 0.1.97 must be used to perform the restore. Use `./APP_SLUG version` to check the version of the binary, where `APP_SLUG` is the unique application slug. For example:
31+
* During a restore, the version of the Embedded Cluster installation assets must match the version of the application in the backup. So if version 0.1.97 of your application was backed up, the Embedded Cluster installation assets for 0.1.97 must be used to perform the restore. Use `./APP_SLUG version` to check the version of the installation assets, where `APP_SLUG` is the unique application slug. For example:
3232

3333
<img alt="version command" src="/images/ec-version-command.png" width="450px"/>
3434

@@ -129,10 +129,10 @@ To restore from a backup:
129129

130130
1. SSH onto a new machine where you want to restore from a backup.
131131

132-
1. Download the Embedded Cluster binary for the version of the application that was included in the backup. See [Download the Embedded Cluster Binary](/vendor/embedded-overview#download-the-embedded-cluster-binary).
132+
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).
133133

134134
:::note
135-
The version of the Embedded Cluster binary must match the version that is in the backup. For more information, see [Limitations and Known Issues](#limitations-and-known-issues).
135+
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).
136136
:::
137137

138138
1. Run the restore command:

docs/vendor/embedded-overview.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Embedded Cluster has the following limitations:
5959

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

62-
* **Embedded Cluster release artifact not available through the Download Portal**: The binary required to install with Embedded Cluster cannot be shared with users through the Download Portal. Users can follow the Embedded Cluster installation instructions to download and extract the binary in order to install with Embedded Cluster. For more information, see [Download the Embedded Cluster Binary](/vendor/embedded-overview#download-the-embedded-cluster-binary).
62+
* **Embedded Cluster installation assets not available through the Download Portal**: The assets required to install with Embedded Cluster cannot be shared with users through the Download Portal. Users can follow the Embedded Cluster installation instructions to download and extract the installation assets. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
6363

6464
* **`minKotsVersion` and `targetKotsVersion` not supported**: The [`minKotsVersion`](/reference/custom-resource-application#minkotsversion-beta) and [`targetKotsVersion`](/reference/custom-resource-application#targetkotsversion) fields in the KOTS Application custom resource are not supported for Embedded Cluster installations. 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`. To avoid installation failures, do not use targetKotsVersion or minKotsVersion in releases that support installation with Embedded Cluster.
6565

@@ -81,20 +81,20 @@ You can use the following steps to get started quickly with Embedded Cluster. Mo
8181

8282
1. Create a new customer or edit an existing customer and select the **Embedded Cluster Enabled (Beta)** license option. Save the customer.
8383

84-
1. Create a new release that includes your application. In that release, create an embedded cluster config that includes, at minimum, the Embedded Cluster version you want to use. See the Embedded Cluster [GitHub repo](https://github.com/replicatedhq/embedded-cluster/releases) to find the latest version.
84+
1. Create a new release that includes your application. In that release, create an Embedded Cluster Config that includes, at minimum, the Embedded Cluster version you want to use. See the Embedded Cluster [GitHub repo](https://github.com/replicatedhq/embedded-cluster/releases) to find the latest version.
8585

86-
Example Embedded Cluster config:
86+
Example Embedded Cluster Config:
8787

8888
```yaml
8989
apiVersion: embeddedcluster.replicated.com/v1beta1
9090
kind: Config
9191
spec:
92-
version: 1.9.1+k8s-1.29
92+
version: 1.12.1+k8s-1.29
9393
```
9494
95-
1. Save the release and promote it to the channel your customer is assigned to.
95+
1. Save the release and promote it to the channel the customer is assigned to.
9696
97-
1. Return to the customer page where you enabled Embedded Cluster. At the top right, click **Install instructions** and choose **Embedded cluster**. A dialog appears with instructions on how to download the Embedded Cluster binary and install your application.
97+
1. Return to the customer page where you enabled Embedded Cluster. At the top right, click **Install instructions** and choose **Embedded Cluster**. A dialog appears with instructions on how to download the Embedded Cluster installation assets and install your application.
9898
9999
![Customer install instructions drop down button](/images/customer-install-instructions-dropdown.png)
100100
@@ -108,7 +108,7 @@ You can use the following steps to get started quickly with Embedded Cluster. Mo
108108
109109
1. Enter an Admin Console password when prompted.
110110
111-
The Admin Console URL is printed when the installation finishes. Access the Admin Console to begin installing your application. You’ll have the opportunity to add nodes if you want a multi-node cluster. Then you can provide application config, run preflights, and deploy your application.
111+
The Admin Console URL is printed when the installation finishes. Access the Admin Console to begin installing your application. During the installation process in the Admin Console, you have the opportunity to add nodes if you want a multi-node cluster. Then you can provide application config, run preflights, and deploy your application.
112112
113113
## About Configuring Embedded Cluster
114114
@@ -294,7 +294,7 @@ To add nodes to a cluster:
294294
```
295295
296296
297-
1. SSH onto the machine you want to join to the cluster. Ensure that the Embedded Cluster binary is available on that node. For more information on downloading the Embedded Cluster binary, see Installing.
297+
1. SSH onto the machine you want to join to the cluster. Ensure that the Embedded Cluster binary is available on that node. For more information about downloading Embedded Cluster installation assets, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
298298
299299
:::important
300300
You must join nodes with the same installer that you used for the first node. If you use a different installer from a different release of your application, the cluster will not be stable.
@@ -356,7 +356,7 @@ When resetting a node, OpenEBS PVCs on the node are deleted. Only PVCs created a
356356

357357
To reset the node of a cluster:
358358

359-
1. SSH onto the machine. Ensure that the Embedded Cluster binary is still available on that machine. For more information on downloading the Embedded Cluster binary, see [Download the Embedded Cluster Binary](#download-the-embedded-cluster-binary) above.
359+
1. SSH onto the machine. Ensure that the Embedded Cluster binary is still available on that machine. For more information about downloading Embedded Cluster installation assets, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
360360

361361
1. Run the reset command to reset the node. The `--reboot` flag automatically reboots the machine to ensure that transient configuration is also reset.
362362

@@ -374,7 +374,7 @@ This section outlines some additional use cases for Embedded Cluster. These are
374374

375375
### NVIDIA GPU Operator
376376

377-
The NVIDIA GPU Operator uses the operator framework within Kubernetes to automate the management of all NVIDIA software components needed to provision GPUs. For more information about this operator, see the [NVIDIA GPU Operator](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/overview.html) documentation. You can include the operator in your release as an additional Helm chart, or using the Embedded Cluster Helm extensions. For information about Helm extensions, see [Helm extensions](/reference/embedded-config#helm-extensions) in _Embedded Cluster Config_.
377+
The NVIDIA GPU Operator uses the operator framework within Kubernetes to automate the management of all NVIDIA software components needed to provision GPUs. For more information about this operator, see the [NVIDIA GPU Operator](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/overview.html) documentation. You can include the operator in your release as an additional Helm chart, or using the Embedded Cluster Helm extensions. For information about Helm extensions, see [extensions](/reference/embedded-config#extensions) in _Embedded Cluster Config_.
378378

379379
Using this operator with Embedded Cluster requires configuring the containerd options in the operator as follows:
380380

docs/vendor/preflight-support-bundle-about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ _Host preflight checks_ automatically run during [Replicated Embedded Cluster](/
6565

6666
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.
6767

68-
For more information about the default Embedded Cluster host preflight checks, see [Host Preflight Checks](/vendor/embedded-overview#host-preflight-checks) in _Using Embedded Cluster (Beta)_.
68+
For more information about the default Embedded Cluster host preflight checks, see [Host Preflight Checks](/vendor/embedded-overview#about-host-preflight-checks) in _Using Embedded Cluster (Beta)_.
6969

7070
For more information about kURL host preflight checks, including information about how to customize the defaults, see [Customizing Host Preflight Checks for kURL](/vendor/preflight-host-preflights).
7171

docs/vendor/releases-sharing-license-install-script.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ To get customer-specific Helm or Embedded Cluster installation instructions:
129129
[View a larger version of this image](/images/helm-install-instructions-dialog.png)
130130
</TabItem>
131131
<TabItem value="ec" label="Embedded Cluster" default>
132-
<p>View the customer-specific Embedded Cluster installation instructions. For more information about installing with Embedded Cluster, see [Install](/vendor/embedded-overview#install) in _Using Embedded Cluster_.</p>
132+
<p>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).</p>
133133
<img alt="Embedded cluster install instructions" src="/images/embedded-cluster-install-dialog-latest.png" width="500px"/>
134134
[View a larger version of this image](/images/embedded-cluster-install-dialog-latest.png)
135135
</TabItem>

docs/vendor/telemetry-air-gap.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To collect telemetry from air gap instances:
6262

6363
For more information, see [Generating Support Bundles](/vendor/support-bundle-generating).
6464

65-
* (KOTS Only) For KOTS installations, users can also generate and download a support bundle from the Admin Console **Troubleshoot** tab to ensure that telemetry and custom metrics are included. See [Generating a Support Bundle Using the Admin Console](/enterprise/troubleshooting-an-app#generate-a-support-bundle-using-the-admin-console).
65+
* (KOTS Only) For KOTS installations, users can also generate and download a support bundle from the Admin Console **Troubleshoot** tab to ensure that telemetry and custom metrics are included. See [Generating a Support Bundle Using the Admin Console](/enterprise/troubleshooting-an-app#generate-a-bundle-from-the-admin-console).
6666

6767
1. After receiving the support bundle from your customer, go to the Vendor Portal **Customers**, **Customer Reporting**, or **Instance Details** page and upload the support bundle:
6868

0 commit comments

Comments
 (0)