diff --git a/docs/vendor/enterprise-portal-v2-about.mdx b/docs/vendor/enterprise-portal-v2-about.mdx index 4a203044b0..b6c06af398 100644 --- a/docs/vendor/enterprise-portal-v2-about.mdx +++ b/docs/vendor/enterprise-portal-v2-about.mdx @@ -36,9 +36,9 @@ The new Enterprise Portal is a complete rebuild of the customer portal experienc ## Current limitations {#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. -- 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. -- Security Center data (CVE reports and SBOMs) is available for Helm and Embedded Cluster installations only. Security data is not displayed for KOTS or kURL installations. +- 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](#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 @@ -55,18 +55,39 @@ Some Enterprise Portal capabilities require additional access: ## 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. To avoid disrupting existing customers, run both portal versions in mixed mode. +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 +### How to get started {#how-to-get-started} -1. **Enable mixed mode.** Contact Replicated to run the New Enterprise Portal alongside the Classic Enterprise Portal. Customers continue using their current portal until you move them to the new version. +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. 1. **Connect a content repo.** Follow the setup steps in [Connect a Git Repo](/vendor/enterprise-portal-v2-connect-repo). Connecting a repo has zero effect on any customer's portal version. No customer sees the new portal until you explicitly switch them. -1. **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 EP access tab. -1. **Move individual customers.** On the customer's **Enterprise Portal access** tab in Vendor Portal, set the **Portal Version** toggle to use the new Enterprise Portal. Only that customer is affected. -1. **Move customers back if needed.** Set the Portal Version toggle back to Classic at any time. The customer immediately returns to the Classic experience. +1. **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. +1. **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. +1. **Move customers back if needed.** Set Portal Version back to Classic at any time. The customer immediately returns to the Classic experience. +1. **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 in mixed mode. It controls the Vendor Portal view that you see. It does not change which portal your customers see. Use the Portal Version toggle on each customer's EP access tab to change their portal. +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 {#kots-and-kurl-customers} + +The Classic Enterprise Portal does not support KOTS or kURL installations. Customers using these install types use the [Download Portal](/vendor/releases-share-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](/vendor/enterprise-portal-v2-use#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](#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](https://replicated-vendor-api.readme.io/reference/patchcustomer) with `is_enterprise_portal_enabled: true` to grant access, then [Update Enterprise Portal settings](https://replicated-vendor-api.readme.io/reference/updateenterpriseportalsettings) with `portalVersion: "v2"` to select the new Enterprise Portal. For more information, see [Customer access](/vendor/enterprise-portal-v2-vendor-api-automation#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](/vendor/enterprise-portal-v2-use#security). For more information about the Security Center toggle, see [Enable Customer Access to Security Information](/vendor/security-center-enable-customer-access). diff --git a/docs/vendor/enterprise-portal-v2-use.mdx b/docs/vendor/enterprise-portal-v2-use.mdx index 750839764e..e7dcc88172 100644 --- a/docs/vendor/enterprise-portal-v2-use.mdx +++ b/docs/vendor/enterprise-portal-v2-use.mdx @@ -32,7 +32,7 @@ All users invited to the same customer team share access to the same pull tokens Once logged in, customers see a sidebar with the navigation defined by the vendor's `toc.yaml`. The default template organizes content into: -- **Installation**: Requirements, release history, and step-by-step install instructions for Linux and Helm +- **Installation**: Requirements, release history, and step-by-step install instructions for Linux (Embedded Cluster) and Helm - **Operations**: Security reports and support bundle management - **Updates**: Check for updates and follow upgrade instructions - **Support**: FAQ and contact support information @@ -76,6 +76,14 @@ Depending on the install method and license entitlements, customers can download For Embedded Cluster air gap installations, customers using a private registry can enter their registry hostname directly in the install flow. The instructions update to include image pull, tag, and push commands targeting that registry, along with the appropriate `--registry` flags on the install command. This is also available during Embedded Cluster upgrades when the instance was originally installed with a private registry. +### KOTS and kURL instances {#kots-and-kurl-instances} + +KOTS and kURL instances appear on the **Instances & Updates** page alongside Helm and Embedded Cluster instances, labeled **KOTS** or **kURL**. Each instance shows its current version and status. + +The Enterprise Portal does not provide step-by-step, in-console install or upgrade instructions for KOTS or kURL. These instance cards don't expand into inline upgrade steps the way Helm and Embedded Cluster cards do. + +Customers can create air gap instance records for KOTS and kURL the same way as for Helm and Embedded Cluster. They can enter instance information manually from the Instances & Updates page, or extract details from an uploaded support bundle. Availability depends on the customer's license having the corresponding install type and air gap option enabled. + ## Team management Customer team admins can manage their portal team from the Team Settings page: @@ -112,7 +120,7 @@ When Security Center is enabled by the vendor, customers with Helm or Embedded C - **SBOMs**: Download the Software Bill of Materials for any release version. SBOMs are accessible to all portal team members regardless of role. :::note -Security Center data is available for Helm and Embedded Cluster installations only. Security data is not displayed for KOTS or kURL installations. +Security Center data is available for Helm and Embedded Cluster installations only. KOTS and kURL instances don't contribute CVE data or upgrade recommendations, and they aren't counted toward instance totals in Security Center. Customers whose only instances are KOTS or kURL see an explanatory message instead of security data. Customers with a mix of instance types still see Security Center for their Helm and Embedded Cluster instances. ::: ## License information