Skip to content

Commit 13118b2

Browse files
committed
feat(sdk): update values schema
1 parent 31b8910 commit 13118b2

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/vendor/replicated-sdk-values-schema.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,13 @@ The `global.replicated` values schema is a set of values that are injected by th
1818

1919
| Field | Type | Description |
2020
| --- | --- | --- |
21-
| `imagePullSecrets` | Array | An array of Kubernetes image pull secrets that are used to pull images from private registries. |
21+
| `global.imageRegistry` | String | The URL of the image registry where the replicated-sdk images are stored. |
22+
| `image.registry` | String | The URL of the image registry where the replicated-sdk images are stored. |
23+
| `image.repository` | String | The name of the replicated/replicated-sdk image repository. |
24+
| `image.tag` | String | The tag of the replicated/replicated-sdk image. |
25+
| `image.pullPolicy` | String | The Kubernetes image pull policy for the replicated/replicated-sdk image. |
26+
| `license` | String | The license ID of customer. |
27+
| `licenseFields` | string | The license fields of the customer. |
2228
| `appName` | String | The name of the application, as specified in the Replicated Vendor Portal. |
2329
| `channelID` | String | The unique ID of the release channel. |
2430
| `channelName` | String | The name of the release channel (e.g., “Stable”, “Beta”). |
@@ -29,3 +35,37 @@ The `global.replicated` values schema is a set of values that are injected by th
2935
| `versionLabel` | String | The version label for the release, often displayed in UI dashboards. |
3036
| `parentChartURL` | String | The URL of the parent Helm chart if the application is nested in a chart hierarchy. |
3137
| `statusInformers` | map | Configuration for custom status informers. Used for application health and status insights. |
38+
| `replicatedAppEndpoint` | String | If it is not using the default Replicated App endpoint https://replicated.app, this field specifies the endpoint to use. |
39+
| `serviceAccountName` | String | The name of the Kubernetes service account used by the Replicated SDK. |
40+
| `clusterRole` | String | The name of the Kubernetes cluster role used by the Replicated SDK. |
41+
| `imagePullSecrets` | Array | An array of Kubernetes image pull secrets that are used to pull images from private registries. |
42+
| `nameOverride` | String | Overrides the name of the chart. |
43+
| `namespaceOverride` | String | Overrides the namespace of the chart. |
44+
| `containerSecurityContext.enabled` | Boolean | Enables the security context for the container. |
45+
| `containerSecurityContext.runAsNonRoot`| Boolean | Runs the container as a non-root user. |
46+
| `containerSecurityContext.readOnlyRootFilesystem` | Boolean | Mounts the container’s root filesystem as read-only. |
47+
| `containerSecurityContext.allowPrivilegeEscalation` | Boolean | Allows privilege escalation for the container. |
48+
| `containerSecurityContext.capabilities.drop` | Array | Define which capabilities for dropping. |
49+
| `podSecurityContext.enabled` | Boolean | Enables the security context for the pod. |
50+
| `podSecurityContext.runAsUser` | Integer | The user ID for the pod. |
51+
| `podSecurityContext.runAsGroup` | Integer | The group ID for the pod. |
52+
| `podSecurityContext.fsGroup` | Integer | The group ID for the pod’s filesystem. |
53+
| `podSecurityContext.supplementalGroups` | Array | The supplemental groups for the pod. |
54+
| `podSecurityContext.seccompProfile.type` | String | The type of seccomp profile. |
55+
| `service.type` | String | The replicated-sdk service type. |
56+
| `service.port` | Integer | The port for the replicated-sdk service. |
57+
| `privateCAConfigmap` | String | The name of the ConfigMap that contains the private CA certificate. |
58+
| `privateCASecret` | String | The name of the Secret that contains the private CA certificate. |
59+
| `extraEnv` | Array | Additional environment variables to inject into the container. |
60+
| `integration.licenseID` | String | The license ID of the customer. |
61+
| `integration.enabled` | Boolean | Enables the integration. |
62+
| `integration.mockData` | string | The mock data for the integration. |
63+
| `isAirgap` | Boolean | Indicates whether the replicated is installed in airgap environment. |
64+
| `replicatedID` | String | The unique ID of the replicated-sdk instance cluster ID. |
65+
| `appID` | String | The unique ID of the replicated app slug. |
66+
| `tolerations` | Array | The tolerations for the pod. |
67+
| `affinity` | Object | The affinity for the pod. |
68+
69+
70+
## Using Replicated Registry Values
71+
With the Replicated proxy registry, each customer’s license information is injected into the application’s environment and grant proxy access to images in an external private registry.

0 commit comments

Comments
 (0)