Add documemntatioon direct into the CRD

rubenvp8510 · rubenvp8510 · commit 353a68f077a8 · 2024-07-08T20:55:50.000-06:00
Signed-off-by: Ruben Vargas &lt;ruben.vp8510@gmail.com&gt;
diff --git a/.chloggen/ingest_tls_openshift.yaml b/.chloggen/ingest_tls_openshift.yaml
@@ -14,7 +14,7 @@ issues: [963]
 # These lines will be padded with 2 spaces and then inserted directly into the document.
 # Use pipe (|) for multiline entries.
 subtext: |
-  On OpenShift when operator config `DistributorServingCertsService` is enabled and the following TempoStack CR is used.
+  On OpenShift when operator config `servingCertsService` is enabled and the following TempoStack CR is used.
   The operator provisions OpenShift serving certificates for the distributor ingest APIs
   ```
     apiVersion: tempo.grafana.com/v1alpha1
diff --git a/apis/tempo/v1alpha1/tempostack_types.go b/apis/tempo/v1alpha1/tempostack_types.go
@@ -493,6 +493,9 @@ type TempoDistributorSpec struct {
 	//
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="TLS"
+	//
+	// If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no
+	// certName or caName is specified, OpenShift service serving certificates will  be used.
 	TLS TLSSpec `json:"tls,omitempty"`
 }
 
diff --git a/bundle/community/manifests/tempo-operator.clusterserviceversion.yaml b/bundle/community/manifests/tempo-operator.clusterserviceversion.yaml
@@ -74,7 +74,7 @@ metadata:
     capabilities: Deep Insights
     categories: Logging & Tracing,Monitoring
     containerImage: ghcr.io/grafana/tempo-operator/tempo-operator:v0.11.1
-    createdAt: "2024-07-08T10:12:34Z"
+    createdAt: "2024-07-09T01:46:53Z"
     description: Create and manage deployments of Tempo, a high-scale distributed
       tracing backend.
     operatorframework.io/cluster-monitoring: "true"
@@ -850,7 +850,10 @@ spec:
           the calculated resources derived from total
         displayName: Resources
         path: template.distributor.resources
-      - description: TLS defines TLS configuration for distributor receivers
+      - description: "TLS defines TLS configuration for distributor receivers \n If
+          openshift feature flag `servingCertsService` is enabled and TLS is enabled
+          but no certName or caName is specified, OpenShift service serving certificates
+          will  be used."
         displayName: TLS
         path: template.distributor.tls
       - description: CA is the name of a ConfigMap containing a CA certificate (service-ca.crt).
diff --git a/bundle/community/manifests/tempo.grafana.com_tempostacks.yaml b/bundle/community/manifests/tempo.grafana.com_tempostacks.yaml
@@ -710,8 +710,12 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                       tls:
-                        description: TLS defines TLS configuration for distributor
-                          receivers
+                        description: |-
+                          TLS defines TLS configuration for distributor receivers
+
+
+                          If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no
+                          certName or caName is specified, OpenShift service serving certificates will  be used.
                         properties:
                           caName:
                             description: |-
diff --git a/bundle/openshift/manifests/tempo-operator.clusterserviceversion.yaml b/bundle/openshift/manifests/tempo-operator.clusterserviceversion.yaml
@@ -74,7 +74,7 @@ metadata:
     capabilities: Deep Insights
     categories: Logging & Tracing,Monitoring
     containerImage: ghcr.io/grafana/tempo-operator/tempo-operator:v0.11.1
-    createdAt: "2024-07-08T10:12:32Z"
+    createdAt: "2024-07-09T01:46:51Z"
     description: Create and manage deployments of Tempo, a high-scale distributed
       tracing backend.
     operatorframework.io/cluster-monitoring: "true"
@@ -850,7 +850,10 @@ spec:
           the calculated resources derived from total
         displayName: Resources
         path: template.distributor.resources
-      - description: TLS defines TLS configuration for distributor receivers
+      - description: "TLS defines TLS configuration for distributor receivers \n If
+          openshift feature flag `servingCertsService` is enabled and TLS is enabled
+          but no certName or caName is specified, OpenShift service serving certificates
+          will  be used."
         displayName: TLS
         path: template.distributor.tls
       - description: CA is the name of a ConfigMap containing a CA certificate (service-ca.crt).
diff --git a/bundle/openshift/manifests/tempo.grafana.com_tempostacks.yaml b/bundle/openshift/manifests/tempo.grafana.com_tempostacks.yaml
@@ -710,8 +710,12 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                       tls:
-                        description: TLS defines TLS configuration for distributor
-                          receivers
+                        description: |-
+                          TLS defines TLS configuration for distributor receivers
+
+
+                          If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no
+                          certName or caName is specified, OpenShift service serving certificates will  be used.
                         properties:
                           caName:
                             description: |-
diff --git a/config/crd/bases/tempo.grafana.com_tempostacks.yaml b/config/crd/bases/tempo.grafana.com_tempostacks.yaml
@@ -706,8 +706,12 @@ spec:
                             x-kubernetes-list-type: atomic
                         type: object
                       tls:
-                        description: TLS defines TLS configuration for distributor
-                          receivers
+                        description: |-
+                          TLS defines TLS configuration for distributor receivers
+
+
+                          If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no
+                          certName or caName is specified, OpenShift service serving certificates will  be used.
                         properties:
                           caName:
                             description: |-
diff --git a/config/manifests/community/bases/tempo-operator.clusterserviceversion.yaml b/config/manifests/community/bases/tempo-operator.clusterserviceversion.yaml
@@ -779,7 +779,10 @@ spec:
           the calculated resources derived from total
         displayName: Resources
         path: template.distributor.resources
-      - description: TLS defines TLS configuration for distributor receivers
+      - description: "TLS defines TLS configuration for distributor receivers \n If
+          openshift feature flag `servingCertsService` is enabled and TLS is enabled
+          but no certName or caName is specified, OpenShift service serving certificates
+          will  be used."
         displayName: TLS
         path: template.distributor.tls
       - description: CA is the name of a ConfigMap containing a CA certificate (service-ca.crt).
diff --git a/config/manifests/openshift/bases/tempo-operator.clusterserviceversion.yaml b/config/manifests/openshift/bases/tempo-operator.clusterserviceversion.yaml
@@ -779,7 +779,10 @@ spec:
           the calculated resources derived from total
         displayName: Resources
         path: template.distributor.resources
-      - description: TLS defines TLS configuration for distributor receivers
+      - description: "TLS defines TLS configuration for distributor receivers \n If
+          openshift feature flag `servingCertsService` is enabled and TLS is enabled
+          but no certName or caName is specified, OpenShift service serving certificates
+          will  be used."
         displayName: TLS
         path: template.distributor.tls
       - description: CA is the name of a ConfigMap containing a CA certificate (service-ca.crt).
diff --git a/docs/spec/tempo.grafana.com_tempostacks.yaml b/docs/spec/tempo.grafana.com_tempostacks.yaml
@@ -104,7 +104,7 @@ spec:                                    # TempoStackSpec defines the desired st
             cpu: "500m"
             memory: "1Gi"
         tolerations: {}                  # Tolerations defines component-specific pod tolerations.
-      tls:                               # TLS defines TLS configuration for distributor receivers
+      tls:                               # TLS defines TLS configuration for distributor receivers   If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no certName or caName is specified, OpenShift service serving certificates will  be used.
         enabled: false                   # Enabled defines if TLS is enabled.
         caName: ""                       # CA is the name of a ConfigMap containing a CA certificate (service-ca.crt). It needs to be in the same namespace as the Tempo custom resource.
         certName: ""                     # Cert is the name of a Secret containing a certificate (tls.crt) and private key (tls.key). It needs to be in the same namespace as the Tempo custom resource.

Original file line number	Diff line number	Diff line change
`@@ -493,6 +493,9 @@ type TempoDistributorSpec struct {`
`493`	`493`	`//`
`494`	`494`	`// +optional`
`495`	`495`	`// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="TLS"`
	`496`	`+ //`
	`497`	+ // If openshift feature flag `servingCertsService` is enabled and TLS is enabled but no
	`498`	`+ // certName or caName is specified, OpenShift service serving certificates will be used.`
`496`	`499`	TLS TLSSpec `json:"tls,omitempty"`
`497`	`500`	`}`
`498`	`501`