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

[BUG] Some OpenSearchClusterSpec names remain after renaming to opensearchCluster #756

Open
ideaship opened this issue Mar 11, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@ideaship
Copy link

What is the bug?

The OpenSearchClusterSpec name which was (mostly) renamed some time ago (commit fea1e20) is still present in the repo.

How can one reproduce the bug?

In the current main branch of opensearch-k8s-operator:

$ git grep -i opensearchclusterspec
.github/workflows/functional-tests.yaml:          helm install opensearch-cluster ../charts/opensearch-cluster --set OpenSearchClusterSpec.enabled=true --wait
docs/designs/crd.md:<h3 id="OpensearchClusterSPec">
docs/userguide/cluster-chart.md:For instance, if you need to change the httpPort to 9300, this can be achieved by setting `OpenSearchClusterSpec.general.httpPort` to `9300` in the [helm chart values](../../charts/opensearch-cluster/values.yaml).
docs/userguide/cluster-chart.md:OpenSearchClusterSpec:
opensearch-operator/functionaltests/execute_tests.sh:helm install opensearch-cluster ../charts/opensearch-cluster --set OpenSearchClusterSpec.enabled=true --wait

What is the expected behavior?

At least the documentation should use the current names instead of referring to names that are no longer in use. For instance, I could only get my values.yaml as described in the Configuring OpenSearch Cluster of docs/userguide/cluster-chart.md to work when I changed OpenSearchClusterSpec: to opensearchCluster:.

@ideaship ideaship added bug Something isn't working untriaged Issues that have not yet been triaged labels Mar 11, 2024
@salyh salyh added documentation Improvements or additions to documentation and removed untriaged Issues that have not yet been triaged labels Mar 28, 2024
@salyh
Copy link
Collaborator

salyh commented Mar 28, 2024

I would absolutely make sense to unify the naming. Thank you for your contribution.

I proposed a general naming convention in #741 (comment), and once we agree on this (or another one), we should adhere to it for all new CRDs, resources, etc., and give it a complete overhaul as a breaking change in the next major version.

I agree that we indeed need to fix the docs for the time being.

@ideaship Would you like to submit a PR for the docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants