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

First version CRD DOCS #91

Merged
merged 14 commits into from Apr 28, 2022
Merged

First version CRD DOCS #91

merged 14 commits into from Apr 28, 2022

Conversation

idanl21
Copy link
Collaborator

@idanl21 idanl21 commented Mar 31, 2022

  • First version of CRD DOCS
  • change busybox image to opster-pub-ecr image (from rate limit errors on past image)

- change busybox image to opster-pub-ecr image (from rate limit errors on past image)
- change busybox image to opster-pub-ecr image (from rate limit errors on past image)
opensearch-operator/pkg/builders/cluster.go Outdated Show resolved Hide resolved


Our CRD is Defined by kind: `OpenSearchCluster`,group: `opensearch.opster.io` and version `v1`.
<table>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Any reason to use a html table over a markdown one?

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.

This is missing some fields:

  • nodePool.persistence
  • nodePool.additionalConfig
  • confMgmt
  • general.drainDataNodes
  • general.defaultRepo
  • Fields from ImageSpec in general
  • DashboardsTlsConfig
  • Security and its subobjects are completely missing
  • probably some more I didn't see

Types object should be the respective type, e.g. []NodePool instead of []object.

All field names should be written exactly as they appear in the YAML (e.g. jvm instead of JVM, tolerations instead of Tolerations).

PS: We should think about moving that doc into the userguide folder and linking it from the main.md

docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
docs/designs/crd.md Outdated Show resolved Hide resolved
idanl21 and others added 10 commits April 24, 2022 16:37
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
Co-authored-by: Sebastian Woehrl <sebastian.woehrl@maibornwolff.de>
@idanl21 idanl21 merged commit a1f8f07 into main Apr 28, 2022
@segalziv segalziv deleted the Add_CRD_doc branch August 21, 2022 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants