Skip to content

Commit 7257cf9

Browse files
ArnobKumarSahaArnobKumarSaha
authored
Update readmes (#1031)
Signed-off-by: Arnob kumar saha <arnob@appscode.com>
1 parent d8ef764 commit 7257cf9

21 files changed

Lines changed: 683 additions & 320 deletions

File tree

‎charts/kubedbcom-cassandra-editor/README.md‎

Lines changed: 58 additions & 57 deletions
Large diffs are not rendered by default.

‎charts/kubedbcom-clickhouse-editor/README.md‎

Lines changed: 19 additions & 15 deletions
Large diffs are not rendered by default.

‎charts/kubedbcom-db2-editor/README.md‎

Lines changed: 11 additions & 14 deletions
Large diffs are not rendered by default.

‎charts/kubedbcom-documentdb-editor/README.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,24 @@ The command removes all the Kubernetes components associated with the chart and
4545

4646
The following table lists the configurable parameters of the `kubedbcom-documentdb-editor` chart and their default values.
4747

48-
| Parameter | Description | Default |
49-
|--------------------|-------------|----------------------------------|
50-
| apiVersion | | <code>kubedb.com/v1alpha2</code> |
51-
| kind | | <code>DocumentDB</code> |
52-
| metadata.name | | <code>documentdb</code> |
53-
| metadata.namespace | | <code>default</code> |
48+
| Parameter | Description | Default |
49+
|----------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
50+
| metadata.resource.group | | <code>kubedb.com</code> |
51+
| metadata.resource.version | | <code>v1alpha2</code> |
52+
| metadata.resource.name | | <code>documentdbs</code> |
53+
| metadata.resource.kind | | <code>DocumentDB</code> |
54+
| metadata.resource.scope | | <code>Namespaced</code> |
55+
| metadata.release.name | | <code>RELEASE-NAME</code> |
56+
| metadata.release.namespace | | <code>default</code> |
57+
| resources.autoscalingKubedbComDocumentDBAutoscaler | | <code>{"apiVersion":"autoscaling.kubedb.com/v1alpha1","kind":"DocumentDBAutoscaler","metadata":{"name":"documentdb","namespace":"demo"},"spec":{"compute":{"documentdb":{"maxAllowed":{"cpu":1,"memory":"2Gi"},"minAllowed":{"cpu":"400m","memory":"400Mi"},"podLifeTimeThreshold":"10m","resourceDiffPercentage":20,"trigger":"On"},"nodeTopology":{"name":"standard-basv2-family"}},"databaseRef":{"name":"documentdb"},"opsRequestOptions":{"apply":"IfReady","timeout":"10m"}}}</code> |
58+
| resources.kubedbComDocumentDB | | <code>{"apiVersion":"kubedb.com/v1alpha2","kind":"DocumentDB","metadata":{"name":"documentdb","namespace":"default"},"spec":{"deletionPolicy":"WipeOut","podTemplate":{"spec":{"containers":[{"name":"documentdb","resources":{"limits":{"cpu":"500m","memory":"1Gi"}}}],"nodeSelector":{"app":"documentdbs.kubedb.com","instance":"hello","namespace":"default","nodepool":"standard-bsv2-family"},"podPlacementPolicy":{"name":"default"},"tolerations":[{"effect":"NoSchedule","key":"app","operator":"Equal","value":"documentdbs.kubedb.com"},{"effect":"NoSchedule","key":"instance","operator":"Equal","value":"hello"},{"effect":"NoSchedule","key":"namespace","operator":"Equal","value":"default"},{"effect":"NoSchedule","key":"nodepool","operator":"Equal","value":"standard-bsv2-family"}]}},"replicas":3,"serviceTemplates":[{"alias":"primary","spec":{"type":"LoadBalancer"}}],"storage":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}},"storageClassName":"default"},"storageType":"Durable","version":"24.4.1"}}</code> |
59+
| resources.secret_auth | | <code>{"apiVersion":"v1","kind":"Secret","metadata":{"name":"documentdb-auth","namespace":"demo"},"stringData":{"password":"thisIs1StrongPassword","username":"root"},"type":"Opaque"}</code> |
5460

5561

5662
Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade -i`. For example:
5763

5864
```bash
59-
$ helm upgrade -i kubedbcom-documentdb-editor appscode/kubedbcom-documentdb-editor -n default --create-namespace --version=v0.33.0 --set apiVersion=kubedb.com/v1alpha2
65+
$ helm upgrade -i kubedbcom-documentdb-editor appscode/kubedbcom-documentdb-editor -n default --create-namespace --version=v0.33.0 --set metadata.resource.group=kubedb.com
6066
```
6167

6268
Alternatively, a YAML file that specifies the values for the parameters can be provided while

0 commit comments

Comments
 (0)