Skip to content

Commit 67bbfa9

Browse files
smccarthy-iecarlesarnalPaulRMellorwtrockisterobin
authored
Service Registry + Kafka + Quarkus quick start (#328)
* clean up draft of service registry quarkus quick start from bilgin * update section IDs to fix quick start build errors, minor edits * add changes to simplify code example in PR 327 * add final step to view generated schemas * clarify separate consumer and producer processes * pick up new attributes * adding technical review feedback from carles and wojciech * adding technical review feedback from carles and wojciech * add OAUTH_SERVER_URL and OAUTH_REALM env vars required for now until quarkus is updated * add correct SR icon, QE and peer review feedback * regen attributes for new guides * regen attributes for new cli guides * Simplify registry quickstart (#327) * Service registry RHOAS CLI (#324) * docs: initial version of the guide * fix: restructure tutorial content for better alignment for RHOAS CLI * docs: service registry cli guide Signed-off-by: prmellor <[email protected]> * docs: service registry cli guide Signed-off-by: prmellor <[email protected]> * fix: remove confusing sentence Co-authored-by: PaulRMellor <[email protected]> * docs: add abstract to procedures Signed-off-by: prmellor <[email protected]> * fix: build issue * docs: service registry instance without defaults Signed-off-by: prmellor <[email protected]> * fix: add mixxing version from consumer config * docs: remove angle brackets from example Signed-off-by: prmellor <[email protected]> * docs: change keys Signed-off-by: prmellor <[email protected]> * fix: another duplicated key * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-service-registry/README.adoc Co-authored-by: PaulRMellor <[email protected]> * fix: build issue * docs: review edits BI Signed-off-by: prmellor <[email protected]> * docs: review edits WT for name command Signed-off-by: prmellor <[email protected]> Co-authored-by: Wojciech Trocki <[email protected]> * docs: updated readme with new CLI doc (#329) Signed-off-by: prmellor <[email protected]> * docs: cli guide mod doc fix (#330) Signed-off-by: prmellor <[email protected]> * Add basic metrics section in getting started QS. (#332) * Add basic metrics section in getting started QS. * SME review from Duncan * Peer tweaks * docs: fix links in CLI guides (#334) * docs: fix links in CLI guides Signed-off-by: prmellor <[email protected]> * cli command updates Signed-off-by: prmellor <[email protected]> * review edits RK Signed-off-by: prmellor <[email protected]> * return wget to step Signed-off-by: prmellor <[email protected]> * Add access mgmt content. (#325) * fix: ./kafka-console-consumer.sh cmd line (#337) Tested with Kafka 2.8.1 and the correct option is: ``` --consumer.config <String: config file> Consumer config properties file. Note that [consumer-property] takes precedence over this config. ``` * Remove name from service account commands (#336) * Rethinking metrics approach (#339) * Rethinking metrics approach * Tweak metrics section * John feedback * Added missing dash to kafka-console-consumer command. (#335) * Fix the pom.xml files for quarkus-service-registry-quickstart (#343) * Update the url for Service Registry core REST API Reference and Kafka Service Fleet Manager API Reference (#341) * Add placeholder values registry quickstart (#333) * Check installation and version of rhoas CLI on Windows (#338) * fix: add kafka access management for rhoas cli (#342) * fix: add kafka acl commands * fix: add note about cli reference doc * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <[email protected]> * Update rhoas-cli-kafka/README.adoc Co-authored-by: Ramakrishna Pattnaik <[email protected]> * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <[email protected]> * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <[email protected]> * Apply suggestions from code review Co-authored-by: PaulRMellor <[email protected]> * Update README.adoc * fix: add acl bullet * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <[email protected]> * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-kafka/README.adoc Co-authored-by: Ramakrishna Pattnaik <[email protected]> * Update rhoas-cli-kafka/README.adoc * Update rhoas-cli-kafka/README.adoc Co-authored-by: PaulRMellor <[email protected]> Co-authored-by: Ramakrishna Pattnaik <[email protected]> * Add missing links to getting started (#347) * rebase for recently added new guides Co-authored-by: Carles Arnal <[email protected]> Co-authored-by: PaulRMellor <[email protected]> Co-authored-by: Wojciech Trocki <[email protected]> Co-authored-by: Stetson Robinson <[email protected]> Co-authored-by: Davide Bizzarri <[email protected]> Co-authored-by: Enda <[email protected]> Co-authored-by: Duncan Doyle <[email protected]> Co-authored-by: Eric Wittmann <[email protected]> Co-authored-by: HemaHG <[email protected]> Co-authored-by: Carles Arnal <[email protected]> Co-authored-by: rkubis <[email protected]> Co-authored-by: Ramakrishna Pattnaik <[email protected]>
1 parent 45efd40 commit 67bbfa9

File tree

17 files changed

+330
-14
lines changed

17 files changed

+330
-14
lines changed

_artifacts/document-attributes.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

access-mgmt/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

consumer-configuration/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

getting-started-service-registry/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

getting-started/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

kafka-bin-scripts/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

kafkacat/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

nodejs/README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
99
:product-version: 1
1010
:product-long: Application Services
1111
:product: App Services
12-
:registry-product-long: OpenShift Service Registry
12+
:registry-product-long: Red Hat OpenShift Service Registry
1313
:registry: Service Registry
1414
// Placeholder URL, when we get a HOST UI for the service we can put it here properly
1515
:service-url: https://console.redhat.com/beta/application-services/streams/
@@ -24,9 +24,11 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
2424
:base-url: https://github.com/redhat-developer/app-services-guides/blob/main/
2525
:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/
2626
:getting-started-url: getting-started/README.adoc
27+
:getting-started-service-registry-url: getting-started-service-registry/README.adoc
2728
:kafka-bin-scripts-url: kafka-bin-scripts/README.adoc
2829
:kafkacat-url: kafkacat/README.adoc
2930
:quarkus-url: quarkus/README.adoc
31+
:quarkus-service-registry-url: quarkus-service-registry/README.adoc
3032
:rhoas-cli-url: rhoas-cli/README.adoc
3133
:rhoas-cli-kafka-url: rhoas-cli-kafka/README.adoc
3234
:rhoas-cli-service-registry-url: rhoas-cli-service-registry/README.adoc

0 commit comments

Comments
 (0)