feat: make dashboard replicas and version fields optional #1087
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make dashboard configuration less verbose by making replicas and version
fields optional when dashboards are disabled.
Changes:
- Add 'omitempty' tag to DashboardsConfig.Replicas and Version fields
- Add kubebuilder default=1 annotation for replicas field
- Use cluster version unless dashboards version is explicitly declared
- Regenerate CRDs to reflect schema changes
Before:
dashboards:
enabled: false
replicas: 0 # Required but redundant
version: "2.9.0" # Required but redundant
After:
dashboards:
enabled: false # No longer requires replicas and version
Signed-off-by: Itamar Syn-Hershko <[email protected]>
synhershko
requested review from
idanl21,
jochenkressin,
pchmielnik,
prudhvigodithi,
salyh and
swoehrl-mw
as code owners
Signed-off-by: josedev-union <[email protected]>
|
|
||
| version := cr.Spec.Dashboards.Version | ||
| if version == "" { | ||
| version = cr.Spec.General.Version |
There was a problem hiding this comment.
This will be a problem in scenarios where we only release OpenSearch. Example for 3.3.1 opensearch-project/opensearch-build#5784. The docker for OpenSearch has 3.3.1 https://hub.docker.com/r/opensearchproject/opensearch/tags, but not for OpenSearch Dashboards https://hub.docker.com/r/opensearchproject/opensearch-dashboards/tags.
CC @getsaurabh02 @peterzhuamazon
There was a problem hiding this comment.
Based on this its good to disable the version (for OSD) only when enabled is false.
There was a problem hiding this comment.
good catch - @josedev-union can you propose a solution?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1082
Make dashboard configuration less verbose by making replicas and version fields optional when dashboards are disabled.
Changes:
Before:
dashboards: enabled: false
replicas: 0 # Required but redundant
version: "2.9.0" # Required but redundant
After:
dashboards:
enabled: false # No longer requires replicas and version
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.