diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index e4fe36299a..c0567d4667 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,8 +1,8 @@ * xref:getting-started/assembly-intro-to-the-registry.adoc[] * xref:getting-started/assembly-intro-to-registry-rules.adoc[] -ifdef:getting-started/:apicurio-registry[] +ifdef::apicurio-registry[] * xref:getting-started/assembly-installing-registry-docker.adoc[] -endif:getting-started/:[] +endif::[] * xref:getting-started/assembly-installing-registry-openshift.adoc[] * xref:getting-started/assembly-installing-registry-storage-openshift.adoc[] * xref:getting-started/assembly-configuring-the-registry.adoc[] diff --git a/docs/modules/ROOT/pages/getting-started/assembly-installing-registry-storage-openshift.adoc b/docs/modules/ROOT/pages/getting-started/assembly-installing-registry-storage-openshift.adoc index e774fca8f1..85e9310ea1 100644 --- a/docs/modules/ROOT/pages/getting-started/assembly-installing-registry-storage-openshift.adoc +++ b/docs/modules/ROOT/pages/getting-started/assembly-installing-registry-storage-openshift.adoc @@ -9,6 +9,7 @@ This chapter explains how to install and configure your chosen registry storage .{kafka-streams} storage * xref:installing-kafka-streams-operatorhub[] * xref:setting-up-kafka-streams-storage[] +* xref:registry-kafka-topic-names[] ifdef::apicurio-registry[] .Embedded Infinispan storage @@ -42,6 +43,7 @@ endif::[] //include::{mod-loc}getting-started/proc_installing-registry-kafka-streams-template-storage.adoc[leveloffset=+1] include::{mod-loc}getting-started/proc-installing-kafka-streams-operatorhub.adoc[leveloffset=+1] include::{mod-loc}getting-started/proc-setting-up-kafka-streams-storage.adoc[leveloffset=+1] +include::{mod-loc}getting-started/ref-registry-kafka-topic-names.adoc[leveloffset=+2] include::{mod-loc}getting-started/proc-setting-up-infinispan-storage.adoc[leveloffset=+1] include::{mod-loc}getting-started/proc-installing-postgresql-operatorhub.adoc[leveloffset=+1] include::{mod-loc}getting-started/proc-setting-up-postgresql-storage.adoc[leveloffset=+1] diff --git a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-strategy.adoc b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-strategy.adoc index 28aa050d3f..907587a259 100644 --- a/docs/modules/ROOT/partials/getting-started/con-registry-serdes-strategy.adoc +++ b/docs/modules/ROOT/partials/getting-started/con-registry-serdes-strategy.adoc @@ -69,10 +69,10 @@ custom Java class that implements `io.apicurio.registry.utils.serde.strategy.Glo [discrete] [id='configuring-globalid-strategy-{context}'] -== Configuring the global ID strategy +== Global ID strategy configuration You can configure the following application property for the global ID strategy: * `apicurio.registry.check-period-ms`: Configures the remote schema lookup period in milliseconds You can configure application properties as Java system properties or include them in the Quarkus -application.properties file. For more details, see the https://quarkus.io/guides/config#overriding-properties-at-runtime[Quarkus documentation]. +`application.properties` file. For more details, see the https://quarkus.io/guides/config#overriding-properties-at-runtime[Quarkus documentation]. diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-kafka-streams-operatorhub.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-kafka-streams-operatorhub.adoc index 0dff783745..945d7380f1 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-kafka-streams-operatorhub.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-kafka-streams-operatorhub.adoc @@ -23,28 +23,26 @@ endif::[] . Change to the OpenShift project in which {registry} is installed. For example, from the *Project* drop-down, select `my-project`. -. In the left navigation menu, click *Catalog* > *OperatorHub*. +. In the left navigation menu, click *Operators* > *OperatorHub*. ifdef::apicurio-registry[] -. In the *Filter by keyword* text box, enter `Strimzi` to find the *{kafka-streams}* Operator. +. In the *Filter by keyword* text box, enter `{kafka-streams}` to find the *{kafka-streams}* Operator. endif::[] ifdef::rh-service-registry[] -. In the *Filter by keyword* text box, enter `AMQ` to find the *Red Hat Integration - {kafka-streams}* Operator. +. In the *Filter by keyword* text box, enter `{kafka-streams}` to find the *Red Hat Integration - {kafka-streams}* Operator. endif::[] -. Read the information about the Operator, and click *Install*. This displays the *Create Operator Subscription* page. +. Read the information about the Operator, and click *Install* to display the Operator subscription page. . Select your subscription settings, for example: -** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ifdef::apicurio-registry[] ** *Update Channel* > *stable* endif::[] ifdef::rh-service-registry[] ** *Update Channel* > *amq-streams-1.5.x* endif::[] +** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ** *Approval Strategy* > *Manual* -. Click *Subscribe*. This displays the *Operators* > *Installed Operators* page. - -. Wait a few moments until the *Status* for the {kafka-streams} Operator displays *Succeeded* and the subscription is *Up to Date*. +. Click *Install*, and wait a few moments until the Operator is ready for use. .Additional resources * link:https://docs.openshift.com/container-platform/{registry-ocp-version}/operators/olm-adding-operators-to-cluster.html[Adding Operators to an OpenShift cluster] diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc index e4e5b820bd..fbada14de3 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-postgresql-operatorhub.adoc @@ -18,20 +18,18 @@ If you do not already have a PostgreSQL database Operator installed, you can ins . Change to the OpenShift project in which {registry} is installed. For example, from the *Project* drop-down, select `my-project`. -. In the left navigation menu, click *Catalog* > *OperatorHub*. +. In the left navigation menu, click *Operators* > *OperatorHub*. . In the *Filter by keyword* text box, enter `PostgreSQL` to find an Operator suitable for your environment, for example, *Crunchy PostgreSQL for OpenShift* or *PostgreSQL Operator by Dev4Ddevs.com*. -. Read the information about the Operator, and click *Install*. This displays the *Create Operator Subscription* page. +. Read the information about the Operator, and click *Install* to display the Operator subscription page. . Select your subscription settings, for example: -** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ** *Update Channel* > *stable* +** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ** *Approval Strategy* > *Manual* -. Click *Subscribe*. This displays the *Operators* > *Installed Operators* page. - -. Wait a few moments until the *Status* for the PostgreSQL Operator displays *Succeeded* and the subscription is *Up to Date*. +. Click *Install*, and wait a few moments until the Operator is ready for use. + IMPORTANT: You must read the documentation from your chosen *PostgreSQL* Operator for details on how to create and manage your database. diff --git a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-operatorhub.adoc b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-operatorhub.adoc index 6e0f7f3b39..73c574a2d3 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-installing-registry-operatorhub.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-installing-registry-operatorhub.adoc @@ -21,31 +21,29 @@ You can install the {registry} Operator on your OpenShift cluster from the Opera .. In the left navigation menu, click *Home* > *Project* > *Create Project*. .. Enter a project name, for example, `my-project`, and click *Create*. -. In the left navigation menu, click *Catalog* > *OperatorHub*. +. In the left navigation menu, click *Operators* > *OperatorHub*. ifdef::apicurio-registry[] -. In the *Filter by keyword* text box, enter `Registry` to find the *{registry} Operator*. +. In the *Filter by keyword* text box, enter `registry` to find the *{registry} Operator*. endif::[] ifdef::rh-service-registry[] -. In the *Filter by keyword* text box, enter `Registry` to find the *Red Hat Integration - {registry} Operator*. +. In the *Filter by keyword* text box, enter `registry` to find the *Red Hat Integration - {registry} Operator*. endif::[] -. Read the information about the Operator, and click *Install*. This displays the *Create Operator Subscription* page. +. Read the information about the Operator, and click *Install* to display the Operator subscription page. . Select your subscription settings, for example: -** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ifdef::rh-service-registry[] ** *Update Channel* > Select one of the following channels: -*** *serviceregistry-1*: All minor and patch updates, such as version 1.1.0 and 1.0.1. For example, a {registry} installation on version 1.0.x automatically upgrades to 1.1.x releases. -*** *serviceregistry-1.0*: Patch updates only, such as version 1.0.1 and 1.0.2. For example, a {registry} installation on version 1.0.x automatically ignores any 1.1.x releases. +*** *serviceregistry-1*: All minor and patch updates, such as 1.1.0 and 1.0.1. An installation on 1.0.x automatically upgrades to 1.1.x. +*** *serviceregistry-1.0*: Patch updates only, such as 1.0.1 and 1.0.2. An installation on 1.0.x automatically ignores 1.1.x. +*** *serviceregistry-1.1*: Patch updates only, such as 1.1.1 and 1.1.2. An installation on 1.1.x automatically ignores 1.0.x. endif::[] ifdef::apicurio-registry[] ** *Update Channel* > *alpha* endif::[] +** *Installation Mode* > *A specific namespace on the cluster* > *my-project* ** *Approval Strategy* > *Manual* -. Click *Subscribe*. This displays the *Operators* > *Installed Operators* page. - -. Wait a few moments until the *Status* for the {registry} Operator displays *Succeeded* and the subscription is *Up to Date*. - +. Click *Install*, and wait a few moments until the Operator is ready for use. .Additional resources * link:https://docs.openshift.com/container-platform/{registry-ocp-version}/operators/olm-adding-operators-to-cluster.html[Adding Operators to an OpenShift cluster] diff --git a/docs/modules/ROOT/partials/getting-started/proc-setting-up-kafka-streams-storage.adoc b/docs/modules/ROOT/partials/getting-started/proc-setting-up-kafka-streams-storage.adoc index 20964cc748..ea8d5c8fc9 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-setting-up-kafka-streams-storage.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-setting-up-kafka-streams-storage.adoc @@ -85,29 +85,6 @@ spec: http://example-apicurioregistry.my-project.my-domain-name.com/ ---- -.Overriding default Kafka topic names -You can change the default names of the Kafka topics that {registry} will use to store data in Kafka. It is sometimes -necessary to do this when sharing the Kafka cluster with other applications that may already be using topics named -`storage-topic` or `global-id-topic`. - -Change the default topic names by overriding them either by setting appropriate environment variables or by -setting appropriate Java system properties: - -.Environment variables for Kafka topic names -[%header,cols="1,2,2"] -|=== -|Topic default -|Environment variable -|System property -|`storage-topic` -a| `REGISTRY_STREAMS_TOPOLOGY_STORAGE_TOPIC` -a| `registry.streams.topology.storage.topic` -|`global-id-topic` -a| `REGISTRY_STREAMS_TOPOLOGY_GLOBAL_ID_TOPIC` -a| `registry.streams.topology.global.id.topic` -|=== - - .Additional resources ifdef::apicurio-registry[] diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc new file mode 100644 index 0000000000..6273b7035c --- /dev/null +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc @@ -0,0 +1,23 @@ +// Metadata created by nebel +// ParentAssemblies: assemblies/getting-started/as_installing-the-registry.adoc + +[id="registry-kafka-topic-names"] + += Kafka topic name configuration +The default Kafka topic names that {registry} uses to store data in Kafka are `storage-topic` and `global-id-topic`. You might be required to change these topic names if you are sharing your Kafka cluster with other applications that already use topics named `storage-topic` or `global-id-topic`. + +You can override the default topic names by setting the appropriate environment variables or Java system properties: + +.Kafka topic name configuration +[%header,cols="1,2,2"] +|=== +|Default topic name +|Environment variable +|Java system property +|`storage-topic` +a| `REGISTRY_STREAMS_TOPOLOGY_STORAGE_TOPIC` +a| `registry.streams.topology.storage.topic` +|`global-id-topic` +a| `REGISTRY_STREAMS_TOPOLOGY_GLOBAL_ID_TOPIC` +a| `registry.streams.topology.global.id.topic` +|===