update APIs to mark TLS Provided mode as Unsupported

Signed-off-by: Mohamed Mahmoud <mmahmoud@redhat.com>
netobserv · Mar 27, 2024 · 8539730 · 8539730
1 parent d232b65
commit 8539730
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 18 deletions.
diff --git a/apis/flowcollector/v1beta1/flowcollector_types.go b/apis/flowcollector/v1beta1/flowcollector_types.go
@@ -301,7 +301,7 @@ type ServerTLSConfigType string
 type ServerTLS struct {
 	// Select the type of TLS configuration:<br>
 	// - `DISABLED` (default) to not configure TLS for the endpoint.
-	// - `PROVIDED` to manually provide cert file and a key file.
+	// - `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)].
 	// - `AUTO` to use OpenShift auto generated certificate using annotations.
 	// +unionDiscriminator
 	// +kubebuilder:validation:Enum:="DISABLED";"PROVIDED";"AUTO"

diff --git a/apis/flowcollector/v1beta2/flowcollector_types.go b/apis/flowcollector/v1beta2/flowcollector_types.go
@@ -308,7 +308,7 @@ const (
 type ServerTLS struct {
 	// Select the type of TLS configuration:<br>
 	// - `Disabled` (default) to not configure TLS for the endpoint.
-	// - `Provided` to manually provide cert file and a key file.
+	// - `Provided` to manually provide cert file and a key file. [Unsupported (*)].
 	// - `Auto` to use OpenShift auto generated certificate using annotations.
 	// +unionDiscriminator
 	// +kubebuilder:validation:Enum:="Disabled";"Provided";"Auto"

diff --git a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml
@@ -286,8 +286,9 @@ spec:
                                     description: Select the type of TLS configuration:<br>
                                       - `DISABLED` (default) to not configure TLS
                                       for the endpoint. - `PROVIDED` to manually provide
-                                      cert file and a key file. - `AUTO` to use OpenShift
-                                      auto generated certificate using annotations.
+                                      cert file and a key file. [Unsupported (*)].
+                                      - `AUTO` to use OpenShift auto generated certificate
+                                      using annotations.
                                     enum:
                                     - DISABLED
                                     - PROVIDED
@@ -2182,8 +2183,9 @@ spec:
                                 description: Select the type of TLS configuration:<br>
                                   - `DISABLED` (default) to not configure TLS for
                                   the endpoint. - `PROVIDED` to manually provide cert
-                                  file and a key file. - `AUTO` to use OpenShift auto
-                                  generated certificate using annotations.
+                                  file and a key file. [Unsupported (*)]. - `AUTO`
+                                  to use OpenShift auto generated certificate using
+                                  annotations.
                                 enum:
                                 - DISABLED
                                 - PROVIDED
@@ -3029,8 +3031,9 @@ spec:
                                     description: Select the type of TLS configuration:<br>
                                       - `Disabled` (default) to not configure TLS
                                       for the endpoint. - `Provided` to manually provide
-                                      cert file and a key file. - `Auto` to use OpenShift
-                                      auto generated certificate using annotations.
+                                      cert file and a key file. [Unsupported (*)].
+                                      - `Auto` to use OpenShift auto generated certificate
+                                      using annotations.
                                     enum:
                                     - Disabled
                                     - Provided
@@ -6028,8 +6031,9 @@ spec:
                                 description: Select the type of TLS configuration:<br>
                                   - `Disabled` (default) to not configure TLS for
                                   the endpoint. - `Provided` to manually provide cert
-                                  file and a key file. - `Auto` to use OpenShift auto
-                                  generated certificate using annotations.
+                                  file and a key file. [Unsupported (*)]. - `Auto`
+                                  to use OpenShift auto generated certificate using
+                                  annotations.
                                 enum:
                                 - Disabled
                                 - Provided

diff --git a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml
@@ -186,7 +186,7 @@ spec:
                                       type: object
                                     type:
                                       default: DISABLED
-                                      description: Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. - `AUTO` to use OpenShift auto generated certificate using annotations.
+                                      description: Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)]. - `AUTO` to use OpenShift auto generated certificate using annotations.
                                       enum:
                                         - DISABLED
                                         - PROVIDED
@@ -1695,7 +1695,7 @@ spec:
                                   type: object
                                 type:
                                   default: DISABLED
-                                  description: Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. - `AUTO` to use OpenShift auto generated certificate using annotations.
+                                  description: Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)]. - `AUTO` to use OpenShift auto generated certificate using annotations.
                                   enum:
                                     - DISABLED
                                     - PROVIDED
@@ -2397,7 +2397,7 @@ spec:
                                       type: object
                                     type:
                                       default: Disabled
-                                      description: Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. - `Auto` to use OpenShift auto generated certificate using annotations.
+                                      description: Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. [Unsupported (*)]. - `Auto` to use OpenShift auto generated certificate using annotations.
                                       enum:
                                         - Disabled
                                         - Provided
@@ -4903,7 +4903,7 @@ spec:
                                   type: object
                                 type:
                                   default: Disabled
-                                  description: Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. - `Auto` to use OpenShift auto generated certificate using annotations.
+                                  description: Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. [Unsupported (*)]. - `Auto` to use OpenShift auto generated certificate using annotations.
                                   enum:
                                     - Disabled
                                     - Provided

diff --git a/docs/FlowCollector.md b/docs/FlowCollector.md
@@ -469,7 +469,7 @@ TLS configuration.
         <td><b>type</b></td>
         <td>enum</td>
         <td>
-          Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. - `AUTO` to use OpenShift auto generated certificate using annotations.<br/>
+          Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)]. - `AUTO` to use OpenShift auto generated certificate using annotations.<br/>
           <br/>
             <i>Enum</i>: DISABLED, PROVIDED, AUTO<br/>
             <i>Default</i>: DISABLED<br/>
@@ -4614,7 +4614,7 @@ TLS configuration.
         <td><b>type</b></td>
         <td>enum</td>
         <td>
-          Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. - `AUTO` to use OpenShift auto generated certificate using annotations.<br/>
+          Select the type of TLS configuration:<br> - `DISABLED` (default) to not configure TLS for the endpoint. - `PROVIDED` to manually provide cert file and a key file. [Unsupported (*)]. - `AUTO` to use OpenShift auto generated certificate using annotations.<br/>
           <br/>
             <i>Enum</i>: DISABLED, PROVIDED, AUTO<br/>
             <i>Default</i>: DISABLED<br/>
@@ -6752,7 +6752,7 @@ TLS configuration.
         <td><b>type</b></td>
         <td>enum</td>
         <td>
-          Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. - `Auto` to use OpenShift auto generated certificate using annotations.<br/>
+          Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. [Unsupported (*)]. - `Auto` to use OpenShift auto generated certificate using annotations.<br/>
           <br/>
             <i>Enum</i>: Disabled, Provided, Auto<br/>
             <i>Default</i>: Disabled<br/>
@@ -14250,7 +14250,7 @@ TLS configuration.
         <td><b>type</b></td>
         <td>enum</td>
         <td>
-          Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. - `Auto` to use OpenShift auto generated certificate using annotations.<br/>
+          Select the type of TLS configuration:<br> - `Disabled` (default) to not configure TLS for the endpoint. - `Provided` to manually provide cert file and a key file. [Unsupported (*)]. - `Auto` to use OpenShift auto generated certificate using annotations.<br/>
           <br/>
             <i>Enum</i>: Disabled, Provided, Auto<br/>
             <i>Default</i>: Disabled<br/>