Skip to content

Commit

Permalink
docs: add namespace creation (OT-CONTAINER-KIT#746)
Browse files Browse the repository at this point in the history
* Remove trailing whitespaces

Signed-off-by: Mathieu Cesbron <[email protected]>

* Add namespace creation on doc

Signed-off-by: Mathieu Cesbron <[email protected]>

---------

Signed-off-by: Mathieu Cesbron <[email protected]>
Signed-off-by: Matt Robinson <[email protected]>
  • Loading branch information
MathieuCesbron authored and mattrobinsonsre committed Jul 11, 2024
1 parent 04dd3fe commit 6858788
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## Local Kubernetes Cluster

For development and testing of operator on local system, we need to set up a [Minikube](https://minikube.sigs.k8s.io/docs/start/) or local Kubernetes cluster.
For development and testing of operator on local system, we need to set up a [Minikube](https://minikube.sigs.k8s.io/docs/start/) or local Kubernetes cluster.

Minikube is a single node Kubernetes cluster that generally gets used for the development and testing on Kubernetes. For creating a Minkube cluster we need to simply run:

Expand All @@ -28,7 +28,7 @@ $ minikube start --vm-driver virtualbox
⌛ Waiting for image downloads to complete ...
✨ Preparing Kubernetes environment ...
🚜 Pulling images required by Kubernetes v1.14.1 ...
🚀 Launching Kubernetes v1.14.1 using kubeadm ...
🚀 Launching Kubernetes v1.14.1 using kubeadm ...
⌛ Waiting for pods: apiserver proxy etcd scheduler controller dns
🔑 Configuring cluster permissions ...
🤔 Verifying component health .....
Expand Down Expand Up @@ -146,7 +146,8 @@ The operator deployment can be done via `helm` cli, we just need to define the c
```shell
$ helm upgrade redis-operator ot-helm/redis-operator \
--install --namespace ot-operators --set redisOperator.imageName=<custom-url> \
--install --create-namespace --namespace ot-operators \
--set redisOperator.imageName=<custom-url> \
--set redisOperator.imageTag=<customTag>
```
Expand All @@ -155,8 +156,8 @@ $ helm upgrade redis-operator ot-helm/redis-operator \
$ helm upgrade redis ot-helm/redis --namespace ot-operators
# For deploying cluster redis
$ helm upgrade redis-cluster ot-helm/redis-cluster \n
--set redisCluster.clusterSize=3 --install --namespace ot-operators \
$ helm upgrade redis-cluster ot-helm/redis-cluster \n
--set redisCluster.clusterSize=3 --install --namespace ot-operators \
--set pdb.enabled=false --set redisCluster.tag=v7.0.5-beta
```
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ $ helm repo add ot-helm https://ot-container-kit.github.io/helm-charts/

```shell
# Deploy the redis-operator
$ helm upgrade redis-operator ot-helm/redis-operator --install --namespace ot-operators
$ helm upgrade redis-operator ot-helm/redis-operator \
--install --create-namespace --namespace ot-operators
```

After deployment, verify the installation of operator
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/docs/Contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ The operator deployment can be done via `helm` cli, we just need to define the c
```shell
$ helm upgrade redis-operator ot-helm/redis-operator \
--install --namespace ot-operators --set redisOperator.imageName=<custom-url> \
--install --create-namespace --namespace ot-operators \
--set redisOperator.imageName=<custom-url> \
--set redisOperator.imageTag=<customTag>
```
Expand Down

0 comments on commit 6858788

Please sign in to comment.