WIP feat(sdk): add values schema #3009
Draft
Conversation
This file contains 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. |
adamancini
approved these changes
Jan 29, 2025
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
| # Add image URL in the values file | ||
| apiImageRepository: proxy.replicated.com/proxy/my-app/quay.io/my-org/api | ||
| apiImageTag: v1.0.1 | ||
| ``` |
There was a problem hiding this comment.
for style, sections between code blocks should have a newline in between them:
```
In your deployment manifest you can reference ....
```yaml
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.
No description provided.