Skip to main content

About the Enterprise Portal

Alpha Feature

Features described on this page are in alpha and subject to change. Some capabilities might require additional access.

The Enterprise Portal gives your customers one central place to view their install and upgrade instructions for each version of your software, set up their environment, manage their team, and get troubleshooting support by uploading support bundles.

By connecting your own GitHub repo, you control the content your customers see. You can serve versioned documentation tied to your releases, auto-generate Helm chart reference docs, customize branding, and distribute Terraform modules through a license-gated proxy registry.

Content is driven by entitlements and channel assignment, so each customer sees only what applies to them.

What your customers can do​

  • Install and upgrade: Step-by-step installation instructions for Helm and Embedded Cluster (Linux), with per-instance commands personalized to each customer's license and environment
  • Automate installs and upgrades: Service account API endpoints let customers create install profiles, fetch structured instructions, and download artifacts from CI/CD systems. For more information, see Service account automation.
  • Manage instances: View all deployed instances, check for available updates, and follow inline upgrade instructions
  • Download install artifacts: Download air gap bundles, Helm chart tarballs, and CLI tools directly from the portal. Available artifacts vary by install method and license entitlements
  • Access security data: Review CVE reports, filter to fixable vulnerabilities, view per-instance upgrade recommendations, and download SBOMs for each release. 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, and configure SAML SSO
  • Download assets: Access vendor-provided files (scripts, checklists, configuration templates) gated by entitlements

What's new​

The new Enterprise Portal is a complete rebuild of the customer portal experience. Key differences from the Classic Enterprise Portal:

  • Content repo driven: All portal content (pages, navigation, branding) is managed 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: Each Git branch becomes a version in the customer's portal, with smart resolution that automatically finds the right content for any release
  • Service account automation docs: Built-in API reference and workflow guide components help customers automate install and upgrade workflows with service account tokens
  • 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: License-gated module registry with native terraform init integration (premium feature)

Current limitations​

  • Installation and upgrade instructions are available only for Embedded Cluster and Helm CLI installations. The Enterprise Portal does not provide instructions for KOTS or kURL. For more information, see KOTS and kURL customers.
  • 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.

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.

Replicated enables the New Enterprise Portal by default for new teams. If your existing team uses the Classic Enterprise Portal, check the Vendor Portal for New Enterprise Portal pages. Contact your Replicated account representative if you do not see them.

Some Enterprise Portal capabilities require additional access:

  • Customer email customization
  • Security Center
  • Terraform module distribution, available to teams on the Business or Enterprise pricing plan

For vendors already using the Classic Enterprise Portal​

If your team already uses the Classic Enterprise Portal, you can adopt the new Enterprise Portal incrementally. Run both portals side by side, then move customers over individually or all together.

The new Enterprise Portal runs at a different domain ({appSlug}.enterpriseportal.app) than Classic (get.replicated.com/{appSlug}/...). Both portals share the same backend, so customer data, licenses, and instance information are consistent across both.

How to get started​

  1. Run both portals side by side. Contact Replicated to enable the new Enterprise Portal for your team alongside the Classic Enterprise Portal. Customers continue using their current portal until you move them.
  2. Connect a content repo. Follow the setup steps in Connect a Git Repo. Connecting a repo has zero effect on any customer's portal version. No customer sees the new portal until you explicitly switch them.
  3. Test it yourself. Use the local CLI preview (replicated enterprise-portal preview) or open the new portal URL directly to see how your content renders. The Vendor Portal also has a "Login as customer" button on each customer's Enterprise Portal access tab.
  4. Move individual customers. On the customer's Enterprise Portal access tab, set Portal Version to Use new Enterprise Portal for this customer. This affects only that customer. If the customer doesn't have Enterprise Portal access yet, turn on Enable Enterprise Portal for this customer first — the Portal Version control only appears after access is on.
  5. Move customers back if needed. Set Portal Version back to Classic at any time. The customer immediately returns to the Classic experience.
  6. Move everyone at the same time, if you don't need a gradual rollout. On Enterprise Portal > Customer Access, turn on Enable Enterprise Portal for all customers to move every customer, including those on KOTS or kURL, off the Download Portal immediately. This doesn't change any customer's individual access or Portal Version setting — it overrides the result while it's on, and turning it back off returns each customer to their individual setting.

Vendor Portal view vs. customer portal version​

The New Portal / Classic Portal toggle appears only when both portals are running for your team. It controls the Vendor Portal view that you see. It does not change which portal your customers see. Use each customer's Portal Version setting to change their portal.

Portal coexistence​

You can run the Download Portal and the new Enterprise Portal side by side, with different customers on each, indefinitely. Treat this as an ongoing state, not only a step toward a full migration.

For a single customer, though, these are alternatives, not concurrent options. Turning on Enterprise Portal access for a customer moves that customer off the Download Portal onto whichever portal version their Portal Version setting selects.

KOTS and kURL customers​

The Classic Enterprise Portal does not support KOTS or kURL installations. Customers using these install types use the Download Portal instead. The new Enterprise Portal supports KOTS and kURL customers as well, with some differences from Helm and Embedded Cluster customers. For details on what your KOTS and kURL customers see, including current limitations, see KOTS and kURL instances in Log in to and Use the Enterprise Portal.

Move a KOTS or kURL customer to the new Enterprise Portal​

Follow the steps in How to get started to run the new Enterprise Portal for your team. This works the same way for KOTS and kURL customers as it does for Helm and Embedded Cluster customers. The app-level Enable Enterprise Portal for all customers option applies to KOTS and kURL customers too.

One thing to plan for: most KOTS and kURL customers don't have Enterprise Portal access enabled yet, since they've been using the Download Portal. You need to turn on Enable Enterprise Portal for this customer before the Portal Version control appears. Classic Enterprise Portal does not support KOTS or kURL. Leaving Portal Version at its default after enabling access does not give the customer a working portal. Set it to Use new Enterprise Portal for this customer explicitly.

To automate this instead of using the Vendor Portal UI: use Patch a customer with is_enterprise_portal_enabled: true to grant access, then Update Enterprise Portal settings with portalVersion: "v2" to select the new Enterprise Portal. For more information, see Customer access in Enterprise Portal Headless Automation.

If you also want this customer to see Security Center, enable it on the same Enterprise Portal access tab. This is a separate toggle from Portal Version. For a KOTS or kURL customer, Security Center shows an explanatory message instead of security data until they also have a Helm or Embedded Cluster instance. See Security. For more information about the Security Center toggle, see Enable Customer Access to Security Information.

On this page