You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/custom-domains-using.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Use Custom Domains
2
2
3
-
This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, and the Download Portal.
3
+
This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, the Replicated Enterprise Portal and the Replicated Download Portal.
4
4
5
5
For information about adding and managing custom domains with the Vendor API v3, see the [customHostnames](https://replicated-vendor-api.readme.io/reference/createcustomhostname) section in the Vendor API v3 documentation.
Copy file name to clipboardExpand all lines: docs/vendor/custom-domains.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ You can configure custom domains for the following services:
16
16
17
17
-**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`.
18
18
19
+
-**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`.
20
+
19
21
-**Download Portal:** The Download Portal can be used to share customer license files, air gap bundles, and so on. By default, the Download Portal uses the domain `get.replicated.com`. Replicated recommends using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`.
20
22
21
23
-**Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. By default, this registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`.
Copy file name to clipboardExpand all lines: docs/vendor/customer-reporting.md
+63-1Lines changed: 63 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,9 @@ As shown in the image above, the **Reporting** page has the following main secti
14
14
*[Manage Customer](#manage-customer)
15
15
*[Time to Install](#time-to-install)
16
16
*[Download Portal](#download-portal)
17
+
*[Enterprise Portal](#enterprise-portal)
17
18
*[Instances](#instances)
19
+
*[Install Attempts](#install-attempts)
18
20
19
21
### Manage Customer
20
22
@@ -53,12 +55,40 @@ For more information about how to interpret the time to install metrics, see [Ti
53
55
54
56
### Download Portal
55
57
58
+
:::note
59
+
If the Replicated Enterprise Portal is enabled for the customer, then an **Enterprise Portal** section is displayed instead of the **Download Portal** section. For more information, see [Enterprise Portal](#enterprise-portal) below.
60
+
:::
61
+
56
62
From the **Download portal** section, you can:
57
63
* Manage the password for the Download Portal
58
64
* Access the unique Download Portal URL for the customer
59
65
60
66
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).
61
67
68
+
### Enterprise Portal (Alpha)
69
+
70
+
:::note
71
+
The **Enterprise Portal** section is available only for customers with the Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
72
+
:::
73
+
74
+
The following shows an example of the **Enterprise Portal** section:
75
+
76
+
77
+
78
+
[View a larger version of this image](/images/customer-reporting-enterprise-portal.png)
79
+
80
+
From the **Enterprise Portal** section, you can:
81
+
* Click **View** to access the unique Enterprise Portal for the customer
82
+
* View the status of the customer's access to the Enterprise Portal
83
+
* View the timestamp when the Enterprise Portal was most recently accessed by the customer
84
+
* View the number of users with Enterprise Portal accounts
85
+
* Click **Invite user** to invite a new user to the Enterprise Portal
86
+
* View the number of install attempts made by the customer. The **Customer Reporting > Install Attempts** section includes additional details about install attempts. For more information, see [Install Attempts](#install-attempts) below.
87
+
* View the number of service accounts created in the Enterprise Portal
88
+
* View the number of support bundles uploaded to the Enterprise Portal
89
+
90
+
For more information about the Enterprise Portal, see [About the Enterprise Portal](/vendor/enterprise-portal-about).
91
+
62
92
### Instances
63
93
64
94
The **Instances** section displays details about the active application instances associated with the customer.
@@ -85,4 +115,36 @@ The **Instances** section displays the following details about each active insta
85
115
* Instance uptime data, including:
86
116
* The timestamp of the last recorded check-in for the instance. For more information about what triggers an instance check-in, see [How the Vendor Portal Collects Instance Data](instance-insights-event-data#about-reporting) in _About Instance and Event Data_.
87
117
* An uptime graph of the previous two weeks. For more information about how the Vendor Portal determines uptime, see [Instance Uptime](instance-insights-details#instance-uptime) in _Instance Details_.
88
-
* The uptime ratio in the previous two weeks.
118
+
* The uptime ratio in the previous two weeks.
119
+
120
+
### Install Attempts (Alpha)
121
+
122
+
:::note
123
+
The **Install Attempts** section is available only for customers with the Replicated Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
124
+
:::
125
+
126
+
The **Install Attempts** section includes details about the installation attempts made by users. These insights are based on the customer's activity in the Enterprise Portal.
127
+
128
+
To track install attempts, the Enterprise Portal creates a unique, _just-in-time_ service account that sends data back to the Vendor Portal when the user starts and completes the installation or takes other actions that are specific to the installation type. These service accounts also provide realtime feedback to the user on their installation progress using checkboxes and status indicators, and allow users to pause and return to an installation attempt.
129
+
130
+
The following shows an example of the **Install Attempts** section:
131
+
132
+
<imgalt="Install attempts section of customer reporting page"src="/images/customer-reporting-install-attempts-expanded.png"width="700px"/>
133
+
134
+
[View a larger version of this image](/images/customer-reporting-install-attempts-expanded.png)
135
+
136
+
The **Install Attempts** section includes the following details about each installation attempt:
137
+
* The installation status (succeeded, stalled, or failed)
138
+
* The date and time when the installation attempt was started
139
+
* The email address of the user that initiated the installation attempt
140
+
* Installation environment details:
141
+
***OS** or **K8s**: The operating system of the VM or bare metal server. Or, the distribution of Kubernetes running in the installation environment.
142
+
***Mode**: If the installation is online (internet-connected) or air gap (offline).
143
+
***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.
144
+
* Installation progress details, including when the installation was started and completed as well as other progress indicators that are specific to the installation type. For example:
145
+
* For installations with Helm, the Enterprise Portal reports when your image registry was accessed and when application images were pulled, as shown below:
[View a larger version of this image](/images/customer-reporting-install-attempts-helm.png)
148
+
* 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:
This topic provides an overview of the Replicated Enterprise Portal.
4
+
5
+
## Overview
6
+
7
+
The Enterprise Portal is a customizable, web-based portal that provides a centralized location where your customers can:
8
+
* View application install and update instructions
9
+
* Manage their team members and service accounts
10
+
* Upload support bundles
11
+
* View insights about their active and inactive instances
12
+
* And more
13
+
14
+
Your customers can access the Enterprise Portal outside their application installation environment at a custom domain that you specify, making it easier for teams to manage instances and get support.
15
+
16
+
For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use).
17
+
18
+
The following shows an example of the Enterprise Portal dashboard:
[View a larger version of this image](/images/enterprise-portal-dashboard.png)
23
+
24
+
## Limitations
25
+
26
+
* The Enterprise Portal is Alpha. The features and functionality of the Enterprise Portal are subject to change.
27
+
28
+
* Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance. For more information, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_.
29
+
30
+
## Comparison to the Download Portal
31
+
32
+
The Enterprise Portal is the next generation version of the Replicated Download Portal. Compared to the Download Portal, the Enterprise Portal not only provides access to installation assets and instructions, but also allows users to track available updates, manage their team and service accounts, view the status of their instances, view license details, and more. These features are designed to make it easier for your customers to manage their instances of your application from a centralized location outside of the installation environment.
33
+
34
+
You can migrate existing customers from the Download Portal to the Enterprise Portal by enabling the Enterprise Portal for their license. For more information, see [Manage Enterprise Portal Access](enterprise-portal-invite).
35
+
36
+
For more information about the Download Portal, see [Access a Customer's Download Portal](/vendor/releases-share-download-portal).
37
+
38
+
## About Customizing the Enterprise Portal
39
+
40
+
You can configure the Enterprise Portal to use a custom domain, add links and contact information, customize the look and feel of the Enterprise Portal, edit the content of invitation and notification emails, and more. Customizing the Enterprise Portal helps ensure that your customers have a consistent branding experience and can access application- and vendor-specific information.
41
+
42
+
For more information about customizing the Enterprise Portal, see [Customize the Enterprise Portal](enterprise-portal-configure).
43
+
44
+
For information about how to set a custom domain for the Enterprise Portal, see [Use Custom Domains](/vendor/custom-domains-using).
45
+
46
+
## About Instance Reporting with the Enterprise Portal
47
+
48
+
This section describes the instance reporting functionality of the Enterprise Portal.
49
+
50
+
### Active and Inactive Instances
51
+
52
+
The Enterprise Portal provides insights to end users about their active and inactive instances, including the application version installed, the instance status, computed metrics like the first and most recent times the instance sent data to the Vendor Portal, and more. For more information about the instance insights available in the Enterprise Portal, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_.
53
+
54
+
55
+
[View a larger version of this image](/images/enterprise-portal-instance-status-details.png)
56
+
57
+
### Customer Reporting
58
+
59
+
The Enterprise Portal sends insights back to the Vendor Portal, which are surfaced on the **Customer Reporting** page. For more information, see [Enterprise Portal](/vendor/customer-reporting#enterprise-portal) in _Customer Reporting_.
60
+
61
+
These insights include details about the customer's install attempts. The Enterprise Portal tracks and reports on install attempts by creating unique, _just-in-time_ service accounts. These service accounts allow the Enterprise Portal to send data back to the Vendor Portal when the user starts and completes the installation or takes other actions that are specific to the installation type. The service accounts also provide realtime feedback to the user on their installation progress using checkboxes and status indicators, and allow users to pause and return to an installation attempt. For more information, see [Install Attempts](/vendor/customer-reporting#install-attempts) in _Customer Reporting_.
62
+
63
+
The following shows an example of the **Install Attempts** section:
64
+
65
+
<imgalt="Install attempts section of customer reporting page"src="/images/customer-reporting-install-attempts-expanded.png"width="700px"/>
66
+
67
+
[View a larger version of this image](/images/customer-reporting-install-attempts-expanded.png)
This topic describes how to customize the Enterprise Portal, including using a custom domain, changing the branding, editing the content of invitation and notification emails, and adding custom documentation.
4
+
5
+
## Manage Enterprise Portal Settings
6
+
7
+
You can edit the settings for the Enterprise Portal to use a custom domain, provide custom links and contact information, customize the look and feel of the Enterprise Portal, and more.
8
+
9
+
To manage Enterprise Portal settings:
10
+
11
+
1. In the Vendor Portal, go to **Enterprise Portal > Settings**.
[View a larger version of this image](/images/enterprise-portal-settings.png)
16
+
17
+
1. Edit the settings as desired:
18
+
19
+
<table>
20
+
<tr>
21
+
<th>Field</th>
22
+
<th>Description</th>
23
+
</tr>
24
+
<tr>
25
+
<td>URL</td>
26
+
<td>The URL where customers can access the Enterprise Portal. You can change the URL to use a custom domain. For information, see [Use Custom Domains](custom-domains-using).</td>
27
+
</tr>
28
+
<tr>
29
+
<td>Title</td>
30
+
<td>The title of the Enterprise Portal. The title is displayed at the top of each page in the Enterprise Portal and is also used in email notifications.</td>
31
+
</tr>
32
+
<tr>
33
+
<td>Page overview</td>
34
+
<td>An overview of the Enterprise Portal.</td>
35
+
</tr>
36
+
<tr>
37
+
<td>Support portal link</td>
38
+
<td>The URL for the portal that your customers can use to get support. This link is provided on the Enterprise Portal **Support** page.</td>
39
+
</tr>
40
+
<tr>
41
+
<td>Contact email</td>
42
+
<td>The email address that customers can use to contact you. This email address is provided on the Enterprise Portal **Support** page.</td>
43
+
</tr>
44
+
<tr>
45
+
<td>Logo</td>
46
+
<td>Upload a custom PNG logo for the Enterprise Portal. The minimum size for the logo is 160px by 160px.</td>
47
+
</tr>
48
+
<tr>
49
+
<td>Favicon</td>
50
+
<td>Upload a custom favicon for the Enterprise Portal. The favicon is displayed in the browser tab.</td>
51
+
</tr>
52
+
<tr>
53
+
<td>Background</td>
54
+
<td>Select or customize the background for the Enterprise Portal.</td>
55
+
</tr>
56
+
<tr>
57
+
<td>Colors</td>
58
+
<td>Set the primary and secondary colors for the Enterprise Portal.</td>
59
+
</tr>
60
+
</table>
61
+
62
+
1. Click **Save**.
63
+
64
+
## Configure Invitation and Notification Emails {#configure-customer-emails}
65
+
66
+
You can customize the invitation and notification emails that are sent to your customers.
67
+
68
+
To configure customer emails:
69
+
70
+
1. In the Vendor Portal, go to **Enterprise Portal > Customer emails**.
[View a larger version of this image](/images/enterprise-portal-customer-emails.png)
75
+
76
+
1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam.
77
+
78
+
After the domain is verified automatically, the email address is displayed under **Verified Sender Address**.
79
+
1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events.
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
84
+
85
+
## Customize Documentation
86
+
87
+
The install and update instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see [Manage Install Types for a License](/vendor/licenses-install-types).
88
+
89
+
You can also customize the documentation that is displayed in the Enterprise Portal by including a link to your installation instructions or by adding your own pre- and post-installation instructions.
90
+
91
+
To customize documentation:
92
+
93
+
1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**.
94
+
95
+
96
+
97
+
[View a larger version of this image](/images/enterprise-portal-knowledge-base.png)
98
+
99
+
1. In the panel on the left, select the installation type.
100
+
101
+
1. Customize the documentation for the selected installation type as desired:
102
+
1. In the documentation links section, add a link to your installation documentation. The link is displayed on the Enterprise Portal **Install** page.
103
+
1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes.
0 commit comments