From 41f1d2e29b96221d94d1f0722ac00c9fd52236b7 Mon Sep 17 00:00:00 2001 From: alb-car Date: Thu, 30 Nov 2023 12:53:26 +0100 Subject: [PATCH] Descriptions for CRD spec --- api/v1/dremiorestserver_types.go | 12 +++++++----- ...rator.dremiorestserver.com_dremiorestservers.yaml | 12 +++++++----- deployment.yaml | 12 +++++++----- 3 files changed, 21 insertions(+), 15 deletions(-) diff --git a/api/v1/dremiorestserver_types.go b/api/v1/dremiorestserver_types.go index 5c37132..6dc54af 100644 --- a/api/v1/dremiorestserver_types.go +++ b/api/v1/dremiorestserver_types.go @@ -23,15 +23,17 @@ import ( // NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. // Important: Run "make generate" after modifying this file -// DremioRestServerSpec defines the desired state of DremioRestServer +// Dremio REST Server properties type DremioRestServerSpec struct { - // JAVA_TOOL_OPTIONS (on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED is required) + // Corresponds to JAVA_TOOL_OPTIONS: on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED is required // +operator-sdk:csv:customresourcedefinitions:type=spec JavaOptions string `json:"javaOptions,omitempty"` // JAVA_TOOL_OPTIONS + // Comma-separated list of tables to expose // +operator-sdk:csv:customresourcedefinitions:type=spec Tables string `json:"tables,omitempty"` // DREMIO_TABLES (comma-separated) + // Properties to connect to Dremio // +operator-sdk:csv:customresourcedefinitions:type=spec Dremio DremioProperties `json:"dremio,omitempty"` @@ -63,7 +65,7 @@ type Requests struct { Memory string `json:"memory,omitempty"` } -// DremioRestServerStatus defines the observed state of DremioRestServer +// Dremio REST Server status type DremioRestServerStatus struct { // +operator-sdk:csv:customresourcedefinitions:type=status State string `json:"state,omitempty" patchStrategy:"merge"` @@ -72,7 +74,7 @@ type DremioRestServerStatus struct { //+kubebuilder:object:root=true //+kubebuilder:subresource:status -// DremioRestServer is the Schema for the dremiorestservers API +// Schema for the dremiorestservers API type DremioRestServer struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -83,7 +85,7 @@ type DremioRestServer struct { //+kubebuilder:object:root=true -// DremioRestServerList contains a list of DremioRestServer +// List of DremioRestServer type DremioRestServerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` diff --git a/config/crd/bases/operator.dremiorestserver.com_dremiorestservers.yaml b/config/crd/bases/operator.dremiorestserver.com_dremiorestservers.yaml index 99e48b8..3d4f12f 100644 --- a/config/crd/bases/operator.dremiorestserver.com_dremiorestservers.yaml +++ b/config/crd/bases/operator.dremiorestserver.com_dremiorestservers.yaml @@ -18,7 +18,7 @@ spec: - name: v1 schema: openAPIV3Schema: - description: DremioRestServer is the Schema for the dremiorestservers API + description: Schema for the dremiorestservers API properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -33,7 +33,7 @@ spec: metadata: type: object spec: - description: DremioRestServerSpec defines the desired state of DremioRestServer + description: Dremio REST Server properties properties: containerLimits: description: Corresponds to resources.limits of a container @@ -52,6 +52,7 @@ spec: type: string type: object dremio: + description: Properties to connect to Dremio properties: host: type: string @@ -68,14 +69,15 @@ spec: type: string type: object javaOptions: - description: JAVA_TOOL_OPTIONS (on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED - is required) + description: 'Corresponds to JAVA_TOOL_OPTIONS: on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED + is required' type: string tables: + description: Comma-separated list of tables to expose type: string type: object status: - description: DremioRestServerStatus defines the observed state of DremioRestServer + description: Dremio REST Server status properties: state: type: string diff --git a/deployment.yaml b/deployment.yaml index ba5d502..41eaf97 100644 --- a/deployment.yaml +++ b/deployment.yaml @@ -30,7 +30,7 @@ spec: - name: v1 schema: openAPIV3Schema: - description: DremioRestServer is the Schema for the dremiorestservers API + description: Schema for the dremiorestservers API properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -45,7 +45,7 @@ spec: metadata: type: object spec: - description: DremioRestServerSpec defines the desired state of DremioRestServer + description: Dremio REST Server properties properties: containerLimits: description: Corresponds to resources.limits of a container @@ -64,6 +64,7 @@ spec: type: string type: object dremio: + description: Properties to connect to Dremio properties: host: type: string @@ -80,14 +81,15 @@ spec: type: string type: object javaOptions: - description: JAVA_TOOL_OPTIONS (on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED - is required) + description: 'Corresponds to JAVA_TOOL_OPTIONS: on JDK 9+, --add-opens=java.base/java.nio=ALL-UNNAMED + is required' type: string tables: + description: Comma-separated list of tables to expose type: string type: object status: - description: DremioRestServerStatus defines the observed state of DremioRestServer + description: Dremio REST Server status properties: state: type: string