Enterprise portal docs (draft) #3218
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| The **Install Attempts** section includes the following details about each installation attempt: | ||
| * The installation status (succeeded, stalled, or failed) |
There was a problem hiding this comment.
^ what are the possible statuses for install attempts?
| * **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. |
There was a problem hiding this comment.
^ this was a guess of what online/offline meant for the Registry field. I figure it has to do with if they have a local registry configured?
| * 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: | ||
|  | ||
| [View a larger version of this image](/images/customer-reporting-install-attempts-vm.png) |
There was a problem hiding this comment.
^ I wasn't sure about the different install characteristics that determine which progress indicators are included
for example, I saw "registry login" and "images pulled" show up on certain installs, and it looked like those were all helm installs, but could use confirmation
same with "assets downloaded". those are just for EC, I guess?
| </tr> | ||
| <tr> | ||
| <td>Page overview</td> | ||
| <td>An overview of the Enterprise Portal.</td> |
There was a problem hiding this comment.
^ I don't think I saw where this appears in the Enterprise Portal
There was a problem hiding this comment.
it doesn't yet... i should decide if we're going to include it :)
| </tr> | ||
| <tr> | ||
| <td>Instance labels</td> | ||
| <td>Any labels applied to the instance.</td> |
There was a problem hiding this comment.
^ I'm not sure about this one. I saw something that appeared to be labels in the UI, but wasn't sure where those would be set
There was a problem hiding this comment.
these are applied by the vendor
| </tr> | ||
| <tr> | ||
| <td>Instance ID</td> | ||
| <td>The unique identifier for the instance.</td> |
There was a problem hiding this comment.
^ does this always show an id or can users set a nickname?
There was a problem hiding this comment.
nicknames are only available for new instances today... we should allow them to rename old instances soon though
| </tr> | ||
| <tr> | ||
| <td>Version</td> | ||
| <td>The application version installed.</td> |
There was a problem hiding this comment.
^ I figure this is just the application/release version that's installed? wasn't sure if there would be any reason this wouldn't match the exact version that's in the vendor portal
| @@ -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`. | |||
|
|
|||
There was a problem hiding this comment.
^ On the About Custom Domains page, add Enterprise Portal to list of endpoints you can alias with a custom domain
docs/vendor/customer-reporting.md
Outdated
| 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 |
There was a problem hiding this comment.
^ Add info about the Enterprise Portal section of the Customer Reporting page
docs/vendor/customer-reporting.md
Outdated
| * The uptime ratio in the previous two weeks. | ||
|
|
||
| ### Install Attempts |
There was a problem hiding this comment.
^ Add info about the Install Attempts section of the Customer Reporting page
|
|
||
| 1. Log in to the Enterprise Portal and go to **Install**. | ||
|
|
||
| 1. On the panel on the left, select the installation type. The installation options available 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). |
There was a problem hiding this comment.
only helm and EC are supported at launch time
| 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. |
There was a problem hiding this comment.
this should change today... they'll be able to create an instance record and when they mark an airgap install complete the instance will show up with the version they were installing on (from which we'll base update emails)
New About the Enterprise Portal: https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/enterprise-portal-about
New Customize the Enterprise Portal https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/enterprise-portal-configure
New Manage Enterprise Portal Access https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/enterprise-portal-invite
New Access and Use the Enterprise Portal https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/enterprise-portal-use
Update Customer Reporting with info about the new Enterprise Portal and Install Attempts sections: https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/customer-reporting#enterprise-portal and https://deploy-preview-3218--replicated-docs-upgrade.netlify.app/vendor/customer-reporting#install-attempts