diff --git a/docs/intro-replicated.mdx b/docs/intro-replicated.mdx index b709d1c765..41c955523e 100644 --- a/docs/intro-replicated.mdx +++ b/docs/intro-replicated.mdx @@ -39,12 +39,6 @@ Finally, the diagram shows how [**instance data**](/vendor/instance-insights-eve The following describes the key features of the Replicated Platform. -### Compatibility Matrix - -Replicated Compatibility Matrix can be used to get kubectl access to running clusters within minutes or less. Compatibility Matrix supports various Kubernetes distributions and versions and can be interacted with through the Vendor Portal or the Replicated CLI. - -For more information, see [About Compatibility Matrix](/vendor/testing-about). - ### Embedded Cluster Replicated Embedded Cluster is a Kubernetes installer based on the open source Kubernetes distribution k0s. With Embedded Cluster, users install and manage both the cluster and the application together as a single appliance on a VM or bare metal server. In this way, Kubernetes is _embedded_ with the application. @@ -67,6 +61,12 @@ For more information, see [Introduction to KOTS](intro-kots). For more information, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about). +The following shows an example of the results of preflight checks displayed in the Admin Console during installation: + +![preflight checks in admin console UI](/images/preflight-warning.png) + +[View a larger version of this image](/images/preflight-warning.png) + ### Proxy Registry The Replicated proxy registry grants proxy access to an application's images using the customer's unique license. This means that customers can get access to application images during installation without the vendor needing to provide registry credentials. @@ -89,6 +89,28 @@ The Vendor Portal can also be interacted with programmatically using the followi * **Vendor API v3**: The Vendor API can be used to complete tasks programmatically, including all tasks for packaging and managing applications, and managing artifacts such as teams and license files. For more information, see [Using the Vendor API v3](/reference/vendor-api-using). +### Enterprise Portal (Beta) + +The Enterprise Portal is a customizable, web-based portal where your customers can view application install and update instructions, upload support bundles, view insights about their active and inactive instances, and more. For more information, see [About the Enteprise Portal](/vendor/enterprise-portal-about). + +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) + +### Compatibility Matrix + +Replicated Compatibility Matrix can be used to create VMs or Kubernetes clusters within minutes or less. You can interact with Compatibility Matrix through the Vendor Portal or the Replicated CLI, making it possible to integrate Compatibility Matrix into your existing CI/CD workflows to programmatically create test environments. + +For more information, see [About Compatibility Matrix](/vendor/testing-about). + +The following shows the Compatibility Matrix page for creating a cluster: + +Create a cluster page + +[View a larger version of this image](/images/create-a-cluster.png) + ## Commercial Software Distribution Lifecycle {#csdl} Replicated Platform features are designed to support ISVs in each phase of the Commercial Software Distribution Lifecycle shown below: @@ -105,8 +127,8 @@ The following describes the phases of the software distribution lifecycle: * **[Develop](#develop)**: Application design and architecture decisions align with customer needs, and development teams can quickly iterate on new features. * **[Test](#test)**: Run automated tests in several customer-representative environments as part of continuous integration and continuous delivery (CI/CD) workflows. -* **[Release](#release)**: Use channels to share releases with external and internal users, publish release artifacts securely, and use consistent versioning. * **[License](#license)**: Licenses are customized to each customer and are easy to issue, manage, and update. +* **[Release](#release)**: Use channels to share releases with external and internal users, publish release artifacts securely, and use consistent versioning. * **[Install](#install)**: Provide unique installation options depending on customers' preferences and experience levels. * **[Report](#report)**: Make more informed prioritization decisions by collecting usage and performance metadata for application instances running in customer environments. * **[Support](#support)**: Diagnose and resolve support issues quickly. @@ -121,18 +143,10 @@ For more information about using the Replicated SDK, see [About the Replicated S ### Test -The Replicated Compatibility Matrix rapidly provisions ephemeral Kubernetes clusters, including multi-node and OpenShift clusters. When integrated into existing CI/CD pipelines for an application, the Compatibility Matrix can be used to automatically create a variety of customer-representative environments for testing code changes. +The Compatibility Matrix can be used to quickly provision ephemeral VMs and Kubernetes clusters. When integrated into existing CI/CD workflows, the Compatibility Matrix can be used to automatically create a variety of customer-representative environments for testing code changes. For more information, see [About Compatibility Matrix](/vendor/testing-about). -### Release - -Release channels in the Replicated Vendor Portal allow ISVs to make different application versions available to different customers, without needing to maintain separate code bases. For example, a "Beta" channel can be used to share beta releases of an application with only a certain subset of customers. - -For more information about working with channels, see [About Channels and Releases](/vendor/releases-about). - -Additionally, the Replicated proxy registry grants proxy access to private application images using the customers' license. This ensures that customers have the right access to images based on the channel they are assigned. For more information about using the proxy registry, see [About the Replicated Proxy Registry](/vendor/private-images-about). - ### License Create customers in the Replicated Vendor Portal to handle licensing for your application in both online and air gap environments. For example: @@ -143,13 +157,23 @@ Create customers in the Replicated Vendor Portal to handle licensing for your ap For more information about working with customers and custom license fields, see [About Customers](/vendor/licenses-about). +### Release + +Release channels in the Replicated Vendor Portal allow ISVs to make different application versions available to different customers, without needing to maintain separate code bases. For example, a "Beta" channel can be used to share beta releases of an application with only a certain subset of customers. + +For more information about working with channels, see [About Channels and Releases](/vendor/releases-about). + +Additionally, the Replicated proxy registry grants proxy access to private application images using the customers' license. This ensures that customers have the right access to images based on the channel they are assigned. For more information about using the proxy registry, see [About the Replicated Proxy Registry](/vendor/private-images-about). + ### Install Applications distributed with the Replicated Platform can support multiple different installation methods from the same application release, helping you to meet your customers where they are. For example: * Customers who are not experienced with Kubernetes or who prefer to deploy to a dedicated cluster in their environment can install on a VM or bare metal server with the Replicated Embedded Cluster installer. For more information, see [Embedded Cluster Overview](/vendor/embedded-overview). -* Customers familiar with Kubernetes and Helm can install in their own existing cluster using Helm. For more information, see [Installing with Helm](/vendor/install-with-helm). -* Customers installing into environments with limited or no outbound internet access (often referred to as air-gapped environments) can securely access and push images to their own internal registry, then install using Helm or a Replicated installer. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) and [Installing and Updating with Helm in Air Gap Environments (Alpha)](/vendor/helm-install-airgap). +* Customers familiar with Kubernetes and Helm can install in their own existing cluster using the Helm CLI. For more information, see [Installing with Helm](/vendor/install-with-helm). +* Customers installing into environments with limited or no outbound internet access (often referred to as air-gapped environments) can securely access and push images to their own internal registry, then install using Helm or a Replicated installer. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap) and [Installing and Updating with Helm in Air Gap Environments](/vendor/helm-install-airgap). + +Additionally, to enhance the installation experience, the Enterprise Portal provides a customizable, web-based portal where your customers can view application install and update instructions, upload support bundles, view insights about their active and inactive instances, and more. For more information, see [About the Enteprise Portal](/vendor/enterprise-portal-about). ### Report @@ -161,6 +185,6 @@ ISVs can also set up email and Slack notifications to get alerted of important i Support teams can use Replicated features to more quickly diagnose and resolve application issues. For example: -- Customize and generate support bundles, which collect and analyze redacted information from the customer's cluster, environment, and application instance. See [About Preflights Checks and Support Bundles](/vendor/preflight-support-bundle-about). +- Customize and generate support bundles, which collect and analyze redacted information from the customer's cluster, environment, and application instance. See [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about). - Provision customer-representative environments with Compatibility Matrix to recreate and diagnose issues. See [About Compatibility Matrix](/vendor/testing-about). - Get insights into an instance's status by accessing telemetry data, which covers the health of the application, the current application version, and details about the infrastructure and cluster where the application is running. For more information, see [Customer Reporting](/vendor/customer-reporting). For more information, see [Customer Reporting](/vendor/customer-reporting). diff --git a/docs/vendor/replicated-onboarding.mdx b/docs/vendor/replicated-onboarding.mdx index 2d12edf2cd..1dfba494e9 100644 --- a/docs/vendor/replicated-onboarding.mdx +++ b/docs/vendor/replicated-onboarding.mdx @@ -208,7 +208,7 @@ After successfully installing the initial release on a VM with Embedded Cluster ### Task 5: Customize the KOTS Admin Console {#admin-console} -Configure the KOTS Application custom resource to add an application name, icon, and status informers. The name and icon will be displayed in the Admin Console and the Replicated Download Portal. The status informers will be used to display the application status on the Admin Console dashboard. +Configure the KOTS Application custom resource to add an application name, icon, and status informers. The name and icon will be displayed in the Admin Console. The status informers will be used to display the application status on the Admin Console dashboard. To configure the KOTS Application custom resource: @@ -437,6 +437,14 @@ For more information, see [Use Custom Domains](/vendor/custom-domains-using). After completing the main onboarding tasks, Replicated recommends that you also complete the following additional tasks to integrate other Replicated features with your application. You can complete these next recommended tasks in any order and at your own pace. +### Enable and Customize the Enterprise Portal (Beta) + +The Enterprise Portal is a customizable, web-based portal where your customers can view application install and update instructions, upload support bundles, view insights about their active and inactive instances, and more. The Enterprise Portal is the next generation of the Download Portal. For more information, see [About the Enteprise Portal](/vendor/enterprise-portal-about). + +The Enterprise Portal is Beta. You can enable access to the Enterprise Portal for all customers or on a per-customer basis. For more information, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite). + +You can also customize the Enterprise Portal so that your customers have a consistent branding experience. For example, you can use a custom domain, add links and contact information, customize the look and feel of the UI, edit the content of invitation and notification emails, and more. For more information about customizing the Enterprise Portal, see [Customize the Enterprise Portal](/vendor/enterprise-portal-configure). + ### Add Support for Helm Installations Existing releases that include one or more Helm charts can be installed with the Helm CLI; it is not necessary to create and manage separate releases or channels for each installation method. @@ -461,7 +469,7 @@ To support and test Helm installations: ### Add Support for Air Gap Installations -Replicated supports installations in _air gap_ environments with little or no outbound internet access. For Embedded Cluster and KOTS, users install by providing an air gap bundle which contains the required images for the Replicated installer and your application. For Helm installations, users install by following automatically-generated instructions provided in the Replicated Enterprise Portal to pull all images and push them to their local image registry. +Replicated supports installations in _air gap_ environments with little or no outbound internet access. For Embedded Cluster and KOTS, users install by providing an air gap bundle that contains the required images for the Replicated installer and your application. For Helm installations, users install by following automatically-generated instructions provided in the Enterprise Portal to pull all images and push them to their local image registry. To add support for air gap installations: @@ -530,11 +538,11 @@ To add support for air gap installations: 1. Create or edit a customer with the **Airgap Download Enabled** entitlement enabled so that you can test air gap installations. See [Create and Manage Customers](/vendor/releases-creating-customer). -1. Download the Embedded Cluster air gap installation assets, then install with Embedded Cluster on an air gap VM to test. See [Install in Air Gap Environments with Embedded Cluster](/enterprise/installing-embedded-air-gap). +1. Download the Embedded Cluster air gap installation assets, then install with Embedded Cluster on an air-gapped VM to test. See [Install in Air Gap Environments with Embedded Cluster](/enterprise/installing-embedded-air-gap). 1. Follow the steps in [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap) to access the Enterprise Portal for the customer and test air gap installation in a cluster with Helm. -1. (Optional) Download the `.airgap` bundle for the release and the air gap bundle for the KOTS Admin Console. You can also download both bundles from the Download Portal for the target customer. Then, install with KOTS in an air gap existing cluster to test. See [Air Gap Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster-airgapped). +1. (Optional) Download the `.airgap` bundle for the release and the air gap bundle for the KOTS Admin Console. Then, install with KOTS in an air gap existing cluster to test. See [Air Gap Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster-airgapped). ### Add Roles for Multi-Node Clusters in Embedded Cluster Installations