-
Notifications
You must be signed in to change notification settings - Fork 31
feat(sdk): add Replicated Helm Install values schema #3009
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
paigecalvert
merged 12 commits into
main
from
dx/sc-118600/add-replicated-values-schema
Feb 14, 2025
Merged
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
221f6c1
feat(sdk): add values schema
DexterYan 31b8910
feat(sdk): update values schema
DexterYan 13118b2
feat(sdk): update values schema
DexterYan c1c55ee
feat(sdk): update values schema
DexterYan cda1da2
update
DexterYan 4626b4f
update
DexterYan f4ca076
update SDK values
adamancini 6b6466f
docs edits
paigecalvert 55cb64f
minor copyedits
paigecalvert b511ab0
add example of replicated sdk values
paigecalvert 0f3492c
edit example
paigecalvert 252377a
Merge branch 'main' into dx/sc-118600/add-replicated-values-schema
paigecalvert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Helm global.replicated Values Schema | ||
|
|
||
| This document describes the values injected by the Replicated registry when using the Helm CLI installation method. It describes the structure and purpose of fields to help developers integrate seamlessly with the Replicated SDK. | ||
|
|
||
| ## Overview | ||
|
|
||
| When a user installs a Helm application using the Helm CLI, the Replicated registry injects a set of customer-specific values into the `replicated` and `global.replicated` keys. | ||
|
|
||
| For additional information about the Replicated SDK, see [Replicated SDK Overview](/vendor/replicated-sdk-overview). | ||
|
|
||
| ## Values Schema Structure | ||
|
|
||
| The `replicated` schema contains the following fields: | ||
|
|
||
| | Field | Type | Description | | ||
| | --- | --- | --- | | ||
| | `enabled` | Boolean | Whether the Replicated SDK is enabled | | ||
| | `appName` | String | The name of the application | | ||
| | `channelID` | String | The unique ID of the release channel | | ||
| | `channelName` | String | The name of the release channel (e.g., "Stable", "Beta") | | ||
| | `channelSequence` | Integer | The sequence number of the channel | | ||
| | `integration.enabled` | Boolean | Whether integration features are enabled | | ||
| | `license` | String | The YAML representation of the customer license | | ||
| | `parentChartURL` | String | The URL of the parent Helm chart | | ||
| | `releaseCreatedAt` | String | The timestamp when the release was created | | ||
| | `releaseNotes` | String | Release notes for the current release | | ||
| | `releaseSequence` | Integer | The sequence number of the release | | ||
| | `replicatedAppEndpoint` | String | The Replicated app endpoint URL | | ||
| | `versionLabel` | String | The version label for the release | | ||
|
|
||
| The `global.replicated` values schema contains the following fields: | ||
|
|
||
| | Field | Type | Description | | ||
| | --- | --- | --- | | ||
| | `channelName` | String | The name of the release channel | | ||
| | `customerEmail` | String | The email address of the customer | | ||
| | `customerName` | String | The name of the customer | | ||
| | `dockerconfigjson` | String | Base64 encoded docker config json for pulling images | | ||
| | `licenseFields.expires_at.description` | String | Description of the license expiration | | ||
paigecalvert marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `licenseFields.expires_at.signature` | Object | Signature data for the expiration field | | ||
| | `licenseFields.expires_at.title` | String | Title of the expiration field | | ||
| | `licenseFields.expires_at.value` | String | Value of the expiration field | | ||
| | `licenseFields.expires_at.valueType` | String | Type of the expiration value | | ||
| | `licenseFields.expires_at.signature.v1` | String | Signature data for the license | | ||
| | `licenseID` | String | The unique identifier for the license | | ||
| | `licenseType` | String | The type of license (e.g., "dev", "prod") | | ||
|
|
||
| ## license Values Schema | ||
|
|
||
| The `license` field in the `global.replicated` values schema is a string that contains the YAML representation of the customer license: | ||
|
|
||
| ```yaml | ||
| apiVersion: kots.io/v1beta1 | ||
| kind: License | ||
| metadata: | ||
| name: name of the license | ||
| spec: | ||
| appSlug: The unique application slug that the customer is associated with. This value never changes. | ||
| channelID: The ID of the channel where the customer is assigned. | ||
| channelName: The name of the channel where the customer is assigned. | ||
| channels: | ||
| - channelID: The ID of the channel where the customer is assigned. | ||
| channelName: The name of the channel where the customer is assigned. | ||
| channelSlug: The unique channel slug. | ||
| endpoint: The default Replicated App endpoint https://replicated.app | ||
| replicatedProxyDomain: The domain of Replicated Proxy Registry. | ||
| customerEmail: The customer email address. | ||
| customerName: The name of the customer. | ||
| endpoint: This is the endpoint that the KOTS Admin Console uses to synchronize the licenses and download updates. | ||
| entitlements: | ||
| expires_at: | ||
| description: License Expiration | ||
| signature: {} | ||
| title: Expiration | ||
| value: "" | ||
| valueType: String | ||
| isAirgapSupported: If a license supports air gap installations with the Replicated installers (KOTS, kURL, Embedded Cluster), then this field is set to true. | ||
| isDisasterRecoverySupported: If a license supports the Embedded Cluster disaster recovery feature, this field is set to true. | ||
| isEmbeddedClusterDownloadEnabled: If a license supports installation with Replicated Embedded Cluster, this field is set to true or missing. | ||
| isKotsInstallEnabled: If a license supports installation with Replicated KOTS, this field is set to true. | ||
| isSnapshotSupported: If a license supports the snapshots backup and restore feature, this field is set to true. | ||
| isSupportBundleUploadSupported: If a license supports uploading a support bundle in the Admin Console, this field is set to true. | ||
| licenseID: Unique ID for the installed license. This value never changes. | ||
| licenseSequence: This value represents the license sequence that the client currently has. | ||
| licenseType: A string value that describes the type of the license | ||
| replicatedProxyDomain: proxy.replicated.com | ||
| signature: The base64-encoded license signature. This value will change when the license is updated. | ||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.