Skip to content

Commit

Permalink
Update Kubernetes installation instructions for YugabyteDB Anywhere w…
Browse files Browse the repository at this point in the history 
…ith version placeholders (#26168)
  • Loading branch information
@sudhanshu456
sudhanshu456 authored Feb 28, 2025
1 parent 597d0c8 commit 9abf529
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 79 deletions.
41 changes: 15 additions & 26 deletions ...view/yugabyte-platform/install-yugabyte-platform/install-software/kubernetes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,16 +154,22 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
1. Apply the following Custom Resource Definition:
```sh
kubectl apply -f https://raw.github.com/yugabyte/charts/2024.1/crds/concatenated_crd.yaml
kubectl apply -f https://raw.github.com/yugabyte/charts/{{< yb-version version="preview" format="short">}}/crds/concatenated_crd.yaml
```
1. Run the following `helm install` command to set the parameters from the preceding YAML file to install the YugabyteDB Anywhere (`yugaware`) Helm chart:
```sh
# Modify the fields kubernetesOperatorNamespace and defaultUser.password fields as required
helm install yugabytedb/yugaware \
--version 2024.1.0 \
--set kubernetesOperatorEnabled=true,kubernetesOperatorNamespace="yb-platform-test",defaultUser.enabled=true,defaultUser.password="Password#Test123"-generate-name
# Modify the fields kubernetesOperatorNamespace and defaultUser username, email and password fields as required
helm install yba yugabytedb/yugaware \
--version {{< yb-version version="preview" format="short">}} \
--namespace yb-platform \
--set yugaware.kubernetesOperatorEnabled=true \
--set yugaware.kubernetesOperatorNamespace='yb-platform-test' \
--set yugaware.defaultUser.enabled=true \
--set yugaware.defaultUser.username=yb_platform_user \
--set yugaware.defaultUser.email='yugabyte_k8s@yugabyte.com' \
--set yugaware.defaultUser.password='Password#Test123'
```
1. Verify that YBA is up, and the Kubernetes Operator is installed successfully using the following commands:
Expand All @@ -172,21 +178,6 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
kubectl get pods -n <yba_namespace>
```
```sh
kubectl get pods -n <operator_namespace>
```
```output
NAME READY STATUS RESTARTS AGE
chart-1706728534-yugabyte-k8s-operator-0 3/3 Running 0 26h
```
Additionally, you should see no stack traces, but the following messages in the `KubernetesOperatorReconciler` log:
```output
LOG.info("Finished running ybUniverseController");
```
1. Create the following custom resource, and save it as `demo-universe.yaml`.
```yaml
Expand All @@ -202,7 +193,7 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
enableNodeToNodeEncrypt: true
enableClientToNodeEncrypt: true
enableLoadBalancer: true
ybSoftwareVersion: "2024.1.0-b2" <- This will be the YBA version
ybSoftwareVersion: "{{< yb-version version="preview" format="build">}}" <- This will be the YBA version
enableYSQLAuth: false
enableYCQL: true
enableYCQLAuth: false
Expand All @@ -218,7 +209,7 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
1. Create a universe using the custom resource `demo-universe.yaml` as follows:
```sh
kubectl apply -f demo-universe.yaml -n yb-platform
kubectl apply -f demo-universe.yaml -n yb-platform-test
```
1. Check the status of the universe as follows:
Expand All @@ -228,10 +219,8 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
```
```output
NAME STATE SOFTWARE VERSION
anab-test-2 Ready 2.23.0.0-b33
anab-test-backups Ready 2.21.1.0-b269
anab-test-restore Ready 2.21.1.0-b269
NAME STATE SOFTWARE VERSION
demo-test Ready {{< yb-version version="preview" format="build">}}
```
For more details, see [Yugabyte Kubernetes Operator](../../../anywhere-automation/yb-kubernetes-operator/).
Expand Down
41 changes: 15 additions & 26 deletions ...able/yugabyte-platform/install-yugabyte-platform/install-software/kubernetes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,16 +154,22 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
1. Apply the following Custom Resource Definition:
```sh
kubectl apply -f https://raw.github.com/yugabyte/charts/2024.1/crds/concatenated_crd.yaml
kubectl apply -f https://raw.github.com/yugabyte/charts/{{< yb-version version="stable" format="short">}}/crds/concatenated_crd.yaml
```
1. Run the following `helm install` command to set the parameters from the preceding YAML file to install the YugabyteDB Anywhere (`yugaware`) Helm chart:
```sh
# Modify the fields kubernetesOperatorNamespace and defaultUser.password fields as required
helm install yugabytedb/yugaware \
--version 2024.1.0 \
--set kubernetesOperatorEnabled=true,kubernetesOperatorNamespace="yb-platform-test",defaultUser.enabled=true,defaultUser.password="Password#Test123"-generate-name
# Modify the fields kubernetesOperatorNamespace and defaultUser username, email and password fields as required
helm install yba yugabytedb/yugaware \
--version {{< yb-version version="stable" format="short">}} \
--namespace yb-platform \
--set yugaware.kubernetesOperatorEnabled=true \
--set yugaware.kubernetesOperatorNamespace='yb-platform-test' \
--set yugaware.defaultUser.enabled=true \
--set yugaware.defaultUser.username=yb_platform_user \
--set yugaware.defaultUser.email='yugabyte_k8s@yugabyte.com' \
--set yugaware.defaultUser.password='Password#Test123'
```
1. Verify that YBA is up, and the Kubernetes Operator is installed successfully using the following commands:
Expand All @@ -172,21 +178,6 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
kubectl get pods -n <yba_namespace>
```
```sh
kubectl get pods -n <operator_namespace>
```
```output
NAME READY STATUS RESTARTS AGE
chart-1706728534-yugabyte-k8s-operator-0 3/3 Running 0 26h
```
Additionally, you should see no stack traces, but the following messages in the `KubernetesOperatorReconciler` log:
```output
LOG.info("Finished running ybUniverseController");
```
1. Create the following custom resource, and save it as `demo-universe.yaml`.
```yaml
Expand All @@ -202,7 +193,7 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
enableNodeToNodeEncrypt: true
enableClientToNodeEncrypt: true
enableLoadBalancer: true
ybSoftwareVersion: "2024.1.0-b2" <- This will be the YBA version
ybSoftwareVersion: "{{< yb-version version="stable" format="build">}}" <- This will be the YBA version
enableYSQLAuth: false
enableYCQL: true
enableYCQLAuth: false
Expand All @@ -218,7 +209,7 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
1. Create a universe using the custom resource `demo-universe.yaml` as follows:
```sh
kubectl apply -f demo-universe.yaml -n yb-platform
kubectl apply -f demo-universe.yaml -n yb-platform-test
```
1. Check the status of the universe as follows:
Expand All @@ -228,10 +219,8 @@ To install YugabyteDB Anywhere and a universe using the Yugabyte Kubernetes Oper
```
```output
NAME STATE SOFTWARE VERSION
anab-test-2 Ready 2.23.0.0-b33
anab-test-backups Ready 2.21.1.0-b269
anab-test-restore Ready 2.21.1.0-b269
NAME STATE SOFTWARE VERSION
demo-test Ready {{< yb-version version="stable" format="build">}}
```
For more details, see [Yugabyte Kubernetes Operator](../../../anywhere-automation/yb-kubernetes-operator/).
Expand Down
43 changes: 16 additions & 27 deletions ...24.1/yugabyte-platform/install-yugabyte-platform/install-software/kubernetes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,39 +154,30 @@ To install YugabyteDB Anywhere (YBA) and a universe using the Yugabyte Kubernete
1. Apply the following Custom Resource Definition:
```sh
kubectl apply -f https://raw.github.com/yugabyte/charts/2024.1/crds/concatenated_crd.yaml
kubectl apply -f https://raw.github.com/yugabyte/charts/{{< yb-version version="v2024.1" format="short">}}/crds/concatenated_crd.yaml
```
1. Run the following `helm install` command to set the parameters from the preceding YAML file to install the YugabyteDB Anywhere (`yugaware`) Helm chart:
```sh
# Modify the fields kubernetesOperatorNamespace and defaultUser.password fields as required
helm install yugabytedb/yugaware \
--version 2024.1.0 \
--set kubernetesOperatorEnabled=true,kubernetesOperatorNamespace="yb-platform-test",defaultUser.enabled=true,defaultUser.password="Password#Test123"-generate-name
# Modify the fields kubernetesOperatorNamespace and defaultUser username, email and password fields as required
helm install yba yugabytedb/yugaware \
--version {{< yb-version version="v2024.1" format="short">}} \
--namespace yb-platform \
--set yugaware.kubernetesOperatorEnabled=true \
--set yugaware.kubernetesOperatorNamespace='yb-platform-test' \
--set yugaware.defaultUser.enabled=true \
--set yugaware.defaultUser.username=yb_platform_user \
--set yugaware.defaultUser.email='yugabyte_k8s@yugabyte.com' \
--set yugaware.defaultUser.password='Password#Test123'
```
1. Verify that YBA is up, and the Kubernetes Operator is installed successfully using the following commands:
1. Verify that YBA is up and the Kubernetes Operator is installed successfully using the following command:
```sh
kubectl get pods -n <yba_namespace>
```
```sh
kubectl get pods -n <operator_namespace>
```
```output
NAME READY STATUS RESTARTS AGE
chart-1706728534-yugabyte-k8s-operator-0 3/3 Running 0 26h
```
Additionally, you should see no stack traces, but the following messages in the `KubernetesOperatorReconciler` log:
```output
LOG.info("Finished running ybUniverseController");
```
1. Create the following custom resource, and save it as `demo-universe.yaml`.
```yaml
Expand All @@ -202,7 +193,7 @@ To install YugabyteDB Anywhere (YBA) and a universe using the Yugabyte Kubernete
enableNodeToNodeEncrypt: true
enableClientToNodeEncrypt: true
enableLoadBalancer: true
ybSoftwareVersion: "2024.1.0-b2" <- This will be the YBA version
ybSoftwareVersion: "{{< yb-version version="v2024.1" format="build">}}" <- This will be the YBA version
enableYSQLAuth: false
enableYCQL: true
enableYCQLAuth: false
Expand All @@ -218,7 +209,7 @@ To install YugabyteDB Anywhere (YBA) and a universe using the Yugabyte Kubernete
1. Create a universe using the custom resource `demo-universe.yaml` as follows:
```sh
kubectl apply -f demo-universe.yaml -n yb-platform
kubectl apply -f demo-universe.yaml -n yb-platform-test
```
1. Check the status of the universe as follows:
Expand All @@ -228,10 +219,8 @@ To install YugabyteDB Anywhere (YBA) and a universe using the Yugabyte Kubernete
```
```output
NAME STATE SOFTWARE VERSION
anab-test-2 Ready 2.23.0.0-b33
anab-test-backups Ready 2.21.1.0-b269
anab-test-restore Ready 2.21.1.0-b269
NAME STATE SOFTWARE VERSION
demo-test Ready {{< yb-version version="v2024.1" format="build">}}
```
For more details, see [Yugabyte Kubernetes Operator](../../../anywhere-automation/yb-kubernetes-operator/).
Expand Down

0 comments on commit 9abf529

Please sign in to comment.