Skip to content

Commit

Permalink
chore: Update README/Schema for changed charts
Browse files Browse the repository at this point in the history
  • Loading branch information
hspitzley-czi committed Oct 24, 2024
1 parent 105b876 commit 3b675e3
Show file tree
Hide file tree
Showing 4 changed files with 911 additions and 0 deletions.
28 changes: 28 additions & 0 deletions argus-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,31 @@
A Helm chart for injecting Argus configuration into a deployment.

## Parameters

### Global parameters


### App context (provided by Argus API)

| Name | Description | Value |
| --------------------------------------------- | -------------------------------------------------- | ----- |
| `global.appContext.envContextConfigMapName` | App environment level configuration configmap name | `""` |
| `global.appContext.stackContextConfigMapName` | Stack level configuration configmap name | `""` |

### App secrets (provided by Argus API)

| Name | Description | Value |
| -------------------------------------------- | --------------------------------------------------------------- | --------- |
| `global.appSecrets.envSecret.secretName` | Environment-level Kube secret name to write External Secrets to | `""` |
| `global.appSecrets.envSecret.secretKey` | Environment-level secret key to map External Secrets from | `""` |
| `global.appSecrets.stackSecret.secretName` | Stack-level Kube secret name to write External Secrets to | `""` |
| `global.appSecrets.stackSecret.secretKey` | Stack-level secret key to map External Secrets from | `""` |
| `global.appSecrets.clusterSecret.secretName` | Cluster-level Kube secret name to write External Secrets to | `""` |
| `global.appSecrets.clusterSecret.secretKey` | Cluster-level secret key to map External Secrets from | `""` |
| `global.deploymentStage` | Deployment stage (eg: rdev, staging, prod) | `staging` |

### global.ingress Ingress configuration

| Name | Description | Value |
| --------------------- | ------------ | ---------------- |
| `global.ingress.host` | Ingress host | `foo.example.co` |
91 changes: 91 additions & 0 deletions argus-config/values.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
"title": "Chart Values",
"type": "object",
"properties": {
"global": {
"type": "object",
"properties": {
"appContext": {
"type": "object",
"properties": {
"envContextConfigMapName": {
"type": "string",
"description": "App environment level configuration configmap name",
"default": ""
},
"stackContextConfigMapName": {
"type": "string",
"description": "Stack level configuration configmap name",
"default": ""
}
}
},
"appSecrets": {
"type": "object",
"properties": {
"envSecret": {
"type": "object",
"properties": {
"secretName": {
"type": "string",
"description": "Environment-level Kube secret name to write External Secrets to",
"default": ""
},
"secretKey": {
"type": "string",
"description": "Environment-level secret key to map External Secrets from",
"default": ""
}
}
},
"stackSecret": {
"type": "object",
"properties": {
"secretName": {
"type": "string",
"description": "Stack-level Kube secret name to write External Secrets to",
"default": ""
},
"secretKey": {
"type": "string",
"description": "Stack-level secret key to map External Secrets from",
"default": ""
}
}
},
"clusterSecret": {
"type": "object",
"properties": {
"secretName": {
"type": "string",
"description": "Cluster-level Kube secret name to write External Secrets to",
"default": ""
},
"secretKey": {
"type": "string",
"description": "Cluster-level secret key to map External Secrets from",
"default": ""
}
}
}
}
},
"deploymentStage": {
"type": "string",
"description": "Deployment stage (eg: rdev, staging, prod)",
"default": "staging"
},
"ingress": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Ingress host",
"default": "foo.example.co"
}
}
}
}
}
}
}
Loading

0 comments on commit 3b675e3

Please sign in to comment.