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

Rework CRD to avoid the Os abbreviation #24

Closed
swoehrl-mw opened this issue Jan 20, 2022 · 1 comment
Closed

Rework CRD to avoid the Os abbreviation #24

swoehrl-mw opened this issue Jan 20, 2022 · 1 comment

Comments

@swoehrl-mw
Copy link
Collaborator

Currently the kind for the operator CRD is Os. That abbreviation is also used in other places in the CRD.

Using the Os abbreviation is not optimal for two reasons:

  • OS is already widely known and used for Operating System, so using it here differently can confuse people
  • A leading member of the OpenSearch community has asked in a discussion thread (OpenSearch name: abbreviation?) not to abbreviate the name to establish a clear brand

As such I suggest renaming the kind of the CRD and also any mention of Os in the CRD fields.
Note: os can still be configured as a shortName for the CRD so a user can still do a quick kubectl get os

This is my suggestion of how the example definition could look like with new names:

apiVersion: opensearch.opster.io/v1 # Renamed
kind: OpenSearchCluster # Renamed
metadata:
  name: opster-opensearch
  namespace: operator-opensearch
spec:
  general:
    clusterName: my-opensearch
    httpPort: 9200 # renamed from osPort
    transportPort: 9300 # Introduced to make both ports configurable
    vendor: opensearch
    version: latest
    serviceName: es-svc
  dashboards: # Renamed from osConfMgmt and moved to make kibana/dashboards a top-level member, later we can add other dashboards-related config options here
    enabled: true
  nodePools: # renamed from osNodes
    - component: masters
      replicas: 3
      diskSize: 30
      NodeSelector:
      cpu: 4
      memory: 16
      ingest: "false"
    - component: nodes
      replicas: 3
      diskSize: 100
      NodeSelector:
      cpu: 4
      memory: 16
      ingest: "true"
    - component: coordinators
      replicas: 3
      diskSize: 100
      NodeSelector:
      cpu: 4
      memory: 16
      ingest: "false"
@shahar35
Copy link
Contributor

Hey Sabastian,
We totally agree, make sense. we will address that and align to the suggested, thank you.

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

No branches or pull requests

3 participants