Skip to content

Edit download portal docs to reflect Install types #3119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2025
Merged

Edit download portal docs to reflect Install types #3119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/partials/kots/_download-portal-about.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/vendor/customer-reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ From the **Download portal** section, you can:
* Manage the password for the Download Portal
* Access the unique Download Portal URL for the customer

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).
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).

### Instances

Expand Down
2 changes: 0 additions & 2 deletions docs/vendor/embedded-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,6 @@ Embedded Cluster has the following limitations:

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

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

* **`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.

* **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).
Expand Down
60 changes: 25 additions & 35 deletions docs/vendor/releases-share-download-portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import DownloadPortal from "../partials/kots/_download-portal-about.mdx"
# Accessing a Customer's Download Portal
Copy link
Contributor Author

@paigecalvert paigecalvert Mar 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ reframed this topic around accessing the download portal for a customer instead of "downloading assets" since now you can also just access install instructions and not download anything


# Downloading Assets from the Download Portal

This topic describes how to download customer license files, air gap bundles, and other assets from the Replicated Download Portal.
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.

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

## Overview

<DownloadPortal/>

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

The following is an example of the Download Portal for an air gap customer installing in their own existing cluster:
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.

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

[View a larger version of this image](/images/download-portal-existing-cluster.png)
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.

## Limitations
## Access the Download Portal

* Installation assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
Copy link
Contributor Author

@paigecalvert paigecalvert Mar 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ removed this now that you can view EC install instructions depending on the customer's install types enabled

To access the Download Portal for a customer:

* 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.
1. In the [Vendor Portal](https://vendor.replicated.com), on the **Customers** page, click on the name of the customer.

## Download Assets from the Download Portal
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).

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

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

1. (Optional) On the **Manage customer** tab, enable the **Airgap Download Enabled** option. This makes air gap bundles available in the Download Portal.
1. (Optional) Under **Advanced install options**, enable the air gap installation options that are supported for the customer:
* Enable **Helm CLI Air Gap Instructions (Helm CLI only)** to display Helm air gap installation instructions in the Download Portal for the customer.
* 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).

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

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

1. Save your changes.

1. On the **Reporting** tab, in the **Download portal** section, click **Manage customer password**.

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

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

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

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

1. Click **Save** to set the password.
1. Click **Save** to set the password.

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

1. In the Download Portal, on the left side of the screen, select one of the following:
* **Bring my own Kubernetes**: View the downloadable assets for existing cluster installations with KOTS.
* **Embedded Kubernetes**: View the downloadable assets for Replicated kURL installations.

:::note
Installation assets for [Replicated Embedded Cluster](/vendor/embedded-overview) are not available for download in the Download Portal.
:::

The following is an example of the Download Portal for an air gap customer:

![download portal for existing cluster air gap installs](/images/download-portal-existing-cluster.png)
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.
Copy link
Contributor Author

@paigecalvert paigecalvert Mar 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The options displayed vary depending on the Install types and Advanced install options that you enabled in the customer's license.

avoided being specific so this doesn't get out of date so easily. the ui should also be self-explanatory


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

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

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

1. To share installation files with a customer, send the customer their unique link and password for the Download Portal.
1. To share installation instructions and assets with a customer, send the customer their unique link and password for the Download Portal.
2 changes: 1 addition & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@ const sidebars = {
'vendor/releases-creating-cli',
'vendor/helm-install-release',
'vendor/releases-sharing-license-install-script',
'vendor/releases-share-download-portal',
'reference/linter',
],
},
Expand All @@ -171,6 +170,7 @@ const sidebars = {
'vendor/releases-creating-customer',
'vendor/licenses-adding-custom-fields',
'vendor/licenses-install-types',
'vendor/releases-share-download-portal',
Copy link
Contributor Author

@paigecalvert paigecalvert Mar 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ moved from Channels and Release to Customers (feels more specific to customers now)

'vendor/licenses-about-types',
'vendor/licenses-download',
{
Expand Down
Binary file modified static/images/airgap-download-enabled.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/download-portal-helm-ec.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/download-portal-link.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading