You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/enterprise/installing-existing-cluster-automation.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,19 +45,19 @@ For a tutorial that demonstrates how to install a sample application using the K
45
45
46
46
## Limitation
47
47
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.
49
49
50
-
## Prerequisite
50
+
## Prerequisites
51
51
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.
53
53
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).
55
55
56
-
<ConfigValuesExample/>
56
+
**Example:**
57
57
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/>
59
59
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.
61
61
62
62
## Install
63
63
@@ -116,7 +116,7 @@ To install with kURL on a VM or bare metal server:
116
116
117
117
### Air Gap Existing Cluster
118
118
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.
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.
*`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.
Copy file name to clipboardExpand all lines: docs/partials/install/_placeholders-global.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,6 @@
2
2
3
3
*`PASSWORD` with a shared password for accessing the Admin Console.
4
4
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.
6
6
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).
Copy file name to clipboardExpand all lines: docs/vendor/releases-share-download-portal.md
+37-29Lines changed: 37 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,42 +2,53 @@ import DownloadPortal from "../partials/kots/_download-portal-about.mdx"
2
2
3
3
# Downloading Release Assets from the Download Portal
4
4
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)
6
11
7
12
## Overview
8
13
9
14
<DownloadPortal/>
10
15
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.
12
17
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:
14
19
15
-

20
+

16
21
17
22
[View a larger version of this image](/images/download-portal-existing-cluster.png)
18
23
19
-
The following is an example of the download portal for an air gap customer installing in an embedded cluster with kURL:
24
+
## Limitation
20
25
21
-

26
+
Release assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
22
27
23
-
[View a larger version of this image](/images/download-portal-kurl.png)
28
+
## Download Assets from the Download Portal
24
29
25
-
### Limitation
30
+
To log in to the Download Portal and download release assets:
26
31
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.
28
33
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.
30
35
31
-
To share installation files with a customer, you can send the customer their unique link and password for the download portal.
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)
34
39
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**.
36
41
37
-
1. (Optional) On the **Manage customer** page, enable the **Airgap Download Enabled** option. This makes air gap bundles available in the Download Portal.
[View a larger version of this image](/images/download-portal-password-popup.png)
51
+
41
52
1. Click **Copy** to copy the password to your clipboard.
42
53
43
54
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:
47
58
1. Click **Visit download portal** to log in to the Download Portal
48
59
and preview your customer's experience.
49
60
50
-
The following is an example of the download portal for an air gap customer:
51
-
52
-

53
-
54
-
[View a larger version of this image](/images/download-portal-existing-cluster.png)
55
-
56
61
:::note
57
62
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).
58
63
:::
59
64
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.
61
68
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
+
:::
63
72
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:
65
74
66
-
To download release assets from the Download Portal:
75
+

67
76
77
+
[View a larger version of this image](/images/download-portal-existing-cluster.png)
68
78
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.
72
80
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.
74
82
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.
0 commit comments