From 306abf4a4cca82735afd1a00b57062eb7041f989 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 13 Aug 2024 01:55:08 +0000 Subject: [PATCH] Sync documentation of main branch --- _data/versioned/main/index/quarkus.yaml | 11 ++ _data/versioned/main/index/relations.yaml | 98 +++++++++++++ .../main/config/quarkus-all-config.adoc | 34 +++++ .../config/quarkus-oidc_quarkus.oidc.adoc | 34 +++++ _versions/main/guides/grpc-cli.adoc | 129 ++++++++++++++++++ _versions/main/guides/grpc.adoc | 1 + 6 files changed, 307 insertions(+) create mode 100644 _versions/main/guides/grpc-cli.adoc diff --git a/_data/versioned/main/index/quarkus.yaml b/_data/versioned/main/index/quarkus.yaml index e085b7c2062..5a396cbfdc8 100644 --- a/_data/versioned/main/index/quarkus.yaml +++ b/_data/versioned/main/index/quarkus.yaml @@ -2816,6 +2816,17 @@ types: - credentials type: guide url: /guides/credentials-provider + - title: Using gRPC CLI + filename: grpc-cli.adoc + summary: This page explains how to use gRPC CLI. + categories: serialization + topics: + - grpc + - cli + extensions: + - io.quarkus:quarkus-grpc-cli + type: guide + url: /guides/grpc-cli - title: Using the Cassandra Client filename: cassandra.adoc summary: This guide covers how to use the Apache Cassandra NoSQL database in Quarkus. diff --git a/_data/versioned/main/index/relations.yaml b/_data/versioned/main/index/relations.yaml index 1c4397747b7..03a57be4696 100644 --- a/_data/versioned/main/index/relations.yaml +++ b/_data/versioned/main/index/relations.yaml @@ -1884,6 +1884,10 @@ url: /guides/update-quarkus type: howto matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using our Tooling url: /guides/tooling type: tutorial @@ -1902,6 +1906,10 @@ url: /guides/cli-tooling type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 /guides/conditional-extension-dependencies: sameTopics: - title: Building my first extension @@ -5683,6 +5691,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -5720,6 +5732,56 @@ url: /guides/grpc-xds type: guide matches: 1 +/guides/grpc-cli: + sameTopics: + - title: Building Quarkus apps with Quarkus Command Line Interface (CLI) + url: /guides/cli-tooling + type: guide + matches: 1 + - title: Command Mode Applications + url: /guides/command-mode-reference + type: reference + matches: 1 + - title: Command Mode with Picocli + url: /guides/picocli + type: guide + matches: 1 + - title: Consuming a gRPC Service + url: /guides/grpc-service-consumption + type: guide + matches: 1 + - title: Deploying your gRPC Service in Kubernetes + url: /guides/grpc-kubernetes + type: guide + matches: 1 + - title: Getting Started with gRPC + url: /guides/grpc-getting-started + type: guide + matches: 1 + - title: gRPC + url: /guides/grpc + type: guide + matches: 1 + - title: gRPC code generation reference guide + url: /guides/grpc-generation-reference + type: reference + matches: 1 + - title: gRPC reference guide + url: /guides/grpc-reference + type: reference + matches: 1 + - title: Implementing a gRPC Service + url: /guides/grpc-service-implementation + type: guide + matches: 1 + - title: Quarkus Virtual Thread support for gRPC services + url: /guides/grpc-virtual-threads + type: guide + matches: 1 + - title: Using xDS gRPC + url: /guides/grpc-xds + type: guide + matches: 1 /guides/grpc-generation-reference: sameTopics: - title: Consuming a gRPC Service @@ -5750,6 +5812,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -5813,6 +5879,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -5900,6 +5970,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using Stork with Kubernetes url: /guides/stork-kubernetes type: guide @@ -5979,6 +6053,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -6042,6 +6120,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -6105,6 +6187,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -6176,6 +6262,10 @@ url: /guides/rest-virtual-threads type: howto matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 - title: Using xDS gRPC url: /guides/grpc-xds type: guide @@ -6251,6 +6341,10 @@ url: /guides/grpc-virtual-threads type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 sameExtensions: - title: gRPC url: /guides/grpc @@ -10766,6 +10860,10 @@ url: /guides/cli-tooling type: guide matches: 1 + - title: Using gRPC CLI + url: /guides/grpc-cli + type: guide + matches: 1 /guides/platform: sameTopics: - title: Class Loading Reference diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc index ddca0f798ef..e65dc54a46a 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -53324,6 +53324,23 @@ endif::add-copy-button-to-env-var[] |link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-oidc_quarkus-oidc-jwks-try-all]] [.property-path]##`quarkus.oidc.jwks.try-all`## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-oidc_quarkus-oidc-provider]] [.property-path]##`quarkus.oidc.provider`## [.description] @@ -55295,6 +55312,23 @@ endif::add-copy-button-to-env-var[] |link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-try-all]] [.property-path]##`quarkus.oidc."tenant".jwks.try-all`## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-oidc_quarkus-oidc-tenant-provider]] [.property-path]##`quarkus.oidc."tenant".provider`## [.description] diff --git a/_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc b/_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc index 154974285c8..e212a1a6ed2 100644 --- a/_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc +++ b/_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc @@ -1975,6 +1975,23 @@ endif::add-copy-button-to-env-var[] |link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-oidc_quarkus-oidc-jwks-try-all]] [.property-path]##`quarkus.oidc.jwks.try-all`## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-oidc_quarkus-oidc-provider]] [.property-path]##`quarkus.oidc.provider`## [.description] @@ -3946,6 +3963,23 @@ endif::add-copy-button-to-env-var[] |link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-try-all]] [.property-path]##`quarkus.oidc."tenant".jwks.try-all`## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-oidc_quarkus-oidc-tenant-provider]] [.property-path]##`quarkus.oidc."tenant".provider`## [.description] diff --git a/_versions/main/guides/grpc-cli.adoc b/_versions/main/guides/grpc-cli.adoc new file mode 100644 index 00000000000..c72376053d9 --- /dev/null +++ b/_versions/main/guides/grpc-cli.adoc @@ -0,0 +1,129 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += Using gRPC CLI +include::_attributes.adoc[] +:categories: serialization +:summary: This page explains how to use gRPC CLI. +:topics: grpc,cli +:extensions: io.quarkus:quarkus-grpc-cli + +This page explains how to use gRPC CLI -- a grpcurl-like tool. + +See basic Quarkus CLI usage first: + +* xref:cli-tooling.adoc[CLI tooling] + +== Examples + +Display gRPC CLI help: + +[source,shell] +---- +quarkus grpc -h +Usage: grpc [-h] [COMMAND] + -h, --help Display this help message. +Commands: + list grpc list + describe grpc describe + invoke grpc invoke +---- + +List all available gRPC services: + +[source,shell] +---- +quarkus grpc list localhost:8080 + +helloworld.Greeter +grpc.health.v1.Health +---- + +Describe a service: + +[source,shell] +---- +quarkus grpc describe localhost:8080 helloworld.Greeter + +{ + "name": "helloworld.proto", + "package": "helloworld", + "dependency": ["google/protobuf/empty.proto"], + "messageType": [{ + "name": "HelloRequest", + "field": [{ + "name": "name", + "number": 1, + "label": "LABEL_OPTIONAL", + "type": "TYPE_STRING" + }] + }, { + "name": "HelloReply", + "field": [{ + "name": "message", + "number": 1, + "label": "LABEL_OPTIONAL", + "type": "TYPE_STRING" + }] + }], + "service": [{ + "name": "Greeter", + "method": [{ + "name": "SayHello", + "inputType": ".helloworld.HelloRequest", + "outputType": ".helloworld.HelloReply", + "options": { + } + }, { + "name": "SayJo", + "inputType": ".google.protobuf.Empty", + "outputType": ".helloworld.HelloReply", + "options": { + } + }, { + "name": "ThreadName", + "inputType": ".helloworld.HelloRequest", + "outputType": ".helloworld.HelloReply", + "options": { + } + }] + }], + "options": { + "javaPackage": "examples", + "javaOuterClassname": "HelloWorldProto", + "javaMultipleFiles": true, + "objcClassPrefix": "HLW" + }, + "syntax": "proto3" +} +{ + "name": "google/protobuf/empty.proto", + "package": "google.protobuf", + "messageType": [{ + "name": "Empty" + }], + "options": { + "javaPackage": "com.google.protobuf", + "javaOuterClassname": "EmptyProto", + "javaMultipleFiles": true, + "goPackage": "google.golang.org/protobuf/types/known/emptypb", + "ccEnableArenas": true, + "objcClassPrefix": "GPB", + "csharpNamespace": "Google.Protobuf.WellKnownTypes" + }, + "syntax": "proto3" +} +---- + +Invoke a service method: + +[source,shell] +---- +quarkus grpc invoke localhost:8080 helloworld.Greeter/SayHello -d '{"name" : "gRPC"}' + +{ + "message": "Hello gRPC" +} +---- diff --git a/_versions/main/guides/grpc.adoc b/_versions/main/guides/grpc.adoc index d0a7abe6bb1..bc16b0bef4c 100644 --- a/_versions/main/guides/grpc.adoc +++ b/_versions/main/guides/grpc.adoc @@ -36,3 +36,4 @@ Quarkus gRPC is based on https://vertx.io/docs/vertx-grpc/java/[Vert.x gRPC]. * xref:grpc-xds.adoc[Enabling xDS gRPC support] * xref:grpc-generation-reference.adoc[gRPC code generation reference guide] * xref:grpc-reference.adoc[gRPC reference guide] +* xref:grpc-cli.adoc[gRPC CLI support]