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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ This section includes guidance and prerequisites to review before you begin onbo
32
32
33
33
The following are some best practices and recommendations for successfully onboarding with Replicated:
34
34
35
-
* When integrating new Replicated features with an application, make changes in small iterations and test frequently by installing or upgrading the application in a development environment. This will help you to more easily identify issues and troubleshoot. This onboarding workflow will guide you through the process of integrating features in small iterations.
35
+
* When integrating new Replicated features with an application, make changes in small iterations and test frequently by installing or upgrading the application in a development environment. This will help you identify issues and troubleshoot. This onboarding workflow will guide you through the process of integrating features in small iterations.
36
36
37
37
* Use the Replicated CLI to create and manage your application and releases. Getting familiar with the Replicated CLI will also help later on when integrating Replicated workflows into your CI/CD pipelines.
38
38
@@ -56,41 +56,41 @@ The following are some best practices and recommendations for successfully onboa
56
56
57
57
## Onboard
58
58
59
-
Complete the tasks in this section to onboard your application to the Replicated Platform. When you are done, you can continue to [Next steps](#next-steps) to integrate other Replicated features with your application.
59
+
Complete the tasks in this section to onboard your application to the Replicated Platform. When you finish, you can continue to [Next steps](#next-steps) to integrate other Replicated features with your application.
60
60
61
61
### Task 1: Create an application
62
62
63
63
<CreateApp/>
64
64
65
65
### Task 2: Modify image references in Helm values to point to the proxy registry {#task-2}
66
66
67
-
Update your Helm values so that image references point to the Replicated proxy registry rather than to your default registry. The proxy regsitry allows you to grant proxy access to application images without exposing registry credentials to your customers.
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.
68
68
69
69
To modify image references to point to the proxy registry:
70
70
71
71
1. <StepCreds/>
72
72
73
73
1. <RewriteHelmValues/>
74
74
75
-
1. If your application is deployed as multiple Helm charts, repeat the previous step to modify image references in the Helm values for each of your charts.
75
+
1. If you deploy your application as multiple Helm charts, repeat the previous step to modify image references in the Helm values for each of your charts.
76
76
77
77
1. Continue to the next task.
78
78
79
-
As part of [Task 4: Create the initial release with HelmChart and Embedded Cluster Config](#first-release), you will inject a Replicated-generated pull secret into your Helm values that grants authentication to pull your private images through the proxy registry.
79
+
As part of [Task 4: Create the initial release with HelmChart and Embedded Cluster Config](#first-release), you will inject a Replicated-generated pull secret into your Helm values. This pull secret grants authentication to pull your private images through the proxy registry.
80
80
81
81
### Task 3: Add the Replicated SDK and package your chart
82
82
83
83
Next, add the Replicated SDK as a dependency of your Helm chart and package the chart as a `.tgz` archive.
84
84
85
-
The Replicated SDK is a Helm chart that can be installed 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).
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).
86
86
87
87
To package your Helm chart with the Replicated SDK:
88
88
89
89
1. Go to the local directory where your Helm chart is.
90
90
91
-
1. In your application Helm chart `Chart.yaml` file, add the YAML below to declare the SDK as a dependency.
91
+
1. In your application Helm chart `Chart.yaml` file, add the following YAML to declare the SDK as a dependency.
92
92
93
-
If your application is installed as multiple charts, declare the SDK as a dependency of the chart that customers install first. Do not declare the SDK in more than one chart. For more information, see [Package a Helm chart for a release](helm-install-release).
93
+
If you install your application as multiple charts, declare the SDK as a dependency of the chart that customers install first. Do not declare the SDK in more than one chart. For more information, see [Package a Helm chart for a release](helm-install-release).
94
94
95
95
<DependencyYaml/>
96
96
@@ -100,7 +100,7 @@ To package your Helm chart with the Replicated SDK:
100
100
101
101
<UnauthorizedError/>
102
102
103
-
1. If your application is deployed as multiple Helm charts, package each chart as a separate `.tgz` archive using the `helm package -u PATH_TO_CHART` command. Do not declare the SDK in more than one chart.
103
+
1. If you deploy your application as multiple Helm charts, package each chart as a separate `.tgz` archive using the `helm package -u PATH_TO_CHART` command. Do not declare the SDK in more than one chart.
104
104
105
105
### Task 4: Create the initial release with HelmChart and Embedded Cluster Config {#first-release}
106
106
@@ -112,7 +112,7 @@ After packaging your Helm chart, you can create a release. The initial release f
112
112
If you have multiple charts, you will add each chart archive to the release, plus a corresponding HelmChart custom resource for each archive.
113
113
114
114
:::note
115
-
Configuring the HelmChart custom resource includes several tasks, and involves the use of Replicated template functions. Depending on how many Helm charts your application uses, Replicated recommends that you allow about two to three hours for configuring the HelmChart custom resource and creating and testing your initial release.
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.
116
116
:::
117
117
118
118
To create the first release for your application:
@@ -121,7 +121,7 @@ To create the first release for your application:
121
121
122
122
1. In the `manifests` directory:
123
123
124
-
1. Move the `.tgz` chart archive that you packaged. If your application is deployed as multiple Helm charts, move each `.tgz` archive to `manifests`.
124
+
1. Move the `.tgz` chart archive that you packaged. If you deploy your application as multiple Helm charts, move each `.tgz` archive to `manifests`.
125
125
126
126
1. Create an `embedded-cluster.yaml` file with the following default Embedded Cluster Config:
127
127
@@ -130,7 +130,7 @@ To create the first release for your application:
130
130
<details>
131
131
<summary>What is the Embedded Cluster Config?</summary>
132
132
133
-
An Embedded Cluster Config must be included in the release to install with Embedded Cluster. The Embedded Cluster Config lets you define several aspects of the Kubernetes cluster that is created.
133
+
You must include an Embedded Cluster Config in the release to install with Embedded Cluster. The Embedded Cluster Config lets you define several aspects of the Kubernetes cluster that Embedded Cluster creates.
134
134
</details>
135
135
136
136
For more information, see [Use Embedded Cluster](/embedded-cluster/v2/embedded-overview).
@@ -160,15 +160,15 @@ To create the first release for your application:
160
160
161
161
1. <InjectPullSecret/>
162
162
163
-
1. If your application is deployed 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.
163
+
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
164
165
-
1. If there are values in any of your Helm charts that need to be set for the installation to succeed, you can set those values 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.
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.
166
166
167
167
:::note
168
-
This is a temporary measure to ensure the values get passed to the Helm chart during installation until you configure the Admin Console Config screen in a later onboarding task.
168
+
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.
169
169
:::
170
170
171
-
1. If your application requires that certain components are deployed before the application and as part of the Embedded Cluster itself, then update the Embedded Cluster Config to add [extensions](/embedded-cluster/v2/embedded-config#extensions). Extensions allow you to provide Helm charts that are deployed before your application. For example, one situation where this is useful is if you want to ship an ingress controller because Embedded Cluster does not include one.
171
+
1. If your application requires that certain components deploy before the application and as part of the Embedded Cluster itself, update the Embedded Cluster Config to add [extensions](/embedded-cluster/v2/embedded-config#extensions). Extensions allow you to provide Helm charts that deploy before your application. For example, one situation where this is useful is if you want to ship an ingress controller because Embedded Cluster does not include one.
172
172
173
173
For more information, see [extensions](/embedded-cluster/v2/embedded-config#extensions) in _Embedded Cluster Config_.
0 commit comments