ISM Policies support

[IshaGirdhar]

This PR fixes #435
Add structs to generate the ISM policy CRDs
Add roles
Add a controller to reconcile the ISM policy
Add Reconciler to create/update and delete the ISM policy from the OS cluster.
Add helper functions.
Add documentation

[swoehrl-mw]

Hi @IshaGirdhar. How does this new PR relate to your old #555? Does it supersede it so the old one can be closed?

[IshaGirdhar]

Hi @IshaGirdhar. How does this new PR relate to your old #555? Does it supersede it so the old one can be closed?

yes old one can be closed.

[AndersBennedsgaard]

Just a couple of small remarks. I'm not a Go expert, but I've skimmed through the code and it looks mainly good to me

[IshaGirdhar]

@idanl21 @swoehrl-mw Please review.

[swoehrl-mw]

Please have a look at my inline comments.
Also plase add tests for the new functionality (you can use users_test.go or role_test.go as a blueprint).

[IshaGirdhar]

Please have a look at my inline comments. Also plase add tests for the new functionality (you can use users_test.go or role_test.go as a blueprint).

Done

[swoehrl-mw]

• Also add the yamls for the new CRD to the PR (both in config/crd/bases and in the helm chart)
• Make sure you are dealing with situations where the policyId is not set (fall back to metadata.name)
• You need to detect situations where policyId is changed and error out (the field should basically be treated as immutable)
• See inline comments

[AndersBennedsgaard]

I've noticed that the https://github.com/Opster/opensearch-k8s-operator/blob/main/opensearch-operator/PROJECT file hasn't been kept up-to-date lately. Additionally, the newly introduced CRD hasn't been added to it. This is because developers haven't utilized a command like kubebuilder create api --group opensearch.opster.io --version v1 --kind ISMPolicy, which would automatically update the PROJECT file.

Considering that we aren't currently using it for any specific purpose, such as OLM integration, should we consider removing it altogether (this can be done in another PR)? Alternatively, should we make a concerted effort to keep it updated?

Reference to the PROJECT file can be found here: https://book.kubebuilder.io/reference/project-config.html

[swoehrl-mw]

I've noticed that the https://github.com/Opster/opensearch-k8s-operator/blob/main/opensearch-operator/PROJECT file hasn't been kept up-to-date lately. Additionally, the newly introduced CRD hasn't been added to it. This is because developers haven't utilized a command like kubebuilder create api --group opensearch.opster.io --version v1 --kind ISMPolicy, which would automatically update the PROJECT file.

Considering that we aren't currently using it for any specific purpose, such as OLM integration, should we consider removing it altogether (this can be done in another PR)? Alternatively, should we make a concerted effort to keep it updated?

Reference to the PROJECT file can be found here: https://book.kubebuilder.io/reference/project-config.html

Good point, it doesn't hurt to have the file, so I'd say keep it and try to keep it consistent.

[AndersBennedsgaard]

@IshaGirdhar would you mind adding the CRD to the PROJECT file?
@swoehrl-mw when this is done, could you approve this PR, or are we missing something?

[swoehrl-mw]

@AndersBennedsgaard

when this is done, could you approve this PR, or are we missing something?

My last review comments were all addressed, so should be good to go.