Skip to content

Commit b03ee0f

Browse files
docs: JK10274.2: Amended section title to include attribute. (#615)
* docs: JK10274.2: Amended section title to include attribute. * Corrected typo and incorrect product name and removed duplicate info. * Added attributes. * Update README.adoc Co-authored-by: John Byrne <[email protected]>
1 parent 2489d8c commit b03ee0f

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

docs/rhoas/iac_tools_rhoas/README.adoc

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ An Ansible role is a special kind of playbook that is fully self-contained and p
119119
=== Installing the OpenShift Application Services Ansible collection
120120

121121
[role="_abstract"]
122-
You can use the OpenShift Application Services Ansible (RHOAS) https://galaxy.ansible.com/rhoas/rhoas[Ansible collection] to fully manage your Kafka environment with Ansible. You can create, view, configure, and delete the following {product-long-kafka} resources:
122+
You can use the {product-long-rhoas} (RHOAS) https://galaxy.ansible.com/rhoas/rhoas[Ansible collection] to fully manage your Kafka environment with Ansible. You can create, view, configure, and delete the following {product-long-kafka} resources:
123123

124124
* Kafka instances
125125
* Service accounts
@@ -178,28 +178,21 @@ $ ansible-doc rhoas.rhoas.create_kafka
178178
====
179179

180180
[id="proc-using-rhoas-ansible-collection_{context}"]
181-
=== Using the {product-long-rhoas} Ansible collection
181+
=== Using the OpenShift Application Services Ansible collection
182182

183183
[role="_abstract"]
184-
You can use the OpenShift Application Services (RHOAS) https://galaxy.ansible.com/rhoas/rhoas[Ansible collection] to fully manage your Kafka environment with Ansible. You can create, view, configure, and delete the following {product-long-kafka} resources:
185-
186-
* Kafka instance
187-
* Service accounts
188-
* Topics
189-
* ACLS
190-
191184
The procedure in this section shows how to create and run an example playbook. The example playbook includes modules for creating a Kafka instance, topic, and service account, and assigning permissions to the service account. You also configure modules to delete the resources that you previously created.
192185

193186
.Prerequisites
194187
* You have a Red Hat account.
195188
* You have an offline token used to authenticate the Ansible modules with the {product-long-rhoas} API.
196189

197190
[NOTE]
198-
The offline token is a refresh token with no expiry and can be used by non-interactive processes to provide an access token for {product-long-rhoas} to authenticate the user. The token is an OpenShift offline token and you can find it at https://cloud.redhat.com/openshift/token.
191+
The offline token is a refresh token with no expiry and can be used by non-interactive processes to provide an access token for OpenShift Application Services to authenticate the user. The token is an OpenShift offline token and you can find it at https://cloud.redhat.com/openshift/token.
199192

200193

201194
.Procedure
202-
. In your IDE, create a new enviornment variables (`.env`) file.
195+
. In your IDE, create a new environment variables (`.env`) file.
203196
. In the `.env` file, add the following variables required by the Ansible collection:
204197
+
205198
`API_BASE_HOST`:: This is the base URL for the API. For example, `\https://api.openshift.com`.
@@ -438,7 +431,7 @@ You can fully manage your Kafka environment through your Terraform system using
438431

439432

440433
[id="proc-install-rhoas-terraform-provider_{context}"]
441-
=== Installing the {product-long-rhoas} Terraform provider
434+
=== Installing the OpenShift Application Services Terraform provider
442435

443436
.Prerequisites
444437
* You have a Red Hat account.
@@ -488,18 +481,18 @@ $ terraform init
488481
When the Terraform provider has been initialized, you see a confirmation message.
489482

490483
[id="proc-using-terraform_{context}"]
491-
=== Using the {product-long-rhoas} (RHOAS) Terraform provider
484+
=== Using the OpenShift Application Services Terraform provider
492485

493486
Resources are the most important element in the Terraform language. Each resource block in a Terraform provider describes one or more infrastructure objects. For {product-long-kafka}, such infrastructure objects might include Kafka instances, service accounts, Access Control Lists (ACLs), and topics. The procedure that follows shows what resources you can add to your Terraform configuration file to create a Kafka instance and its associated resources such as service accounts and topics.
494487

495488
.Prerequisites
496489

497490
* You have a Red Hat account.
498-
* You have an offline token that authenticates the Terraform resources with the OpenShift Application Services API.
491+
* You have an offline token that authenticates the Terraform resources with the {product-long-rhoas} API.
499492

500493
[NOTE]
501494
====
502-
The offline token is a refresh token with no expiry and can be used by non-interactive processes to provide an access token for {product-long-rhoas} to authenticate the user. The token is an OpenShift offline token and you can find it at https://cloud.redhat.com/openshift/token. Because the offline token is a sensitive value that varies between environments it is best specified as an `OFFLINE_TOKEN` environment variable when running `terraform apply` in a terminal. To set this environment variable, enter the following command in a terminal window, replacing _<offline_token>_ with the value of the offline token:
495+
The offline token is a refresh token with no expiry and can be used by non-interactive processes to provide an access token for OpenShift Application Services to authenticate the user. The token is an OpenShift offline token and you can find it at https://cloud.redhat.com/openshift/token. Because the offline token is a sensitive value that varies between environments it is best specified as an `OFFLINE_TOKEN` environment variable when running `terraform apply` in a terminal. To set this environment variable, enter the following command in a terminal window, replacing _<offline_token>_ with the value of the offline token:
503496
[source, subs="+quotes"]
504497
----
505498
export OFFLINE_TOKEN=<offline_token>

0 commit comments

Comments
 (0)