diff --git a/docs/vendor/custom-domains-using.md b/docs/vendor/custom-domains-using.md index 12d3b58a34..b7112082af 100644 --- a/docs/vendor/custom-domains-using.md +++ b/docs/vendor/custom-domains-using.md @@ -1,6 +1,6 @@ # Use Custom Domains -This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, and the Download Portal. +This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, the Replicated Enterprise Portal and the Replicated Download Portal. For information about adding and managing custom domains with the Vendor API v3, see the [customHostnames](https://replicated-vendor-api.readme.io/reference/createcustomhostname) section in the Vendor API v3 documentation. diff --git a/docs/vendor/custom-domains.md b/docs/vendor/custom-domains.md index 6f5e3f8719..ffc22a88e2 100644 --- a/docs/vendor/custom-domains.md +++ b/docs/vendor/custom-domains.md @@ -16,6 +16,8 @@ You can configure custom domains for the following services: - **Replicated app service:** Upstream application YAML and metadata, including a license ID, are pulled from the app service. By default, this service uses the domain `replicated.app`. Replicated recommends using a CNAME such as `updates.{your app name}.com`. +- **Enterprise Portal:** The Enterprise Portal is a web-based portal that provides end customers with a centralized location for managing their installation. By default, the Enterprise Portal uses the domain **`[DOMAIN].replicated.com`**. Replicated recommending using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`. + - **Download Portal:** The Download Portal can be used to share customer license files, air gap bundles, and so on. By default, the Download Portal uses the domain `get.replicated.com`. Replicated recommends using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`. - **Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. By default, this registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`. diff --git a/docs/vendor/customer-reporting.md b/docs/vendor/customer-reporting.md index 9ce0f8ecb7..b58d32cf61 100644 --- a/docs/vendor/customer-reporting.md +++ b/docs/vendor/customer-reporting.md @@ -14,7 +14,9 @@ As shown in the image above, the **Reporting** page has the following main secti * [Manage Customer](#manage-customer) * [Time to Install](#time-to-install) * [Download Portal](#download-portal) +* [Enterprise Portal](#enterprise-portal) * [Instances](#instances) +* [Install Attempts](#install-attempts) ### Manage Customer @@ -53,12 +55,40 @@ For more information about how to interpret the time to install metrics, see [Ti ### Download Portal +:::note +If the Replicated Enterprise Portal is enabled for the customer, then an **Enterprise Portal** section is displayed instead of the **Download Portal** section. For more information, see [Enterprise Portal](#enterprise-portal) below. +::: + 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 [Access a Customer's Download Portal](releases-share-download-portal). +### Enterprise Portal (Alpha) + +:::note +The **Enterprise Portal** section is available only for customers with the Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite). +::: + +The following shows an example of the **Enterprise Portal** section: + +![Enterprise Portal section of customer reporting page](/images/customer-reporting-enterprise-portal.png) + +[View a larger version of this image](/images/customer-reporting-enterprise-portal.png) + +From the **Enterprise Portal** section, you can: +* Click **View** to access the unique Enterprise Portal for the customer +* View the status of the customer's access to the Enterprise Portal +* View the timestamp when the Enterprise Portal was most recently accessed by the customer +* View the number of users with Enterprise Portal accounts +* Click **Invite user** to invite a new user to the Enterprise Portal +* View the number of install attempts made by the customer. The **Customer Reporting > Install Attempts** section includes additional details about install attempts. For more information, see [Install Attempts](#install-attempts) below. +* View the number of service accounts created in the Enterprise Portal +* View the number of support bundles uploaded to the Enterprise Portal + +For more information about the Enterprise Portal, see [About the Enterprise Portal](/vendor/enterprise-portal-about). + ### Instances The **Instances** section displays details about the active application instances associated with the customer. @@ -85,4 +115,36 @@ The **Instances** section displays the following details about each active insta * Instance uptime data, including: * The timestamp of the last recorded check-in for the instance. For more information about what triggers an instance check-in, see [How the Vendor Portal Collects Instance Data](instance-insights-event-data#about-reporting) in _About Instance and Event Data_. * An uptime graph of the previous two weeks. For more information about how the Vendor Portal determines uptime, see [Instance Uptime](instance-insights-details#instance-uptime) in _Instance Details_. - * The uptime ratio in the previous two weeks. \ No newline at end of file + * The uptime ratio in the previous two weeks. + +### Install Attempts (Alpha) + +:::note +The **Install Attempts** section is available only for customers with the Replicated Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite). +::: + +The **Install Attempts** section includes details about the installation attempts made by users. These insights are based on the customer's activity in the Enterprise Portal. + +To track install attempts, the Enterprise Portal creates a unique, _just-in-time_ service account that sends data back to the Vendor Portal when the user starts and completes the installation or takes other actions that are specific to the installation type. These service accounts also provide realtime feedback to the user on their installation progress using checkboxes and status indicators, and allow users to pause and return to an installation attempt. + +The following shows an example of the **Install Attempts** section: + +Install attempts section of customer reporting page + +[View a larger version of this image](/images/customer-reporting-install-attempts-expanded.png) + +The **Install Attempts** section includes the following details about each installation attempt: +* The installation status (succeeded, stalled, or failed) +* The date and time when the installation attempt was started +* The email address of the user that initiated the installation attempt +* Installation environment details: + * **OS** or **K8s**: The operating system of the VM or bare metal server. Or, the distribution of Kubernetes running in the installation environment. + * **Mode**: If the installation is online (internet-connected) or air gap (offline). + * **Registry**: If the image registry used is online (accessed over the internet) or offline (a local registry is used). For air gap installations, the registry is always offline. Users can also optionally use a local image registry in online installations. +* Installation progress details, including when the installation was started and completed as well as other progress indicators that are specific to the installation type. For example: + * For installations with Helm, the Enterprise Portal reports when your image registry was accessed and when application images were pulled, as shown below: + ![Helm install attempt progress details](/images/customer-reporting-install-attempts-helm.png) + [View a larger version of this image](/images/customer-reporting-install-attempts-helm.png) + * For installations with Replicated Embedded Cluster on VMs or bare metal servers, the Enterprise Portal reports when the installation assets were downloaded, as shown below: + ![VM-based install attempt progress details](/images/customer-reporting-install-attempts-vm.png) + [View a larger version of this image](/images/customer-reporting-install-attempts-vm.png) \ No newline at end of file diff --git a/docs/vendor/enterprise-portal-about.mdx b/docs/vendor/enterprise-portal-about.mdx new file mode 100644 index 0000000000..a100aff7b0 --- /dev/null +++ b/docs/vendor/enterprise-portal-about.mdx @@ -0,0 +1,67 @@ +# About the Enterprise Portal (Alpha) + +This topic provides an overview of the Replicated Enterprise Portal. + +## Overview + +The Enterprise Portal is a customizable, web-based portal that provides a centralized location where your customers can: +* View application install and update instructions +* Manage their team members and service accounts +* Upload support bundles +* View insights about their active and inactive instances +* And more + +Your customers can access the Enterprise Portal outside their application installation environment at a custom domain that you specify, making it easier for teams to manage instances and get support. + +For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use). + +The following shows an example of the Enterprise Portal dashboard: + +![Enterprise Portal dashboard](/images/enterprise-portal-dashboard.png) + +[View a larger version of this image](/images/enterprise-portal-dashboard.png) + +## Limitations + +* The Enterprise Portal is Alpha. The features and functionality of the Enterprise Portal are subject to change. + +* Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance. For more information, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_. + +## Comparison to the Download Portal + +The Enterprise Portal is the next generation version of the Replicated Download Portal. Compared to the Download Portal, the Enterprise Portal not only provides access to installation assets and instructions, but also allows users to track available updates, manage their team and service accounts, view the status of their instances, view license details, and more. These features are designed to make it easier for your customers to manage their instances of your application from a centralized location outside of the installation environment. + +You can migrate existing customers from the Download Portal to the Enterprise Portal by enabling the Enterprise Portal for their license. For more information, see [Manage Enterprise Portal Access](enterprise-portal-invite). + +For more information about the Download Portal, see [Access a Customer's Download Portal](/vendor/releases-share-download-portal). + +## About Customizing the Enterprise Portal + +You can configure the Enterprise Portal to use a custom domain, add links and contact information, customize the look and feel of the Enterprise Portal, edit the content of invitation and notification emails, and more. Customizing the Enterprise Portal helps ensure that your customers have a consistent branding experience and can access application- and vendor-specific information. + +For more information about customizing the Enterprise Portal, see [Customize the Enterprise Portal](enterprise-portal-configure). + +For information about how to set a custom domain for the Enterprise Portal, see [Use Custom Domains](/vendor/custom-domains-using). + +## About Instance Reporting with the Enterprise Portal + +This section describes the instance reporting functionality of the Enterprise Portal. + +### Active and Inactive Instances + +The Enterprise Portal provides insights to end users about their active and inactive instances, including the application version installed, the instance status, computed metrics like the first and most recent times the instance sent data to the Vendor Portal, and more. For more information about the instance insights available in the Enterprise Portal, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_. + +![active and inactive instances](/images/enterprise-portal-instance-status-details.png) +[View a larger version of this image](/images/enterprise-portal-instance-status-details.png) + +### Customer Reporting + +The Enterprise Portal sends insights back to the Vendor Portal, which are surfaced on the **Customer Reporting** page. For more information, see [Enterprise Portal](/vendor/customer-reporting#enterprise-portal) in _Customer Reporting_. + +These insights include details about the customer's install attempts. The Enterprise Portal tracks and reports on install attempts by creating unique, _just-in-time_ service accounts. These service accounts allow the Enterprise Portal to send data back to the Vendor Portal when the user starts and completes the installation or takes other actions that are specific to the installation type. The service accounts also provide realtime feedback to the user on their installation progress using checkboxes and status indicators, and allow users to pause and return to an installation attempt. For more information, see [Install Attempts](/vendor/customer-reporting#install-attempts) in _Customer Reporting_. + +The following shows an example of the **Install Attempts** section: + +Install attempts section of customer reporting page + +[View a larger version of this image](/images/customer-reporting-install-attempts-expanded.png) \ No newline at end of file diff --git a/docs/vendor/enterprise-portal-configure.mdx b/docs/vendor/enterprise-portal-configure.mdx new file mode 100644 index 0000000000..c1eb16adb9 --- /dev/null +++ b/docs/vendor/enterprise-portal-configure.mdx @@ -0,0 +1,104 @@ +# Customize the Enterprise Portal (Alpha) + +This topic describes how to customize the Enterprise Portal, including using a custom domain, changing the branding, editing the content of invitation and notification emails, and adding custom documentation. + +## Manage Enterprise Portal Settings + +You can edit the settings for the Enterprise Portal to use a custom domain, provide custom links and contact information, customize the look and feel of the Enterprise Portal, and more. + +To manage Enterprise Portal settings: + +1. In the Vendor Portal, go to **Enterprise Portal > Settings**. + + ![Enterprise Portal settings page](/images/enterprise-portal-settings.png) + + [View a larger version of this image](/images/enterprise-portal-settings.png) + +1. Edit the settings as desired: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
URLThe URL where customers can access the Enterprise Portal. You can change the URL to use a custom domain. For information, see [Use Custom Domains](custom-domains-using).
TitleThe title of the Enterprise Portal. The title is displayed at the top of each page in the Enterprise Portal and is also used in email notifications.
Page overviewAn overview of the Enterprise Portal.
Support portal linkThe URL for the portal that your customers can use to get support. This link is provided on the Enterprise Portal **Support** page.
Contact emailThe email address that customers can use to contact you. This email address is provided on the Enterprise Portal **Support** page.
LogoUpload a custom PNG logo for the Enterprise Portal. The minimum size for the logo is 160px by 160px.
FaviconUpload a custom favicon for the Enterprise Portal. The favicon is displayed in the browser tab.
BackgroundSelect or customize the background for the Enterprise Portal.
ColorsSet the primary and secondary colors for the Enterprise Portal.
+ +1. Click **Save**. + +## Configure Invitation and Notification Emails {#configure-customer-emails} + +You can customize the invitation and notification emails that are sent to your customers. + +To configure customer emails: + +1. In the Vendor Portal, go to **Enterprise Portal > Customer emails**. + + ![Enterprise Portal customer emails page](/images/enterprise-portal-customer-emails.png) + + [View a larger version of this image](/images/enterprise-portal-customer-emails.png) + +1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam. + + After the domain is verified automatically, the email address is displayed under **Verified Sender Address**. +1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. + + ![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png) + + [View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png) + +## Customize Documentation + +The install and update instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see [Manage Install Types for a License](/vendor/licenses-install-types). + +You can also customize the documentation that is displayed in the Enterprise Portal by including a link to your installation instructions or by adding your own pre- and post-installation instructions. + +To customize documentation: + +1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**. + + ![Enterprise Portal knowledge base page](/images/enterprise-portal-knowledge-base.png) + + [View a larger version of this image](/images/enterprise-portal-knowledge-base.png) + +1. In the panel on the left, select the installation type. + +1. Customize the documentation for the selected installation type as desired: + 1. In the documentation links section, add a link to your installation documentation. The link is displayed on the Enterprise Portal **Install** page. + 1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes. +1. Click **Save changes**. \ No newline at end of file diff --git a/docs/vendor/enterprise-portal-invite.mdx b/docs/vendor/enterprise-portal-invite.mdx new file mode 100644 index 0000000000..78ff78a818 --- /dev/null +++ b/docs/vendor/enterprise-portal-invite.mdx @@ -0,0 +1,47 @@ +# Manage Enterprise Portal Access (Alpha) + +This topic describes how to enable or disable customer access to the Enterprise Portal. It also describes how to invite users to the Enterprise Portal from the Replicated Vendor Portal. + +For information about customizing the invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure). + +## Manage Customer Access to the Enterprise Portal {#manage-ep-access} + +You can enable and disable access to the Enterprise Portal for all customers, or on a per-customer basis. When access to the Enterprise Portal is disabled, the customer has access to the Replicated Download Portal instead. + +To control customer access to the Enterprise Portal: + +* In the Vendor Portal, do one of the following to enable or disable Enterprise Portal access for your customers: + + * Go to **Enterprise Portal > Access**. For **Portal access**, enable or disable the toggle to control if all customers have access to the Enterprise Portal or the Download Portal. + + ![enterprise portal access toggle](/images/enterprise-portal-access-toggle.png) + [View a larger version of this image](/images/enterprise-portal-access-toggle.png) + + * Go to **Customers** and select the target customer. On the customer's page, go to **Manage Enterprise Portal Access** and enable or disable the **Enterprise Portal access** toggle to control if the customer has access to the Enterprise Portal or the Download Portal. + + ![customer-specific enterprise portal access toggle](/images/customer-enterprise-portal-access-toggle.png) + [View a larger version of this image](/images/customer-enterprise-portal-access-toggle.png) + +## Invite Users + +This section describes how to invite users to the Enterprise Portal using the Vendor Portal. Your customers can also invite users to the Enterprise Portal from the Enterprise Portal **Team settings** page. For more information, see [Manage Users](enterprise-portal-use#manage-users) in _Access and Use the Enterprise Portal_. + +To invite users to the Enterprise Portal: + +1. Enable access to the Enterprise Portal for the customer. See [Manage Customer Access to the Enterprise Portal](#manage-ep-access) above. + +1. (Optional) Customize the Enterprise Portal invitation email. For more information, see [Configure Invitation and Notification Emails](enterprise-portal-configure#configure-customer-emails) in _Customize the Enterprise Portal_. + +1. In the Vendor Portal, go to either **Enterprise Portal > Access** or to **Customers > [Customer Name] > Manage Enterprise Portal Access**. Then, click **Invite user**. + + ![invite user button](/images/vendor-portal-enterprise-portal-invite-user.png) + [View a larger version of this image](/images/vendor-portal-enterprise-portal-invite-user.png) + +1. In the **Invite user** dialog, for **Customer**, select the customer from the dropdown where the user is associated. + + ![invite user dialog](/images/enterprise-portal-invite-user-dialog.png) + [View a larger version of this image](/images/enterprise-portal-invite-user-dialog.png) + +1. For **Email**, enter the user's email address. + +1. Click **Send invite**. \ No newline at end of file diff --git a/docs/vendor/enterprise-portal-use.mdx b/docs/vendor/enterprise-portal-use.mdx new file mode 100644 index 0000000000..ae2088748b --- /dev/null +++ b/docs/vendor/enterprise-portal-use.mdx @@ -0,0 +1,209 @@ +# Access and Use the Enterprise Portal (Alpha) + +This topic describes how to access and use the Replicated Enterprise Portal. + +## Access the Enterprise Portal + +To access the Enterprise Portal for a customer: + +1. If your email address is not yet added to the customer's Enterprise Portal team, send an invitation. See [Invite Users](enterprise-portal-invite#invite-users). You can follow the link in the invitation email to access the Enterprise Portal. + +1. In the Vendor Portal, do one of the following to get the unique Enterprise Portal link for the customer: + * Go to **Customers > [Customer Name] > Enterprise Portal Access**. Click **View customer's portal link**. + + ![customer-specific enterprise portal access toggle](/images/customer-enterprise-portal-access-toggle.png) + + [View a larger version of this image](/images/customer-enterprise-portal-access-toggle.png) + + * Go to **Customers > [Customer Name] > Reporting** and click **View** in the **Enterprise Portal** section. + + ![Enterprise Portal section of customer reporting page](/images/customer-reporting-enterprise-portal.png) + + [View a larger version of this image](/images/customer-reporting-enterprise-portal.png) + + +1. In the dialog, enter the email address for the existing Enterprise Portal user and click **Continue with email**. The Vendor Portal generates a verification code and sends it to the email address. + +## View Install and Update Instructions + +This section describes how to view install and update instructions in the Enterprise Portal. + +The install and update instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see [Manage Install Types for a License](/vendor/licenses-install-types). + +### View Install Instructions + +To view install instructions in the Enterprise Portal: + +1. Log in to the Enterprise Portal and go to **Install**. + +1. On the panel on the left, if there are multiple installation types available for the customer's license, select the installation type to use (Helm or Embedded Cluster). + + The installation options displayed in the Enterprise Portal are based on the customer's license. For more information, see [Manage Install Types for a License](/vendor/licenses-install-types). + +1. Follow the instructions provided to install. Status indicators track your progress throughout the installation. + + If you exit the Enterprise Portal before completing the installation, you can resume the installation process by clicking **Continue installation** on the **Install** page, as shown below: + + ![Enterprise Portal continue installation button](/images/enterprise-portal-continue-install.png) + + [View a larger version of this image](/images/enterprise-portal-continue-install.png) + +### View Update Instructions + +To view update instructions in the Enterprise Portal: + +1. Log in to the Enterprise Portal and go to **Update**. + + For any online instances, the Enterprise Portal displays an **Update available** button when a new version is available. + +1. If an **Update available** button is displayed, click it to view and follow the update instructions for the given instance. + +## View Active and Inactive Instances + +Users can view their active and inactive instances in the Enterprise Portal, including the instance status and other details. + +:::note +Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance. +::: + +To view instances in the Enterprise Portal: + +1. In the Enterprise Portal, go to **Updates**. + +1. Under **Active Instances**, view details about the active instances. Select **View inactive instances** to view details about inactive instances. + + ![enterprise portal instance details](/images/enterprise-portal-instance-details.png) + [View a larger version of this image](/images/enterprise-portal-instance-details.png) + + The following table describes the instance details available on the **Updates** page: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
Instance IDThe unique identifier for the instance.
VersionThe application version installed.
Instance statusThe status of the instance, based on the status informers configured for the application. For more information, see [Enable and Understand Application Status](/vendor/insights-app-status).
First check-inThe timestamp when the instance first sent data to the Vendor Portal.
Last check-inThe timestamp when the instance most recently sent data to the Vendor Portal.
First readyThe timestamp when the instance first reached a ready state. For more information about the ready state, see [About Resource Statuses](/vendor/insights-app-status#resource-statuses) in _Enable and Understand Application Status_.
Instance labelsAny labels applied to the instance.
+ +## View Release History + +To view the release history in the Enterprise Portal: + +1. In the Enterprise Portal, go to **Release History**. + +1. In the **Version History** panel on the left, select a version to view details about the given release. + +## View License Details + +Customers can view license information, including expiration dates and available features. + +To manage licenses in the Enterprise Portal: + +1. In the Enterprise Portal, go to **License**. + +1. Under **License Details**, view license information including the expiration date, status, associated release channels, custom license fields, and more. + + ![enterprise portal license details](/images/enterprise-portal-license-details.png) + [View a larger version of this image](/images/enterprise-portal-license-details.png) + +## Manage Team Settings + +This section includes information about how to manage users and service accounts in the Enterprise Portal. + +### Manage Users + +Customers can invite additional users to the portal and manage their access. + +To manage invite and manage users in the Enterprise Portal: + +1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select **Team settings**. + + ![enterprise portal team settings](/images/enterprise-portal-user-account.png) + + [View a larger version of this image](/images/enterprise-portal-user-account.png) + +1. Click **Users**. + +1. Manage users as desired: + * To invite a new user, click **Invite user**. + * To delete a user, find the target user in the table and open the menu. Select **Delete user**. + +### Manage Service Accounts + +To manage service accounts in the Enterprise Portal: + +1. In the Enterprise Portal, openthe user account dropdown in the top right of the page and select **Team settings**. + + ![enterprise portal team settings](/images/enterprise-portal-user-account.png) + + [View a larger version of this image](/images/enterprise-portal-user-account.png) + +1. Click **Service accounts**. + +1. Manage service accounts as desired: + * To create a new service account, click **Create Service Account**. + * To view a service account token, find the target service account in the table and click **View** under **Token**. + * The revoke a service account's token, find the target service account in the table and open the menu under **Actions**. Select **Revoke**. + +## Manage User Settings + +Each user can manage their settings in the Enterprise Portal, including enabling and disabling email notifications for various system events. + +To manage user settings in the Enterprise Portal: + +1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select **User settings**. + + ![enterprise portal team settings](/images/enterprise-portal-user-account.png) + + [View a larger version of this image](/images/enterprise-portal-user-account.png) + +1. Edit the user settings as desired: + * Edit profile information + * Manage email notification preferences + +## Collect, Upload, and Manage Support Bundles + +End customers can use the portal to collect, upload, and manage support bundles. + +To manage support bundles in the Enterprise Portal: + +1. In the Enterprise Portal, go to **Support**. + + ![enterprise portal support](/images/enterprise-portal-support.png) + + [View a larger version of this image](/images/enterprise-portal-support.png) + +1. Manage support bundles as desired: + + * For **Support Bundle Collection**, follow the instructions provided to collect a support bundle based on the environment. + + * To upload a support bundle, click **Upload support bundle**. + + * To view, download, or delete previous support bundles, select **Download** or **Delete** in the **Support Bundles** table. \ No newline at end of file diff --git a/docs/vendor/licenses-install-types.mdx b/docs/vendor/licenses-install-types.mdx index 26ed2e6a3c..c96f999dbf 100644 --- a/docs/vendor/licenses-install-types.mdx +++ b/docs/vendor/licenses-install-types.mdx @@ -16,10 +16,10 @@ The following shows an example of the **Install types** field in a license: The installation types that are enabled or disabled for a license determine the following: * The Replicated installers ([Replicated KOTS](../intro-kots), [Replicated Embedded Cluster](/vendor/embedded-overview), [Replicated kURL](/vendor/kurl-about)) that the customer's license entitles them to use -* The installation assets and/or instructions provided in the Replicated Download Portal for the customer +* The installation assets and/or instructions provided in the Replicated Enterprise Portal for the customer * The customer's KOTS Admin Console experience -Setting the supported installation types on a per-customer basis gives you greater control over the installation method used by each customer. It also allows you to provide a more curated Download Portal experience, in that customers will only see the installation assets and instructions that are relevant to them. +Setting the supported installation types on a per-customer basis gives you greater control over the installation method used by each customer. It also allows you to provide a more curated Enterprise Portal experience, in that customers will only see the installation assets and instructions that are relevant to them. ## Understanding Install Types {#install-types} @@ -37,7 +37,7 @@ The following describes each installation type available, as well as the require Existing Cluster (Helm CLI) -

Allows the customer to install with Helm in an existing cluster. The customer does not have access to the Replicated installers (Embedded Cluster, KOTS, and kURL).

When the Helm CLI Air Gap Instructions (Helm CLI only) install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See Understanding Additional Install Options below.

+

Allows the customer to install with Helm in an existing cluster. The customer does not have access to the Replicated installers (Embedded Cluster, KOTS, and kURL).

When the Helm CLI Air Gap Instructions (Helm CLI only) install option is also enabled, the Enterprise Portal displays instructions on how to pull Helm installable images into a local repository. See Understanding Additional Install Options below.

The latest release promoted to the channel where the customer is assigned must contain one or more Helm charts. It can also include Replicated custom resources, such as the Embedded Cluster Config custom resource, the KOTS HelmChart, Config, and Application custom resources, or the Troubleshoot Preflight and SupportBundle custom resources.

@@ -90,12 +90,12 @@ After enabling installation types in the **Available install types** field, you Helm CLI Air Gap Instructions (Helm CLI only) -

When enabled, a customer will see instructions on the Download Portal on how to pull Helm installable images into their local repository.

Helm CLI Air Gap Instructions is enabled by default when you select the Existing Cluster (Helm CLI) install type. For more information see [Installing with Helm in Air Gap Environments](/vendor/helm-install-airgap)

+

When enabled, a customer will see instructions on the Enterprise Portal on how to pull Helm installable images into their local repository.

Helm CLI Air Gap Instructions is enabled by default when you select the Existing Cluster (Helm CLI) install type. For more information see [Installing with Helm in Air Gap Environments](/vendor/helm-install-airgap)

The Existing Cluster (Helm CLI) install type must be enabled Air Gap Installation Option (Replicated Installers only) -

When enabled, new installations with this license have an option in their Download Portal to install from an air gap package or do a traditional online installation.

+

When enabled, new installations with this license have an option in their Enterprise Portal to install from an air gap package or do a traditional online installation.

At least one of the following Replicated install types must be enabled: