Skip to content

Commit a064b32

Browse files
committed
edits
1 parent 24fd7be commit a064b32

File tree

8 files changed

+59
-44
lines changed

8 files changed

+59
-44
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,19 @@ For a tutorial that demonstrates how to install a sample application using the K
4545

4646
## Limitation
4747

48-
Replicated Embedded Cluster does not support headless installations with the KOTS CLI.
48+
[Replicated Embedded Cluster](/vendor/embedded-overview) does not support automated, or _headless_, installations with the KOTS CLI.
4949

50-
## Prerequisite
50+
## Prerequisites
5151

52-
Create a ConfigValues file to define the configuration settings for the application. For air gap environments, ensure that you can access the ConfigValues file that you create from your installation environment.
52+
* Create a ConfigValues YAML file to define the configuration settings for the application. For air gap environments, ensure that you can access the ConfigValues file that you create from your installation environment.
5353

54-
**Example:**
54+
A ConfigValues file includes the names of the configuration fields for the application along with a user-supplied `value` for each field. The ConfigValues file is specific to the application. For more information, see [Sharing a ConfigValues File](/vendor/releases-configvalues).
5555

56-
<ConfigValuesExample/>
56+
**Example:**
5757

58-
As shown in the example above, the ConfigValues file includes the names of the configuration fields for the application along with a user-supplied `value` for each field.
58+
<ConfigValuesExample/>
5959

60-
The ConfigValues file is specific to the application. For more information, see [Sharing a ConfigValues File](/vendor/releases-configvalues).
60+
* (Air Gap Only) For air gap installations, ensure that the **Airgap Download Enabled** option is enabled for the license that will be used to install.
6161

6262
## Install
6363

@@ -116,7 +116,7 @@ To install with kURL on a VM or bare metal server:
116116

117117
### Air Gap Existing Cluster
118118

119-
Air gap installations in existing clusters require the application `.airgap` bundle and the KOTS Admin Console `kotsadm.tar.gz` air gap bundle. Additionally, images for the application and the KOTS Admin Console must be pushed to a local private registry. For more information about downloading the necessary air gap bundles, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles).
119+
Air gap installations in existing clusters require the application `.airgap` bundle and the KOTS Admin Console `kotsadm.tar.gz` air gap bundle. Additionally, images for the application and the KOTS Admin Console must be pushed to a local private registry.
120120

121121
To install in an air gap existing cluster:
122122

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
You can use Replicated kURL to provision a cluster and install an application on a VM or bare metal server. When you use the KOTS CLI to install an application in a kURL cluster, you first run the kURL installation script to provision the cluster and automatically install KOTS in the cluster. Then, you can run the `kots install` command to install the application.
1+
When you use the KOTS CLI to install an application in a kURL cluster, you first run the kURL installation script to provision the cluster and automatically install KOTS in the cluster. Then, you can run the `kots install` command to install the application.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* `PATH_TO_AIRGAP_BUNDLE` with the path to the application `.airgap` bundle. For information about downloading the `.airgap` bundle, see [Build and Download the Application Bundle](/vendor/releases-download-airgap-bundles#air-gap-bundle) in _Downloading Air Gap Bundles_.
1+
* `PATH_TO_AIRGAP_BUNDLE` with the path to the `.airgap` bundle for the application release. For information about building and downloading air gap bundles with the Vendor API v3, see [Trigger airgap build for a channel's release](https://replicated-vendor-api.readme.io/reference/channelreleaseairgapbuild) and [Get airgap bundle download URL for the active release on the channel](https://replicated-vendor-api.readme.io/reference/channelreleaseairgapbundleurl) in the Vendor API v3 documentation.

docs/partials/install/_placeholders-global.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
* `PASSWORD` with a shared password for accessing the Admin Console.
44

5-
* `PATH_TO_LICENSE` with the path to your license file.
5+
* `PATH_TO_LICENSE` with the path to your license file. See [Downloading Customer Licenses](/vendor/licenses-download). For information about how to download licenses with the Vendor API v3, see [Download a customer license file as YAML](https://replicated-vendor-api.readme.io/reference/downloadlicense) in the Vendor API v3 documentation.
66

7-
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file.
7+
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. See [Generating a ConfigValues File](/vendor/releases-configvalues).

docs/vendor/releases-share-download-portal.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,53 @@ import DownloadPortal from "../partials/kots/_download-portal-about.mdx"
22

33
# Downloading Release Assets from the Download Portal
44

5-
This topic describes how to share customer license files, air gap bundles, and other assets with customers through the Replicated download portal.
5+
This topic describes how to download customer license files, air gap bundles, and other assets from the Replicated Download Portal.
6+
7+
For information about downloading release assets with the Vendor API v3, see the following pages in the Vendor API v3 documentation:
8+
* [Download a customer license file as YAML](https://replicated-vendor-api.readme.io/reference/downloadlicense)
9+
* [Trigger airgap build for a channel's release](https://replicated-vendor-api.readme.io/reference/channelreleaseairgapbuild)
10+
* [Get airgap bundle download URL for the active release on the channel](https://replicated-vendor-api.readme.io/reference/channelreleaseairgapbundleurl)
611

712
## Overview
813

914
<DownloadPortal/>
1015

11-
The most common use case for the download portal is for customers installing into air gap environments who must download both their license file as well as multiple air gap bundles. In this case, the download portal makes it easy for customers to find and download the correct KOTS admin console or kURL air gap bundle based on the selected application version to ensure compatibility.
16+
The most common use case for the Download Portal is for customers installing into air gap environments who need to download both their license file as well as multiple air gap bundles.
1217

13-
The following is an example of the download portal for an air gap customer installing in their own existing cluster:
18+
The following is an example of the Download Portal for an air gap customer installing in their own existing cluster:
1419

15-
![download portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
20+
![Download Portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
1621

1722
[View a larger version of this image](/images/download-portal-existing-cluster.png)
1823

19-
The following is an example of the download portal for an air gap customer installing in an embedded cluster with kURL:
24+
## Limitation
2025

21-
![download portal for kURL air gap installs](/images/download-portal-kurl.png)
26+
Release assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
2227

23-
[View a larger version of this image](/images/download-portal-kurl.png)
28+
## Download Assets from the Download Portal
2429

25-
### Limitation
30+
To log in to the Download Portal and download release assets:
2631

27-
Air gap bundles for the Replicated Embedded Cluster installer are not available in the Download Portal.
32+
1. In the [Vendor Portal](https://vendor.replicated.com), on the **Customers** page, click on the name of the customer.
2833

29-
## Get the Customer-Specific Download Portal URL and Password
34+
1. (Optional) On the **Manage customer** tab, enable the **Airgap Download Enabled** option. This makes air gap bundles available in the Download Portal.
3035

31-
To share installation files with a customer, you can send the customer their unique link and password for the download portal.
36+
![airgap download enabled license option](/images/airgap-download-enabled.png)
3237

33-
To get the URL and generate a password for the download portal:
38+
[View a larger version of this image](/images/airgap-download-enabled.png)
3439

35-
1. In the [Vendor Portal](https://vendor.replicated.com), on the **Customers** page, click on the name of the customer.
40+
1. On the **Reporting** tab, in the **Download portal** section, click **Manage customer password**.
3641

37-
1. (Optional) On the **Manage customer** page, enable the **Airgap Download Enabled** option. This makes air gap bundles available in the Download Portal.
42+
![download portal section](/images/download-portal-link.png)
43+
44+
[View a larger version of this image](/images/download-portal-link.png)
3845

3946
1. In the pop-up window, enter a password or click **Generate**.
4047

48+
![download portal password pop-up](/images/download-portal-password-popup.png)
49+
50+
[View a larger version of this image](/images/download-portal-password-popup.png)
51+
4152
1. Click **Copy** to copy the password to your clipboard.
4253

4354
After the password is saved, it cannot be retrieved again. If you lose the password, you can generate a new one.
@@ -47,29 +58,26 @@ To get the URL and generate a password for the download portal:
4758
1. Click **Visit download portal** to log in to the Download Portal
4859
and preview your customer's experience.
4960

50-
The following is an example of the download portal for an air gap customer:
51-
52-
![download portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
53-
54-
[View a larger version of this image](/images/download-portal-existing-cluster.png)
55-
5661
:::note
5762
By default, the Download Portal uses the domain `get.replicated.com`. You can optionally use a custom domain for the Download Portal. For more information, see [Using Custom Domains](/vendor/custom-domains-using).
5863
:::
5964

60-
1. Send the URL and password for the Download Portal to your customer.
65+
1. In the Download Portal, on the left side of the screen, select one of the following:
66+
* **Bring my own cluster**: View the downloadable assets for existing cluster installations with KOTS.
67+
* **Embedded cluster**: View the downloadable assets for Replicated kURL installations.
6168

62-
## Download Assets from the Download Portal {#download-portal}
69+
:::note
70+
Release assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
71+
:::
6372

64-
Users can download release assets, including air gap bundles and their licenses, from the Download Portal.
73+
The following is an example of the Download Portal for an air gap customer:
6574

66-
To download release assets from the Download Portal:
75+
![download portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
6776

77+
[View a larger version of this image](/images/download-portal-existing-cluster.png)
6878

69-
1. On the left side of the screen, select one of the following:
70-
* **Bring my own cluster**: View the air gap bundles for existing cluster installations with KOTS.
71-
* **Embedded cluster**: View the air gap bundles for kURL installations.
79+
1. Under **Select application version**, use the dropdown to select the target application release version. The Download Portal automatically makes the correct air gap bundles available for download based on the selected application version.
7280

73-
1. Under **Select application version**, use the dropdown to select the target application release version. The download portal automatically makes the correct air gap bundles available for download based on the selected application version.
81+
1. Click the download button to download each asset.
7482

75-
1. Click the download button to download each asset.
83+
1. To share installation files with a customer, send the customer their unique link and password for the Download Portal.

sidebars.js

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,6 @@ const sidebars = {
249249
'vendor/admin-console-customize-config-screen',
250250
'vendor/config-screen-map-inputs',
251251
'vendor/config-screen-conditional',
252-
'vendor/releases-configvalues',
253252
{
254253
type: 'category',
255254
label: 'Tutorial: Set Helm Chart Values with KOTS',
@@ -353,7 +352,7 @@ const sidebars = {
353352
},
354353
{
355354
type: 'category',
356-
label: 'Installing in Existing Clusters',
355+
label: 'Installing in Existing Clusters with KOTS',
357356
items: [
358357
'enterprise/installing-existing-cluster',
359358
'enterprise/installing-existing-cluster-airgapped',
@@ -368,7 +367,15 @@ const sidebars = {
368367
'enterprise/cluster-management-add-nodes',
369368
],
370369
},
371-
'enterprise/installing-existing-cluster-automation',
370+
{
371+
type: 'category',
372+
label: 'Installing with the KOTS CLI',
373+
items: [
374+
'enterprise/installing-existing-cluster-automation',
375+
'vendor/releases-configvalues',
376+
],
377+
},
378+
372379
'enterprise/installing-stateful-component-requirements',
373380
],
374381
},
21 KB
Loading
38.3 KB
Loading

0 commit comments

Comments
 (0)