docs(bridge): doc renaming updates (#12146)

Signed-off-by: prmellor <pmellor@redhat.com>

Author: PaulRMellor

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridge.java

@@ -111,14 +111,14 @@ public KafkaBridge(KafkaBridgeSpec spec, KafkaBridgeStatus status) {
     }
 
     @Override
-    @Description("The specification of the Kafka Bridge.")
+    @Description("The specification of the HTTP Bridge.")
     @RequiredInVersions("v1+")
     public KafkaBridgeSpec getSpec() {
         return super.getSpec();
     }
 
     @Override
-    @Description("The status of the Kafka Bridge.")
+    @Description("The status of the HTTP Bridge.")
     public KafkaBridgeStatus getStatus() {
         return super.getStatus();
     }

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridgeSpec.java

@@ -89,7 +89,7 @@ public void setReplicas(int replicas) {
             description = "The `enableMetrics` configuration is deprecated and will be removed in the future.")
     @PresentInVersions("v1beta2")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
-    @Description("Enable the metrics for the Kafka Bridge. Default is false.")
+    @Description("Enable the metrics for the HTTP Bridge. Default is false.")
     public Boolean getEnableMetrics() {
         return enableMetrics;
     }
@@ -110,7 +110,7 @@ public void setMetricsConfig(MetricsConfig metricsConfig) {
         this.metricsConfig = metricsConfig;
     }
 
-    @Description("Logging configuration for Kafka Bridge.")
+    @Description("Logging configuration for HTTP Bridge.")
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     @Override
     public Logging getLogging() {
@@ -154,7 +154,7 @@ public void setAuthentication(KafkaClientAuthentication authentication) {
         this.authentication = authentication;
     }
 
-    @Description("TLS configuration for connecting Kafka Bridge to the cluster.")
+    @Description("TLS configuration for connecting HTTP Bridge to the cluster.")
     @JsonInclude(JsonInclude.Include.NON_NULL)
     public ClientTls getTls() {
         return tls;
@@ -214,7 +214,7 @@ public void setHttp(KafkaBridgeHttpConfig http) {
         this.http = http;
     }
 
-    @Description("The container image used for Kafka Bridge pods. "
+    @Description("The container image used for HTTP Bridge pods. "
         + "If no image name is explicitly specified, the image name corresponds to the image specified in the Cluster Operator configuration. "
         + "If an image name is not defined in the Cluster Operator configuration, a default value is used.")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
@@ -226,7 +226,7 @@ public void setImage(String image) {
         this.image = image;
     }
 
-    @Description("Template for Kafka Bridge resources. " +
+    @Description("Template for HTTP Bridge resources. " +
             "The template allows users to specify how a `Deployment` and `Pod` is generated.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public KafkaBridgeTemplate getTemplate() {
@@ -258,7 +258,7 @@ public void setReadinessProbe(Probe readinessProbe) {
     }
 
     @JsonInclude(JsonInclude.Include.NON_NULL)
-    @Description("The configuration of tracing in Kafka Bridge.")
+    @Description("The configuration of tracing in HTTP Bridge.")
     public Tracing getTracing() {
         return tracing;
     }

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridgeStatus.java

@@ -29,7 +29,7 @@ public class KafkaBridgeStatus extends Status {
     private int replicas;
     private String labelSelector;
 
-    @Description("The URL at which external client applications can access the Kafka Bridge.")
+    @Description("The URL at which external client applications can access the HTTP Bridge.")
     public String getUrl() {
         return url;
     }

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridgeTemplate.java

@@ -44,7 +44,7 @@ public class KafkaBridgeTemplate implements UnknownPropertyPreserving {
     private ResourceTemplate serviceAccount;
     private Map<String, Object> additionalProperties;
 
-    @Description("Template for Kafka Bridge `Deployment`.")
+    @Description("Template for HTTP Bridge `Deployment`.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public DeploymentTemplate getDeployment() {
         return deployment;
@@ -54,7 +54,7 @@ public void setDeployment(DeploymentTemplate deployment) {
         this.deployment = deployment;
     }
 
-    @Description("Template for Kafka Bridge `Pods`.")
+    @Description("Template for HTTP Bridge `Pods`.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public PodTemplate getPod() {
         return pod;
@@ -64,7 +64,7 @@ public void setPod(PodTemplate pod) {
         this.pod = pod;
     }
 
-    @Description("Template for Kafka Bridge API `Service`.")
+    @Description("Template for HTTP Bridge API `Service`.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public InternalServiceTemplate getApiService() {
         return apiService;
@@ -74,7 +74,7 @@ public void setApiService(InternalServiceTemplate apiService) {
         this.apiService = apiService;
     }
 
-    @Description("Template for Kafka Bridge `PodDisruptionBudget`.")
+    @Description("Template for HTTP Bridge `PodDisruptionBudget`.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public PodDisruptionBudgetTemplate getPodDisruptionBudget() {
         return podDisruptionBudget;
@@ -84,7 +84,7 @@ public void setPodDisruptionBudget(PodDisruptionBudgetTemplate podDisruptionBudg
         this.podDisruptionBudget = podDisruptionBudget;
     }
 
-    @Description("Template for the Kafka Bridge container")
+    @Description("Template for the HTTP Bridge container")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public ContainerTemplate getBridgeContainer() {
         return bridgeContainer;
@@ -94,7 +94,7 @@ public void setBridgeContainer(ContainerTemplate bridgeContainer) {
         this.bridgeContainer = bridgeContainer;
     }
 
-    @Description("Template for the Kafka Bridge init container")
+    @Description("Template for the HTTP Bridge init container")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public ContainerTemplate getInitContainer() {
         return initContainer;
@@ -104,7 +104,7 @@ public void setInitContainer(ContainerTemplate initContainer) {
         this.initContainer = initContainer;
     }
 
-    @Description("Template for the Kafka Bridge ClusterRoleBinding.")
+    @Description("Template for the HTTP Bridge ClusterRoleBinding.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public ResourceTemplate getClusterRoleBinding() {
         return clusterRoleBinding;
@@ -114,7 +114,7 @@ public void setClusterRoleBinding(ResourceTemplate clusterRoleBinding) {
         this.clusterRoleBinding = clusterRoleBinding;
     }
 
-    @Description("Template for the Kafka Bridge service account.")
+    @Description("Template for the HTTP Bridge service account.")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public ResourceTemplate getServiceAccount() {
         return serviceAccount;

api/src/test/resources/crds/v1/046-Crd-kafkabridge.yaml

@@ -64,7 +64,7 @@ spec:
                 description: The number of pods in the `Deployment`. Required in the `v1` version of the Strimzi API. Defaults to `1` in the `v1beta2` version of the Strimzi API.
               image:
                 type: string
-                description: "The container image used for Kafka Bridge pods. If no image name is explicitly specified, the image name corresponds to the image specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used."
+                description: "The container image used for HTTP Bridge pods. If no image name is explicitly specified, the image name corresponds to the image specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used."
               bootstrapServers:
                 type: string
                 description: A list of host:port pairs for establishing the initial connection to the Kafka cluster.
@@ -97,7 +97,7 @@ spec:
                       required:
                       - secretName
                     description: Trusted certificates for TLS connection.
-                description: TLS configuration for connecting Kafka Bridge to the cluster.
+                description: TLS configuration for connecting HTTP Bridge to the cluster.
               authentication:
                 type: object
                 properties:
@@ -302,7 +302,7 @@ spec:
                     description: '`ConfigMap` entry where the logging configuration is stored. '
                 required:
                 - type
-                description: Logging configuration for Kafka Bridge.
+                description: Logging configuration for HTTP Bridge.
               clientRackInitImage:
                 type: string
                 description: The image of the init container used for initializing the `client.rack`.
@@ -428,7 +428,7 @@ spec:
                         - RollingUpdate
                         - Recreate
                         description: Pod replacement strategy for deployment configuration changes. Valid values are `RollingUpdate` and `Recreate`. Defaults to `RollingUpdate`.
-                    description: Template for Kafka Bridge `Deployment`.
+                    description: Template for HTTP Bridge `Deployment`.
                   pod:
                     type: object
                     properties:
@@ -1073,7 +1073,7 @@ spec:
                               csi: {}
                               image: {}
                         description: Additional volumes that can be mounted to the pod.
-                    description: Template for Kafka Bridge `Pods`.
+                    description: Template for HTTP Bridge `Pods`.
                   apiService:
                     type: object
                     properties:
@@ -1106,7 +1106,7 @@ spec:
                           - IPv4
                           - IPv6
                         description: "Specifies the IP Families used by the service. Available options are `IPv4` and `IPv6`. If unspecified, Kubernetes will choose the default value based on the `ipFamilyPolicy` setting."
-                    description: Template for Kafka Bridge API `Service`.
+                    description: Template for HTTP Bridge API `Service`.
                   podDisruptionBudget:
                     type: object
                     properties:
@@ -1128,7 +1128,7 @@ spec:
                         type: integer
                         minimum: 0
                         description: "Maximum number of unavailable pods to allow automatic Pod eviction. A Pod eviction is allowed when the `maxUnavailable` number of pods or fewer are unavailable after the eviction. Setting this value to 0 prevents all voluntary evictions, so the pods must be evicted manually. Defaults to 1."
-                    description: Template for Kafka Bridge `PodDisruptionBudget`.
+                    description: Template for HTTP Bridge `PodDisruptionBudget`.
                   bridgeContainer:
                     type: object
                     properties:
@@ -1271,7 +1271,7 @@ spec:
                             subPathExpr:
                               type: string
                         description: Additional volume mounts which should be applied to the container.
-                    description: Template for the Kafka Bridge container.
+                    description: Template for the HTTP Bridge container.
                   clusterRoleBinding:
                     type: object
                     properties:
@@ -1289,7 +1289,7 @@ spec:
                             type: object
                             description: Annotations added to the Kubernetes resource.
                         description: Metadata applied to the resource.
-                    description: Template for the Kafka Bridge ClusterRoleBinding.
+                    description: Template for the HTTP Bridge ClusterRoleBinding.
                   serviceAccount:
                     type: object
                     properties:
@@ -1307,7 +1307,7 @@ spec:
                             type: object
                             description: Annotations added to the Kubernetes resource.
                         description: Metadata applied to the resource.
-                    description: Template for the Kafka Bridge service account.
+                    description: Template for the HTTP Bridge service account.
                   initContainer:
                     type: object
                     properties:
@@ -1450,8 +1450,8 @@ spec:
                             subPathExpr:
                               type: string
                         description: Additional volume mounts which should be applied to the container.
-                    description: Template for the Kafka Bridge init container.
-                description: Template for Kafka Bridge resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
+                    description: Template for the HTTP Bridge init container.
+                description: Template for HTTP Bridge resources. The template allows users to specify how a `Deployment` and `Pod` is generated.
               tracing:
                 type: object
                 properties:
@@ -1462,11 +1462,11 @@ spec:
                     description: "Type of the tracing used. Currently the only supported type is `opentelemetry` for OpenTelemetry tracing. As of Strimzi 0.37.0, `jaeger` type is not supported anymore and this option is ignored."
                 required:
                 - type
-                description: The configuration of tracing in Kafka Bridge.
+                description: The configuration of tracing in HTTP Bridge.
             required:
             - replicas
             - bootstrapServers
-            description: The specification of the Kafka Bridge.
+            description: The specification of the HTTP Bridge.
           status:
             type: object
             properties:
@@ -1496,13 +1496,13 @@ spec:
                 description: The generation of the CRD that was last reconciled by the operator.
               url:
                 type: string
-                description: The URL at which external client applications can access the Kafka Bridge.
+                description: The URL at which external client applications can access the HTTP Bridge.
               replicas:
                 type: integer
                 description: The current number of pods being used to provide this resource.
               labelSelector:
                 type: string
                 description: Label selector for pods providing this resource.
-            description: The status of the Kafka Bridge.
+            description: The status of the HTTP Bridge.
         required:
         - spec

documentation/api/io.strimzi.api.kafka.model.bridge.KafkaBridgeConsumerSpec.adoc

@@ -1,8 +1,8 @@
 :_mod-docs-content-type: CONCEPT
 
-Configures consumer options for the Kafka Bridge.
+Configures consumer options for the HTTP Bridge.
 
-.Example Kafka Bridge consumer configuration
+.Example HTTP Bridge consumer configuration
 [source,yaml,subs="attributes+"]
 ----
 apiVersion: {KafkaBridgeApiVersion}
@@ -47,10 +47,10 @@ Properties with the following prefixes cannot be set:
 * `ssl.` 
 
 If the `config` property contains an option that cannot be changed, it is disregarded, and a warning message is logged to the Cluster Operator log file.
-All other supported options are forwarded to Kafka Bridge, including the following exceptions to the options configured by Strimzi:
+All other supported options are forwarded to HTTP Bridge, including the following exceptions to the options configured by Strimzi:
 
 * Any `ssl` configuration for xref:con-common-configuration-ssl-reference[supported TLS versions and cipher suites]
 
 IMPORTANT: The Cluster Operator does not validate keys or values in the `config` object.
-If an invalid configuration is provided, the Kafka Bridge deployment might not start or might become unstable.
-In this case, fix the configuration so that the Cluster Operator can roll out the new configuration to all Kafka Bridge nodes.
+If an invalid configuration is provided, the HTTP Bridge deployment might not start or might become unstable.
+In this case, fix the configuration so that the Cluster Operator can roll out the new configuration to all HTTP Bridge nodes.

documentation/api/io.strimzi.api.kafka.model.bridge.KafkaBridgeHttpConfig.adoc

@@ -1,9 +1,9 @@
 :_mod-docs-content-type: CONCEPT
 
-Configures HTTP access to a Kafka cluster for the Kafka Bridge.
-The default HTTP configuration is for the Kafka Bridge to listen on port 8080.
+Configures HTTP access to a Kafka cluster for the HTTP Bridge.
+The default HTTP configuration is for the HTTP Bridge to listen on port 8080.
 
-.Example Kafka Bridge HTTP configuration
+.Example HTTP Bridge HTTP configuration
 [source,yaml,subs="attributes+"]
 ----
 apiVersion: {KafkaBridgeApiVersion}
@@ -20,7 +20,7 @@ spec:
   # ...
 ----
 
-As well as enabling HTTP access to a Kafka cluster, HTTP properties provide the capability to enable and define access control for the Kafka Bridge through Cross-Origin Resource Sharing (CORS).
+As well as enabling HTTP access to a Kafka cluster, HTTP properties provide the capability to enable and define access control for the HTTP Bridge through Cross-Origin Resource Sharing (CORS).
 CORS is a HTTP mechanism that allows browser access to selected resources from more than one origin.
 To configure CORS, you define a list of allowed resource origins and HTTP access methods.
 For the origins, you can use a URL or a Java regular expression.

documentation/api/io.strimzi.api.kafka.model.bridge.KafkaBridgeProducerSpec.adoc

@@ -1,8 +1,8 @@
 :_mod-docs-content-type: CONCEPT
 
-Configures producer options for the Kafka Bridge.
+Configures producer options for the HTTP Bridge.
 
-.Example Kafka Bridge producer configuration
+.Example HTTP Bridge producer configuration
 [source,yaml,subs="attributes+"]
 ----
 apiVersion: {KafkaBridgeApiVersion}
@@ -45,10 +45,10 @@ Properties with the following prefixes cannot be set:
 * `ssl.` 
 
 If the `config` property contains an option that cannot be changed, it is disregarded, and a warning message is logged to the Cluster Operator log file.
-All other supported options are forwarded to Kafka Bridge, including the following exceptions to the options configured by Strimzi:
+All other supported options are forwarded to HTTP Bridge, including the following exceptions to the options configured by Strimzi:
 
 * Any `ssl` configuration for xref:con-common-configuration-ssl-reference[supported TLS versions and cipher suites]
 
 IMPORTANT: The Cluster Operator does not validate the keys or values of `config` properties.
-If an invalid configuration is provided, the Kafka Bridge deployment might not start or might become unstable.
-In this case, fix the configuration so that the Cluster Operator can roll out the new configuration to all Kafka Bridge nodes.
+If an invalid configuration is provided, the HTTP Bridge deployment might not start or might become unstable.
+In this case, fix the configuration so that the Cluster Operator can roll out the new configuration to all HTTP Bridge nodes.

documentation/api/io.strimzi.api.kafka.model.bridge.KafkaBridgeSpec.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: CONCEPT
 
-Configures a Kafka Bridge cluster.
+Configures a HTTP Bridge cluster.
 
 Configuration options relate to:
 
@@ -13,7 +13,7 @@ Configuration options relate to:
 [id='property-http-bridge-logging-{context}']
 = Logging
 
-Kafka Bridge has its own preconfigured loggers:
+HTTP Bridge has its own preconfigured loggers:
 
 [cols="1m,2,1",options="header"]
 |===
@@ -76,7 +76,7 @@ spec:
   # ...
 ----
 
-Kafka Bridge uses the Apache `log4j2` logger implementation.
+HTTP Bridge uses the Apache `log4j2` logger implementation.
 Use the `logging` property to configure loggers and logger levels.
 
 You can set log levels using either the `inline` or `external` logging configuration types.