Skip to content

Commit

Permalink
Update chart installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Sep 30, 2018
1 parent 308bbeb commit 3eedc4a
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 50 deletions.
2 changes: 1 addition & 1 deletion chart/kubedb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following table lists the configurable parameters of the KubeDB chart and th
| `apiserver.versionPriority` | The ordering of this API inside of the group. | 15 |
| `apiserver.enableValidatingWebhook` | Enable validating webhooks for KubeDB CRDs | `true` |
| `apiserver.enableMutatingWebhook` | Enable mutating webhooks for KubeDB CRDs | `true` |
| `apiserver.ca` | CA certificate used by main Kubernetes api server | `` |
| `apiserver.ca` | CA certificate used by main Kubernetes api server | `not-ca-cert` |
| `apiserver.disableStatusSubresource` | If true, disables status sub resource for crds. Otherwise enables based on Kubernetes version | `false` |
| `enableAnalytics` | Send usage events to Google Analytics | `true` |

Expand Down
8 changes: 8 additions & 0 deletions chart/kubedb/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
To verify that KubeDB has started, run:

kubectl --namespace={{ .Release.Namespace }} get deployments -l "release={{ .Release.Name }}, app={{ template "kubedb.name" . }}"

If you have not installed kubedb-catalog chart, run:

helm install appscode/kubedb-catalog --name kubedb-catalog

If you have already installed kubedb-catalog, upgrade using the following command:

helm upgrade kubedb-catalog appscode/kubedb-catalog
14 changes: 7 additions & 7 deletions chart/kubedb/templates/mutating-webhook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/elasticsearches
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -31,7 +31,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/postgreses
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -44,7 +44,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/mysqls
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -57,7 +57,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/mongodbs
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -70,7 +70,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/redises
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -83,7 +83,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/memcacheds
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -96,7 +96,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/mutators.kubedb.com/v1alpha1/etcds
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand Down
18 changes: 9 additions & 9 deletions chart/kubedb/templates/validating-webhook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/elasticsearches
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -31,7 +31,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/postgreses
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -44,7 +44,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/mysqls
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -57,7 +57,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/mongodbs
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -70,7 +70,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/redises
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -83,7 +83,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/memcacheds
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -96,7 +96,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/etcds
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -109,7 +109,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/snapshots
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand All @@ -122,7 +122,7 @@ webhooks:
namespace: default
name: kubernetes
path: /apis/validators.kubedb.com/v1alpha1/dormantdatabases
caBundle: {{ default "not-ca-cert" .Values.apiserver.ca | b64enc }}
caBundle: {{ b64enc .Values.apiserver.ca }}
rules:
- apiGroups: ["kubedb.com"]
apiVersions: ["*"]
Expand Down
2 changes: 1 addition & 1 deletion chart/kubedb/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ apiserver:
# enableValidatingWebhook is used to configure validating webhook for KubeDB CRDs
enableValidatingWebhook: true
# CA certificate used by main Kubernetes api server
ca:
ca: not-ca-cert
# If true, disables status sub resource for crds.
# Otherwise, enables status sub resource for Kubernetes version >= 1.11 and disables for other versions.
disableStatusSubresource: false
Expand Down
33 changes: 1 addition & 32 deletions docs/setup/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,20 +129,8 @@ NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb 0.9.0-beta.0 0.9.0-beta.0 KubeDB by AppsCode - Production ready databases ...
appscode/kubedb-catalog 0.9.0-beta.0 0.9.0-beta.0 KubeDB Catalog by AppsCode - Catalog for database versions

# Step 1(a): Kubernetes 1.9.x - 1.10.x
$ helm install appscode/kubedb --name kubedb-operator --version 0.9.0-beta.0 \
--namespace kube-system \
--set apiserver.ca="$(onessl get kube-ca)" \
--set apiserver.enableValidatingWebhook=true \
--set apiserver.enableMutatingWebhook=true

# Step 1(b): Kubernetes 1.11.0 or later
$ helm install appscode/kubedb --name kubedb-operator --version 0.9.0-beta.0 \
--namespace kube-system \
--set apiserver.ca="$(onessl get kube-ca)" \
--set apiserver.enableValidatingWebhook=true \
--set apiserver.enableMutatingWebhook=true \
--set apiserver.enableStatusSubresource=true
--namespace kube-system

# Step 2: wait until crds are registered
$ kubectl get crds -l app=kubedb -w
Expand All @@ -168,25 +156,6 @@ snapshots.kubedb.com 6s
$ helm install appscode/kubedb-catalog --name kubedb-catalog
```

To install `onessl`, run the following commands:

```console
# Mac OSX amd64:
curl -fsSL -o onessl https://github.com/kubepack/onessl/releases/download/0.7.0/onessl-darwin-amd64 \
&& chmod +x onessl \
&& sudo mv onessl /usr/local/bin/

# Linux amd64:
curl -fsSL -o onessl https://github.com/kubepack/onessl/releases/download/0.7.0/onessl-linux-amd64 \
&& chmod +x onessl \
&& sudo mv onessl /usr/local/bin/

# Linux arm64:
curl -fsSL -o onessl https://github.com/kubepack/onessl/releases/download/0.7.0/onessl-linux-arm64 \
&& chmod +x onessl \
&& sudo mv onessl /usr/local/bin/
```

To see the detailed configuration options, visit [here](https://github.com/kubedb/cli/tree/master/chart/kubedb).

</div>
Expand Down

0 comments on commit 3eedc4a

Please sign in to comment.