Add Helm CLI only onboarding steps #3750
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
|
|
||
| <UnauthorizedError/> | ||
|
|
||
| 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. |
There was a problem hiding this comment.
^ I waited to tell them to package their chart(s) until after they added the SDK to the primary chart and then updated image refs throughout. In the next task, they'll add the chart archive to their first release
|
|
||
| ### Task 4: Add the HelmChart Custom Resource and Create a Release | ||
|
|
||
| For each Helm chart used by your application, add a unique Replicated HelmChart custom resource. Replicated uses the HelmChart resource to generate a list of the images that are used by your Helm chart. This enables features such as air gap installations and scanning and reporting on application images with the [Replicated Security Center (Alpha)](/vendor/security-center-about). For more information, see [HelmChart v2](/reference/custom-resource-helmchart-v2). |
There was a problem hiding this comment.
^ Describes what the HelmChart custom resource is/is for from the perspective of a Helm CLI only vendor
| ``` | ||
| :::note | ||
| For online (internet-connected) Helm CLI installations, you do not need to configure any additional fields in the HelmChart custom resource besides `chart.name` and `chart.chartVersion`. If you also plan to support Helm CLI installations in air-gapped environments, you will update the HelmChart custom resource as part of [Next Steps > Add Support for Air Gap Installations](#air-gap). | ||
| ::: |
There was a problem hiding this comment.
^ added this note to clarify that they just need to add the chart name and version for this first iteration in order to support online Helm cli installs
|
|
||
| After successfully installing the release in a cluster with the Helm CLI, go to the next task. You will continue to iterate throughout the rest of the onboarding process by creating and promoting new releases, then installing the new version in your development environment. | ||
|
|
||
| ### Task 5: Set up the Enterprise Portal |
There was a problem hiding this comment.
The next three tasks, including setting up the enterprise portal, adding a preflight spec, and adding a support bundle spec, are all the same steps as in the main Embedded Cluster onboarding workflow (https://deploy-preview-3750--replicated-docs.netlify.app/vendor/replicated-onboarding)
|
|
||
| ### Task 8: Alias Replicated Endpoints With Your Own Custom Domains {#custom-domains} | ||
|
|
||
| <CustomDomains/> |
There was a problem hiding this comment.
^ only difference for adding custom domains compared to the main embedded cluster onboarding flow is that for embedded cluster, you have to add your custom domains for the proxy registry and app service to the embedded cluster Config. For Helm CLI installs, there aren't any additional steps beyond what's listed in the partial
|
|
||
| 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. | ||
|
|
||
| ### Add Support for Air Gap Installations {#air-gap} |
There was a problem hiding this comment.
This is a new section on how to add air gap support for Helm CLI installs. We previously just had steps on adding support for air gap Embedded Cluster installs here: https://deploy-preview-3750--replicated-docs.netlify.app/vendor/replicated-onboarding#add-support-for-air-gap-installations
| Replicated recommends that you use Compatibility Matrix (CMX) to create an air-gapped environment for testing your releases. For more information, see [Test in Air Gap Environments](/vendor/testing-network-policy). | ||
| ::: | ||
|
|
||
| To add support for air gap installations with the Helm CLI: |
There was a problem hiding this comment.
^ Could use confirmation that this is the workflow for Helm CLI-only vendors to enable air gap installs
The one step that I wasn't certain about including was configuring the additionalImages field in the KOTS Application custom resource if there are any images that need to be listed in air gap install instructions that are not referenced in your Helm charts, like if you use a k8s operator. Wasn't sure if additionalImages might also be necessary/relevant for Helm CLI air gap installs
|
|
||
| 1. In the [Vendor Portal](https://vendor.replicated.com), go the channel where the release was promoted to build the air gap bundle. Do one of the following: | ||
| * If the **Automatically create airgap builds for newly promoted releases in this channel** setting is enabled on the channel, watch for the build status to complete. | ||
| * If automatic air gap builds are not enabled, go to the **Release history** page for the channel and build the air gap bundle manually. |
There was a problem hiding this comment.
^ note: this could also use confirmation. I am fairly certain that you need to trigger the air gap builder in order to get air gap install instructions in the enterprise portal
| 8. (Optional) Customize the support bundle spec by adding additional collectors and analyzers. | ||
|
|
||
| ### Task 9: Alias Replicated Endpoints with Your Own Domains | ||
| ### Task 9: Set Up the Enterprise Portal |
There was a problem hiding this comment.
^ Added these steps to enable Enterprise Portal to the main Embedded Cluster onboarding workflow as well. Previously, this was listed as an optional next step, and enterprise portal was still listed as Beta
| <EnterprisePortal/> | ||
|
|
||
| After adding a custom domain for the Replicated proxy registry, be sure to update any image references in your Helm chart values to point to your custom domain rather than the proxy registry at `proxy.replicated.com`. For more information, see [Task 2: Modify Image References in Helm Values to Point to the Proxy Registry](#task-2). | ||
| ### Task 10: Alias Replicated Endpoints With Your Own Domains {#custom-domains} |
There was a problem hiding this comment.
^ rewrote the custom domains task so that it uses actual numbered steps. previously, it just linked over to the relevant docs pages for more info
xavpaice
left a comment
xavpaice
left a comment
There was a problem hiding this comment.
Thanks, this covers what I was asking for plus more.
Adds a new onboarding workflow for Helm CLI-only (Builders) vendors. The main onboarding workflow for Helm CLI only vendors includes steps for:
This new Helm CLI only onboarding repurposes much of the existing content from the main onboarding workflow for Embedded Cluster by adding the reusable content to partials. Some tasks/steps/content that were reused include "Before Your Begin" content on best practices/getting help from the community, and onboarding steps on creating your application in the vendor portal, adding preflight/support bundle specs, setting up the enterprise portal, and more
As part of these changes, there were also some updates to the existing, main onboarding workflow to bring it up to date and make sure it includes all the same tasks (like setting up the enterprise portal)
Preview: Onboard to the Replicated Platform (Helm CLI Installs Only)