You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,11 @@
1
1
# cloud-native-storage-self-service-manager
2
2
3
-
CNS Manager is a diagnostic and self-service tool that helps detect and auto-remediate some of the known issues in storage control plane in vCenter. It also provides certain table stake features, such as datastore decommission to complement the Cloud Native Storage solution offered in vCenter.
4
-
CNS Manager exposes APIs that can be invoked by authorized users to detect issues.
3
+
CNS Manager is a diagnostic and self-service tool that helps detect and auto-remediate some of the known issues in storage control plane in vCenter.
5
4
5
+
This repository provides artifacts for deploying CNS manager in a [vSphere Supervisor 8.0 cluster](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/vsphere-supervisor-concepts-and-planning/vsphere-iaas-control-plane-concepts/what-is-vsphere-with-tanzu.html), as well as the client sdk to invoke its endpoints.
6
6
7
-
This repository provides artifacts for deploying CNS manager in Supervisor cluster[#TODO: add a link], as well as the client sdk to invoke its endpoints.
8
-
9
-
## Deploying cns-manager
10
-
CNS manager needs to be deployed in one of the namespaces running on [Supervisor Management Zones](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0.html) in the vCenter.
7
+
## Deploying cns-manager on vSphere Supervisor 8.0
8
+
CNS manager needs to be deployed in one of the namespaces running on the Supervisor in the vCenter.
11
9
If there are multiple Kubernetes clusters in a vCenter, it's recommended that it be deployed in a dedicated admin-managed cluster, but it's not a must. However, the admin should be responsible to secure the Kubernetes cluster where CNS manager is deployed since it will have credentials to vCenter and the Kubernetes cluster.
12
10
Also if you want CNS manager to be highly available, deploy it on a Kubernetes cluster that's highly available itself.
13
11
@@ -17,7 +15,7 @@ The deployment is supported with two authentication mechanisms to limit who can
17
15
1. Basic Auth - The CNS manager admin can choose fixed credentials at the time of deployment. This auth mechanism is less secure than OAuth2 to be used in Production. Nevertheless, it can be used for a quick deployment to test the application and in air-gapped environments where the vCenter is not connected to the internet.
18
16
See these [instructions](docs/book/deployment/basicauth.md) for basic auth deployment.
19
17
20
-
2. OAuth2 - With OAuth2, the authentication is delegated to an OIDC provider such as Gitlab, Github,Google etc. It does require creating an OAuth application on the OIDC provider before deploying CNS manager.
18
+
2. OAuth2 - With OAuth2, the authentication is delegated to an OIDC provider such as Gitlab, Github,Google etc. It does require creating an OAuth application on the OIDC provider before deploying CNS manager.
21
19
See these [instructions](docs/book/deployment/oauth2.md) for OAuth2 deployment.
22
20
23
21
## Enabling TLS for your deployment
@@ -34,7 +32,7 @@ The following section explains how to register a Kubernetes cluster with CNS man
34
32
**1. Generate a kubeconfig with minimal privileges for CNS manager:**
35
33
* The provided script `scripts/get-kubeconfig.sh` generates a kubeconfig for CNS manager with minimal privileges required for its functioning. But if you're fine with providing admin kubeconfig for the cluster to be registered, you can skip kubeconfig generation part mentioned below and directly jump to cluster registration part.
36
34
37
-
Note : The script may not work on all Kubernetes distributions if they don't adhere to the [recommended steps](https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/2.0/vmware-vsphere-csp-getting-started/GUID-A1982536-F741-4614-A6F2-ADEE21AA4588.html) for deploying vSphere CSI driver.
35
+
Note : The script may not work on all Kubernetes distributions if they don't adhere to the [recommended steps](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/container-storage-plugin/3-0/getting-started-with-vmware-vsphere-container-storage-plug-in-3-0.html) for deploying vSphere CSI driver.
38
36
39
37
* The script takes 2 mandatory input parameters. First is the path to the cluster's kubeconfig file and the second is the name of the file where the generated kubeconfig file with minimal privileges should be stored. Here is how you can run the script:
Copy file name to clipboardExpand all lines: docs/book/supported_scale.md
+1-9Lines changed: 1 addition & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,4 @@
3
3
This topic provides the configuration limits for CNS manager and the features it offers. When you use CNS manager in your environment, stay within the supported and recommended limits.
4
4
5
5
**Number of Kubernetes clusters in vCenter registered with CNS manager**
6
-
32
7
-
8
-
9
-
**Number of concurrent PV migrations**
10
-
On CNS manager application level, there can be 8 volume migrations that can be invoked in parallel across all clusters.
11
-
And on vCenter level, the limits for simultaneous migrations can be be derived from this document - https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-25EA5833-03B5-4EDD-A167-87578B8009B3.html
12
-
13
-
This translates to concurrent migration limits to be 1 per VM(for attached volumes), 2 per host & 8 per datastore.
14
-
If there are parallel FCD migrations invoked beyond these limits, they will be queued based on the limits for each type of resource. CNS manager supports queueing upto 400 volumes at any given time.
0 commit comments