Skip to content

Commit 07a8413

Browse files
authored
jc-2045 update rhoas connector cli doc (#643)
* jc-2045 update rhoas connector cli doc * jc-2045 * jc-2045 updated attribute for addon connectors guide
1 parent 7ffb9c4 commit 07a8413

File tree

27 files changed

+74
-8
lines changed

27 files changed

+74
-8
lines changed

README.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
:product: App Services
22
:product-long-kafka: OpenShift Streams for Apache Kafka
33
:product-long-registry: OpenShift Service Registry
4+
:product-long-connectors: OpenShift Connectors
5+
:product-long-rhoas}: OpenShift Application Services
46

57
= {product} guides and samples
68

@@ -25,6 +27,11 @@
2527
* link:./docs/registry/rhoas-cli-getting-started-registry[Getting started with the rhoas CLI for {product-long-registry}]
2628
* link:./docs/registry/quarkus-registry[Using Quarkus applications with Kafka instances and {product-long-registry} instances]
2729

30+
== {product-long-connectors} guides
31+
32+
* link:./docs/connectors/getting-started-connectors/[Getting started with {product-long-connectors}]
33+
* link:./docs/connectors/rhoas-cli-getting-started-connectors/[Managing {product-long-connectors} by using the {product-long-rhoas} CLI]
34+
2835
== Core guides
2936

3037
* link:./docs/rhoas/rhoas-cli-installation[Installing and configuring the rhoas CLI]

docs/_artifacts/document-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/api-designer/getting-started-api-designer/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/connectors/getting-started-connectors/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/connectors/rhoas-cli-getting-started-connectors/README.adoc

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer
@@ -105,14 +107,19 @@ Use this guide to complete the following tasks:
105107
* {base-url}{getting-started-rhoas-cli-url-connectors}#proc-create-connector-namespace_connectors-rhoas-cli[Create a namespace to host your {product-connectors} instances]
106108
* {base-url}{getting-started-rhoas-cli-url-connectors}#proc-building-connector-configuration-cli_connectors-rhoas-cli[Build a configuration file for each type of connector that you want to create]
107109
* {base-url}{getting-started-rhoas-cli-url-connectors}#proc-create-connector-instances_connectors-rhoas-cli[Create {connectors} instances]
110+
* {base-url}{getting-started-rhoas-cli-url-connectors}#proc-commands-managing-connectors[Managing {connectors} instances]
108111

109112
.Prerequisites
110-
113+
ifndef::community[]
111114
* You have a {org-name} account.
112-
* You've installed the latest version of the `rhoas` CLI. See {base-url}{installation-guide-url-cli}[Installing and configuring the rhoas CLI^].
115+
endif::[]
116+
ifdef::community[]
117+
* You have an {org-name} account.
118+
endif::[]
119+
* You've installed the latest version of the `rhoas` CLI as described in {base-url}{installation-guide-url-cli}[Installing and configuring the {product-rhoas} CLI^].
113120
* You've completed the following tasks:
114121
+
115-
*Note:* You can find detailed instructions for these tasks in {base-url}{getting-started-rhoas-cli-url-kafka}[Getting started with the rhoas CLI for {product-long-kafka}^].
122+
*Note:* You can find detailed instructions for these tasks in {base-url}{getting-started-rhoas-cli-url-kafka}[Creating Kafka resources by using the {product-rhoas} CLI^].
116123

117124
** Create a Kafka instance.
118125
[source,subs="+quotes"]
@@ -157,9 +164,11 @@ A {connectors} namespace hosts your {connectors} instances.
157164

158165
The namespace that you use depends on your OpenShift Dedicated environment.
159166

160-
If you're using a trial cluster in your own OpenShift Dedicated environment:: The namespace is created when you add the {product-connectors} service to your trial cluster, as described in https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01[Adding the Red Hat OpenShift {connectors} add-on to your OpenShift Dedicated trial cluster^]. Your OpenShift Dedicated trial cluster namespace is active for 60 days.
167+
If you're using the hosted preview environment:: You must create a preview namespace before you can create {connectors} instances. A preview namespace is active for 48 hours.
168+
169+
If you're using a trial cluster in your own OpenShift Dedicated environment:: The namespace is created when you add the {product-connectors} service to your trial cluster, as described in {addon-url-connectors}[Adding the Red Hat OpenShift {connectors} add-on to your OpenShift cluster^]. Your OpenShift Dedicated trial cluster namespace is active for 60 days.
161170

162-
If you're using the OpenShift {connectors} evaluation site:: You must create an evaluation namespace before you can create {connectors} instances. An evaluation namespace is active for 48 hours.
171+
If you're using your own {rosa-name} cluster:: The namespace is created when you add the {product-connectors} service to your cluster, as described in {addon-url-connectors}[Adding the Red Hat OpenShift {connectors} add-on to your OpenShift cluster^]. You can create {connectors} instances depending on your subscription, as described in https://access.redhat.com/articles/6990631[Red Hat OpenShift Connectors Tiers^].
163172

164173
.Prerequisites
165174

@@ -324,7 +333,7 @@ The result shows the `test-generator.json` and `test-http.json` files.
324333

325334
. Optionally, you can edit a configuration file in an editor of your choice.
326335
+
327-
*Note:* To prevent saving sensitive data to disk, the values for the service account and the namespace are not included in the configuration file. You're prompted to specify those values when you create a {product-connectors} instance.
336+
*Note:* To prevent saving sensitive data to disk, the values for the service account and the namespace are not included in the configuration file. You're prompted to specify those values when you create an {product-connectors} instance.
328337

329338
[id="proc-create-connector-instances_{context}"]
330339
== Creating {connectors} instances
@@ -406,10 +415,10 @@ $ rhoas connector list
406415
. Verify that your sink {connectors} instance is receiving messages by viewing your https://webhook.site[Webhook.site^] page in a web browser.
407416

408417
[id="proc-commands-managing-connectors_{context}"]
409-
== Commands for managing {connectors} instances
418+
== Managing {connectors} instances
410419

411420
[role="_abstract"]
412-
For more information about the `rhoas connector` commands that you can use to manage your {connectors} instances, use the following command help:
421+
The following 'rhoas connector' help commands describe additional 'rhoas connector' commands that you can use to manage your {connectors} instances:
413422

414423
* `rhoas connector namespace -h` for managing {connectors} namespaces
415424
* `rhoas connector type -h` for viewing the available types of connectors

docs/kafka/access-mgmt-kafka/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/kafka/consumer-configuration-kafka/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/kafka/getting-started-kafka/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/kafka/kafka-bin-scripts-kafka/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

docs/kafka/kafka-instance-settings/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
6969
:service-url-connectors: https://console.redhat.com/application-services/connectors
7070
:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
7171
:getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
72+
:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
73+
7274

7375
//OpenShift API Designer
7476
:product-long-api-designer: OpenShift API Designer

0 commit comments

Comments
 (0)