Fix api description

3scale-ops · Mar 22, 2024 · 08e421e · 08e421e
1 parent a595607
commit 08e421e
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 11 deletions.
diff --git a/apis/marin3r/v1alpha1/resources.go b/apis/marin3r/v1alpha1/resources.go
@@ -43,7 +43,8 @@ type Resource struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +optional
 	GenerateFromTlsSecret *string `json:"generateFromTlsSecret,omitempty"`
-	// The name of a Kubernetes Secret of type "kubernetes.io/tls"
+	// The name of a Kubernetes Secret of type "Opaque". It will generate an
+	// envoy "generic secret" proto.
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +optional
 	GenerateFromOpaqueSecret *SecretKeySelector `json:"generateFromOpaqueSecret,omitempty"`

diff --git a/bundle/manifests/marin3r.3scale.net_envoyconfigrevisions.yaml b/bundle/manifests/marin3r.3scale.net_envoyconfigrevisions.yaml
diff --git a/bundle/manifests/marin3r.3scale.net_envoyconfigs.yaml b/bundle/manifests/marin3r.3scale.net_envoyconfigs.yaml
diff --git a/bundle/manifests/marin3r.clusterserviceversion.yaml b/bundle/manifests/marin3r.clusterserviceversion.yaml
diff --git a/config/crd/bases/marin3r.3scale.net_envoyconfigrevisions.yaml b/config/crd/bases/marin3r.3scale.net_envoyconfigrevisions.yaml
@@ -351,7 +351,8 @@ spec:
                       - targetPort
                       type: object
                     generateFromOpaqueSecret:
-                      description: The name of a Kubernetes Secret of type "kubernetes.io/tls"
+                      description: The name of a Kubernetes Secret of type "Opaque".
+                        It will generate an envoy "generic secret" proto.
                       properties:
                         alias:
                           description: A unique name to refer to the name:key combination

diff --git a/config/crd/bases/marin3r.3scale.net_envoyconfigs.yaml b/config/crd/bases/marin3r.3scale.net_envoyconfigs.yaml
@@ -344,7 +344,8 @@ spec:
                       - targetPort
                       type: object
                     generateFromOpaqueSecret:
-                      description: The name of a Kubernetes Secret of type "kubernetes.io/tls"
+                      description: The name of a Kubernetes Secret of type "Opaque".
+                        It will generate an envoy "generic secret" proto.
                       properties:
                         alias:
                           description: A unique name to refer to the name:key combination

diff --git a/config/manifests/bases/marin3r.clusterserviceversion.yaml b/config/manifests/bases/marin3r.clusterserviceversion.yaml
@@ -359,7 +359,8 @@ spec:
           be used to generate the endpoint resource
         displayName: Generate From Endpoint Slices
         path: resources[0].generateFromEndpointSlices
-      - description: The name of a Kubernetes Secret of type "kubernetes.io/tls"
+      - description: The name of a Kubernetes Secret of type "Opaque". It will generate
+          an envoy "generic secret" proto.
         displayName: Generate From Opaque Secret
         path: resources[0].generateFromOpaqueSecret
       - description: The name of a Kubernetes Secret of type "kubernetes.io/tls"
@@ -544,7 +545,8 @@ spec:
           be used to generate the endpoint resource
         displayName: Generate From Endpoint Slices
         path: resources[0].generateFromEndpointSlices
-      - description: The name of a Kubernetes Secret of type "kubernetes.io/tls"
+      - description: The name of a Kubernetes Secret of type "Opaque". It will generate
+          an envoy "generic secret" proto.
         displayName: Generate From Opaque Secret
         path: resources[0].generateFromOpaqueSecret
       - description: The name of a Kubernetes Secret of type "kubernetes.io/tls"

diff --git a/docs/api-reference/reference.asciidoc b/docs/api-reference/reference.asciidoc
@@ -318,7 +318,7 @@ Resource holds serialized representation of an envoy resource
 | *`type`* __Type__ | Type is the type url for the protobuf message
 | *`value`* __RawExtension__ | Value is the protobufer message that configures the resource. The proto must match the envoy configuration API v3 specification for the given resource type (https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol#resource-types)
 | *`generateFromTlsSecret`* __string__ | The name of a Kubernetes Secret of type "kubernetes.io/tls"
-| *`generateFromOpaqueSecret`* __xref:{anchor_prefix}-github-com-3scale-ops-marin3r-apis-marin3r-v1alpha1-secretkeyselector[$$SecretKeySelector$$]__ | The name of a Kubernetes Secret of type "kubernetes.io/tls"
+| *`generateFromOpaqueSecret`* __xref:{anchor_prefix}-github-com-3scale-ops-marin3r-apis-marin3r-v1alpha1-secretkeyselector[$$SecretKeySelector$$]__ | The name of a Kubernetes Secret of type "Opaque". It will generate an envoy "generic secret" proto.
 | *`generateFromEndpointSlices`* __xref:{anchor_prefix}-github-com-3scale-ops-marin3r-apis-marin3r-v1alpha1-generatefromendpointslices[$$GenerateFromEndpointSlices$$]__ | Specifies a label selector to watch for EndpointSlices that will be used to generate the endpoint resource
 | *`blueprint`* __xref:{anchor_prefix}-github-com-3scale-ops-marin3r-apis-marin3r-v1alpha1-blueprint[$$Blueprint$$]__ | Blueprint specifies a template to generate a configuration proto. It is currently only supported to generate secret configuration resources from k8s Secrets
 |===