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
redhat-developer · Feb 28, 2023 · 07a8413 · 07a8413
1 parent 7ffb9c4
commit 07a8413
Show file tree

Hide file tree

Showing 27 changed files with 74 additions and 8 deletions.
diff --git a/README.adoc b/README.adoc
@@ -1,6 +1,8 @@
 :product: App Services
 :product-long-kafka: OpenShift Streams for Apache Kafka
 :product-long-registry: OpenShift Service Registry
+:product-long-connectors: OpenShift Connectors
+:product-long-rhoas}: OpenShift Application Services
 
 = {product} guides and samples
 
@@ -25,6 +27,11 @@
 * link:./docs/registry/rhoas-cli-getting-started-registry[Getting started with the rhoas CLI for {product-long-registry}]
 * link:./docs/registry/quarkus-registry[Using Quarkus applications with Kafka instances and {product-long-registry} instances]
 
+== {product-long-connectors} guides
+
+* link:./docs/connectors/getting-started-connectors/[Getting started with {product-long-connectors}]
+* link:./docs/connectors/rhoas-cli-getting-started-connectors/[Managing {product-long-connectors} by using the {product-long-rhoas} CLI]
+
 == Core guides
 
 * link:./docs/rhoas/rhoas-cli-installation[Installing and configuring the rhoas CLI]

diff --git a/docs/_artifacts/document-attributes.adoc b/docs/_artifacts/document-attributes.adoc
@@ -69,6 +69,8 @@
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/api-designer/getting-started-api-designer/README.adoc b/docs/api-designer/getting-started-api-designer/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/connectors/getting-started-connectors/README.adoc b/docs/connectors/getting-started-connectors/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/connectors/rhoas-cli-getting-started-connectors/README.adoc b/docs/connectors/rhoas-cli-getting-started-connectors/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer
@@ -105,14 +107,19 @@ Use this guide to complete the following tasks:
 * {base-url}{getting-started-rhoas-cli-url-connectors}#proc-create-connector-namespace_connectors-rhoas-cli[Create a namespace to host your {product-connectors} instances]
 * {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]
 * {base-url}{getting-started-rhoas-cli-url-connectors}#proc-create-connector-instances_connectors-rhoas-cli[Create {connectors} instances]
+* {base-url}{getting-started-rhoas-cli-url-connectors}#proc-commands-managing-connectors[Managing {connectors} instances]
 
 .Prerequisites
-
+ifndef::community[]
 * You have a {org-name} account.
-* You've installed the latest version of the `rhoas` CLI. See {base-url}{installation-guide-url-cli}[Installing and configuring the rhoas CLI^].
+endif::[]
+ifdef::community[]
+* You have an {org-name} account.
+endif::[]
+* 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^].
 * You've completed the following tasks:
 +
-*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}^].
+*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^].
 
 ** Create a Kafka instance.
 [source,subs="+quotes"]
@@ -157,9 +164,11 @@ A {connectors} namespace hosts your {connectors} instances.
 
 The namespace that you use depends on your OpenShift Dedicated environment.
 
-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.
+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.
+
+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.
 
-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.
+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^].
 
 .Prerequisites
 
@@ -324,7 +333,7 @@ The result shows the `test-generator.json` and `test-http.json` files.
 
 . Optionally, you can edit a configuration file in an editor of your choice.
 +
-*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.
+*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.
 
 [id="proc-create-connector-instances_{context}"]
 == Creating {connectors} instances
@@ -406,10 +415,10 @@ $ rhoas connector list
 . Verify that your sink {connectors} instance is receiving messages by viewing your https://webhook.site[Webhook.site^] page in a web browser.
 
 [id="proc-commands-managing-connectors_{context}"]
-== Commands for managing {connectors} instances
+== Managing {connectors} instances
 
 [role="_abstract"]
-For more information about the `rhoas connector` commands that you can use to manage your {connectors} instances, use the following command help:
+The following 'rhoas connector' help commands describe additional 'rhoas connector' commands that you can use to manage your {connectors} instances:
 
 * `rhoas connector namespace -h` for managing {connectors} namespaces
 * `rhoas connector type -h` for viewing the available types of connectors

diff --git a/docs/kafka/access-mgmt-kafka/README.adoc b/docs/kafka/access-mgmt-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/consumer-configuration-kafka/README.adoc b/docs/kafka/consumer-configuration-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/getting-started-kafka/README.adoc b/docs/kafka/getting-started-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/kafka-bin-scripts-kafka/README.adoc b/docs/kafka/kafka-bin-scripts-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/kafka-instance-settings/README.adoc b/docs/kafka/kafka-instance-settings/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/kcat-kafka/README.adoc b/docs/kafka/kcat-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/message-browsing-kafka/README.adoc b/docs/kafka/message-browsing-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/metrics-monitoring-kafka/README.adoc b/docs/kafka/metrics-monitoring-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/nodejs-kafka/README.adoc b/docs/kafka/nodejs-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/quarkus-kafka/README.adoc b/docs/kafka/quarkus-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/rhoas-cli-getting-started-kafka/README.adoc b/docs/kafka/rhoas-cli-getting-started-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/service-binding-kafka/README.adoc b/docs/kafka/service-binding-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/kafka/topic-configuration-kafka/README.adoc b/docs/kafka/topic-configuration-kafka/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/registry/access-mgmt-registry/README.adoc b/docs/registry/access-mgmt-registry/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/registry/getting-started-registry/README.adoc b/docs/registry/getting-started-registry/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/registry/quarkus-registry/README.adoc b/docs/registry/quarkus-registry/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/registry/rhoas-cli-getting-started-registry/README.adoc b/docs/registry/rhoas-cli-getting-started-registry/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/registry/service-binding-registry/README.adoc b/docs/registry/service-binding-registry/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/rhoas/iac_tools_rhoas/README.adoc b/docs/rhoas/iac_tools_rhoas/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer

diff --git a/docs/rhoas/rhoas-cli-installation/README.adoc b/docs/rhoas/rhoas-cli-installation/README.adoc
@@ -69,6 +69,8 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :service-url-connectors: https://console.redhat.com/application-services/connectors
 :getting-started-url-connectors: connectors/getting-started-connectors/README.adoc
 :getting-started-rhoas-cli-url-connectors: connectors/rhoas-cli-getting-started-connectors/README.adoc
+:addon-url-connectors: https://access.redhat.com/documentation/en-us/openshift_connectors/1/guide/15a79de0-8827-4bf1-b445-8e3b3eef7b01
+
 
 //OpenShift API Designer
 :product-long-api-designer: OpenShift API Designer