Skip to content

Commit fac69a2

Browse files
committed
Edit download portal docs to reflect Install types
1 parent 6812acf commit fac69a2

8 files changed

+27
-45
lines changed

Diff for: docs/partials/kots/_download-portal-about.mdx

-6
This file was deleted.

Diff for: docs/vendor/customer-reporting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ From the **Download portal** section, you can:
5757
* Manage the password for the Download Portal
5858
* Access the unique Download Portal URL for the customer
5959

60-
You can use the Download Portal to give your customers access to the files they need to install your application, such as their license file or air gap bundles. For more information, see [Downloading Assets from the Download Portal](releases-share-download-portal).
60+
You can use the Download Portal to give your customers access to the files they need to install your application, such as their license file or air gap bundles. For more information, see [Accessing a Customer's Download Portal](releases-share-download-portal).
6161

6262
### Instances
6363

Diff for: docs/vendor/embedded-overview.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,6 @@ Embedded Cluster has the following limitations:
111111

112112
* **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).
113113

114-
* **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).
115-
116114
* **`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.
117115

118116
* **Support bundles over 100MB in the Admin Console**: Support bundles are stored in rqlite. Bundles over 100MB could cause rqlite to crash, causing errors in the installation. You can still generate a support bundle from the command line. For more information, see [Generating Support Bundles for Embedded Cluster](/vendor/support-bundle-embedded).

Diff for: docs/vendor/releases-share-download-portal.md

+25-35
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
import DownloadPortal from "../partials/kots/_download-portal-about.mdx"
1+
# Accessing a Customer's Download Portal
22

3-
# Downloading Assets from the Download Portal
4-
5-
This topic describes how to download customer license files, air gap bundles, and other assets from the Replicated Download Portal.
3+
This topic describes how to access installation instructions and download installation assets (such as customer license files and air gap bundles) from the Replicated Download Portal.
64

75
For information about downloading air gap bundles and licenses with the Vendor API v3, see the following pages in the Vendor API v3 documentation:
86
* [Download a customer license file as YAML](https://replicated-vendor-api.readme.io/reference/downloadlicense)
@@ -11,37 +9,39 @@ For information about downloading air gap bundles and licenses with the Vendor A
119

1210
## Overview
1311

14-
<DownloadPortal/>
15-
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+
The Replicated Download Portal can be used to share license files, air gap bundles, and other assets with customers. From the Download Portal, customers can also view instructions for how to install a release with Replicated Embedded Cluster or the Helm CLI.
1713

18-
The following is an example of the Download Portal for an air gap customer installing in their own existing cluster:
14+
A unique Download Portal link is available for each customer. The Download Portal uses information from the customer's license to make the relevant assets and installation instructions available.
1915

20-
![Download Portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
16+
## Limitation
2117

22-
[View a larger version of this image](/images/download-portal-existing-cluster.png)
18+
Sessions in the Download Portal are valid for 72 hours. After the session expires, your customer must log in again. The Download Portal session length is not configurable.
2319

24-
## Limitations
20+
## Access the Download Portal
2521

26-
* Installation assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
22+
To access the Download Portal for a customer:
2723

28-
* Sessions in the Download Portal are valid for 72 hours. After the session expires, your customer must log in again. The Download Portal session length is not configurable.
24+
1. In the [Vendor Portal](https://vendor.replicated.com), on the **Customers** page, click on the name of the customer.
2925

30-
## Download Assets from the Download Portal
26+
1. On the **Manage customer** tab, under **Install types**, enable the installation types that are supported for the customer. This determines the installation instructions and assets that are available for the customer in the Download Portal. For more information about install types, see [Managing Install Types for a License](/vendor/licenses-install-types).
3127

32-
To log in to the Download Portal and download assets:
28+
<img alt="install types" src="/images/license-install-types.png" width="700px"/>
3329

34-
1. In the [Vendor Portal](https://vendor.replicated.com), on the **Customers** page, click on the name of the customer.
30+
[View a larger version of this image](/images/license-install-types.png)
3531

36-
1. (Optional) On the **Manage customer** tab, enable the **Airgap Download Enabled** option. This makes air gap bundles available in the Download Portal.
32+
1. (Optional) Under **Advanced install options**, enable the air gap installation options that are supported for the customer:
33+
* Enable **Helm CLI Air Gap Instructions (Helm CLI only)** to display Helm air gap installation instructions in the Download Portal for the customer.
34+
* Enable **Air Gap Installation Option (Replicated Installers only)** to allow the customer to install from an air gap bundle using one of the Replicated installers (KOTS, kURL, Embedded Cluster).
3735

38-
![airgap download enabled license option](/images/airgap-download-enabled.png)
36+
<img alt="advanced install options" src="/images/airgap-download-enabled.png" width="500px"/>
3937

4038
[View a larger version of this image](/images/airgap-download-enabled.png)
4139

40+
1. Save your changes.
41+
4242
1. On the **Reporting** tab, in the **Download portal** section, click **Manage customer password**.
4343

44-
![download portal section](/images/download-portal-link.png)
44+
<img alt="download portal section" src="/images/download-portal-link.png" width="450px"/>
4545

4646
[View a larger version of this image](/images/download-portal-link.png)
4747

@@ -55,7 +55,7 @@ To log in to the Download Portal and download assets:
5555

5656
After the password is saved, it cannot be retrieved again. If you lose the password, you can generate a new one.
5757

58-
1. Click **Save** to set the password.
58+
1. Click **Save** to set the password.
5959

6060
1. Click **Visit download portal** to log in to the Download Portal
6161
and preview your customer's experience.
@@ -64,22 +64,12 @@ and preview your customer's experience.
6464
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).
6565
:::
6666

67-
1. In the Download Portal, on the left side of the screen, select one of the following:
68-
* **Bring my own Kubernetes**: View the downloadable assets for existing cluster installations with KOTS.
69-
* **Embedded Kubernetes**: View the downloadable assets for Replicated kURL installations.
70-
71-
:::note
72-
Installation assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
73-
:::
74-
75-
The following is an example of the Download Portal for an air gap customer:
76-
77-
![download portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
67+
1. In the Download Portal, on the left side of the screen, select the installation type. The options displayed vary depending on the **Install types** and **Advanced install options** that you enabled in the customer's license.
7868

79-
[View a larger version of this image](/images/download-portal-existing-cluster.png)
69+
The following is an example of the Download Portal with options for Helm and Embedded Cluster installations:
8070

81-
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.
71+
![download portal showing embedded cluster installation instructions](/images/download-portal-helm-ec.png)
8272

83-
1. Click the download button to download each asset.
73+
[View a larger version of this image](/images/download-portal-helm-ec.png)
8474

85-
1. To share installation files with a customer, send the customer their unique link and password for the Download Portal.
75+
1. To share installation instructions and assets with a customer, send the customer their unique link and password for the Download Portal.

Diff for: sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ const sidebars = {
159159
'vendor/releases-creating-cli',
160160
'vendor/helm-install-release',
161161
'vendor/releases-sharing-license-install-script',
162-
'vendor/releases-share-download-portal',
163162
'reference/linter',
164163
],
165164
},
@@ -171,6 +170,7 @@ const sidebars = {
171170
'vendor/releases-creating-customer',
172171
'vendor/licenses-adding-custom-fields',
173172
'vendor/licenses-install-types',
173+
'vendor/releases-share-download-portal',
174174
'vendor/licenses-about-types',
175175
'vendor/licenses-download',
176176
{

Diff for: static/images/airgap-download-enabled.png

-121 KB
Loading

Diff for: static/images/download-portal-helm-ec.png

211 KB
Loading

Diff for: static/images/download-portal-link.png

-14.7 KB
Loading

0 commit comments

Comments
 (0)