diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable.adoc new file mode 100644 index 00000000..12a91b4d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable.adoc @@ -0,0 +1,65 @@ +:summaryTableId: quarkus-google-cloud-bigtable_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-enabled]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.enabled`## + +[.description] +-- +Indicates whether the Bigtable service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-image-name]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Bigtable service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Bigtable service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable_quarkus.google.adoc new file mode 100644 index 00000000..12a91b4d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-bigtable_quarkus.google.adoc @@ -0,0 +1,65 @@ +:summaryTableId: quarkus-google-cloud-bigtable_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-enabled]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.enabled`## + +[.description] +-- +Indicates whether the Bigtable service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-image-name]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Bigtable service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-bigtable_quarkus-google-cloud-bigtable-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.bigtable.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Bigtable service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_BIGTABLE_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin.adoc new file mode 100644 index 00000000..550a15fb --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-firebase-admin_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firebase-admin_quarkus-google-cloud-firebase-auth-enabled]] [.property-path]##`quarkus.google.cloud.firebase.auth.enabled`## + +[.description] +-- +Enable or disable Firebase authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIREBASE_AUTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIREBASE_AUTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin_quarkus.google.adoc new file mode 100644 index 00000000..550a15fb --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firebase-admin_quarkus.google.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-firebase-admin_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firebase-admin_quarkus-google-cloud-firebase-auth-enabled]] [.property-path]##`quarkus.google.cloud.firebase.auth.enabled`## + +[.description] +-- +Enable or disable Firebase authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIREBASE_AUTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIREBASE_AUTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore.adoc new file mode 100644 index 00000000..9eadd25d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore.adoc @@ -0,0 +1,254 @@ +:summaryTableId: quarkus-google-cloud-firestore_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-enabled]] [.property-path]##`quarkus.google.cloud.firestore.devservice.enabled`## + +[.description] +-- +Indicates whether the Firestore service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-image-name]] [.property-path]##`quarkus.google.cloud.firestore.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Firestore service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.firestore.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Firestore service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-host-override]] [.property-path]##`quarkus.google.cloud.firestore.host-override`## + +[.description] +-- +Overrides the default service host. This is most commonly used for development or testing activities with a local Google Cloud Firestore emulator instance. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_HOST_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_HOST_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-total-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.total-timeout`## + +[.description] +-- +Total timeout for all retries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_TOTAL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_TOTAL_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-initial-retry-delay]] [.property-path]##`quarkus.google.cloud.firestore.retry.initial-retry-delay`## + +[.description] +-- +Delay before the first retry. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RETRY_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RETRY_DELAY+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-retry-delay-multiplier]] [.property-path]##`quarkus.google.cloud.firestore.retry.retry-delay-multiplier`## + +[.description] +-- +Controls the rate of change of the delay. Next retry is multiplied by this factor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RETRY_DELAY_MULTIPLIER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RETRY_DELAY_MULTIPLIER+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-retry-delay]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-retry-delay`## + +[.description] +-- +Limits the maximum retry delay. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RETRY_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RETRY_DELAY+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-attempts]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-attempts`## + +[.description] +-- +Determines the maximum number of attempts. When number of attempts reach this limit they stop retrying. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_ATTEMPTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_ATTEMPTS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-initial-rpc-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.initial-rpc-timeout`## + +[.description] +-- +Timeout for the initial RPC. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RPC_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RPC_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-rpc-timeout-multiplier]] [.property-path]##`quarkus.google.cloud.firestore.retry.rpc-timeout-multiplier`## + +[.description] +-- +Controls the rate of change of the RPC timeout. Next timeout is multiplied by this factor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RPC_TIMEOUT_MULTIPLIER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RPC_TIMEOUT_MULTIPLIER+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-rpc-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-rpc-timeout`## + +[.description] +-- +Limits the maximum RPC timeout. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RPC_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RPC_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-database-id]] [.property-path]##`quarkus.google.cloud.firestore.database-id`## + +[.description] +-- +The firestore database identifier. It not set, the default will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DATABASE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DATABASE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-google-cloud-firestore_quarkus-google] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore_quarkus.google.adoc new file mode 100644 index 00000000..9eadd25d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-firestore_quarkus.google.adoc @@ -0,0 +1,254 @@ +:summaryTableId: quarkus-google-cloud-firestore_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-enabled]] [.property-path]##`quarkus.google.cloud.firestore.devservice.enabled`## + +[.description] +-- +Indicates whether the Firestore service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-image-name]] [.property-path]##`quarkus.google.cloud.firestore.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Firestore service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.firestore.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Firestore service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-host-override]] [.property-path]##`quarkus.google.cloud.firestore.host-override`## + +[.description] +-- +Overrides the default service host. This is most commonly used for development or testing activities with a local Google Cloud Firestore emulator instance. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_HOST_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_HOST_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-total-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.total-timeout`## + +[.description] +-- +Total timeout for all retries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_TOTAL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_TOTAL_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-initial-retry-delay]] [.property-path]##`quarkus.google.cloud.firestore.retry.initial-retry-delay`## + +[.description] +-- +Delay before the first retry. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RETRY_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RETRY_DELAY+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-retry-delay-multiplier]] [.property-path]##`quarkus.google.cloud.firestore.retry.retry-delay-multiplier`## + +[.description] +-- +Controls the rate of change of the delay. Next retry is multiplied by this factor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RETRY_DELAY_MULTIPLIER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RETRY_DELAY_MULTIPLIER+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-retry-delay]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-retry-delay`## + +[.description] +-- +Limits the maximum retry delay. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RETRY_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RETRY_DELAY+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-attempts]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-attempts`## + +[.description] +-- +Determines the maximum number of attempts. When number of attempts reach this limit they stop retrying. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_ATTEMPTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_ATTEMPTS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-initial-rpc-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.initial-rpc-timeout`## + +[.description] +-- +Timeout for the initial RPC. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RPC_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_INITIAL_RPC_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-retry-rpc-timeout-multiplier]] [.property-path]##`quarkus.google.cloud.firestore.retry.rpc-timeout-multiplier`## + +[.description] +-- +Controls the rate of change of the RPC timeout. Next timeout is multiplied by this factor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RPC_TIMEOUT_MULTIPLIER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_RPC_TIMEOUT_MULTIPLIER+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-google-cloud-firestore_quarkus-google-cloud-firestore-retry-max-rpc-timeout]] [.property-path]##`quarkus.google.cloud.firestore.retry.max-rpc-timeout`## + +[.description] +-- +Limits the maximum RPC timeout. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RPC_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_RETRY_MAX_RPC_TIMEOUT+++` +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-google-cloud-firestore_quarkus-google-cloud-firestore-database-id]] [.property-path]##`quarkus.google.cloud.firestore.database-id`## + +[.description] +-- +The firestore database identifier. It not set, the default will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DATABASE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_FIRESTORE_DATABASE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-google-cloud-firestore_quarkus-google] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging.adoc new file mode 100644 index 00000000..bb17b8c5 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging.adoc @@ -0,0 +1,286 @@ +:summaryTableId: quarkus-google-cloud-logging_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-default-log]] [.property-path]##`quarkus.google.cloud.logging.default-log`## + +[.description] +-- +Which Google Operations log should be used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LOG+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-enabled]] [.property-path]##`quarkus.google.cloud.logging.enabled`## + +[.description] +-- +Enable or disable the Google Cloud logging. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-format]] [.property-path]##`quarkus.google.cloud.logging.format`## + +[.description] +-- +Configure base formatting to be either plain text or structured json. Allowed values: TEXT++\|++JSON + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +a|LogFormat +|`text` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-synchronicity]] [.property-path]##`quarkus.google.cloud.logging.synchronicity`## + +[.description] +-- +Configure GCP logging synchronicity. Allowed values: SYNC++\|++ASYNC + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_SYNCHRONICITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_SYNCHRONICITY+++` +endif::add-copy-button-to-env-var[] +-- +a|Synchronicity +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-flush-level]] [.property-path]##`quarkus.google.cloud.logging.flush-level`## + +[.description] +-- +Configure auto flush level. Allowed values: DEBUG++\|++INFO++\|++WARN++\|++ERROR++\|++FATAL + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_FLUSH_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_FLUSH_LEVEL+++` +endif::add-copy-button-to-env-var[] +-- +a|ConfigLevel +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-default-label-default-label]] [.property-path]##`quarkus.google.cloud.logging.default-label."default-label"`## + +[.description] +-- +Configure default labels. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LABEL__DEFAULT_LABEL_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LABEL__DEFAULT_LABEL_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-resource-type]] [.property-path]##`quarkus.google.cloud.logging.resource.type`## + +[.description] +-- +The resource type of the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`global` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-resource-label-label]] [.property-path]##`quarkus.google.cloud.logging.resource.label."label"`## + +[.description] +-- +Resource labels. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_LABEL__LABEL_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_LABEL__LABEL_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-gcp-tracing-enabled]] [.property-path]##`quarkus.google.cloud.logging.gcp-tracing.enabled`## + +[.description] +-- +Use this setting to determine if extracted trace ID's should also be forwarded to GCP for linking with GCP Operations Tracing. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-gcp-tracing-project-id]] [.property-path]##`quarkus.google.cloud.logging.gcp-tracing.project-id`## + +[.description] +-- +If the GCP Operations Tracing is in another project, configure it here. By default the logging project will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-stack-trace-included]] [.property-path]##`quarkus.google.cloud.logging.structured.stack-trace.included`## + +[.description] +-- +Include stack traces when exceptions are thrown. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_STACK_TRACE_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_STACK_TRACE_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-mdc-included]] [.property-path]##`quarkus.google.cloud.logging.structured.mdc.included`## + +[.description] +-- +Include MDC values in the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-mdc-field-name]] [.property-path]##`quarkus.google.cloud.logging.structured.mdc.field-name`## + +[.description] +-- +Field name for MDC values, defaults to 'mdc'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mdc` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-parameters-included]] [.property-path]##`quarkus.google.cloud.logging.structured.parameters.included`## + +[.description] +-- +Include parameter values in the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-parameters-field-name]] [.property-path]##`quarkus.google.cloud.logging.structured.parameters.field-name`## + +[.description] +-- +Field name for parameter values, defaults to 'parameters'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`parameters` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-log-target]] [.property-path]##`quarkus.google.cloud.logging.log-target`## + +[.description] +-- +Configures if logs should be written to stdout or stderr instead of using Google Cloud Operations API. Useful if app is deployed to managed Google Cloud Platform environment with installed logger agent. Possible values: STDOUT, STDERR and CLOUD_LOGGING. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_LOG_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_LOG_TARGET+++` +endif::add-copy-button-to-env-var[] +-- +a|LogTarget +|`cloud-logging` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging_quarkus.google.adoc new file mode 100644 index 00000000..bb17b8c5 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-logging_quarkus.google.adoc @@ -0,0 +1,286 @@ +:summaryTableId: quarkus-google-cloud-logging_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-default-log]] [.property-path]##`quarkus.google.cloud.logging.default-log`## + +[.description] +-- +Which Google Operations log should be used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LOG+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-enabled]] [.property-path]##`quarkus.google.cloud.logging.enabled`## + +[.description] +-- +Enable or disable the Google Cloud logging. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-format]] [.property-path]##`quarkus.google.cloud.logging.format`## + +[.description] +-- +Configure base formatting to be either plain text or structured json. Allowed values: TEXT++\|++JSON + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +a|LogFormat +|`text` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-synchronicity]] [.property-path]##`quarkus.google.cloud.logging.synchronicity`## + +[.description] +-- +Configure GCP logging synchronicity. Allowed values: SYNC++\|++ASYNC + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_SYNCHRONICITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_SYNCHRONICITY+++` +endif::add-copy-button-to-env-var[] +-- +a|Synchronicity +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-flush-level]] [.property-path]##`quarkus.google.cloud.logging.flush-level`## + +[.description] +-- +Configure auto flush level. Allowed values: DEBUG++\|++INFO++\|++WARN++\|++ERROR++\|++FATAL + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_FLUSH_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_FLUSH_LEVEL+++` +endif::add-copy-button-to-env-var[] +-- +a|ConfigLevel +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-default-label-default-label]] [.property-path]##`quarkus.google.cloud.logging.default-label."default-label"`## + +[.description] +-- +Configure default labels. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LABEL__DEFAULT_LABEL_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_DEFAULT_LABEL__DEFAULT_LABEL_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-resource-type]] [.property-path]##`quarkus.google.cloud.logging.resource.type`## + +[.description] +-- +The resource type of the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`global` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-resource-label-label]] [.property-path]##`quarkus.google.cloud.logging.resource.label."label"`## + +[.description] +-- +Resource labels. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_LABEL__LABEL_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_RESOURCE_LABEL__LABEL_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-gcp-tracing-enabled]] [.property-path]##`quarkus.google.cloud.logging.gcp-tracing.enabled`## + +[.description] +-- +Use this setting to determine if extracted trace ID's should also be forwarded to GCP for linking with GCP Operations Tracing. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-gcp-tracing-project-id]] [.property-path]##`quarkus.google.cloud.logging.gcp-tracing.project-id`## + +[.description] +-- +If the GCP Operations Tracing is in another project, configure it here. By default the logging project will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_GCP_TRACING_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-stack-trace-included]] [.property-path]##`quarkus.google.cloud.logging.structured.stack-trace.included`## + +[.description] +-- +Include stack traces when exceptions are thrown. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_STACK_TRACE_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_STACK_TRACE_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-mdc-included]] [.property-path]##`quarkus.google.cloud.logging.structured.mdc.included`## + +[.description] +-- +Include MDC values in the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-mdc-field-name]] [.property-path]##`quarkus.google.cloud.logging.structured.mdc.field-name`## + +[.description] +-- +Field name for MDC values, defaults to 'mdc'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_MDC_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mdc` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-parameters-included]] [.property-path]##`quarkus.google.cloud.logging.structured.parameters.included`## + +[.description] +-- +Include parameter values in the log. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_INCLUDED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_INCLUDED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-structured-parameters-field-name]] [.property-path]##`quarkus.google.cloud.logging.structured.parameters.field-name`## + +[.description] +-- +Field name for parameter values, defaults to 'parameters'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_STRUCTURED_PARAMETERS_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`parameters` + +a| [[quarkus-google-cloud-logging_quarkus-google-cloud-logging-log-target]] [.property-path]##`quarkus.google.cloud.logging.log-target`## + +[.description] +-- +Configures if logs should be written to stdout or stderr instead of using Google Cloud Operations API. Useful if app is deployed to managed Google Cloud Platform environment with installed logger agent. Possible values: STDOUT, STDERR and CLOUD_LOGGING. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_LOGGING_LOG_TARGET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_LOGGING_LOG_TARGET+++` +endif::add-copy-button-to-env-var[] +-- +a|LogTarget +|`cloud-logging` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub.adoc new file mode 100644 index 00000000..421266bc --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub.adoc @@ -0,0 +1,82 @@ +:summaryTableId: quarkus-google-cloud-pubsub_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-enabled]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.enabled`## + +[.description] +-- +Indicates whether the Pub/Sub service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-image-name]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Pub/Sub service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Pub/Sub service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-emulator-host]] [.property-path]##`quarkus.google.cloud.pubsub.emulator-host`## + +[.description] +-- +Enable emulator and set its host. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_EMULATOR_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_EMULATOR_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub_quarkus.google.adoc new file mode 100644 index 00000000..421266bc --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-pubsub_quarkus.google.adoc @@ -0,0 +1,82 @@ +:summaryTableId: quarkus-google-cloud-pubsub_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-enabled]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.enabled`## + +[.description] +-- +Indicates whether the Pub/Sub service should be enabled or not. The default value is 'false'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-image-name]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.image-name`## + +[.description] +-- +Sets the Docker image name for the Google Cloud SDK. This image is used to emulate the Pub/Sub service in the development environment. The default value is 'gcr.io/google.com/cloudsdktool/google-cloud-cli'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gcr.io/google.com/cloudsdktool/google-cloud-cli` + +a|icon:lock[title=Fixed at build time] [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-devservice-emulator-port]] [.property-path]##`quarkus.google.cloud.pubsub.devservice.emulator-port`## + +[.description] +-- +Specifies the emulatorPort on which the Pub/Sub service should run in the development environment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_EMULATOR_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_DEVSERVICE_EMULATOR_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-google-cloud-pubsub_quarkus-google-cloud-pubsub-emulator-host]] [.property-path]##`quarkus.google.cloud.pubsub.emulator-host`## + +[.description] +-- +Enable emulator and set its host. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PUBSUB_EMULATOR_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PUBSUB_EMULATOR_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner.adoc new file mode 100644 index 00000000..9e4deb35 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-spanner_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-spanner_quarkus-google-cloud-spanner-emulator-host]] [.property-path]##`quarkus.google.cloud.spanner.emulator-host`## + +[.description] +-- +Enable emulator and set its host. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SPANNER_EMULATOR_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SPANNER_EMULATOR_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner_quarkus.google.adoc new file mode 100644 index 00000000..9e4deb35 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-spanner_quarkus.google.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-spanner_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-spanner_quarkus-google-cloud-spanner-emulator-host]] [.property-path]##`quarkus.google.cloud.spanner.emulator-host`## + +[.description] +-- +Enable emulator and set its host. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SPANNER_EMULATOR_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SPANNER_EMULATOR_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage.adoc new file mode 100644 index 00000000..626b63c0 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-storage_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-storage_quarkus-google-cloud-storage-host-override]] [.property-path]##`quarkus.google.cloud.storage.host-override`## + +[.description] +-- +Overrides the default service host. This is most commonly used for development or testing activities with a local Google Cloud Storage emulator instance. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_STORAGE_HOST_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_STORAGE_HOST_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage_quarkus.google.adoc new file mode 100644 index 00000000..626b63c0 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud-storage_quarkus.google.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-google-cloud-storage_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud-storage_quarkus-google-cloud-storage-host-override]] [.property-path]##`quarkus.google.cloud.storage.host-override`## + +[.description] +-- +Overrides the default service host. This is most commonly used for development or testing activities with a local Google Cloud Storage emulator instance. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_STORAGE_HOST_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_STORAGE_HOST_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud.adoc new file mode 100644 index 00000000..32837cd7 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud.adoc @@ -0,0 +1,116 @@ +:summaryTableId: quarkus-google-cloud_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud_quarkus-google-cloud-enable-metadata-server]] [.property-path]##`quarkus.google.cloud.enable-metadata-server`## + +[.description] +-- +Enable or disable metadata server access to retrieve configuration options (projectId, region...). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_ENABLE_METADATA_SERVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_ENABLE_METADATA_SERVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud_quarkus-google-cloud-project-id]] [.property-path]##`quarkus.google.cloud.project-id`## + +[.description] +-- +Google Cloud project ID. It defaults to `ServiceOptions.getDefaultProjectId()` if `google.cloud.enable-metadata-server` is set to true (which is the default), so to the project ID corresponding to the default credentials if the default credentials are set, otherwise null. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-service-account-location]] [.property-path]##`quarkus.google.cloud.service-account-location`## + +[.description] +-- +Google Cloud service account file location. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-service-account-encoded-key]] [.property-path]##`quarkus.google.cloud.service-account-encoded-key`## + +[.description] +-- +Google Cloud service account base64 encoded content. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_ENCODED_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_ENCODED_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-access-token-enabled]] [.property-path]##`quarkus.google.cloud.access-token-enabled`## + +[.description] +-- +Enable Google Cloud access token authentication For example, the access token which is returned as part of OpenId Connect Authorization Code Flow may be used to access Google Cloud services on behalf of the authenticated user. Note that if a service account location is configured then the access token will be ignored even if this property is enabled. Disable this property if the default Google Cloud authentication is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_ACCESS_TOKEN_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_ACCESS_TOKEN_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud_quarkus-google-cloud-secret-manager-enabled]] [.property-path]##`quarkus.google.cloud.secret-manager-enabled`## + +[.description] +-- +Whether to enable the secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SECRET_MANAGER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SECRET_MANAGER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-google-cloud_quarkus.google.adoc b/docs/modules/ROOT/pages/includes/quarkus-google-cloud_quarkus.google.adoc new file mode 100644 index 00000000..32837cd7 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-google-cloud_quarkus.google.adoc @@ -0,0 +1,116 @@ +:summaryTableId: quarkus-google-cloud_quarkus-google +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-google-cloud_quarkus-google-cloud-enable-metadata-server]] [.property-path]##`quarkus.google.cloud.enable-metadata-server`## + +[.description] +-- +Enable or disable metadata server access to retrieve configuration options (projectId, region...). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_ENABLE_METADATA_SERVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_ENABLE_METADATA_SERVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud_quarkus-google-cloud-project-id]] [.property-path]##`quarkus.google.cloud.project-id`## + +[.description] +-- +Google Cloud project ID. It defaults to `ServiceOptions.getDefaultProjectId()` if `google.cloud.enable-metadata-server` is set to true (which is the default), so to the project ID corresponding to the default credentials if the default credentials are set, otherwise null. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-service-account-location]] [.property-path]##`quarkus.google.cloud.service-account-location`## + +[.description] +-- +Google Cloud service account file location. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-service-account-encoded-key]] [.property-path]##`quarkus.google.cloud.service-account-encoded-key`## + +[.description] +-- +Google Cloud service account base64 encoded content. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_ENCODED_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SERVICE_ACCOUNT_ENCODED_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-google-cloud_quarkus-google-cloud-access-token-enabled]] [.property-path]##`quarkus.google.cloud.access-token-enabled`## + +[.description] +-- +Enable Google Cloud access token authentication For example, the access token which is returned as part of OpenId Connect Authorization Code Flow may be used to access Google Cloud services on behalf of the authenticated user. Note that if a service account location is configured then the access token will be ignored even if this property is enabled. Disable this property if the default Google Cloud authentication is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_ACCESS_TOKEN_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_ACCESS_TOKEN_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-google-cloud_quarkus-google-cloud-secret-manager-enabled]] [.property-path]##`quarkus.google.cloud.secret-manager-enabled`## + +[.description] +-- +Whether to enable the secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GOOGLE_CLOUD_SECRET_MANAGER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GOOGLE_CLOUD_SECRET_MANAGER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 89830936..505bd89e 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -41,6 +41,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/ROOT/pages/includes/ + + maven-resources-plugin @@ -53,11 +61,6 @@ ${project.basedir}/modules/ROOT/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - quarkus-google-cloud-services.adoc - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/pom.xml b/pom.xml index ba966671..61221896 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ 2.11.0-SNAPSHOT pom - 3.13.0 + 3.14.0 3.5.0 3.26.3 1.41.0-alpha @@ -84,6 +84,11 @@ quarkus-extension-maven-plugin ${quarkus.version} + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + io.quarkus quarkus-maven-plugin