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

Fix userguide for projectedVolumes #953

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

Akila-I
Copy link
Contributor

@Akila-I Akila-I commented Jan 30, 2025

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

  • 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 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.

Copy link
Collaborator

@swoehrl-mw swoehrl-mw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Akila-I. Thanks for noticing this error and opening the PR.
LGTM

@swoehrl-mw swoehrl-mw merged commit 335eb90 into opensearch-project:main Jan 31, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants