minimal doc changes for v3 (#5615)

* broker link

* add operator docs

* operatorhub screenshot

* fix operator docs

* update

docs/modules/ROOT/partials/getting-started/proc-exporting-importing-using-rest-api.adoc

@@ -55,4 +55,4 @@ endif::[]
 [role="_additional-resources"]
 .Additional resources
 * For more details, see the `admin` endpoint in the {registry-rest-api}.
-* For details on export tools for migrating from {registry} version 1.x to 2.x, see link:https://github.com/Apicurio/apicurio-registry/tree/main/utils/exportV1[Apicurio Registry export utility for 1.x versions].
+//* For details on export tools for migrating from {registry} version 1.x to 2.x, see link:https://github.com/Apicurio/apicurio-registry/tree/main/utils/exportV1[Apicurio Registry export utility for 1.x versions].

operator/docs/README.adoc

@@ -0,0 +1,17 @@
+== Apicurio Registry Operator Documentation
+
+The Apicurio Registry Operator documentation is created using https://asciidoc.org/[AsciiDoc] and https://antora.org/[Antora] site generator.
+
+You can perform a local build of the documentation for test purposes using the `antora` tool (https://antora.org/):
+
+. Install the `antora` tool using the following steps: https://docs.antora.org/antora/2.3/install-and-run-quickstart/
+. In the `apicurio-registry-operator/docs` directory, enter the following command:
++
+----
+$ antora local-test-playbook.yml
+----
++
+. Change to the `./target/dist/apicurio-registry-operator` directory.
+. Open the generated `index.html` file in your browser.
+
+NOTE: See `docs/modules/ROOT/partials/shared/attributes.adoc` for configurable parameters.

operator/docs/antora.yml

@@ -0,0 +1,6 @@
+name: apicurio-registry-operator
+title: Apicurio Registry Operator
+version: '3.0.0-dev-v1.x'
+start_ROOT: ROOT:index.adoc
+nav:
+  - modules/ROOT/nav.adoc

operator/docs/local-test-playbook.yml

@@ -0,0 +1,27 @@
+site:
+  title: Apicurio Registry Operator PREVIEW
+  url: https://www.apicur.io/registry/docs
+  start_page: apicurio-registry-operator::index.adoc
+content:
+  edit_url: https://github.com/Apicurio/apicurio-registry/tree/main/docs
+  sources:
+    - url: ../../
+      branches: HEAD
+      start_path: operator/docs
+
+ui:
+  bundle:
+    url: https://raw.githubusercontent.com/Apicurio/apicurio-docs-ui/main/dist/ui-bundle.zip
+    snapshot: true
+
+runtime:
+  cache_dir: ./target/antora-cache
+
+output:
+  dir: ./target/dist
+
+asciidoc:
+  attributes:
+    plantuml-server-url: https://www.plantuml.com/plantuml
+    plantuml-fetch-diagram: true
+    mod-loc: partial$

operator/docs/modules/ROOT/examples/apicurioregistry_kafkasql_plain_cr.yaml

@@ -0,0 +1,9 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-kafkasql
+spec:
+  configuration:
+    persistence: "kafkasql"
+    kafkasql:
+      bootstrapServers: "my-cluster-kafka-bootstrap.registry-example-kafkasql-plain.svc:9092"

operator/docs/modules/ROOT/examples/apicurioregistry_kafkasql_scram_cr.yaml

@@ -0,0 +1,14 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-kafkasql-scram
+spec:
+  configuration:
+    persistence: "kafkasql"
+    kafkasql:
+      bootstrapServers: "my-cluster-kafka-bootstrap.registry-example-kafkasql-scram.svc:9093"
+      security:
+        scram:
+          truststoreSecretName: my-cluster-cluster-ca-cert
+          user: my-user
+          passwordSecretName: my-user

operator/docs/modules/ROOT/examples/apicurioregistry_kafkasql_tls_cr.yaml

@@ -0,0 +1,13 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-kafkasql-tls
+spec:
+  configuration:
+    persistence: "kafkasql"
+    kafkasql:
+      bootstrapServers: "my-cluster-kafka-bootstrap.registry-example-kafkasql-tls.svc:9093"
+      security:
+        tls:
+          keystoreSecretName: my-user
+          truststoreSecretName: my-cluster-cluster-ca-cert

operator/docs/modules/ROOT/examples/apicurioregistry_mem_cr.yaml

@@ -0,0 +1,8 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-mem
+spec:
+  configuration:
+    persistence: "mem" # Optional (default value)
+    # NOTE: No additional configuration required for *dev* deployment

operator/docs/modules/ROOT/examples/apicurioregistry_sql_cr.yaml

@@ -0,0 +1,12 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-sql
+spec:
+  configuration:
+    persistence: "sql"
+    sql:
+      dataSource:
+        url: "jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>"
+        userName: "postgres"
+        password: "<password>" # Optional

operator/docs/modules/ROOT/examples/keycloak/apicurioregistry_kafkasql_keycloak_cr.yaml

@@ -0,0 +1,19 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-kafkasql-keycloak
+spec:
+  configuration:
+    security:
+      keycloak:
+        url: "http://keycloak-http-<namespace>.apps.<cluster host>"
+        # ^ Required
+        # Use an HTTP URL in development.
+        realm: "registry"
+        # apiClientId: "registry-client-api"
+        # ^ Optional (default value)
+        # uiClientId: "registry-client-ui"
+        # ^ Optional (default value)
+    persistence: 'kafkasql'
+    kafkasql:
+      bootstrapServers: '<my-cluster>-kafka-bootstrap.<my-namespace>.svc:9092'

operator/docs/modules/ROOT/examples/keycloak/apicurioregistry_mem_keycloak_cr.yaml

@@ -0,0 +1,16 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-keycloak
+spec:
+  configuration:
+    security:
+      keycloak:
+        url: "http://keycloak-http-<namespace>.apps.<cluster host>"
+        # ^ Required
+        # Use an HTTP URL in development.
+        realm: "registry"
+        # apiClientId: "registry-client-api"
+        # ^ Optional (default value)
+        # uiClientId: "registry-client-ui"
+        # ^ Optional (default value)

operator/docs/modules/ROOT/examples/keycloak/apicurioregistry_sql_keycloak_cr.yaml

@@ -0,0 +1,23 @@
+apiVersion: registry.apicur.io/v1
+kind: ApicurioRegistry
+metadata:
+  name: example-apicurioregistry-sql-keycloak
+spec:
+  configuration:
+    persistence: "sql"
+    sql:
+      dataSource:
+        url: "jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>"
+        userName: "postgres"
+        password: "<password>"
+        # ^ Optional
+    security:
+      keycloak:
+        url: "http://keycloak-http-<namespace>.apps.<cluster host>"
+        # ^ Required
+        # Use an HTTP URL in development.
+        realm: "registry"
+        # apiClientId: "registry-client-api"
+        # ^ Optional (default value)
+        # uiClientId: "registry-client-ui"
+        # ^ Optional (default value)

operator/docs/modules/ROOT/examples/keycloak/keycloak.yaml

@@ -0,0 +1,12 @@
+apiVersion: keycloak.org/v1alpha1
+kind: Keycloak
+metadata:
+  name: example-keycloak
+  labels:
+    app: sso
+spec:
+  instances: 1
+  externalAccess:
+    enabled: True
+  podDisruptionBudget:
+    enabled: True

operator/docs/modules/ROOT/examples/keycloak/keycloak_http_ingress.yaml

@@ -0,0 +1,18 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: keycloak-http
+  labels:
+    app: keycloak
+spec:
+  rules:
+    - host: KEYCLOAK_HTTP_HOST
+      http:
+        paths:
+          - path: /
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: keycloak-http
+                port:
+                  number: 8080

operator/docs/modules/ROOT/examples/keycloak/keycloak_http_route.yaml

@@ -0,0 +1,15 @@
+apiVersion: route.openshift.io/v1
+kind: Route
+metadata:
+  name: keycloak-http
+  labels:
+    app: keycloak
+spec:
+  path: /
+  to:
+    kind: Service
+    name: keycloak-http
+    weight: 100
+  port:
+    targetPort: keycloak-http
+  wildcardPolicy: None

operator/docs/modules/ROOT/examples/keycloak/keycloak_http_service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: keycloak-http
+  labels:
+    app: keycloak
+spec:
+  ports:
+    - name: keycloak-http
+      protocol: TCP
+      port: 8080
+      targetPort: 8080
+  selector:
+    app: keycloak
+    component: keycloak
+  type: ClusterIP
+  sessionAffinity: None
+status:
+  loadBalancer: {}

operator/docs/modules/ROOT/examples/keycloak/keycloak_realm.yaml

@@ -0,0 +1,63 @@
+apiVersion: keycloak.org/v1alpha1
+kind: KeycloakRealm
+metadata:
+  name: registry-keycloakrealm
+  labels:
+    app: sso
+spec:
+  instanceSelector:
+    matchLabels:
+      app: sso
+  realm:
+    displayName: Registry
+    enabled: true
+    id: registry
+    realm: registry
+    sslRequired: none
+    roles:
+      realm:
+        - name: sr-admin
+        - name: sr-developer
+        - name: sr-readonly
+    clients:
+      - clientId: registry-client-ui
+        implicitFlowEnabled: true
+        redirectUris:
+          - '*'
+        standardFlowEnabled: true
+        webOrigins:
+          - '*'
+        publicClient: true
+      - clientId: registry-client-api
+        implicitFlowEnabled: true
+        redirectUris:
+          - '*'
+        standardFlowEnabled: true
+        webOrigins:
+          - '*'
+        publicClient: true
+    users:
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-admin
+        username: registry-admin
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-developer
+        username: registry-developer
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-readonly
+        username: registry-user

operator/docs/modules/ROOT/examples/keycloak/keycloak_realm_import.yaml

@@ -0,0 +1,61 @@
+apiVersion: k8s.keycloak.org/v2alpha1
+kind: KeycloakRealmImport
+metadata:
+  name: registry-keycloakrealm
+  labels:
+    app: keycloak
+spec:
+  keycloakCRName: example-keycloak
+  realm:
+    displayName: Registry
+    enabled: true
+    id: registry
+    realm: registry
+    sslRequired: none
+    roles:
+      realm:
+        - name: sr-admin
+        - name: sr-developer
+        - name: sr-readonly
+    clients:
+      - clientId: registry-client-ui
+        implicitFlowEnabled: true
+        redirectUris:
+          - '*'
+        standardFlowEnabled: true
+        webOrigins:
+          - '*'
+        publicClient: true
+      - clientId: registry-client-api
+        implicitFlowEnabled: true
+        redirectUris:
+          - '*'
+        standardFlowEnabled: true
+        webOrigins:
+          - '*'
+        publicClient: true
+    users:
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-admin
+        username: registry-admin
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-developer
+        username: registry-developer
+      - credentials:
+          - temporary: false
+            type: password
+            value: changeme
+        enabled: true
+        realmRoles:
+          - sr-readonly
+        username: registry-user

operator/docs/modules/ROOT/examples/templates/https/README.md

@@ -0,0 +1,21 @@
+This collection of OpenShift templates provides examples of how to configure Red Hat Integration - Service Registry to use HTTPS. Each template contains comments with instructions and details.
+
+We suggest you read the examples in the following order of increasing complexity:
+
+Edge termination:
+
+- registry-default-edge
+- registry-certmanager-edge
+- registry-certmanager-letsencrypt-edge
+- registry-certmanager-letsencrypt-custom-domain-edge
+
+Passthrough termination:
+
+- registry-certmanager-passthrough
+
+In addition, there is a collection of examples on how to configure Red Hat Single Sign-On (Keycloak) to use HTTPS, and integrate it with Service Registry:
+
+- registry-keycloak-default-edge
+- registry-keycloak-certmanager-letsencrypt-edge
+
+You can merge multiple examples together to configure HTTPS for both Service Registry and Red Hat Single Sign-On.