Skip to content

Commit

Permalink
Fix userguide for projectedVolumes (#953)
Browse files Browse the repository at this point in the history
### Description
Deploying an OpenSearch cluster with projected volumes as described in
the current documentation leads to the following error
```
OpenSearchCluster.opensearch.opster.io "opensearch" is invalid: spec.general.additionalVolumes[1].projected.sources: Invalid value: "object": spec.general.additionalVolumes[1].projected.sources in body must be of type array: "object"
```
This PR corrects the userguide on how to add a projected volume to
OpenSearchCluster CRD.

### Issues Resolved
_List any issues this PR will resolve, e.g. Closes [...]._ 

### Check List
- [x] Commits are signed per the DCO using --signoff 
- [ ] Unittest added for the new/changed functionality and all unit
tests are successful
- [ ] Customer-visible features documented
- [ ] No linter warnings (`make lint`)

If CRDs are changed:
- [ ] CRD YAMLs updated (`make manifests`) and also copied into the helm
chart
- [ ] Changes to CRDs documented

Please refer to the [PR
guidelines](https://github.com/opensearch-project/opensearch-k8s-operator/blob/main/docs/developing.md#submitting-a-pr)
before submitting this pull request.

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

Signed-off-by: Akila-I <akila.99g@gmail.com>
  • Loading branch information
Akila-I authored Jan 31, 2025
1 parent d8c71cc commit 335eb90
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/userguide/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -756,7 +756,7 @@ spec:
path: /path/to/mount/volume
projected:
sources:
serviceAccountToken:
- serviceAccountToken:
path: "token"
dashboards:
additionalVolumes:
Expand Down

0 comments on commit 335eb90

Please sign in to comment.