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/replicated-onboarding.mdx
+61-30Lines changed: 61 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,11 @@ import WriteYourDocs from "../partials/getting-started/_write-your-docs.mdx"
20
20
21
21
# Onboard to the Replicated Platform (Embedded Cluster v2)
22
22
23
-
This topic describes how to onboard applications to the Replicated Platform to support installations with Replicated Embedded Cluster v2. For more information, see [Embedded Cluster Overview](/embedded-cluster/v2/embedded-overview).
23
+
This topic describes how to onboard applications to the Replicated Platform to support installations with Replicated Embedded Cluster v2.
24
+
For more information, see [Embedded Cluster Overview](/embedded-cluster/v2/embedded-overview).
24
25
25
-
If you will support only Helm CLI installations for your application, see [Onboard to the Replicated Platform (Helm CLI installs only)](replicated-onboarding-helm-only).
26
+
If you will support only Helm CLI installations for your application,
27
+
see [Onboard to the Replicated Platform (Helm CLI installs only)](replicated-onboarding-helm-only) instead.
26
28
27
29
## Before you begin
28
30
@@ -64,7 +66,8 @@ Complete the tasks in this section to onboard your application to the Replicated
64
66
65
67
### Task 2: Modify image references in Helm values to point to the proxy registry {#task-2}
66
68
67
-
Update your Helm values so that image references point to the Replicated proxy registry rather than to your default registry. The proxy registry allows you to grant proxy access to application images without exposing registry credentials to your customers.
69
+
Update your Helm values so that image references point to the Replicated proxy registry rather than to your default registry.
70
+
The proxy registry allows you to grant proxy access to application images without exposing registry credentials to your customers.
68
71
69
72
To modify image references to point to the proxy registry:
70
73
@@ -82,7 +85,10 @@ To modify image references to point to the proxy registry:
82
85
83
86
Next, add the Replicated SDK as a dependency of your Helm chart and package the chart as a `.tgz` archive.
84
87
85
-
You can install the Replicated SDK as a small service alongside your application. The SDK provides access to key Replicated functionality, including an in-cluster API and automatic access to insights and operational telemetry for instances running in customer environments. For more information, see [About the Replicated SDK](/vendor/replicated-sdk-overview).
88
+
You can install the Replicated SDK as a small service alongside your application.
89
+
The SDK provides access to key Replicated functionality, including an in-cluster API.
90
+
It also provides automatic access to insights and operational telemetry for instances running in customer environments.
91
+
For more information, see [About the Replicated SDK](/vendor/replicated-sdk-overview).
86
92
87
93
To package your Helm chart with the Replicated SDK:
88
94
@@ -104,15 +110,17 @@ To package your Helm chart with the Replicated SDK:
104
110
105
111
### Task 4: Create the initial release with HelmChart and Embedded Cluster Config {#first-release}
106
112
107
-
After packaging your Helm chart, you can create a release. The initial release for your application will include the minimum files required to install a Helm chart with the Embedded Cluster v2 installer:
113
+
After packaging your Helm chart, you can create a release.
114
+
The initial release for your application will include the minimum files required to install a Helm chart with the Embedded Cluster v2 installer:
If you have multiple charts, you will add each chart archive to the release, plus a corresponding HelmChart custom resource for each archive.
113
120
114
121
:::note
115
-
Configuring the HelmChart custom resource includes several tasks and involves Replicated template functions. Depending on how many Helm charts your application uses, allow about two to three hours for configuring the HelmChart custom resource and creating and testing your initial release.
122
+
Configuring the HelmChart custom resource includes several tasks and involves Replicated template functions.
123
+
Depending on how many Helm charts your application uses, allow about two to three hours for this work.
116
124
:::
117
125
118
126
To create the first release for your application:
@@ -162,7 +170,7 @@ To create the first release for your application:
162
170
163
171
1. If you deploy your application as multiple Helm charts, repeat the previous steps to add and configure a separate HelmChart custom resource for each Helm chart archive in the release.
164
172
165
-
1. If any Helm chart values must be set for a successful installation, you can set them using the `values` key in the corresponding HelmChart custom resource. See [values](/reference/custom-resource-helmchart-v2#values) in _HelmChart v2_. If your default Helm values are sufficient for installation, you can skip this step.
173
+
1. If a successful installation requires specific Helm chart values, you can set them using the `values` key in the corresponding HelmChart custom resource. See [values](/reference/custom-resource-helmchart-v2#values) in _HelmChart v2_. If your default Helm values are sufficient for installation, you can skip this step.
166
174
167
175
:::note
168
176
This is a temporary measure to ensure the values get passed to the Helm chart during installation. You can undo this change after you configure the Admin Console Config screen in a later onboarding task.
@@ -180,11 +188,13 @@ To create the first release for your application:
180
188
181
189
1. Install the release in your development environment to test. See [Online installation with Embedded Cluster](/embedded-cluster/v2/installing-embedded).
182
190
183
-
After successfully installing the initial release on a VM with Embedded Cluster, go to the next task. You will continue to iterate throughout the rest of the onboarding process by creating and promoting new releases, then upgrading to the new version in your development environment.
191
+
After successfully installing the initial release on a VM with Embedded Cluster, go to the next task.
192
+
You will continue to iterate throughout the rest of the onboarding process by creating and promoting new releases, then upgrading to the new version in your development environment.
184
193
185
194
### Task 5: Customize the Admin Console {#admin-console}
186
195
187
-
Configure the Replicated Application custom resource to add an application name, icon, and status informers. The name and icon will be displayed in the Admin Console. The status informers will be used to display the application status on the Admin Console dashboard.
196
+
Configure the Replicated Application custom resource to add an application name, icon, and status informers.
197
+
The Admin Console displays the name and icon. The status informers display the application status on the Admin Console dashboard.
188
198
189
199
To configure the Replicated Application custom resource:
190
200
@@ -227,10 +237,12 @@ To configure the Replicated Application custom resource:
227
237
228
238
### Task 6: Set up the Admin Console Config screen and map to Helm values
229
239
230
-
The Admin Console Config screen is used to collect required and optional application configuration values from your users. User-supplied values provided on the Config screen can be mapped to your Helm values.
240
+
Use the Admin Console Config screen to collect required and optional application configuration values from your users.
241
+
You can map user-supplied values from the Config screen to your Helm values.
231
242
232
243
:::note
233
-
Setting up the Admin Console config screen can include the use of various types of input fields, conditional statements, and Replicated template functions. Depending on your application's configuration options, Replicated recommends that you allow about two to three hours for configuring the Config custom resource and testing the Admin Console config screen.
244
+
Setting up the Admin Console config screen can include various types of input fields, conditional statements, and Replicated template functions.
245
+
Depending on your application's configuration options, allow about two to three hours for configuring the Config custom resource and testing the Admin Console config screen.
234
246
:::
235
247
236
248
To set up the Admin Console Config screen for your application:
@@ -293,7 +305,7 @@ To define preflight checks for your application:
293
305
294
306
1. In your Helm chart `templates` directory, add a Kubernetes Secret that includes a preflight spec. For more information, see [Define preflight checks](/vendor/preflight-defining). For examples, see [Example preflight specs](/vendor/preflight-examples).
295
307
296
-
If your application is deployed as multiple Helm charts, add the Secret to the `templates` directory for the chart that is installed first.
308
+
If you deploy your application as multiple Helm charts, add the Secret to the `templates` directory for the chart you install first.
297
309
298
310
1. Update dependencies and package the chart as a `.tgz`:
299
311
@@ -341,15 +353,22 @@ To add the default support bundle spec to your application:
341
353
342
354
## Next steps
343
355
344
-
After completing the main onboarding tasks, Replicated recommends that you also complete the following additional tasks to integrate other Replicated features with your application. You can complete these next recommended tasks in any order and at your own pace.
356
+
After completing the main onboarding tasks,
357
+
Replicated recommends that you also complete the following additional tasks to integrate other Replicated features with your application.
358
+
You can complete these next recommended tasks in any order and at your own pace.
345
359
346
360
### Add support for Helm installations
347
361
348
-
Existing releases that include one or more Helm charts can be installed with the Helm CLI; it is not necessary to create and manage separate releases or channels for each installation method.
362
+
You can install existing releases that include one or more Helm charts with the Helm CLI.
363
+
You do not need to create and manage separate releases or channels for each installation method.
349
364
350
-
To enable Helm installations for Helm charts distributed with Replicated, the only extra step is to add a Secret to your chart to authenticate with the Replicated proxy registry.
365
+
To enable Helm installations for Helm charts distributed with Replicated,
366
+
add a Secret to your chart to authenticate with the Replicated proxy registry.
351
367
352
-
This is the same secret that is passed to Embedded Cluster in the HelmChart custom resource using `'{{repl ImagePullSecretName }}'`, which you did as part of [Task 4: Create and install the initial release](#first-release). So, whereas this Secret is created automatically for Embedded Cluster installations, you need to create it and add it to your Helm chart for Helm installations.
368
+
This is the same secret that passed to Embedded Cluster in the HelmChart custom resource using `'{{repl ImagePullSecretName }}'`,
369
+
which you did as part of [Task 4: Create and install the initial release](#first-release).
370
+
Whereas Embedded Cluster installations create this Secret automatically,
371
+
you need to create it and add it to your Helm chart for Helm installations.
353
372
354
373
To support and test Helm installations:
355
374
@@ -363,44 +382,56 @@ To support and test Helm installations:
363
382
364
383
1. Test the installation in a cluster where you have kubectl access. See [Create a cluster](/vendor/environment-setup#about-creating-a-cluster) in _Set Up Your Environment_.
365
384
366
-
1. In the cluster, istall the release with Helm to test your changes. For more information, see [Install with Helm](/vendor/install-with-helm).
385
+
1. In the cluster, install the release with Helm to test your changes. For more information, see [Install with Helm](/vendor/install-with-helm).
367
386
368
387
### Add support for air gap installations
369
388
370
-
Replicated supports installations in _air-gapped_ environments with little or no outbound internet access. For Embedded Cluster, users install with an air gap bundle that contains the required images for the Replicated installer and your application. For Helm installations, users log in to the Enterprise Portal and follow automatically-generated instructions to pull all images and push them to their local image registry.
389
+
Replicated supports installations in _air-gapped_ environments with little or no outbound internet access.
390
+
For Embedded Cluster, users install with an air gap bundle that contains the required images for the Replicated installer and your application.
391
+
For Helm installations, users log in to the Enterprise Portal. They then follow automatically-generated instructions to pull all images and push them to their local image registry.
371
392
372
-
There are additional steps to configure your releases to support installations in air-gapped environments. For more information, see [Add support for air gap installations](replicated-onboarding-air-gap).
393
+
There are additional steps to configure your releases to support installations in air-gapped environments.
394
+
For more information, see [Add support for air gap installations](replicated-onboarding-air-gap).
373
395
374
396
### Add roles for multi-node clusters in Embedded Cluster installations
375
397
376
-
The Embedded Cluster Config supports roles for multi-node clusters. One or more roles can be selected and assigned to a node when it is joined to the cluster. Node roles can be used to determine which nodes run the Kubernetes control plane, and to assign application workloads to particular nodes.
398
+
The Embedded Cluster Config supports roles for multi-node clusters.
399
+
You can select and assign one or more roles to a node when it joins the cluster.
400
+
Use node roles to determine which nodes run the Kubernetes control plane and to assign application workloads to particular nodes.
377
401
378
402
For more information, see [roles](/embedded-cluster/v2/embedded-config#roles) in _Embedded Cluster Config_.
379
403
380
404
### Add and map license entitlements
381
405
382
-
You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can use entitlements to:
383
-
* Limit the number of active users permitted
384
-
* Limit the number of nodes a customer is permitted on their cluster
406
+
You can add custom license entitlements for your application in the Vendor Portal.
407
+
Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can use entitlements to:
408
+
* Limit the number of active users
409
+
* Limit the number of nodes a customer can have in their cluster
385
410
* Identify a customer on a "Premium" plan that has access to additional features or functionality not available with your base plan
386
411
387
-
For more information about how to create and assign custom entitlements in the Vendor Portal, see [Manage customer license fields](/vendor/licenses-adding-custom-fields) and [Creating and managing customers](/vendor/releases-creating-customer).
412
+
For more information about how to create and assign custom entitlements in the Vendor Portal,
413
+
see [Manage customer license fields](/vendor/licenses-adding-custom-fields) and [Creating and managing customers](/vendor/releases-creating-customer).
388
414
389
415
#### Map entitlements to Helm values
390
416
391
-
You can map license entitlements to your Helm values using Replicated template functions. This is useful when you need to set certain values based on the user's license information. For more information, see [values](/reference/custom-resource-helmchart-v2#values) in _HelmChart v2_.
417
+
You can map license entitlements to your Helm values using Replicated template functions.
418
+
This is useful when you need to set certain values based on the user's license information.
419
+
For more information, see [values](/reference/custom-resource-helmchart-v2#values) in _HelmChart v2_.
392
420
393
421
#### Query entitlements before installation and at runtime
394
422
395
-
You can add logic to your application to query license entitlements both before deployment and at runtime. For example, you might want to add preflight checks that verify a user's entitlements before installing. Or, you can expose additional product functionality dynamically at runtime based on a customer's entitlements.
423
+
You can add logic to your application to query license entitlements both before deployment and at runtime.
424
+
For example, you might want to add preflight checks that verify a user's entitlements before installing.
425
+
Or, you can expose additional product functionality dynamically at runtime based on a customer's entitlements.
396
426
397
427
For more information, see:
398
428
* [Querying entitlements with the Replicated SDK API](/vendor/licenses-reference-sdk)
399
429
* [Checking entitlements in preflights with Replicated template functions](/vendor/licenses-referencing-fields)
400
430
401
431
### Add application links to the Admin Console dashboard
402
432
403
-
You can add the Kubernetes SIG Application custom resource to your release to add a link to your application from the Admin Console dashboard. This makes it easier for users to access your application after installation.
433
+
You can add the Kubernetes SIG Application custom resource to your release to add a link to your application from the Admin Console dashboard.
434
+
This makes it easier for users to access your application after installation.
404
435
405
436
You can also configure the Kubernetes SIG Application resource add links to other resources like documentation or dashboards.
406
437
@@ -418,9 +449,9 @@ Consider the following recommendations and best practices:
418
449
419
450
* Your support bundles will most likely need to include other collectors and analyzers that are not in your preflight checks. This is because some of the information used for troubleshooting (such as logs) is not necessary when running preflight checks before installation.
420
451
421
-
* If your application is installed as multiple Helm charts, you can optionally add separate support bundle specs in each chart. This can make it easier to keep the specs up-to-date and to avoid merge conflicts that can be caused when multiple team members contribute to a single, large support bundle spec. When an application has multiple support bundle specs, the specs are automatically merged when generating a support bundle so that only a single support bundle is provided to the user.
452
+
* If you install your application as multiple Helm charts, you can optionally add separate support bundle specs in each chart. This can make it easier to keep the specs up-to-date and to avoid merge conflicts when multiple team members contribute to a single, large support bundle spec. When an application has multiple support bundle specs, the support bundle generation process automatically merges the specs so that users receive only a single bundle.
422
453
423
-
The documentation for the open-source Troubleshoot project includes the full list of available collectors and analyzers that you can use. See [All collectors](https://troubleshoot.sh/docs/collect/all/) and the [Analyze](https://troubleshoot.sh/docs/analyze/) section in the Troubleshoot documentation.
454
+
The documentation for the opensource Troubleshoot project includes the full list of available collectors and analyzers that you can use. See [All collectors](https://troubleshoot.sh/docs/collect/all/) and the [Analyze](https://troubleshoot.sh/docs/analyze/) section in the Troubleshoot documentation.
424
455
425
456
You can also view common examples of collectors and analyzers used in preflight checks and support bundles in [Preflight spec examples](preflight-examples) and [Support bundle spec examples](support-bundle-examples).
426
457
@@ -432,7 +463,7 @@ For more information, see configure the disaster recovery feature for Embedded C
432
463
433
464
### Add custom metrics
434
465
435
-
In addition to the built-in insights displayed in the Vendor Portal by default (such as uptime and time to install), you can also configure custom metrics to measure instances of your application running in customer environments. Custom metrics can be collected for application instances running in online or air gap environments using the Replicated SDK.
466
+
The Vendor Portal displays built-in insights by default, such as uptime and time to install. You can also configure custom metrics to measure instances of your application running in customer environments. You can collect custom metrics for application instances running in online or air gap environments using the Replicated SDK.
436
467
437
468
For more information, see [Configure custom metrics](/vendor/custom-metrics).
0 commit comments