Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs with default compat matrix details #138

Merged
merged 8 commits into from
Jan 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
9 changes: 9 additions & 0 deletions artifacts/vanilla/vdo-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion config/default/manager_auth_proxy_patch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion config/manager/controller_manager_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 8 additions & 0 deletions config/vanilla_k8s/compat_matrix_configmap.yaml
Original file line number Diff line number Diff line change
@@ -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"
9 changes: 9 additions & 0 deletions config/vanilla_k8s/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Adds namespace to all resources.
namespace: vmware-system-vdo
# namespace: default

bases:
- ../default

resources:
- compat_matrix_configmap.yaml
2 changes: 2 additions & 0 deletions docs/getting-started/configure_drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions docs/getting-started/getting-started-from-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 3 additions & 15 deletions docs/getting-started/getting-started-via-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand All @@ -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

Expand Down