Skip to content

Commit

Permalink
Use helm oci charts
Browse files Browse the repository at this point in the history
Signed-off-by: Tamal Saha <[email protected]>
  • Loading branch information
tamalsaha committed Dec 9, 2023
1 parent a48416d commit fdfd080
Show file tree
Hide file tree
Showing 35 changed files with 125 additions and 172 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,11 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
The license server will email us with a "license.txt" file attached after we provide the necessary data. Run the following commands listed below to install KubeDB.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,11 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
The license server will email us with a "license.txt" file attached after we provide the necessary data. Run the following commands listed below to install KubeDB.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,11 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
The license server will email us with a "license.txt" file attached after we provide the necessary data. Run the following commands listed below to install KubeDB.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

Verify the installation by the following command,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ e5b4a1a0-5a67-4657-b390-db7200108bae
```

The license server will email us with a "license.txt" file attached after we provide the necessary data. To install KubeDB, run the following commands,

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,11 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
After giving the required information, the license server will send us an email with a "license.txt" file attached. We will run the following commands listed below to install KubeDB.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,16 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'

After providing the necessary information, we will get an email from the license server which includes a `license.txt` file. Now, we will run the following helm commands to install KubeDB.


```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

You can verify the KubeDB installation by the following command,


```bash
$ kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAMESPACE NAME READY STATUS RESTARTS AGE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,11 @@ $ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'
The license server will email us with a "license.txt" file attached after we provide the necessary data. Run the following commands listed below to install KubeDB.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

Verify the installation by the following command,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,16 @@ fc435a61-c74b-9243-83a5-f1110ef2462c

After providing the required information, we will receive an email from the license server including a `license.txt` file. To install KubeDB, use the following helm commands.


```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version v2023.12.11 \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

Verify the KubeDB installation by the following command,


```bash
$ kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubedb"
NAMESPACE NAME READY STATUS RESTARTS AGE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,12 @@ On the other hand, `DenyList` contains all the rejected versions for the update
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running.

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

### spec.stash
Expand Down
7 changes: 5 additions & 2 deletions content/docs/v2023.12.11/guides/kafka/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,12 @@ On the other hand, `DenyList` contains all the rejected versions for the upgrade
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running.

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

## Next Steps
Expand Down
7 changes: 5 additions & 2 deletions content/docs/v2023.12.11/guides/memcached/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,11 @@ The default value of this field is `false`. If `spec.deprecated` is set `true`,
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running. To use a user-defined policy, the name of the polict has to be set in `spec.podSecurityPolicies` and in the list of allowed policy names in KubeDB operator like below:

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
--set additionalPodSecurityPolicies[0]=custom-db-policy
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

## Next Steps
Expand Down
7 changes: 5 additions & 2 deletions content/docs/v2023.12.11/guides/mongodb/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,12 @@ On the other hand, `DenyList` contains all the rejected versions for the update
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running.

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

## Next Steps
Expand Down
7 changes: 5 additions & 2 deletions content/docs/v2023.12.11/guides/postgres/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,12 @@ The default value of this field is `false`. If `spec.deprecated` is set `true`,
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running.

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy
--set additionalPodSecurityPolicies[1]=custom-snapshotter-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

## Next Steps
Expand Down
7 changes: 5 additions & 2 deletions content/docs/v2023.12.11/guides/redis/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,11 @@ On the other hand, `DenyList` contains all the rejected versions for the update
`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running. To use a user-defined policy, the name of the policy has to be set in `spec.podSecurityPolicies` and in the list of allowed policy names in KubeDB operator like below:

```bash
helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \
--set additionalPodSecurityPolicies[0]=custom-db-policy
helm upgrade -i kubedb oci://ghcr.io/appscode-charts/kubedb \
--namespace kubedb --create-namespace \
--set additionalPodSecurityPolicies[0]=custom-db-policy \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

## Next Steps
Expand Down
56 changes: 10 additions & 46 deletions content/docs/v2023.12.11/setup/install/kubedb.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,40 +86,23 @@ If you are willing to purchase KubeDB but need more time to test in your dev clu
KubeDB can be installed via [Helm](https://helm.sh/) using the [chart](https://github.com/kubedb/installer/tree/{{< param "info.installer" >}}/charts/kubedb) from [AppsCode Charts Repository](https://github.com/appscode/charts). To install, follow the steps below:

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update

$ helm search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb {{< param "info.version" >}} {{< param "info.version" >}} KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler {{< param "info.autoscaler" >}} {{< param "info.autoscaler" >}} KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Custom Resource Definitions
appscode/kubedb-dashboard {{< param "info.dashboard" >}} {{< param "info.dashboard" >}} KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards {{< param "info.version" >}} {{< param "info.version" >}} A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics {{< param "info.version" >}} {{< param "info.version" >}} KubeDB State Metrics
appscode/kubedb-ops-manager {{< param "info.ops-manager" >}} {{< param "info.ops-manager" >}} KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner {{< param "info.provisioner" >}} {{< param "info.provisioner" >}} KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager {{< param "info.schema-manager" >}} {{< param "info.schema-manager" >}} KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server {{< param "info.ui-server" >}} {{< param "info.ui-server" >}} A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server {{< param "info.webhook-server" >}} {{< param "info.webhook-server" >}} KubeDB Webhook Server by AppsCode

$ helm install kubedb appscode/kubedb \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

{{< notice type="warning" message="If you are using **private Docker registries** using *self-signed certificates*, please pass the registry domains to the operator like below:" >}}

```
$ helm install kubedb appscode/kubedb \
```bash
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set global.insecureRegistries[0]=hub.example.com \
--set global.insecureRegistries[1]=hub2.example.com \
--set-file global.license=/path/to/the/license.txt
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
```

To see the detailed configuration options, visit [here](https://github.com/kubedb/installer/tree/{{< param "info.installer" >}}/charts/kubedb).
Expand All @@ -132,26 +115,7 @@ To see the detailed configuration options, visit [here](https://github.com/kubed
If you prefer to not use Helm, you can generate YAMLs from KubeDB chart and deploy using `kubectl`. Here we are going to show the procedure using Helm 3.

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update

$ helm search repo appscode/kubedb
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/kubedb {{< param "info.version" >}} {{< param "info.version" >}} KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler {{< param "info.autoscaler" >}} {{< param "info.autoscaler" >}} KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-crds {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Custom Resource Definitions
appscode/kubedb-dashboard {{< param "info.dashboard" >}} {{< param "info.dashboard" >}} KubeDB Dashboard by AppsCode
appscode/kubedb-grafana-dashboards {{< param "info.version" >}} {{< param "info.version" >}} A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-metrics {{< param "info.version" >}} {{< param "info.version" >}} KubeDB State Metrics
appscode/kubedb-ops-manager {{< param "info.ops-manager" >}} {{< param "info.ops-manager" >}} KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter {{< param "info.version" >}} {{< param "info.version" >}} KubeDB Opscenter by AppsCode
appscode/kubedb-provisioner {{< param "info.provisioner" >}} {{< param "info.provisioner" >}} KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager {{< param "info.schema-manager" >}} {{< param "info.schema-manager" >}} KubeDB Schema Manager by AppsCode
appscode/kubedb-ui-server {{< param "info.ui-server" >}} {{< param "info.ui-server" >}} A Helm chart for kubedb-ui-server by AppsCode
appscode/kubedb-webhook-server {{< param "info.webhook-server" >}} {{< param "info.webhook-server" >}} KubeDB Webhook Server by AppsCode

$ helm template kubedb appscode/kubedb \
$ helm template kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
Expand All @@ -160,8 +124,8 @@ $ helm template kubedb appscode/kubedb \

{{< notice type="warning" message="If you are using **private Docker registries** using *self-signed certificates*, please pass the registry domains to the operator like below:" >}}

```
$ helm template kubedb appscode/kubedb \
```bash
$ helm template kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set-file global.license=/path/to/the/license.txt \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Let's install KubeDB with operator monitoring enabled.
**Helm 3:**

```bash
$ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set kubedb-provisioner.monitoring.enabled=true \
--set kubedb-provisioner.monitoring.agent=prometheus.io/builtin \
Expand All @@ -60,7 +61,8 @@ $ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
**YAML (with Helm 3):**

```bash
$ helm template kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm template kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set kubedb-provisioner.monitoring.enabled=true \
--set kubedb-provisioner.monitoring.agent=prometheus.io/builtin \
Expand Down
6 changes: 4 additions & 2 deletions content/docs/v2023.12.11/setup/monitoring/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ You have to provides these flags while installing or upgrading or updating KubeD
**Helm 3:**

```bash
$ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set monitoring.enabled=true \
--set monitoring.agent=prometheus.io/operator \
Expand All @@ -124,7 +125,8 @@ $ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
**YAML (with Helm 3):**

```bash
$ helm template kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm template kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--set monitoring.enabled=true \
--set monitoring.agent=prometheus.io/operator \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Let's install KubeDB operator with monitoring enabled.
**Helm 3:**

```bash
$ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm install kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--no-hooks \
--set monitoring.enabled=true \
Expand All @@ -61,7 +62,8 @@ $ helm install kubedb appscode/kubedb --version {{< param "info.version" >}} \
**YAML (with Helm 3):**

```bash
$ helm template kubedb appscode/kubedb --version {{< param "info.version" >}} \
$ helm template kubedb oci://ghcr.io/appscode-charts/kubedb \
--version {{< param "info.version" >}} \
--namespace kubedb --create-namespace \
--no-hooks \
--set monitoring.enabled=true \
Expand Down
Loading

0 comments on commit fdfd080

Please sign in to comment.