opensearch-project/opensearch-k8s-operator

[BUG] Please update examples and documentaiton

Jeansen opened this issue · 11 comments

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 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?

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

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

@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 ;-)

[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

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)?

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

@Jeansen @prudhvigodithi check #759

operator is unable to handle security settings of admin user and there is even WIP PR opened by @nijave: #816

problem is, that the issue is not reprodusible when upgrading cluster and in CI of this repo, which doesn't mean that the issue does not exists.

@Jeansen @prudhvigodithi check #759

operator is unable to handle security settings of admin user and there is even WIP PR opened by @nijave: #816

problem is, that the issue is not reprodusible when upgrading cluster and in CI of this repo, which doesn't mean that the issue does not exists.

Ideally need to figure out what the difference is. Seems something related to this security setup shell script inside the OpenSearch image (there's something causing it to run which then enforces the user restrictions and breaks for people but it doesn't seem to run in the CI environment)

By the way, this is for a home setup so I haven't had much time to dedicate to investigating

@nijave Well, so far I was able to to test it but I've prepared everything regarding the custom password, with respect to @prudhvigodithi 's hint. I'll report as soon as I can test it, but am currently in head-deep preparing for my CKS Exam.