Skip to content

Commit

Permalink
Add documentation for deprecating disableCSI
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Negus <striker57@gmail.com>
  • Loading branch information
vivek-koppuru and chrisnegus committed May 25, 2023
1 parent e63a2d6 commit 375385e
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ Follow these steps to create an EKS Anywhere cluster that can be used either as
* Add [Optional]({{< relref "/docs/reference/clusterspec/optional/" >}}) configuration settings as needed.
See [Github provider]({{< relref "/docs/reference/clusterspec/optional/gitops#github-provider" >}}) to see how to identify your Git information.
* Create at least two control plane nodes, three worker nodes, and three etcd nodes for a production cluster, to provide high availability and rolling upgrades.
>**_Note:_** Installing CSI as part of vSphere cluster creation is now deprecated as of `v0.16.0`. Please refer to `disableCSI`
>[documentation]({{< relref "/docs/reference/clusterspec/vsphere#disablecsi-optional-deprecated" >}}) for more information.
1. Set Credential Environment Variables

Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ linkTitle: "What's New?"
weight: 35
---

{{% alert title="Warnings" color="warning" %}}
* EKS Anywhere releases `v0.15.0` - `v0.15.2` have an issue with Tinkerbell provider where BMC/IPMI calls time out for certain hardware.<br>
Please upgrade to `v0.15.3` if you are using Tinkerbell (Bare Metal) provider.
* Installing CSI as part of VSphere cluster creation is now deprecated as of `v0.16.0`. Please refer to `disableCSI`
[documentation]({{< relref "/docs/reference/clusterspec/vsphere#disablecsi-optional-deprecated" >}}) for more information.
{{% /alert %}}

## Unreleased

## [v0.15.4](https://github.com/aws/eks-anywhere/releases/tag/v0.15.4)
Expand Down
8 changes: 6 additions & 2 deletions docs/content/en/docs/reference/clusterspec/vsphere.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ metadata:
name: my-cluster-datacenter
spec:
datacenter: <span style="color:red">"datacenter1"</span> <a href="#datacenter-required"># vSphere datacenter name on which to deploy EKS Anywhere (required) </a>
disableCSI: false <a href="#disablecsi-optional"># Set to true to not have EKS Anywhere install and manage vSphere CSI driver</a>
disableCSI: false <a href="#disablecsi-optional-deprecated"># Deprecation warning: Click to see more. Set to true to not have EKS Anywhere install and manage vSphere CSI driver</a>
server: <span style="color:red">"myvsphere.local"</span> <a href="#server-required"># FQDN or IP address of vCenter server (required) </a>
network: <span style="color:red">"network1"</span> <a href="#network-required"># Path to the VM network on which to deploy EKS Anywhere (required) </a>
insecure: false <a href="#insecure-optional"># Set to true if vCenter does not have a valid certificate </a>
Expand Down Expand Up @@ -254,7 +254,11 @@ openssl x509 -sha1 -fingerprint -in ca.crt -noout
If you specify the wrong thumbprint, an error message will be printed with the expected thumbprint. If no valid
certificate is being used, `insecure` must be set to true.

### disableCSI (optional)
### disableCSI (optional) [DEPRECATED]
>**_NOTE:_** Installing CSI through EKS Anywhere is now deprecated as of v0.16.0. This field will be removed starting from
> v0.17.0 and setting `disableCSI` to `true` as mentioned below will be the default behavior. You can track this change with this
> [issue](https://github.com/aws/eks-anywhere/issues/5517).
Set `disableCSI` to `true` if you don't want to have EKS Anywhere install and manage the vSphere CSI driver for you.
More details on the driver are [here](https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/2.0/vmware-vsphere-csp-getting-started/GUID-C44D8071-85E7-4933-83EA-6797518C1837.html)

Expand Down

0 comments on commit 375385e

Please sign in to comment.