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] Please update examples and documentaiton #800

Closed
Jeansen opened this issue May 5, 2024 · 8 comments
Closed

[BUG] Please update examples and documentaiton #800

Jeansen opened this issue May 5, 2024 · 8 comments
Labels
documentation Improvements or additions to documentation

Comments

@Jeansen
Copy link

Jeansen commented May 5, 2024

Obviously documentations is quite off track. Starting with the README, it still references version 2.3 although we are already at 2.6. The examples in the examples folder using CRs still reference OpenSearch version 2.3.0. Current version is 2.13.0! And with the breaking changes introduced in 2.12.0 it is not clear, how to do this in the operator CR. I'd be happy to see some updates here.

@Jeansen Jeansen added bug Something isn't working untriaged Issues that have not yet been triaged labels May 5, 2024
@dtaivpp
Copy link
Contributor

dtaivpp commented May 12, 2024

@Jeansen this is a solid callout. I am working through some of this. Which change for 2.12 are your referring to? The new default password policies?

@dtaivpp
Copy link
Contributor

dtaivpp commented May 12, 2024

Also, @prudhvigodithi do you think it's worth keeping some of the older examples around? I was thinking we could organize into something like below because I feel like it's good to have the older examples around for those who need it. But then we can have some updated ones.

opensearch-operator
    └─ examples
        ├─ 2.X
        │   ├─ example_a.yml 
        │   └─ example_b.yml
        └─ 1.X 
            ├─ example_a.yml 
            └─ example_b.yml

@Jeansen
Copy link
Author

Jeansen commented May 12, 2024

@Jeansen this is a solid callout. I am working through some of this. Which change for 2.12 are your referring to? The new default password policies?

@dtaivpp in my case, yes. But in general - like I wrote - there are also lot's of versions mentioned in the examples which are rather old.. Organizing examples into folders makes sense. One could also rename the files including a versions, but that IMHO makes the list quite long. Having folders is much more organized.

@dtaivpp
Copy link
Contributor

dtaivpp commented May 12, 2024

@prudhvigodithi maybe we just support latest for each major version? Then we can template it a bit better and test these.

@Jeansen
Copy link
Author

Jeansen commented May 14, 2024

@dtaivpp everything that works for you. But with respect to cloud technologies, I agree that it might be reasonable to only support the latest version for each major (supported) versions. After all, it's all about rolling releases in the cloud ;-)

@prudhvigodithi
Copy link
Collaborator

[Triage]
Hey @dtaivpp and @Jeansen, I got the PR merged related to the compatibility matrix #792. Moving forward as we prepare of the release, along with the compatibility matrix we should go ahead and update the examples and documentation accordingly.
Adding @swoehrl-mw @salyh @bbarani

@prudhvigodithi prudhvigodithi added documentation Improvements or additions to documentation and removed bug Something isn't working untriaged Issues that have not yet been triaged labels May 14, 2024
@Jeansen
Copy link
Author

Jeansen commented Jun 5, 2024

Cool, thanks. I had not expected it to be as easy as increasing numbers. But what about the new the new default password policies? Has there been anything added to the docs (in another MR)?

@prudhvigodithi
Copy link
Collaborator

Hey @Jeansen please check here #703 (comment), operator handles the security settings of the cluster and would not impact the new default password, the process is still the same for updating the admin password Custom Admin User.
Thank you
@getsaurabh02 @swoehrl-mw

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

No branches or pull requests

3 participants