Sync documentation of main branch

quarkusio · Mar 5, 2024 · 15e58fd · 15e58fd
1 parent 54eaf9f
commit 15e58fd
Show file tree

Hide file tree

Showing 33 changed files with 2,157 additions and 132 deletions.
diff --git a/_data/versioned/main/index/quarkus.yaml b/_data/versioned/main/index/quarkus.yaml
@@ -328,6 +328,16 @@ types:
     - io.quarkus:quarkus-grpc
     type: reference
     url: /guides/grpc-generation-reference
+  - title: gRPC reference guide
+    filename: grpc-reference.adoc
+    summary: Learn how to configure gRPC server and clients.
+    categories: serialization
+    topics:
+    - grpc
+    extensions:
+    - io.quarkus:quarkus-grpc
+    type: reference
+    url: /guides/grpc-reference
   concepts:
   - title: Authentication mechanisms in Quarkus
     filename: security-authentication-mechanisms.adoc

diff --git a/_data/versioned/main/index/relations.yaml b/_data/versioned/main/index/relations.yaml
@@ -5400,6 +5400,10 @@
     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
@@ -5429,6 +5433,10 @@
     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
@@ -5459,6 +5467,10 @@
     url: /guides/grpc
     type: guide
     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
@@ -5488,6 +5500,10 @@
     url: /guides/grpc
     type: guide
     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
@@ -5514,6 +5530,10 @@
     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
@@ -5543,6 +5563,10 @@
     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
@@ -5577,6 +5601,10 @@
     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
@@ -5626,6 +5654,10 @@
     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
@@ -5646,6 +5678,69 @@
     url: /guides/stork-kubernetes
     type: guide
     matches: 1
+/guides/grpc-reference:
+  sameTopics:
+  - 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: 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
+  sameExtensions:
+  - 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: 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
 /guides/grpc-service-consumption:
   sameTopics:
   - title: Deploying your gRPC Service in Kubernetes
@@ -5664,6 +5759,10 @@
     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
@@ -5693,6 +5792,10 @@
     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
@@ -5723,6 +5826,10 @@
     url: /guides/grpc-generation-reference
     type: reference
     matches: 1
+  - title: gRPC reference guide
+    url: /guides/grpc-reference
+    type: reference
+    matches: 1
   - title: Quarkus Virtual Thread support for gRPC services
     url: /guides/grpc-virtual-threads
     type: guide
@@ -5752,6 +5859,10 @@
     url: /guides/grpc-generation-reference
     type: reference
     matches: 1
+  - title: gRPC reference guide
+    url: /guides/grpc-reference
+    type: reference
+    matches: 1
   - title: Quarkus Virtual Thread support for gRPC services
     url: /guides/grpc-virtual-threads
     type: guide
@@ -5778,6 +5889,10 @@
     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
@@ -5823,6 +5938,10 @@
     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
@@ -5849,6 +5968,10 @@
     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

diff --git a/...configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration b/...configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.GrpcClientConfiguration
diff --git a/...fig/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig b/...fig/all-configuration-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig
@@ -0,0 +1 @@
+[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Whether SSL/TLS is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":".trust-all","additionalKeys":[],"configDoc":"Enable trusting all certificates. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_ALL","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.PemTrustCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERTIFICATE_PEM_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERTIFICATE_JKS_PASSWORD","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-p12","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_TRUST_CERTIFICATE_P12_PASSWORD","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.PemKeyCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_PEM_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_PEM_CERTS","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_JKS_PATH","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_JKS_PASSWORD","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-p12","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.grpc.runtime.config.TlsClientConfig.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-certificate-p12.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_P12_PATH","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-p12.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEY_CERTIFICATE_P12_PASSWORD","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".verify-hostname","additionalKeys":[],"configDoc":"Whether hostname should be verified in the SSL/TLS handshake.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-hostname","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERIFY_HOSTNAME","enum":false}}]
diff --git a/...tion-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.JksConfiguration b/...tion-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.JksConfiguration
@@ -0,0 +1 @@
+[{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}}]
diff --git a/...oups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PemKeyCertConfiguration b/...oups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PemKeyCertConfiguration
@@ -0,0 +1 @@
+[{"configDocKey":{"type":"string","key":".keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_KEYS","enum":false}},{"configDocKey":{"type":"string","key":".certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTS","enum":false}}]
diff --git a/...ps-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PemTrustCertConfiguration b/...ps-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PemTrustCertConfiguration
@@ -0,0 +1 @@
+[{"configDocKey":{"type":"string","key":".certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_CERTS","enum":false}}]
diff --git a/...tion-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PfxConfiguration b/...tion-groups-generated-doc/io.quarkus.grpc.runtime.config.TlsClientConfig.PfxConfiguration
@@ -0,0 +1 @@
+[{"configDocKey":{"type":"string","key":".path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PATH","enum":false}},{"configDocKey":{"type":"string","key":".password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_PASSWORD","enum":false}}]