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 vanilla install notes with escape character note #569

Merged
merged 2 commits into from
May 2, 2024
Merged
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
14 changes: 14 additions & 0 deletions docs/vanilla.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ port = "443"
% kubectl -n <velero-namespace> create secret generic velero-vsphere-config-secret --from-file=csi-vsphere.conf
```

**NOTE:** If the configuration values contain [Golang escape characters](https://yourbasic.org/golang/multiline-string/), please ensure it is properly escaped. See example below.

If your VC password is `pwd\123`, the configuration file's password key-value should be `password = "pwd\\123"`.
varunsrinivasan2 marked this conversation as resolved.
Show resolved Hide resolved

Examples:

- VC password: `pwd\123`
- Config file: `password = "pwd\\123"`
- VC password: `pwd\nWithNewline`
- Config file: `password = "password\\nWithNewLine""`
- VC password: `Admin!23\'"`
- Config file: `password = "Admin!23\\'\""`

### Create Velero vSphere Plugin Config

The config map provides information about the cluster flavor and VC Credential Secret created in the previous step during
Expand Down Expand Up @@ -157,6 +170,7 @@ port = "443"
% kubectl -n <velero-namespace> create secret generic velero-vsphere-config-secret --from-file=csi-vsphere.conf
```


### Create Velero vSphere Plugin Configuration

The config map provides information about the cluster flavor and VC Credential Secret created in the previous step during
Expand Down
Loading