From 5dc0e7d0fecc0f00d8ac2da4e609d27b313910b8 Mon Sep 17 00:00:00 2001 From: Adarshkumar14 Date: Wed, 18 May 2022 14:53:29 +0530 Subject: [PATCH] Updating the Namespace Installation guide (#188) * adding doc for 2.9.0 Signed-off-by: Adarshkumar14 * updating the namespace Installation guide Signed-off-by: Adarshkumar14 * upating litmusctl documentation Signed-off-by: Adarshkumar14 * updating master doc Signed-off-by: Adarshkumar14 * some minor changes Signed-off-by: Adarshkumar14 --- website/docs/litmusctl/installation.md | 27 ++++++++---- ...haoscenter-namespace-scope-installation.md | 43 +++++++++++++------ .../version-2.9.0/litmusctl/installation.md | 28 ++++++++---- ...haoscenter-namespace-scope-installation.md | 43 +++++++++++++------ 4 files changed, 95 insertions(+), 46 deletions(-) diff --git a/website/docs/litmusctl/installation.md b/website/docs/litmusctl/installation.md index e73bfc7..b51a6e5 100644 --- a/website/docs/litmusctl/installation.md +++ b/website/docs/litmusctl/installation.md @@ -29,73 +29,82 @@ To install the latest version of litmusctl follow the below steps: + + - + + - + + - + + - + + - + + - + + - + + - + + -
Platformsv0.10.0v0.9.0 v0.7.0 v0.6.0 v0.5.0v0.4.0 master(Unreleased)
litmusctl-darwin-amd64 (MacOS)Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-386Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-amd64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-armClick hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-arm64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-386Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-amd64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-armClick hereClick here Click here Click here Click hereClick here Click here
diff --git a/website/docs/user-guides/chaoscenter-namespace-scope-installation.md b/website/docs/user-guides/chaoscenter-namespace-scope-installation.md index 2d3b2ad..7544ce5 100644 --- a/website/docs/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/docs/user-guides/chaoscenter-namespace-scope-installation.md @@ -101,18 +101,18 @@ Visit https://docs.litmuschaos.io/ to find more info. #### **Set the namespace on which you want to install Litmus ChaosCenter** -```bash -export LITMUS_PORTAL_NAMESPACE="" -kubectl get ns ${LITMUS_PORTAL_NAMESPACE} -``` -> If the namespace is not already present then create the target namespace `kubectl create ns ${LITMUS_PORTAL_NAMESPACE}` or `kubectl create ns ` +> Create a namespace `kubectl create ns ` + +```bash +kubectl create ns litmus +``` Expected Output ```bash NAME STATUS AGE -litmus Active 79m +litmus Active 2s ``` #### **Install the required Litmus CRDs** @@ -129,6 +129,7 @@ kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/lit customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/cronworkflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflows.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/workflowtasksets.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/chaosengines.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosexperiments.litmuschaos.io created @@ -141,27 +142,41 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0/litmus-namespaced-2.0.0.yaml --output litmus-portal-namespaced-K8s-template.yml -envsubst < litmus-portal-namespaced-K8s-template.yml > -${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -kubectl apply -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE} +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/2.9.0/litmus-namespaced-2.9.0.yaml -n ``` -> You need to export the namespace in order for the above step to work `export LITMUS_PORTAL_NAMESPACE=""`. Ignore if already done in the first step. +> You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation Expected Output ```bash +role.rbac.authorization.k8s.io/argo-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/argo-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-namespace-scope-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/litmus-namespace-scope-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/subscriber-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/subscriber-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-admin-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/litmus-admin-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/chaos-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/chaos-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/event-tracker-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/event-tracker-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-server-role created +rolebinding.rbac.authorization.k8s.io/litmus-server-rb created +serviceaccount/litmus-server-account created +secret/litmus-portal-admin-secret created configmap/litmus-portal-admin-config created +configmap/litmusportal-frontend-nginx-configuration created deployment.apps/litmusportal-frontend created service/litmusportal-frontend-service created -serviceaccount/litmus-server-account created -role.rbac.authorization.k8s.io/litmus-server created -rolebinding.rbac.authorization.k8s.io/litmus-server-rb created deployment.apps/litmusportal-server created service/litmusportal-server-service created +deployment.apps/litmusportal-auth-server created +service/litmusportal-auth-server-service created statefulset.apps/mongo created service/mongo-service created +service/mongo-headless-service created ``` ## **Verify your installation** diff --git a/website/versioned_docs/version-2.9.0/litmusctl/installation.md b/website/versioned_docs/version-2.9.0/litmusctl/installation.md index e73bfc7..f682586 100644 --- a/website/versioned_docs/version-2.9.0/litmusctl/installation.md +++ b/website/versioned_docs/version-2.9.0/litmusctl/installation.md @@ -27,75 +27,85 @@ For more information including a complete list of litmusctl operations, see the To install the latest version of litmusctl follow the below steps: + + + - + + - + + - + + - + + - + + - + + - + + - + + -
Platformsv0.10.0v0.9.0 v0.7.0 v0.6.0 v0.5.0v0.4.0 master(Unreleased)
litmusctl-darwin-amd64 (MacOS)Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-386Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-amd64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-armClick hereClick here Click here Click here Click hereClick here Click here
litmusctl-linux-arm64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-386Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-amd64Click hereClick here Click here Click here Click hereClick here Click here
litmusctl-windows-armClick hereClick here Click here Click here Click hereClick here Click here
diff --git a/website/versioned_docs/version-2.9.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-2.9.0/user-guides/chaoscenter-namespace-scope-installation.md index 02e07ee..7544ce5 100644 --- a/website/versioned_docs/version-2.9.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-2.9.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -101,18 +101,18 @@ Visit https://docs.litmuschaos.io/ to find more info. #### **Set the namespace on which you want to install Litmus ChaosCenter** -```bash -export LITMUS_PORTAL_NAMESPACE="" -kubectl get ns ${LITMUS_PORTAL_NAMESPACE} -``` -> If the namespace is not already present then create the target namespace `kubectl create ns ${LITMUS_PORTAL_NAMESPACE}` or `kubectl create ns ` +> Create a namespace `kubectl create ns ` + +```bash +kubectl create ns litmus +``` Expected Output ```bash NAME STATUS AGE -litmus Active 79m +litmus Active 2s ``` #### **Install the required Litmus CRDs** @@ -129,6 +129,7 @@ kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/lit customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/cronworkflows.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflows.argoproj.io created +customresourcedefinition.apiextensions.k8s.io/workflowtasksets.argoproj.io created customresourcedefinition.apiextensions.k8s.io/workflowtemplates.argoproj.io created customresourcedefinition.apiextensions.k8s.io/chaosengines.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/chaosexperiments.litmuschaos.io created @@ -141,27 +142,41 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/2.9.0/litmus-namespaced-2.9.0.yaml --output litmus-portal-namespaced-K8s-template.yml -envsubst < litmus-portal-namespaced-K8s-template.yml > -${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -kubectl apply -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE} +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/2.9.0/litmus-namespaced-2.9.0.yaml -n ``` -> You need to export the namespace in order for the above step to work `export LITMUS_PORTAL_NAMESPACE=""`. Ignore if already done in the first step. +> You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation Expected Output ```bash +role.rbac.authorization.k8s.io/argo-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/argo-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-namespace-scope-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/litmus-namespace-scope-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/subscriber-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/subscriber-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-admin-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/litmus-admin-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/chaos-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/chaos-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/event-tracker-role-for-litmusportal-server created +rolebinding.rbac.authorization.k8s.io/event-tracker-rb-for-litmusportal-server created +role.rbac.authorization.k8s.io/litmus-server-role created +rolebinding.rbac.authorization.k8s.io/litmus-server-rb created +serviceaccount/litmus-server-account created +secret/litmus-portal-admin-secret created configmap/litmus-portal-admin-config created +configmap/litmusportal-frontend-nginx-configuration created deployment.apps/litmusportal-frontend created service/litmusportal-frontend-service created -serviceaccount/litmus-server-account created -role.rbac.authorization.k8s.io/litmus-server created -rolebinding.rbac.authorization.k8s.io/litmus-server-rb created deployment.apps/litmusportal-server created service/litmusportal-server-service created +deployment.apps/litmusportal-auth-server created +service/litmusportal-auth-server-service created statefulset.apps/mongo created service/mongo-service created +service/mongo-headless-service created ``` ## **Verify your installation**