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/reference/custom-resource-preflight.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ The following fields are supported on all optional collectors for preflights and
67
67
</tr>
68
68
<tr>
69
69
<td><code>exclude</code></td>
70
-
<td>(Optional) Based on the runtime available configuration, a conditional can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for Replicated KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the collector is not included.</td>
70
+
<td>(Optional) (KOTS Only) Based on the runtime available configuration, a conditional can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for Replicated KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the collector is not included.</td>
71
71
</tr>
72
72
</table>
73
73
@@ -110,11 +110,11 @@ The following fields are supported on all optional analyzers for preflights and
110
110
</tr>
111
111
<tr>
112
112
<td><code>exclude</code></td>
113
-
<td>(Optional) For KOTS only, a condition based on the runtime available configuration can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the analyzer is not included.</td>
113
+
<td>(Optional) (KOTS Only) A condition based on the runtime available configuration can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the analyzer is not included.</td>
114
114
</tr>
115
115
<tr>
116
116
<td><code>strict</code></td>
117
-
<td>(Optional) For KOTS only, an analyzer can be set to <code>strict: true</code> so that <code>fail</code> outcomes for that analyzer prevent the release from deploying until the vendor-specified requirements are met. When <code>exclude: true</code> is also specified, <code>exclude</code> overrides <code>strict</code> and the analyzer is not executed.</td>
117
+
<td>(Optional) (KOTS Only) An analyzer can be set to <code>strict: true</code> so that <code>fail</code> outcomes for that analyzer prevent the release from being deployed by KOTS until the vendor-specified requirements are met. When <code>exclude: true</code> is also specified, <code>exclude</code> overrides <code>strict</code> and the analyzer is not executed.</td>
Copy file name to clipboardExpand all lines: docs/reference/custom-resource-redactor.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,16 @@
1
-
# Redactor (KOTS-Only)
1
+
# Redactor (KOTSOnly)
2
2
3
-
This topic describes the Redactor custom resource. The information in this topic applies to Replicated KOTS installations only.
3
+
This topic describes how to define redactors with the Redactor custom resource.
4
+
5
+
:::note
6
+
Custom redactors defined with the Redactor resource apply only to installations with Replicated KOTS.
7
+
:::
4
8
5
9
## Overview
6
10
7
11
Preflight checks and support bundles include built-in redactors. These built-in redactors use regular expressions to identify and hide potentially sensitive data before it is analyzed. For example, the built-in redactors hide values that match common patterns for data sources, passwords, and user IDs that can be found in standard database connection strings. They also hide environment variables with names that begin with words like token, password, or user. To view the complete list of regex patterns for the built-in redactors, see [`redact.go`](https://github.com/replicatedhq/troubleshoot/blob/main/pkg/redact/redact.go#L204) in the open-source Troubleshoot GitHub repo.
8
12
9
-
For KOTS installations, you can also add custom redactors to support bundles using the Redactor custom resource manifest file. For example, you can redact API keys or account numbers, depending on your customer needs. For more information about redactors, see [Redacting Data](https://troubleshoot.sh/docs/redact/) in the Troubleshoot documentation.
13
+
For Replicated KOTS installations, you can also add custom redactors to support bundles using the Redactor custom resource manifest file. For example, you can redact API keys or account numbers, depending on your customer needs. For more information about redactors, see [Redacting Data](https://troubleshoot.sh/docs/redact/) in the Troubleshoot documentation.
Copy file name to clipboardExpand all lines: docs/vendor/customer-reporting.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,7 @@ The **Instances** section displays the following details about each active insta
81
81
* Whether the instance is installed in a Replicated kURL cluster.
82
82
* (kURL Clusters Only) The number of nodes ready in the cluster.
83
83
* (KOTS Only) The KOTS version running in the cluster.
84
-
*(Replicated SDK Only) The Replicated SDK version running in the cluster.
84
+
* The Replicated SDK version running in the cluster.
85
85
* The cloud provider and region, if applicable.
86
86
* Instance uptime data, including:
87
87
* 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_.
Copy file name to clipboardExpand all lines: docs/vendor/distributing-workflow.md
+2-9Lines changed: 2 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,7 @@ If you are new to Replicated, complete the following prerequisites before you ge
10
10
11
11
* Create an account in the Vendor Portal. You can either create a new team or join an existing team. For more information, see [Creating a Vendor Account](vendor-portal-creating-account).
12
12
13
-
* Complete a basic Replicated onboarding workflow to create an application and then promote and install initial releases in a development environment:
14
-
* (Recommended) For Helm chart-based applications, Replicated recommends that you complete the [Replicated Quick Start](/vendor/replicated-onboarding) workflow before getting started with KOTS. The workflow in _Replicated Quick Start_ demonstrates how to add a Helm chart to a release in the vendor platform and then install with the Helm CLI.
15
-
16
-
:::note
17
-
Packaging your application with Helm is recommended because it allows you to support both installations with the Helm CLI and with KOTS from the same release, without having to maintain separate sets of Helm charts or application manifests.
18
-
:::
19
-
20
-
* Alternatively, if you do _not_ intend to distribute a Helm application with Replicated, see [Install with KOTS in an Existing Cluster](tutorial-cli-setup) for a workflow that uses a sample application with Kubernetes manifests.
13
+
* Review [Replicated Onboarding](/vendor/replicated-onboarding) for more information about onboarding an application to the Replicated Platform before you get started with KOTS.
21
14
22
15
## Add Custom Resources
23
16
@@ -131,6 +124,6 @@ You can choose to use either Replicated Embedded Cluster or Replicated kURL to e
131
124
132
125
## Configure Additional Replicated Features
133
126
134
-
Review the [Features Checklist](/vendor/replicated-onboarding#features-checklist) in _Replicated Quick Start_ for a list of features to integrate with your application to fully onboard onto the Replicated platform.
127
+
See [Replicated Onboarding](/vendor/replicated-onboarding) for a list of features to integrate with your application to fully onboard onto the Replicated platform.
135
128
136
129
For example, you can add custom domains for the Replicated registry and app service, configure checks in your application for custom license entitlements, collect custom metrics using the Replicated SDK API, and more.
Copy file name to clipboardExpand all lines: docs/vendor/kots-faq.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ For vendors that do not want to use Helm, applications distributed with Replicat
22
22
23
23
Replicated recommends that new users start by completing one or more labs or tutorials to get familiar with the processes of creating, installing, and iterating on releases for an application with the Replicated Platform.
24
24
25
-
Then, when you are ready to begin onboarding your own application to the Replicated Platform, see [Replicated Quick Start](replicated-onboarding) for a list of Replicated features to begin integrating.
25
+
Then, when you are ready to begin onboarding your own application to the Replicated Platform, see [Replicated Onboarding](replicated-onboarding) for a list of Replicated features to begin integrating.
26
26
27
27
#### Labs
28
28
@@ -59,7 +59,7 @@ The phases are:
59
59
* Report
60
60
* Support
61
61
62
-
For more information about the Replicated features that enhance each phase of the lifecycle, see [About the Commerical Software Distribution Lifecycle](../intro-replicated#life-cycle) in _Introduction to Replicated_.
62
+
For more information about the Replicated features that enhance each phase of the lifecycle, see [Introduction to Replicated](../intro-replicated).
@@ -96,7 +95,7 @@ Replicated enforces the following logic when a license expires:
96
95
To change the behavior of your application when a license expires, you can can add custom logic in your application that queries the `expires_at` field using the Replicated SDK in-cluster API. For more information, see [Querying Entitlements with the Replicated SDK API](/vendor/licenses-reference-sdk).
97
96
* Expired licenses cannot log in to the Replicated registry to pull a Helm chart for installation or upgrade.
98
97
* Expired licenses cannot pull application images through the Replicated proxy registry or from the Replicated registry.
99
-
*(KOTS Only) KOTS prevents instances with expired licenses from receiving updates.
98
+
*In Replicated KOTS installations, KOTS prevents instances with expired licenses from receiving updates.
100
99
101
100
## About Customer Channel Assignment {#channel-assignment}
102
101
@@ -110,23 +109,6 @@ For example, if the latest release promoted to the Beta channel is version 1.25.
110
109
111
110
For more information about how to mark a release as required, see [Properties](releases-about#properties) in _About Channels and Releases_. For more information about how to synchronize licenses in the Admin Console, see [Updating Licenses](/enterprise/updating-licenses).
112
111
113
-
### Assigning KOTS and Helm-Only Customers
114
-
115
-
<KotsEntitlement/>
116
-
117
-
To prevent KOTS or Helm CLI-only customers from accessing a release that they cannot install, Replicated enforces the following channel assignment rules:
118
-
* A KOTS customer can be assigned to a channel only when the head release contains the required KOTS manifests.
119
-
120
-
<imgwidth="400px"alt="KOTS customer blocked from channel assignment"src="/images/channel-assignment-helm-only.png"/>
121
-
122
-
[View a larger version of this image](/images/channel-assignment-helm-only.png)
123
-
124
-
* A Helm CLI-only customer can be assigned to a channel only when the head release contains at least one Helm chart.
125
-
126
-
<imgwidth="400px"alt="Helm customer blocked from channel assignment"src="/images/channel-assignment-kots-only.png"/>
127
-
128
-
[View a larger version of this image](/images/channel-assignment-kots-only.png)
129
-
130
112
## About the Customers Page
131
113
132
114
The following shows an example of the **Customers** page:
@@ -145,7 +127,7 @@ From the **Customers** page, you can do the following:
145
127
146
128
* Click the **Manage customer** button to edit details such as the customer name and email, the custom license fields assigned to the customer, and the license expiration policy. For more information, see [Creating and Managing Customers](releases-creating-customer).
147
129
148
-
*(KOTS Only) Download the license file for each customer.
130
+
* Download the license file for each customer.
149
131
150
132
* Click the **Customer reporting** button to view data about the active application instances associated with each customer. For more information, see [Customer Reporting](customer-reporting).
|`appSlug`| Application slug value. This value never changes. |
10
14
|`channelID`| Current channel ID from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
11
15
|`channelName`| Current channel name from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
12
16
|`customerName`| The name of the customer. |
13
-
|`endpoint`| (KOTS Only) The endpoint that the Replicated Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
17
+
|`endpoint`| (KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
14
18
|`entitlements`| The `entitlements` property includes the `expires_at` field and any custom entitlements for the license. For more information about adding custom license fields, see [Managing Custom License Fields](licenses-adding-custom-fields).|
15
19
|`expires_at`| <p>Defines the expiration date for the license. The date is encoded in ISO 8601 format (`2026-01-23T00:00:00Z`) and is set to midnight UTC on the date selected. If a license does not expire, this field is missing.</p><p>By default, instances with an expired license continue to run. Additionally, instances installed with KOTS that have an expired license do not receive updates. For more information about the default behavior when a license expires, see [License Expiration Handling](licenses-about#expiration) in _About Customers_.</p>|
16
20
|`isAirgapSupported`| (KOTS Only) If a license supports air gapped installations, then this field is set to `true`. If air gapped is not supported, this field is missing. When you enable this feature, the `.rli` file will have license meta data embedded in it, and must be re-downloaded. |
0 commit comments