Skip to content
This repository was archived by the owner on Dec 4, 2023. It is now read-only.

Commit 4cfd917

Browse files
smccarthy-iesmccarthy-ie
authored
docs: add categories to instance settings docs, tidy up (Apicurio#2534)
1 parent 4c280fb commit 4cfd917

File tree

6 files changed

+47
-23
lines changed

6 files changed

+47
-23
lines changed

‎docs/modules/ROOT/pages/getting-started/assembly-managing-registry-artifacts-ui.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ This chapter explains how to manage schema and API artifacts stored in the regis
1111
ifdef::apicurio-registry[]
1212
* xref:configuring-registry-ui_{context}[]
1313
endif::[]
14-
* xref:adding-artifacts-using-console_{context}[]
1514
* xref:browsing-artifacts-using-console_{context}[]
15+
* xref:adding-artifacts-using-console_{context}[]
1616
* xref:configuring-rules-using-console_{context}[]
1717
* xref:configuring-settings-using-console_{context}[]
1818
* xref:exporting-importing-using-web-console_{context}[]
@@ -22,8 +22,8 @@ endif::[]
2222
ifdef::apicurio-registry[]
2323
include::{mod-loc}getting-started/proc-configuring-registry-ui.adoc[leveloffset=+1]
2424
endif::[]
25-
include::{mod-loc}getting-started/proc-adding-artifacts-using-console.adoc[leveloffset=+1]
2625
include::{mod-loc}getting-started/proc-browsing-artifacts-using-console.adoc[leveloffset=+1]
26+
include::{mod-loc}getting-started/proc-adding-artifacts-using-console.adoc[leveloffset=+1]
2727
include::{mod-loc}getting-started/proc-configuring-rules-using-console.adoc[leveloffset=+1]
2828
include::{mod-loc}getting-started/proc-configuring-settings-using-console.adoc[leveloffset=+1]
2929
include::{mod-loc}getting-started/proc-exporting-importing-using-web-console.adoc[leveloffset=+1]

‎docs/modules/ROOT/partials/getting-started/proc-browsing-artifacts-using-console.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ endif::[]
4545

4646
ifdef::apicurio-registry,rh-service-registry[]
4747
[role="_additional-resources"]
48+
.Additional resources
4849
* xref:adding-artifacts-using-console_{context}[]
4950
* xref:configuring-rules-using-console_{context}[]
5051
* {registry-reference}

‎docs/modules/ROOT/partials/getting-started/proc-configuring-settings-using-console.adoc

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,20 @@ endif::[]
2929
.Procedure
3030

3131
ifdef::apicurio-registry,rh-service-registry[]
32-
. In the web console, click the *Settings* page.
32+
. In the {registry} web console, click the *Settings* page.
3333
endif::[]
3434

3535
ifdef::rh-openshift-sr[]
36-
. In the web console, click the {registry} instance that you want to configure, and then click the *Settings* page.
36+
. In the {registry} web console, click the {registry} instance that you want to configure, and then click the *Settings* page.
3737
endif::[]
3838

3939
. Select the settings that you want to configure for this {registry} instance:
4040
+
41-
.{registry} instance configuration settings
41+
.Authentication settings
4242
[%header,cols="2,4"]
4343
|===
4444
|Setting
4545
|Description
46-
| *Authenticated read access*
47-
|
48-
ifdef::apicurio-registry,rh-service-registry[]
49-
Displayed only when authentication is already enabled.
50-
endif::[]
51-
When selected, requests from any authenticated user
52-
ifdef::rh-openshift-sr[]
53-
in the same organization
54-
endif::[]
55-
(regardless of their user role) are granted at least read-only access. Not selected by default.
5646
|*HTTP basic authentication*
5747
|
5848
ifdef::apicurio-registry,rh-service-registry[]
@@ -65,6 +55,18 @@ endif::[]
6555
ifdef::rh-openshift-sr[]
6656
Selected by default.
6757
endif::[]
58+
|===
59+
+
60+
.Authorization settings
61+
[%header,cols="2,4"]
62+
|===
63+
|Setting
64+
|Description
65+
ifdef::apicurio-registry,rh-service-registry[]
66+
| *Anonymous read access*
67+
|Displayed only when authentication is already enabled.
68+
When selected, requests from anonymous users (requests without any credentials) are granted read-only access. For example, this is useful if you want to use this instance to publish schemas or APIs externally. Not selected by default.
69+
endif::[]
6870
| *Artifact owner-only authorization*
6971
|
7072
ifdef::apicurio-registry,rh-service-registry[]
@@ -75,19 +77,40 @@ ifdef::apicurio-registry,rh-service-registry[]
7577
| *Artifact group owner-only authorization*
7678
|Displayed only when authentication is already enabled and *Artifact owner-only authorization* is selected.
7779
When selected, {registry} allows only the artifact group owner (creator) to have write access to an artifact group, for example, to add or remove artifacts in the group. Not selected by default.
78-
| *Anonymous read access*
79-
|Displayed only when authentication is already enabled.
80-
When selected, requests from anonymous users (requests without any credentials) are granted read-only access. For example, this is useful if you want to use this instance to publish schemas or APIs externally. Not selected by default.
8180
endif::[]
81+
| *Authenticated read access*
82+
|
83+
ifdef::apicurio-registry,rh-service-registry[]
84+
Displayed only when authentication is already enabled.
85+
endif::[]
86+
When selected, requests from any authenticated user
87+
ifdef::rh-openshift-sr[]
88+
in the same organization
89+
endif::[]
90+
(regardless of their user role) are granted at least read-only access. Not selected by default.
91+
|===
92+
+
93+
.Compatibility settings
94+
[%header,cols="2,4"]
95+
|===
96+
|Setting
97+
|Description
8298
| *Legacy ID mode (compatibility API)*
8399
| When selected, the Confluent Schema Registry compatibility API uses `globalId` instead of `contentId` as an artifact identifier. For example, this is useful when migrating from legacy {registry} instances based on the v1 Core Registry API. Not selected by default.
100+
|===
101+
+
84102
ifdef::apicurio-registry,rh-service-registry[]
103+
.Web console settings
104+
[%header,cols="2,4"]
105+
|===
106+
|Setting
107+
|Description
85108
|*Download link expiry*
86109
| The number of seconds that a generated link to a `.zip` download file is active before expiring for security reasons, for example, when exporting artifact data from the instance. Defaults to 30 seconds.
87110
| *UI read-only mode*
88111
| When selected, the {registry} web console is set to read-only, preventing create, read, update, or delete operations. Changes made using the Core Registry API are not affected by this setting. Not selected by default.
89-
endif::[]
90112
|===
113+
endif::[]
91114

92115
//. Click *Save* to confirm your settings.
93116

‎docs/modules/ROOT/partials/getting-started/proc-installing-kafka-streams-operatorhub.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you do not already have {kafka-streams} installed, you can install the {kafka
1313

1414
* You must have cluster administrator access to an OpenShift cluster
1515
ifdef::rh-service-registry[]
16-
* See link:https://access.redhat.com/documentation/en-us/red_hat_amq/{amq-version}/html/using_amq_streams_on_openshift/getting-started-str[Using AMQ Streams on OpenShift] for detailed information on installing {kafka-streams}. This section shows a simple example of installing using the OpenShift OperatorHub.
16+
* See link:https://access.redhat.com/documentation/en-us/red_hat_amq/{amq-version}/html/using_amq_streams_on_openshift/index[Using AMQ Streams on OpenShift] for detailed information on installing {kafka-streams}. This section shows a simple example of installing using the OpenShift OperatorHub.
1717
endif::[]
1818

1919
.Procedure

‎docs/modules/ROOT/partials/getting-started/proc-migrating-registry-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ifdef::apicurio-registry[]
1818
link:https://github.com/Apicurio/apicurio-registry/releases/download/{registry-release}/apicurio-registry-utils-exportV1-{registry-release}.jar[{registry} exportV1 tool] from GitHub.
1919
endif::[]
2020
ifdef::rh-service-registry[]
21-
link:https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=red.hat.integration[{registry} exportV1 tool] from the Red Hat Customer Portal.
21+
link:{download-url-registry-distribution}[{registry} exportV1 tool] from the Red Hat Customer Portal.
2222
endif::[]
2323
This is a Java application that you can run on the command line.
2424

‎docs/modules/ROOT/partials/shared/attributes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ endif::[]
5252
:context: registry
5353

5454
//integration products
55-
:amq-version: 2022.q1
55+
:amq-version: 2021.q3
5656
:fuse-version: 7.10
5757
:3scale-version: 2.11
5858

@@ -70,7 +70,7 @@ include::attributes-links.adoc[]
7070

7171
// Download URLs
7272
:download-url-registry-container-catalog: https://catalog.redhat.com/software/containers/search
73-
:download-url-registry-distribution: https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=red.hat.integration
73+
:download-url-registry-distribution: https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=red.hat.integration&version=2022-Q1
7474

7575

7676
// internal links

0 commit comments

Comments
 (0)