About the Enterprise Portal

Beta Feature

The Enterprise Portal is Beta and is available to all vendors. Some capabilities might require additional access.

The Enterprise Portal is where your customers install, update, secure, and get support for your application. Each customer signs in to a portal with your branding and sees only what applies to their license and channel. That includes install instructions generated for their environment, their running instances and available updates, security reports, release history, and support bundle uploads.

The portal works out of the box from Replicated's content template, with no content to write. You keep the template in a GitHub repository you control, so your documentation, navigation, and branding are versioned alongside your releases. Customize it only when you want the portal to look and read more like your own product.

If you already run your own customer portal, you can use the Enterprise Portal headless instead. The Vendor API and the customer service account API provide installation instructions, update instructions, and artifact downloads without sending customers to the portal UI, and they don't require a GitHub repository.

What your customers can do

• Install and upgrade: Step-by-step installation instructions for each install method the customer's license allows, such as Helm, Embedded Cluster, KOTS, and kURL.
• Automate installs and upgrades: Service account API endpoints let customers create install options, fetch structured instructions, and download artifacts from CI/CD systems, including KOTS and kURL when those install types are entitled. For more information, see Headless Enterprise Portal: customer API.
• Manage instances: View all deployed instances and check for available updates. Helm and Embedded Cluster instances expand into inline CLI instructions. KOTS and kURL instances expand into guided Admin Console application-upgrade steps.
• Download install artifacts and files: Download air gap bundles, Helm chart tarballs, and CLI tools directly from the portal, including versioned install and update artifacts for KOTS and kURL air gap instances. Available artifacts vary by install method and license entitlements. Customers can also download files you provide, such as scripts, checklists, and configuration templates, gated by entitlements.
• Access security data: Review CVE reports, filter to fixable vulnerabilities, view per-instance upgrade recommendations, and download SBOMs. Available for Helm and Embedded Cluster installs when Security Center is enabled.
• View release history: Browse release notes and track what's changed between versions.
• Upload support bundles: Generate and upload diagnostic bundles for faster troubleshooting.
• Manage their team: Invite users, create service accounts, configure SAML SSO, and register a release webhook.

What's new

The new Enterprise Portal is a complete rebuild of the customer portal experience. It replaces two earlier experiences: the Classic Enterprise Portal and the Download Portal. The Classic Enterprise Portal served Helm and Embedded Cluster customers. The Download Portal shared license files, air gap bundles, and install instructions, including for KOTS and kURL. What is new depends on which experience your customers use today.

New compared to the Classic Enterprise Portal

• KOTS and kURL support: Serves KOTS and kURL customers directly in the portal. They can view instances, browse versions, follow install instructions, and download air gap artifacts. The default content template includes dedicated KOTS and kURL install pages, shown only to customers whose license enables KOTS or kURL. These customers previously used the separate Download Portal.
• Content repo driven: You manage all portal content (pages, navigation, branding) through a GitHub repo you control, not through Vendor Portal UI forms
• MDX components: Interactive, customer-aware components (install commands, version selectors, upgrade paths) that adapt to each customer's license and instance state
• Versioned docs: Keep different content for different releases in Git branches. Each release on a customer's channel shows the content from the branch it resolves to, so you only create a branch when your docs change
• Service account automation: Customers automate install and upgrade workflows with service account tokens, aided by a built-in API reference and workflow guide
• Release webhooks: Customers can register a webhook that receives a release.available event when you promote a release with notifications turned on, so their pipelines can start upgrades without polling
• Local preview: replicated enterprise-portal preview lets you preview the full portal locally with live reload
• Helm chart reference: Auto-generated from your promoted releases with AI-enhanced descriptions
• Terraform module distribution (Alpha): License-gated module registry with native terraform init integration (premium feature, available by request)

Additionally new compared to the Download Portal

Customers moving from the Download Portal gain the same content and automation capabilities. The Download Portal already shared KOTS and kURL artifacts. The Enterprise Portal also generates KOTS and kURL install CLI commands (KOTS air gap remains a documented procedure with placeholders). For upgrades, it provides target-aware Admin Console guidance and air gap application bundles rather than generating KOTS or kURL upgrade CLI commands in the portal UI. It also adds the following, which the Download Portal has no equivalent for:

• Accounts and teams: Individual user sign-in through magic link, email invitation, or SAML SSO, replacing the Download Portal's shared password, plus multi-user team management
• Instance and update management: The Instances & Updates page shows deployed instances and detects available updates. Helm and Embedded Cluster cards expand into inline CLI steps. KOTS and kURL cards expand into guided Admin Console application-upgrade steps, including the selected application bundle for entitled air gap customers. For details, see KOTS and kURL instances in Log in to and use the Enterprise Portal. The Download Portal has no instance concept.
• Support bundle uploads: Customers generate and upload support bundles for troubleshooting directly from the portal

Current limitations

• Air gap instance records do not appear until the customer creates one from the Instances & Updates page, either by manually entering instance information or by extracting details from an uploaded support bundle. Availability depends on the customer's license having the corresponding install type and air gap option enabled.
• Security Center data (CVE reports and SBOMs) is available for Helm and Embedded Cluster installations only. Customers whose only instances are KOTS or kURL see an explanatory message instead of security data. Customers with a mix of instance types see Security Center data for their Helm and Embedded Cluster instances.
• If you have many version branches and need to make a change across all versions, you must update each branch individually.
• Air gap Helm installations relocate images to the customer's private registry using docker tag and docker push, which does not preserve image digests or multi-architecture image manifests. If your application references images by digest (@sha256:...) or ships multi-architecture images, the relocated images might not match what your chart expects, which can cause image pull failures.

Requirements

Enterprise Portal uses a GitHub App integration to sync content from your repo. The App has read-only access and never writes to or modifies your repositories. You must have a GitHub organization. GitLab, Bitbucket, and other git providers are not supported. The headless APIs don't require a GitHub repository.

The new Enterprise Portal is available to all teams. If your team uses the Classic Enterprise Portal, go to Enterprise Portal in the Vendor Portal and select New Portal to set it up.

Some Enterprise Portal capabilities require additional access:

• Customer email customization. For more information, see Customize customer emails.
• Terraform module distribution (Alpha), available by request to teams on the Business or Enterprise pricing plan

Move customers to the new Enterprise Portal

If your team already uses the Classic Enterprise Portal or the Download Portal, you can adopt the new Enterprise Portal incrementally and run the portals side by side. For how to move customers, plan for the change in portal address, and move KOTS and kURL customers, see Give customers access to the new Enterprise Portal in Manage customer access.

KOTS and kURL customers

KOTS and kURL customers can use the new Enterprise Portal, but the Classic Enterprise Portal doesn't support them. If your team also has the Classic Enterprise Portal, set Portal Version to Use new Enterprise Portal for this customer explicitly after you turn on Enterprise Portal access for a KOTS or kURL customer. For more information, see KOTS and kURL customers in Manage customer access.