Skip to content

Commit c37bbaa

Browse files
committed
Edit xrefs in vendor
1 parent 5660c09 commit c37bbaa

14 files changed

+38
-34
lines changed

docs/vendor/admin-console-customize-config-screen.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,4 +132,4 @@ To add fields to the Admin Console configuration screen:
132132

133133
After you add user input fields to the configuration screen, you use template functions to map the user-supplied values to manifest files in your release. If you use a Helm chart for your application, you map the values to the Helm chart `values.yaml` file using the HelmChart custom resource.
134134

135-
For more information, see [Mapping User-Supplied Values](config-screen-map-inputs).
135+
For more information, see [Map User-Supplied Values](config-screen-map-inputs).

docs/vendor/helm-image-registry.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ To enable the proxy registry:
124124
```
125125

126126
:::note
127-
If you configured a custom domain for the proxy registry, use the custom domain instead of `proxy.replicated.com`. For more information, see [Using Custom Domains](custom-domains-using).
127+
If you configured a custom domain for the proxy registry, use the custom domain instead of `proxy.replicated.com`. For more information, see [Use Custom Domains](custom-domains-using).
128128
:::
129129

130-
1. Log in to the Replicated registry and install the chart, passing the local `values.yaml` file you created with the `--values` flag. See [Installing with Helm](install-with-helm).
130+
1. Log in to the Replicated registry and install the chart, passing the local `values.yaml` file you created with the `--values` flag. See [Install with Helm](install-with-helm).
131131

132132

133133

docs/vendor/helm-native-about.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The following limitations apply when deploying Helm charts with the `kots.io/v1b
7272

7373
* When updating the HelmChart custom resource in a release from `kots.io/v1beta1` to `kots.io/v1beta2`, the diff viewer shows a large diff because the underlying file structure of the rendered manifests is different.
7474

75-
* Editing downstream Kustomization files to make changes to the application before deploying is not supported. This is because KOTS does not use Kustomize when installing Helm charts with the `kots.io/v1beta2` HelmChart custom resource. For more information about patching applications with Kustomize, see [Patching with Kustomize](/enterprise/updating-patching-with-kustomize).
75+
* Editing downstream Kustomization files to make changes to the application before deploying is not supported. This is because KOTS does not use Kustomize when installing Helm charts with the `kots.io/v1beta2` HelmChart custom resource. For more information about patching applications with Kustomize, see [Patch with Kustomize](/enterprise/updating-patching-with-kustomize).
7676

7777
* <GitOpsLimitation/>
7878

@@ -202,7 +202,7 @@ To deploy Helm charts with version `kots.io/v1beta1` of the HelmChart custom res
202202
kind: Kustomization
203203
```
204204

205-
End users can edit the downstream Kustomization files to make changes before deploying the application. Any instructions that users add to the Kustomization files in the downstream directory take priority over midstream and base Kustomization files. For more information about how users can make changes before deploying, see [Patching with Kustomize](/enterprise/updating-patching-with-kustomize).
205+
End users can edit the downstream Kustomization files to make changes before deploying the application. Any instructions that users add to the Kustomization files in the downstream directory take priority over midstream and base Kustomization files. For more information about how users can make changes before deploying, see [Patch with Kustomize](/enterprise/updating-patching-with-kustomize).
206206

207207
1. **Deploys the Helm chart**: KOTS runs `kustomize build` for any Kustomization files in the `overlays/downstream/charts` directory. KOTS then packages the resulting manifests into a new chart for Helm to consume.
208208

docs/vendor/instance-insights-details.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ As shown in the image above, the **Instance details** page includes the followin
3131
* **Current State**: Information about the state of the instance, such as the current application version. See [Current State](#current-state) below.
3232
* **Instance Insights**: Key performance indicators (KPIs) related to health, performance, and adoption. See [Insights](#insights) below.
3333
* **Instance Information**: Information about the cluster where the instance is installed, such as the version of Kubernetes running on the cluster. See [Instance Information](#instance-information) below.
34-
* **Custom Metrics**: The values for any custom metrics that are configured for the application, from the most recent check-in. For more information about configuring custom metrics, see [Configuring Custom Metrics](/vendor/custom-metrics).
34+
* **Custom Metrics**: The values for any custom metrics that are configured for the application, from the most recent check-in. For more information about configuring custom metrics, see [Configure Custom Metrics](/vendor/custom-metrics).
3535
* **Instance Uptime**: Details about instance uptime over time. See [Instance Uptime](#instance-uptime) below.
3636
* **Instance Activity**: Event data stream. See [Instance Activity](#instance-activity) below.
3737

@@ -302,7 +302,7 @@ The following tables describe the events that can be displayed in the **Instance
302302

303303
You can filter the activity feed by any custom metrics that are configured for the application. The labels for the custom metrics vary depending on the custom key value pairs included in the data set that is sent to the Vendor Portal. For example, the key value pair `"num_projects": 5` is displayed as **Num Projects: 5** in the activity feed.
304304

305-
For more information about configuring custom metrics, see [Configuring Custom Metrics](/vendor/custom-metrics).
305+
For more information about configuring custom metrics, see [Configure Custom Metrics](/vendor/custom-metrics).
306306
#### Infrastructure status {#infrastructure}
307307

308308
<table>

docs/vendor/kots-faq.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ The KOTS Admin Console and the Replicated Download Portal support the use of a c
154154

155155
For more information, see [Customizing the Admin Console and Download Portal](/vendor/admin-console-customize-app-icon) and [About Custom Domains](custom-domains).
156156

157+
For more information, see [Use Custom Domains](/vendor/custom-domains-using).
158+
157159
## Replicated SDK FAQs
158160

159161
### What is the SDK?
@@ -200,7 +202,7 @@ Yes. Replicated supports the use of custom domains to alias the endpoints for Re
200202

201203
Replicated domains are external to your domain and can require additional security reviews by your customer. Using custom domains as aliases can bring the domains inside an existing security review and reduce your exposure.
202204

203-
For more information, see [Using Custom Domains](/vendor/custom-domains-using).
205+
For more information, see [Use Custom Domains](/vendor/custom-domains-using).
204206

205207
### How does Replicated collect telemetry from instances of my application?
206208

docs/vendor/packaging-public-images.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ docker pull REPLICATED_PROXY_DOMAIN/proxy/APPSLUG/UPSTREAM_REGISTRY_HOSTNAME/IMA
1717
```
1818
Where:
1919
* `APPSLUG` is your Replicated app slug found on the [app settings page](https://vendor.replicated.com/settings).
20-
* `REPLICATED_PROXY_DOMAIN` is `proxy.replicated.com` or your custom domain. For information about how to set a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).
20+
* `REPLICATED_PROXY_DOMAIN` is `proxy.replicated.com` or your custom domain. For information about how to set a custom domain for the proxy registry, see [Use Custom Domains](/vendor/custom-domains-using).
2121
* `UPSTREAM_REGISTRY_HOSTNAME` is the hostname for the public registry where the image is located. If the image is located in a namespace within the registry, include the namespace after the hostname. For example, `quay.io/namespace`.
2222
* `IMAGE` is the image name.
2323
* `TAG` is the image tag.
@@ -55,7 +55,7 @@ The following example shows how to pull a public image when a custom domain is c
5555
```bash
5656
docker pull my.customdomain.io/proxy/APPSLUG/public.ecr.aws/nginx/nginx:latest
5757
```
58-
For information about how to set a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).
58+
For information about how to set a custom domain for the proxy registry, see [Use Custom Domains](/vendor/custom-domains-using).
5959

6060
## Related Topic
6161

docs/vendor/private-images-kots.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,6 @@ To enable the proxy registry:
7070

7171
* **Kubernetes Operators**: For applications packaged with Kubernetes Operators, KOTS cannot modify pods that are created at runtime by the Operator. To support the use of private images in all environments, the Operator code should use KOTS functionality to determine the image name and image pull secrets for all pods when they are created. For instructions, see [Referencing Images](/vendor/operator-referencing-images) in the _Packaging Kubernetes Operators_ section.
7272

73-
1. If you are deploying Pods to namespaces other than the application namespace, add the namespace to the `additionalNamespaces` attribute of the KOTS Application custom resource. This ensures that KOTS can provision the `imagePullSecret` in the namespace to allow the Pod to pull the image. For instructions, see [Defining Additional Namespaces](operator-defining-additional-namespaces).
73+
1. If you are deploying Pods to namespaces other than the application namespace, add the namespace to the `additionalNamespaces` attribute of the KOTS Application custom resource. This ensures that KOTS can provision the `imagePullSecret` in the namespace to allow the Pod to pull the image. For instructions, see [Defining Additional Namespaces](operator-defining-additional-namespaces).
74+
75+
1. (Optional) Add a custom domain for the proxy registry instead of `proxy.replicated.com`. See [Use Custom Domains](custom-domains-using).

docs/vendor/releases-about.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ The following describes each of the channel settings:
4848
* **Set this channel to default**: When enabled, sets the channel as the default channel. The default channel cannot be archived.
4949
* **Custom domains**: Select the customer-facing domains that releases promoted to this channel use for the Replicated registry, Replicated proxy registry, Replicated app service, or Replicated Download Portal endpoints. If a default custom domain exists for any of these endpoints, choosing a different domain in the channel settings overrides the default. If no custom domains are configured for an endpoint, the drop-down for the endpoint is disabled.
5050

51-
For more information about configuring custom domains and assigning default domains, see [Using Custom Domains](custom-domains-using).
51+
For more information about configuring custom domains and assigning default domains, see [Use Custom Domains](custom-domains-using).
5252
* The following channel settings apply only to applications that support KOTS:
5353
* **Automatically create airgap builds for newly promoted releases in this channel**: When enabled, the Vendor Portal automatically builds an air gap bundle when a new release is promoted to the channel. When disabled, you can generate an air gap bundle manually for a release on the **Release History** page for the channel.
5454
* **Enable semantic versioning**: When enabled, the Vendor Portal verifies that the version label for any releases promoted to the channel uses a valid semantic version. For more information, see [Semantic Versioning](releases-about#semantic-versioning) in _About Releases_.
55-
* **Enable new airgap bundle format**: When enabled, air gap bundles built for releases promoted to the channel use a format that supports image digests. This air gap bundle format also ensures that identical image layers are not duplicated, resulting in a smaller air gap bundle size. For more information, see [Using Image Digests in Air Gap Installations](private-images-tags-digests#digests-air-gap) in _Using Image Tags and Digests_.
55+
* **Enable new airgap bundle format**: When enabled, air gap bundles built for releases promoted to the channel use a format that supports image digests. This air gap bundle format also ensures that identical image layers are not duplicated, resulting in a smaller air gap bundle size. For more information, see [Use Image Digests in Air Gap Installations](private-images-tags-digests#digests-air-gap) in _Use Image Tags and Digests_.
5656

5757
:::note
5858
The new air gap bundle format is supported for applications installed with KOTS v1.82.0 or later.

docs/vendor/releases-creating-channels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To create a channel:
2020
1. Enter a name and description for the channel.
2121
1. (Recommended) Enable semantic versioning on the channel if it is not enabled by default by turning on **Enable semantic versioning**. For more information about semantic versioning and defaults, see [Semantic Versioning](releases-about#semantic-versioning).
2222

23-
1. (Recommended) Enable an air gap bundle format that supports image digests and deduplication of image layers, by turning on **Enable new air gap bundle format**. For more information, see [Using Image Tags and Digests](private-images-tags-digests).
23+
1. (Recommended) Enable an air gap bundle format that supports image digests and deduplication of image layers, by turning on **Enable new air gap bundle format**. For more information, see [Use Image Tags and Digests](private-images-tags-digests).
2424

2525
1. Click **Create Channel**.
2626

docs/vendor/replicated-sdk-installing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This topic describes the methods for distributing and installing the Replicated
99

1010
It includes information about how to install the SDK alongside Helm charts or Kubernetes manifest-based applications using the Helm CLI or a Replicated installer (Replicated KOTS, kURL, Embedded Cluster). It also includes information about installing the SDK as a standalone component in integration mode.
1111

12-
For information about installing the SDK in air gap mode, see [Installing the SDK in Air Gap Environments](replicated-sdk-airgap).
12+
For information about installing the SDK in air gap mode, see [Install the SDK in Air Gap Environments](replicated-sdk-airgap).
1313

1414
## Requirement
1515

0 commit comments

Comments
 (0)