Skip to content

Commit

Permalink
docs: clarify connDisableAuthentication value requires quotes
Browse files Browse the repository at this point in the history
  • Loading branch information
iamjoemccormick committed Jan 2, 2025
1 parent 6752e2e commit 61393bc
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/build-test-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ on:
branches:
- "master"
paths-ignore:
- "**/*.md"
- "**/*.txt"
- "CHANGELOG.md"
- "CONTRIBUTING.md"
- "README.md"
- "SECURITY.md"
- 'docs/**'

env:
# Equivalent of BUILD_PLATFORMS in the Makefile and release-tools build.make. We cannot just set
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ deployment guide](operator/README.md).
```yaml
config:
beegfsClientConf:
connDisableAuthentication: true
connDisableAuthentication: "true" # note the quotes are required
```
* Provide connAuth details in `csi-beegfs-connauth.yaml` if your existing
file system does use connection authentication.
Expand Down
12 changes: 8 additions & 4 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -783,10 +783,14 @@ parameter falls under determines its level of support in the driver.

Special attention should be paid to these parameters.

* `connDisableAuthentication` - Added in BeeGFS v7.3.1 and BeeGFS v7.2.7. If the
file system the BeeGFS client will connect to does not use connAuth files,
this must be set to `true`.

* `connDisableAuthentication` - Added in BeeGFS v7.3.1 and BeeGFS v7.2.7. If the file system the
BeeGFS client will connect to does not use connAuth files, this must be set to `"true"`.
* Note: To avoid YAML interpeting the value as a native boolean, it must be enclosed in double
quotes or you will get an error like:

```
failed to handle configuration file: likely missing quotes around an integer or boolean beegfsClientConf value: error unmarshaling JSON: while decoding JSON: json: cannot unmarshal bool into Go struct field BeegfsConfig.config.beegfsClientConf of type string`
```

<a name="no-effect"></a>
#### No Effect
Expand Down

0 comments on commit 61393bc

Please sign in to comment.