Skip to content

Commit dee52e5

Browse files
committed
docs edits
1 parent c4025a1 commit dee52e5

3 files changed

Lines changed: 65 additions & 81 deletions

File tree

docs/vendor/customer-reporting.md

Lines changed: 11 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -91,51 +91,23 @@ For more information about the Enterprise Portal, see [About the Enterprise Port
9191

9292
### Instances
9393

94-
The **Instances** section displays details about the active application instances associated with the customer.
95-
96-
You can click any of the rows in the **Instances** section to open the **Instance details** page. The **Instance details** page displays additional event data and computed metrics to help you understand the performance and status of each active application instance. For more information, see [Instance Details](instance-insights-details).
94+
The **Instances** section displays details about the active application instances associated with the customer. You can also enable the **Show archived instances** and **Show inactive instances** checkboxes to view archived and inactive instances.
95+
96+
From the **Instances** section, you can:
97+
* Click any of the instances to open its **Instance details** page. For more information, see [Instance Details](instance-insights-details).
98+
* Bulk archive instances. For more information, see [Bulk archive instances](/vendor/releases-creating-customers#bulk-archive-instances) in _Create and manage customers_.
99+
* View instances details, including:
100+
* The first seven characters of the instance ID
101+
* The instance's status. See [Enabling and Understanding Application Status](insights-app-status).
102+
* The application version
103+
* Details about the cluster where the instance is installed
104+
* Instance uptime data. For more information, see [Instance Uptime](instance-insights-details#instance-uptime) in _Instance Details_.
97105

98106
The following shows an example of a row for an active instance in the **Instances** section:
99107

100108
![Row in the Instances section](/images/instance-row.png)
101109
[View a larger version of this image](/images/instance-row.png)
102110

103-
The **Instances** section displays the following details about each active instance:
104-
* The first seven characters of the instance ID.
105-
* The status of the instance. Possible statuses are Missing, Unavailable, Degraded, Ready, and Updating. For more information, see [Enabling and Understanding Application Status](insights-app-status).
106-
* The application version.
107-
* Details about the cluster where the instance is installed, including:
108-
* The Kubernetes distribution for the cluster, if applicable.
109-
* The Kubernetes version running in the cluster.
110-
* Whether the instance is installed in a Replicated kURL cluster.
111-
* (kURL Clusters Only) The number of nodes ready in the cluster.
112-
* (KOTS Only) The KOTS version running in the cluster.
113-
* The Replicated SDK version running in the cluster.
114-
* The cloud provider and region, if applicable.
115-
* Instance uptime data, including:
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_.
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_.
118-
* The uptime ratio in the previous two weeks.
119-
120-
#### Show archived instances
121-
122-
Archived instances are hidden from the **Instances** section by default. To include archived instances in the list, enable the **Show Archived Instances** toggle on the **Customers > Instances** tab.
123-
124-
For more information about archiving and unarchiving individual instances, see [Archive and Unarchive Instances](instance-insights-details#archive-and-unarchive-instances) in _Instance Details_.
125-
126-
#### Bulk archive instances
127-
128-
You can archive multiple instances at once from the **Customers > Instances** tab.
129-
130-
To bulk archive instances:
131-
132-
1. On the **Customers > Instances** tab, click the archive icon in the table toolbar to enable bulk selection mode.
133-
1. Select the instances that you want to archive by using the checkboxes in each row.
134-
1. Click **Archive instances**.
135-
1. In the confirmation dialog, click **Archive**.
136-
137-
The Vendor Portal archives all eligible instances and skips any instances that do not meet the archiving criteria (for example, active production instances). A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. You can archive up to 100 instances in a single bulk operation.
138-
139111
### Install attempts (Beta)
140112

141113
:::note

docs/vendor/instance-insights-details.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
11
# Instance details
22

33
This topic describes using the Replicated Vendor Portal to quickly understand the recent events and performance of application instances installed in your customers' environments.
4-
## About the instance details page {#about-page}
5-
6-
The Vendor Portal provides insights about the health, status, and performance of the active application instances associated with each customer license on the **Instance details** page. You can use the insights on the **Instance details** page to more quickly troubleshoot issues with your customers' active instances, helping to reduce support burden.
7-
8-
For example, you can use the **Instance details** page to track the following events for each instance:
9-
10-
* Recent performance degradation or downtime
11-
* Length of instance downtime
12-
* Recent changes to the cluster or infrastructure
13-
* Changes in the number of nodes, such as nodes lost or added
14-
* Changes in the cluster's Kubernetes version
15-
* Changes in the application version that the instance is running
164

17-
To access the **Instance details** page, go to **Customers** and click the **Customer reporting** button for the customer that you want to view:
5+
## About the instance details page {#about-page}
186

19-
![Customer reporting button on the Customers page](/images/customer-reporting-button.png)
7+
The Vendor Portal provides insights about the health, status, and performance of the active application instances associated with each customer license on the **Instance details** page. You can use these insights to more quickly troubleshoot issues with your customers' active instances, helping to reduce support burden.
208

21-
From the **Reporting** page for the selected customer, click the **View details** button for the desired application instance.
9+
From the **Instance details** page, you can also archive and unarchive instances. For more information, see [Archive or unarchive an instance](/vendor/releases-creating-customer#archive-instance) in _Create and manage customers_.
2210

2311
The following shows an example of the **Instance details** page:
2412

@@ -371,17 +359,3 @@ For more information about configuring custom metrics, see [Configure Custom Met
371359
</td>
372360
</tr>
373361
</table>
374-
375-
## Archive and unarchive instances
376-
377-
You can archive application instances that are inactive, air gap, or installed with a development license. Archiving an instance hides it from all views in the Vendor Portal. You can unarchive an instance at any time to restore it to the active instances list.
378-
379-
To archive or unarchive an instance:
380-
381-
1. From the **Instance details** page for the target instance, click **Archive instance** or **Unarchive instance**.
382-
383-
1. In the confirmation dialog, click **Archive** or **Unarchive**.
384-
385-
:::note
386-
The **Archive instance** button is visible on the **Instance details** page for all instances, but the backend enforces the eligibility criteria. If the instance is active, online, and installed with a production or trial license, the archive request returns an error.
387-
:::

docs/vendor/releases-creating-customer.mdx

Lines changed: 51 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ To edit a locked field:
9292

9393
## Archive a customer
9494

95-
When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. Archival does not affect the utility of license files downloaded before the customer was archived.
95+
When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only.
9696

97-
To expire a license, set an expiration date and policy in the **Expiration policy** field before you archive the customer.
97+
Archiving a customer does not change the functionality or utility of licenses downloaded before the customer was archived. To expire a license, set an expiration date and policy in the **Expiration policy** field before you archive the customer.
9898

9999
To archive a customer:
100100

@@ -104,26 +104,64 @@ To archive a customer:
104104

105105
You can unarchive by clicking **Unarchive Customer** in the customer's **Manage customer** page.
106106

107-
## Export customer and instance data {#export}
107+
## Manage customer instances
108108

109-
<Download/>
109+
### Archive or unarchive an instance {#archive-instance}
110+
111+
You can archive application instances that are inactive, air gap, or installed with a Development license. Archiving an instance hides it from all views in the Vendor Portal. You can unarchive an instance at any time to restore it to the active instances list.
112+
113+
To archive or unarchive an instance:
114+
115+
1. From the **Instance details** page for the target instance, click **Archive instance** or **Unarchive instance**.
116+
117+
:::note
118+
The **Archive instance** button is visible on the **Instance details** page for all instances, but if the instance is active, online, and installed with a production or trial license, the archive request returns an error.
119+
:::
120+
121+
1. In the confirmation dialog, click **Archive** or **Unarchive**.
122+
123+
### Bulk archive instances
124+
125+
You can archive up to 100 instances in a single bulk operation.
126+
127+
When you bulk archive, the Vendor Portal archives all eligible instances and skips any instances that do not meet the archiving criteria (for example, active production instances).
110128

111-
For more information about the data fields in the CSV downloads, see [Data Dictionary](/vendor/instance-data-export#data-dictionary) in _Export Customers and Instance Data_.
112-
## Filter and search customers
129+
To bulk archive instances:
113130

114-
The **Customers** page provides a search box and filters that help you find customers:
131+
1. On the **Customers > Instances** tab, click the archive icon in the table toolbar to enable bulk selection mode.
132+
1. Select the instances that you want to archive by using the checkboxes in each row.
133+
1. Click **Archive instances**.
134+
1. In the confirmation dialog, click **Archive**.
115135

116-
<img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/>
136+
A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped.
117137

118-
[View a larger version of this image](/images/customers-filter.png)
138+
## Search customers
119139

120-
You can filter customers based on whether they are active, by license type, and by channel name. You can filter using more than one criteria, such as Active, Paid, and Stable. However, you can select only one license type and one channel at a time.
140+
You can search your customers using filters in the Vendor Portal. If you want to filter using multiple license types or channels, you can download a CSV file instead. For more information, see [Export customer and instance data](#export) on this page.
121141

122-
If there is adoption rate data available for the channel that you are filtering by, you can also filter by current version, previous version, and older versions.
142+
To filter and search your list of customers:
123143

124-
You can also filter customers by custom ID or email address. To filter customers by custom ID or email, use the search box and prepend your search term with "customId:" (ex: `customId:1234`) or "email:" (ex: `email:bob@replicated.com`).
144+
* On the **Customers** page, use the search box and filters to find customer records. For example, you can filter by active or inactive customer records, license type, release channel, and more.
145+
146+
To filter customers by custom ID or email, use the search box and prepend your search term with "customId:" (ex: `customId:1234`) or "email:" (ex: `email:bob@replicated.com`).
147+
148+
<img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/>
149+
150+
[View a larger version of this image](/images/customers-filter.png)
151+
152+
## View archived and inactive instances
153+
154+
By default, the Vendor Portal hides archived and inactive instances from each customer's **Instances** list.
155+
156+
To view archived and inactive instances:
157+
158+
* Go to the **Customers** page, select the customer, and go to the **Reporting** tab. Scroll to the **Instances** section and enable the **Show archived instances** or **Show inactive instances** checkboxes.
159+
160+
## Export customer and instance data {#export}
161+
162+
<Download/>
125163

126-
If you want to filter information using multiple license types or channels, you can download a CSV file instead. For more information, see [Export Customer and Instance Data](#export) above.
164+
For more information about the data fields in the CSV downloads, see [Data Dictionary](/vendor/instance-data-export#data-dictionary) in _Export customer and instance data_.
127165

128166
## Replace a license in an existing installation
129167

0 commit comments

Comments
 (0)