feat(sdk): add Replicated Helm Install values schema #3009
Conversation
✅ 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. |
There was a problem hiding this comment.
some small nitpicks, and 1 new ask:
there is also a top-level key replicated that has values we inject:
replicated:
enabled: true
appName: powerdns
channelID: 2jKkegBMseH5wJMR02vPYcC6Aii
channelName: Unstable
channelSequence: 33
integration:
enabled: true
license: {}
parentChartURL: oci://registry.replicated.com/powerdns/unstable/powerdns-authoritative
releaseCreatedAt: "2024-11-25T20:38:22Z"
releaseNotes: 'CLI release of adamancini/library-chart-pattern triggered by ada [SHA: 1457889-dirty] [25 Nov 24 15:38 EST]'
releaseSequence: 88
replicatedAppEndpoint: https://replicated.app
versionLabel: Unstable-1457889-dirty
replicated.license contains a License object:
apiVersion: kots.io/v1beta1
kind: License
metadata:
name: somebigbank
spec:
appSlug: powerdns
channelID: 2jKkegBMseH5wJMR02vPYcC6Aii
channelName: Unstable
channels:
- channelID: 2jbelsjWVVHmP3xQ0EnNhA2qXua
channelName: adamancini/library-chart-pattern
channelSlug: adamancini-library-chart-pattern
endpoint: https://replicated.app
replicatedProxyDomain: proxy.replicated.com
- channelID: 2jKkegBMseH5wJMR02vPYcC6Aii
channelName: Unstable
channelSlug: unstable
endpoint: https://replicated.app
isDefault: true
replicatedProxyDomain: proxy.replicated.com
- channelID: 2jnDLb5ihJNtfWG3l447jQG4H5K
channelName: library-chart-pattern
channelSlug: library-chart-pattern
endpoint: https://replicated.app
replicatedProxyDomain: proxy.replicated.com
- channelID: 2nRKXG7AJ07JXuDIQqyiaksUkgJ
channelName: Dev
channelSlug: dev
endpoint: https://replicated.app
replicatedProxyDomain: proxy.replicated.com
customerEmail: ada@replicated.com
customerName: some big bank
endpoint: https://replicated.app
entitlements:
expires_at:
description: License Expiration
signature: {}
title: Expiration
value: ""
valueType: String
isAirgapSupported: true
isDisasterRecoverySupported: true
isEmbeddedClusterDownloadEnabled: true
isKotsInstallEnabled: true
isSnapshotSupported: true
isSupportBundleUploadSupported: true
licenseID: 2jbfVR0m7tIy1tDec5ktplXuYvx
licenseSequence: 16
licenseType: dev
replicatedProxyDomain: proxy.replicated.com
signature: ey..J9
parentChartURL: oci://registry.replicated.com/powerdns/unstable/powerdns-authoritative
releaseCreatedAt: "2024-11-25T20:38:22Z"
releaseNotes: 'CLI release of adamancini/library-chart-pattern triggered by ada [SHA: 1457889-dirty] [25 Nov 24 15:38 EST]'
releaseSequence: 88
replicatedAppEndpoint: https://replicated.app
versionLabel: Unstable-1457889-dirty
| Here is an example of how to use the `global.replicated` values schema in your application: | ||
|
|
||
| ```yaml | ||
| dockerconfigjson: '{{ .Values.global.replicated.dockerconfigjson }}' |
There was a problem hiding this comment.
I can see the intent here, but this is probably not how I would show a sample of using this dockerconfigjson key - at face value, yeah it does make sense, it's syntactically correct, but I think putting it into context is a better example: https://docs.replicated.com/vendor/helm-image-registry#enable-the-proxy-registry
adamancini
changed the title
Really appreciate! Looks good to me. |
There was a problem hiding this comment.
Unrelated change: just moved this content out of the partial since it was only being used in one place in the docs
| The values in the `global.replicated` field provide information about the following: | ||
| * Details about the fields in the customer's license, such as the field name, description, signature, value, and any custom license fields that you define. You can use this license information to check license entitlments before the application is installed. For more information, see [Checking Entitlements in Helm Charts Before Deployment](/vendor/licenses-reference-helm). | ||
| * A base64 encoded Docker configuration file. To proxy images from an external private registry with the Replicated proxy registry, you can use the `global.replicated.dockerconfigjson` field to create an image pull secret for the proxy registry. For more information, see [Proxying Images for Helm Installations](/vendor/helm-image-registry). | ||
| During installation, the Replicated registry injects values into the `global.replicated` key of the parent Helm chart's values file. For more information about the values schema, see [Helm global.replicated Values Schema](helm-install-values-schema). |
There was a problem hiding this comment.
^ Replaced the existing content about global.replicated with a link to the new values schema topic
| @@ -0,0 +1,61 @@ | |||
| import SdkValues from "../partials/replicated-sdk/_sdk-values.mdx" | |||
|
|
|||
There was a problem hiding this comment.
Note: I renamed this topic from replicated-sdk-values-schema to helm-install-values-schema since the global.replicated field doesn't actually have anything to do with the sdk
|
|
||
| ## Replicated SDK Helm Values | ||
|
|
||
| <SdkValues/> |
There was a problem hiding this comment.
^ added the same info about the replicated sdk replicated values in the SDK overview topic as well
sidebars.js
Outdated
| 'vendor/install-with-helm', | ||
| 'vendor/helm-install-airgap', | ||
| 'vendor/using-third-party-registry-proxy', | ||
| 'vendor/helm-install-values-schema', |
There was a problem hiding this comment.
^ added the new values schema topic to the Helm Installations with Replicated section of the docs
|
Hi @adamancini , @DexterYan , @xavpaice , I made some updates to this PR to do the following:
When possible, could you review to make sure the technical content looks accurate and confirm that are OK with the edits? I'll hold off on merging until hearing back to make sure it looks good. Thanks! |
New page: https://deploy-preview-3009--replicated-docs.netlify.app/vendor/helm-install-values-schema