-
Notifications
You must be signed in to change notification settings - Fork 35
docs: add instance archive and bulk archive documentation #4056
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,3 +33,6 @@ yarn-error.log* | |
|
|
||
| # Algolia Search | ||
| .env | ||
|
|
||
| # Git worktrees | ||
| .worktrees | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -91,32 +91,23 @@ For more information about the Enterprise Portal, see [About the Enterprise Port | |
|
|
||
| ### Instances | ||
|
|
||
| The **Instances** section displays details about the active application instances associated with the customer. | ||
|
|
||
| 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). | ||
| 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. | ||
|
|
||
| From the **Instances** section, you can: | ||
| * Click any of the instances to open its **Instance details** page. For more information, see [Instance Details](instance-insights-details). | ||
| * Bulk archive instances. For more information, see [Bulk archive instances](/vendor/releases-creating-customers#bulk-archive-instances) in _Create and manage customers_. | ||
| * View instances details, including: | ||
| * The first seven characters of the instance ID | ||
| * The instance's status. See [Enabling and Understanding Application Status](insights-app-status). | ||
| * The application version | ||
| * Details about the cluster where the instance is installed | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| * Instance uptime data. For more information, see [Instance Uptime](instance-insights-details#instance-uptime) in _Instance Details_. | ||
|
|
||
| The following shows an example of a row for an active instance in the **Instances** section: | ||
|
|
||
|  | ||
| [View a larger version of this image](/images/instance-row.png) | ||
|
|
||
| The **Instances** section displays the following details about each active instance: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. all this info felt like overkill |
||
| * The first seven characters of the instance ID. | ||
| * 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). | ||
| * The application version. | ||
| * Details about the cluster where the instance is installed, including: | ||
| * The Kubernetes distribution for the cluster, if applicable. | ||
| * The Kubernetes version running in the cluster. | ||
| * Whether the instance is installed in a Replicated kURL cluster. | ||
| * (kURL Clusters Only) The number of nodes ready in the cluster. | ||
| * (KOTS Only) The KOTS version running in the cluster. | ||
| * The Replicated SDK version running in the cluster. | ||
| * The cloud provider and region, if applicable. | ||
| * Instance uptime data, including: | ||
| * 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_. | ||
| * 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_. | ||
| * The uptime ratio in the previous two weeks. | ||
|
|
||
| ### Install attempts (Beta) | ||
|
|
||
| :::note | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,12 @@ | ||
| # Instance details | ||
|
|
||
| This topic describes using the Replicated Vendor Portal to quickly understand the recent events and performance of application instances installed in your customers' environments. | ||
| ## About the instance details page {#about-page} | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also cut back on a lot of the info here |
||
|
|
||
| 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. | ||
|
|
||
| For example, you can use the **Instance details** page to track the following events for each instance: | ||
|
|
||
| * Recent performance degradation or downtime | ||
| * Length of instance downtime | ||
| * Recent changes to the cluster or infrastructure | ||
| * Changes in the number of nodes, such as nodes lost or added | ||
| * Changes in the cluster's Kubernetes version | ||
| * Changes in the application version that the instance is running | ||
|
|
||
| To access the **Instance details** page, go to **Customers** and click the **Customer reporting** button for the customer that you want to view: | ||
| ## About the instance details page {#about-page} | ||
|
|
||
|  | ||
| 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. | ||
|
|
||
| From the **Reporting** page for the selected customer, click the **View details** button for the desired application instance. | ||
| 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_. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ added to the Instance details page with a link for more info |
||
|
|
||
| The following shows an example of the **Instance details** page: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -92,9 +92,9 @@ To edit a locked field: | |
|
|
||
| ## Archive a customer | ||
|
|
||
| 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. | ||
| When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| To expire a license, set an expiration date and policy in the **Expiration policy** field before you archive the customer. | ||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| To archive a customer: | ||
|
|
||
|
|
@@ -104,26 +104,64 @@ To archive a customer: | |
|
|
||
| You can unarchive by clicking **Unarchive Customer** in the customer's **Manage customer** page. | ||
|
|
||
| ## Export customer and instance data {#export} | ||
| ## Manage customer instances | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. added this section to the Create and manage customers page, since we already had info about searching and filtering customers & exporting customer/instance data here |
||
|
|
||
| <Download/> | ||
| ### Archive or unarchive an instance {#archive-instance} | ||
|
|
||
| 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. | ||
|
|
||
| To archive or unarchive an instance: | ||
|
|
||
| 1. From the **Instance details** page for the target instance, click **Archive instance** or **Unarchive instance**. | ||
|
|
||
| :::note | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| 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. | ||
| ::: | ||
|
|
||
| 1. In the confirmation dialog, click **Archive** or **Unarchive**. | ||
|
|
||
| ### Bulk archive instances | ||
|
|
||
| You can archive up to 100 instances in a single bulk operation. | ||
|
|
||
| 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). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| 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_. | ||
| ## Filter and search customers | ||
| To bulk archive instances: | ||
|
|
||
| The **Customers** page provides a search box and filters that help you find customers: | ||
| 1. On the **Customers > Instances** tab, click the archive icon in the table toolbar to enable bulk selection mode. | ||
| 1. Select the instances that you want to archive by using the checkboxes in each row. | ||
| 1. Click **Archive instances**. | ||
| 1. In the confirmation dialog, click **Archive**. | ||
|
|
||
| <img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/> | ||
| A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| [View a larger version of this image](/images/customers-filter.png) | ||
| ## Search customers | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| 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. | ||
| To filter and search your list of customers: | ||
|
|
||
| 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`). | ||
| * 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. | ||
|
|
||
| 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`). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| <img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/> | ||
|
|
||
| [View a larger version of this image](/images/customers-filter.png) | ||
|
|
||
| ## View archived and inactive instances | ||
|
|
||
| By default, the Vendor Portal hides archived and inactive instances from each customer's **Instances** list. | ||
|
|
||
| To view archived and inactive instances: | ||
|
|
||
| * 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. | ||
|
|
||
| ## Export customer and instance data {#export} | ||
|
|
||
| <Download/> | ||
|
|
||
| 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. | ||
| 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_. | ||
|
|
||
| ## Replace a license in an existing installation | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ added this with a link for more info