Update info about installer-only annotation #2869
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
replicated-ci
added
type::docs
paigecalvert
commented
Dec 3, 2024
| <td>The latest release promoted to the channel where the customer is assigned must contain only Helm charts and Replicated Custom Resources. Any other Kubernetes resources must include the `kots.io/installer-only` annotation. See <a href="#installer-only-annotation">kots.io/installer-only Annotation</a> below.</td> | ||
| <td><p>Allows the customer to install with Helm in an existing cluster. The customer does not have access to the Replicated installers (Embedded Cluster, KOTS, and kURL).</p><p>When the <strong>Helm CLI Air Gap Instructions (Helm CLI only)</strong> install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See <a href="#install-options">Understanding Additional Install Options</a> below.</p></td> | ||
| <td> | ||
| <p>The latest release promoted to the channel where the customer is assigned must contain one or more Helm charts. It can also include Replicated custom resources, such as the Embedded Cluster Config custom resource, the KOTS HelmChart, Config, and Application custom resources, or the Troubleshoot Preflight and SupportBundle custom resources.</p> |
Contributor
Author
There was a problem hiding this comment.
^ Edited this description which previously said that the release must only include helm charts or Replicated resources. Now, it can include other resources as long as they have the annotation
Also added some examples of what we're talking about when we say Replicated custom resources
paigecalvert
commented
Dec 3, 2024
| <td><p>Allows the customer to install with Helm in an existing cluster. The customer does not have access to the Replicated installers (Embedded Cluster, KOTS, and kURL).</p><p>When the <strong>Helm CLI Air Gap Instructions (Helm CLI only)</strong> install option is also enabled, the Download Portal displays instructions on how to pull Helm installable images into a local repository. See <a href="#install-options">Understanding Additional Install Options</a> below.</p></td> | ||
| <td> | ||
| <p>The latest release promoted to the channel where the customer is assigned must contain one or more Helm charts. It can also include Replicated custom resources, such as the Embedded Cluster Config custom resource, the KOTS HelmChart, Config, and Application custom resources, or the Troubleshoot Preflight and SupportBundle custom resources.</p> | ||
| <InstallerOnlyAnnotation/> |
Contributor
Author
There was a problem hiding this comment.
^ Moved the info that was previously in the installer-only subsection below into the cell in the table, including the YAML sample. (Needed to make this a partial so that the YAML would render)
paigecalvert
commented
Dec 3, 2024
| </tr> | ||
| </table> | ||
|
|
||
| ### `kots.io/installer-only` Annotation {#installer-only-annotation} |
Contributor
Author
There was a problem hiding this comment.
Moved this info up into the cell in the table
paigecalvert
commented
Dec 3, 2024
| * You must have a customer in the Replicated Vendor Portal with a valid email address. This email address is only used as a username for the Replicated registry and is never contacted. For more information about creating and editing customers in the Vendor Portal, see [Creating a Customer](/vendor/releases-creating-customer). | ||
| * The customer used to install must have a valid email address. This email address is only used as a username for the Replicated registry and is never contacted. For more information about creating and editing customers in the Vendor Portal, see [Creating a Customer](/vendor/releases-creating-customer). | ||
|
|
||
| * The customer used to install must have the **Existing Cluster (Helm CLI)** install type enabled. For more information about enabling install types for customers in the Vendor Portal, see [Managing Install Types for a License](licenses-install-types). |
Contributor
Author
There was a problem hiding this comment.
^ Added this prerequisite to enable the Helm CLI install type for the customer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the requirements for the Helm install type to include the annotation YAML sample in the cell of the table: https://deploy-preview-2869--replicated-docs.netlify.app/vendor/licenses-install-types#install-types