From e57531acce2285ae1720faafcd74c5709fa1fd50 Mon Sep 17 00:00:00 2001 From: Mathieu Cesbron <45229023+MathieuCesbron@users.noreply.github.com> Date: Thu, 11 Jan 2024 09:34:53 +0100 Subject: [PATCH] docs: add namespace creation (#746) * Remove trailing whitespaces Signed-off-by: Mathieu Cesbron * Add namespace creation on doc Signed-off-by: Mathieu Cesbron --------- Signed-off-by: Mathieu Cesbron --- CONTRIBUTING.md | 11 ++++++----- README.md | 3 ++- docs/content/en/docs/Contribute/_index.md | 3 ++- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efb2f47d7..6cb1cf5ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: @@ -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 ..... @@ -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= \ + --install --create-namespace --namespace ot-operators \ + --set redisOperator.imageName= \ --set redisOperator.imageTag= ``` @@ -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 ``` diff --git a/README.md b/README.md index 18a916b7a..a5e4b7fa0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/content/en/docs/Contribute/_index.md b/docs/content/en/docs/Contribute/_index.md index a0639bd17..d4104bc7d 100644 --- a/docs/content/en/docs/Contribute/_index.md +++ b/docs/content/en/docs/Contribute/_index.md @@ -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= \ + --install --create-namespace --namespace ot-operators \ + --set redisOperator.imageName= \ --set redisOperator.imageTag= ```