Skip to content

Commit

Permalink
Update deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gohilankit committed Oct 7, 2022
1 parent 9750fe7 commit 97bf5c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
10 changes: 3 additions & 7 deletions docs/book/deployment/basicauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,8 @@
Below are the steps to configure, deploy & run cns-manager on a vanilla Kubernetes cluster with basic auth.

### Prepare the config
1. Capture kubeconfig of the cluster in which CNS manager is being deployed in a file named sv_kubeconfig.
Refer to sample config file provided under config folder. The kube config on master VM can be checked using below command:
```
// On master VM
cat ~/.kube/config
```
1. Capture kubeconfig of the cluster in which CNS manager is being deployed in a file named `sv_kubeconfig`.
Refer to sample config file provided under config folder.

2. Create a file named vc_creds.json and copy into it the credentials to your VC.
Refer to sample config file provided under config folder.
Expand All @@ -27,7 +23,7 @@ So the CNS manager endpoint would be <WORKER_NODE_IP>:30008.
Note : If your cloud provider supports a load balancer, you can choose to deploy a load balancer service instead. In that case, the CNS manager endpoint would be <LB_SVC_EXTERNAL_IP>:30008

Also if you need to change kubeconfig or VC creds after the deployment script has run, then you can either:
a. Recreate the secrets sv-kubeconfig & vc-creds created from these files and restart the cns- manager deployment, OR
a. Recreate the secrets `sv-kubeconfig` & `vc-creds` created from these files and restart the cns- manager deployment, OR
b. Delete the namespace and run the deployment script again.

### Deploy the application
Expand Down
10 changes: 3 additions & 7 deletions docs/book/deployment/oauth2.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,8 @@ CNS Manager uses oauth2-proxy for providing authentication using OIDC providers
Below are the steps to configure, deploy & run cns-manager on a vanilla Kubernetes cluster with OAuth2.

### Prepare the config
1. Capture kubeconfig of the cluster in which CNS manager is being deployed in a file named sv_kubeconfig.
Refer to sample config file provided under config folder. The kube config on master VM can be checked using below command:
```
// On master VM
cat ~/.kube/config
```
1. Capture kubeconfig of the cluster in which CNS manager is being deployed in a file named `sv_kubeconfig`.
Refer to sample config file provided under config folder.

2. Create a file named vc_creds.json and copy into it the credentials to your VC.
Refer to sample config file provided under config folder.
Expand All @@ -29,7 +25,7 @@ So the CNS manager endpoint would be <WORKER_NODE_IP>:30008.
Note : If your cloud provider supports a load balancer, you can choose to deploy a load balancer service instead. In that case, the CNS manager endpoint would be <LB_SVC_EXTERNAL_IP>:30008

Also if you need to change kubeconfig or VC creds after the deployment script has run, then you can either:
a. Recreate the secrets sv-kubeconfig & vc-creds created from these files and restart the cns- manager deployment, OR
a. Recreate the secrets `sv-kubeconfig` & `vc-creds` created from these files and restart the cns- manager deployment, OR
b. Delete the namespace and run the deployment script again.

### Register an OAuth application and Update configuration
Expand Down

0 comments on commit 97bf5c7

Please sign in to comment.