Update docs with default compat matrix details (#138)

* Update docs with default compat matrix

* Minor changes

* Minor changes

* Incorporating review comments

* Add configmap to artifacts

* Minor changes

* Minor changes

* Update the port metrics

Makefile

@@ -105,7 +105,7 @@ manifests: controller-gen kustomize ## Generate WebhookConfiguration, ClusterRol
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) output:rbac:dir=./config/rbac rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 	@mkdir -p $(ARTIFACTS_DIR)/vanilla
 	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default > $(ARTIFACTS_DIR)/vanilla/vdo-spec.yaml
+	$(KUSTOMIZE) build config/vanilla_k8s > $(ARTIFACTS_DIR)/vanilla/vdo-spec.yaml
 
 manifests-openshift: kustomize
 	@echo "** Making manifest based on the latest oc certified version $(OC_CERTIFIED_LATEST_VERSION)"

artifacts/vanilla/vdo-spec.yaml

@@ -577,6 +577,15 @@ subjects:
   namespace: vmware-system-vdo
 ---
 apiVersion: v1
+data:
+  auto-upgrade: disabled
+  versionConfigURL: https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases/download/0.1.1/compatibility.yaml
+kind: ConfigMap
+metadata:
+  name: compat-matrix-config
+  namespace: vmware-system-vdo
+---
+apiVersion: v1
 data:
   controller_manager_config.yaml: |
     apiVersion: controller-runtime.sigs.k8s.io/v1alpha1

config/default/manager_auth_proxy_patch.yaml

@@ -22,5 +22,5 @@ spec:
       - name: manager
         args:
         - "--health-probe-bind-address=:8081"
-        - "--metrics-bind-address=127.0.0.1:8080"
+        - "--metrics-bind-address=127.0.0.1:8089"
         - "--leader-elect"

config/manager/controller_manager_config.yaml

@@ -3,7 +3,7 @@ kind: ControllerManagerConfig
 health:
   healthProbeBindAddress: :8081
 metrics:
-  bindAddress: 127.0.0.1:8080
+  bindAddress: 127.0.0.1:8089
 webhook:
   port: 9443
 leaderElection:

config/vanilla_k8s/compat_matrix_configmap.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: compat-matrix-config
+  namespace: vmware-system-vdo
+data:
+  versionConfigURL: "https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases/download/0.1.1/compatibility.yaml"
+  auto-upgrade: "disabled"

config/vanilla_k8s/kustomization.yaml

@@ -0,0 +1,9 @@
+# Adds namespace to all resources.
+namespace: vmware-system-vdo
+# namespace: default
+
+bases:
+  - ../default
+
+resources:
+  - compat_matrix_configmap.yaml

docs/getting-started/configure_drivers.md

@@ -96,5 +96,7 @@ Allow Root Access? (Y/N) y█
 
 To get more info on Net Permissions, please refer [CSI](https://vsphere-csi-driver.sigs.k8s.io/driver-deployment/installation.html#vsphereconf_for_file) document
 
+**Note**: For CSI driver version >= 2.5, that does not rely on vSphere Cloud Provider in order to obtain the VM node uuid, VDO updates the `internal-feature-states.csi.vsphere.vmware.com` configmap to set the "use-csinode-id" key as true.
+
 
 This completes VDO configuration. You can check the status of drivers using `vdoctl status` command.

docs/getting-started/getting-started-from-release.md

@@ -91,6 +91,7 @@ Tip: Compatibility matrix has been configured, you might want to try 'vdoctl con
 ```
 The Compatibility matrix used can be found [here (compatibility.yaml)](https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases/)
 
+**Note:** vdoctl deploys vdo with a default compatibility matrix. This uses the default matrix available at [compatibility.yaml](https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases/). Once VDO is deployed, user can choose to update the compatiblity matrix using [vdoctl update command](../vdoctl/vdoctl_update_compatibility-matrix.md)
 
 #### Configure Drivers
 

docs/getting-started/getting-started-via-code.md

@@ -63,7 +63,7 @@ export K8S_MASTER_SSH_PWD=PASSWORD
 make deploy-k8s-cluster
 ```
 
-Refer the [MakeFile](../Makefile) for more details.
+Refer the [MakeFile](../../Makefile) for more details.
 
 
 ### Deploying Drivers
@@ -83,20 +83,6 @@ compatibility-matrix using `vdoctl` command line tool. You can either use the
 self made binary of vdoctl from the above steps or you can download the
 vdoctl binary from our release page and place the binary in your system path.
 
-```shell
-vdoctl configure compatibility-matrix
-✔ Web URL
-Web URL https://raw.githubusercontent.com/asifdxtreme/Docs/master/sample/matrix/matrix.yaml
-```
-Note: You can either use this sample url or create your own matrix.
-
-Local file path can be provided by appending `file:/` before the absolute path
-
-For example,
-Matrix located at `$HOME/matrix.yaml` can be provided as
-```shell
-file:/$HOME/matrix.yaml
-```
 
 Generally with each new release a New Compatibility Matrix will be released,
 you can get more details from [here](https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases).
@@ -107,6 +93,8 @@ kubectl get pods -n vmware-system-vdo
 vmware-system-vdo    vdo-controller-manager-66758456d8-mnqgv      2/2     Running   0          99s
 ```
 
+**Note:** vdoctl deploys vdo with a default compatibility matrix. This uses the default matrix available at [compatibility.yaml](https://github.com/vmware-tanzu/vsphere-kubernetes-drivers-operator/releases/). Once VDO is deployed, user can choose to update the compatiblity matrix using [vdoctl update command](../vdoctl/vdoctl_update_compatibility-matrix.md)
+
 #### Configure Drivers
 vdoctl configure drivers command is used to provide VDO with the necessary configuration enabling VDO to install/configure vSphere CPI and CSI drivers