diff --git a/docs/modules/onecx-quarkus/pages/includes/attributes.adoc b/docs/modules/onecx-quarkus/pages/includes/attributes.adoc index 023f27a..dd7ae98 100644 --- a/docs/modules/onecx-quarkus/pages/includes/attributes.adoc +++ b/docs/modules/onecx-quarkus/pages/includes/attributes.adoc @@ -1,4 +1,4 @@ :project-version: 0.26.0 -:quarkus-version: 3.13.2 +:quarkus-version: 3.14.3 :examples-dir: ./../examples/ \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-parameters.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-parameters.adoc index 4a2f17c..3fcdb79 100644 --- a/docs/modules/onecx-quarkus/pages/includes/onecx-parameters.adoc +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-parameters.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: onecx-parameters +:summaryTableId: onecx-parameters_onecx-parameters [.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|[[onecx-parameters_configuration]]link:#onecx-parameters_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-enabled]]`link:#onecx-parameters_onecx-parameters-devservices-enabled[onecx.parameters.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-enabled]] [.property-path]##`onecx.parameters.devservices.enabled`## [.description] -- @@ -19,52 +16,52 @@ If DevServices has been explicitly enabled or disabled. DevServices is generally When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-log]]`link:#onecx-parameters_onecx-parameters-devservices-log[onecx.parameters.devservices.log]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-log]] [.property-path]##`onecx.parameters.devservices.log`## [.description] -- Enabled or disable log of the mock-server + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_LOG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_LOG+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-image-name]]`link:#onecx-parameters_onecx-parameters-devservices-image-name[onecx.parameters.devservices.image-name]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-image-name]] [.property-path]##`onecx.parameters.devservices.image-name`## [.description] -- The container image name to use, for container based DevServices providers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-port]]`link:#onecx-parameters_onecx-parameters-devservices-port[onecx.parameters.devservices.port]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-port]] [.property-path]##`onecx.parameters.devservices.port`## [.description] -- @@ -72,18 +69,18 @@ Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-shared]]`link:#onecx-parameters_onecx-parameters-devservices-shared[onecx.parameters.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-shared]] [.property-path]##`onecx.parameters.devservices.shared`## [.description] -- @@ -93,18 +90,18 @@ The discovery uses the `quarkus-dev-service-mockserver` label. The value is conf Container sharing is only used in dev mode. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-service-name]]`link:#onecx-parameters_onecx-parameters-devservices-service-name[onecx.parameters.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-service-name]] [.property-path]##`onecx.parameters.devservices.service-name`## [.description] -- @@ -112,69 +109,69 @@ The value of the `onecx-dev-service-parametersr` label attached to the started c This property is used when you need multiple shared MockServer servers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`onecx-parameters` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-reuse]]`link:#onecx-parameters_onecx-parameters-devservices-reuse[onecx.parameters.devservices.reuse]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-reuse]] [.property-path]##`onecx.parameters.devservices.reuse`## [.description] -- Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Testcontainers configuration has been explicitly set to allow container reuse. To enable reuse, ass `testcontainers.reuse.enable=true` in your `.testcontainers.properties` file, to be stored in your home. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_REUSE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_REUSE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-import-file]]`link:#onecx-parameters_onecx-parameters-devservices-import-file[onecx.parameters.devservices.import-file]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-import-file]] [.property-path]##`onecx.parameters.devservices.import-file`## [.description] -- The import data from file during the start. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_IMPORT_FILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_IMPORT_FILE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-image-name]]`link:#onecx-parameters_onecx-parameters-devservices-db-image-name[onecx.parameters.devservices.db.image-name]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-image-name]] [.property-path]##`onecx.parameters.devservices.db.image-name`## [.description] -- The container image name to use, for unleash database. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_DB_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_DB_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`postgres:15.2` - -a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-service-name]]`link:#onecx-parameters_onecx-parameters-devservices-db-service-name[onecx.parameters.devservices.db.service-name]` - +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-service-name]] [.property-path]##`onecx.parameters.devservices.db.service-name`## [.description] -- @@ -182,132 +179,137 @@ The value of the `onecx-dev-service-parameters-db` label attached to the started This property is used when you need multiple shared Unleash DB servers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_DB_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_DB_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`parameters-db` - -a| [[onecx-parameters_onecx-parameters-enabled]]`link:#onecx-parameters_onecx-parameters-enabled[onecx.parameters.enabled]` - +a| [[onecx-parameters_onecx-parameters-enabled]] [.property-path]##`onecx.parameters.enabled`## [.description] -- If set to true, the application will attempt to look up the configuration from Consul + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[onecx-parameters_onecx-parameters-update-interval-in-milliseconds]]`link:#onecx-parameters_onecx-parameters-update-interval-in-milliseconds[onecx.parameters.update-interval-in-milliseconds]` - +a| [[onecx-parameters_onecx-parameters-update-interval-in-milliseconds]] [.property-path]##`onecx.parameters.update-interval-in-milliseconds`## [.description] -- Scheduler configuration + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_UPDATE_INTERVAL_IN_MILLISECONDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_UPDATE_INTERVAL_IN_MILLISECONDS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`30000` - -a| [[onecx-parameters_onecx-parameters-update-at-start]]`link:#onecx-parameters_onecx-parameters-update-at-start[onecx.parameters.update-at-start]` - +a| [[onecx-parameters_onecx-parameters-update-at-start]] [.property-path]##`onecx.parameters.update-at-start`## [.description] -- Pull parameters during start phase + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_UPDATE_AT_START+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_UPDATE_AT_START+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[onecx-parameters_onecx-parameters-application-id]]`link:#onecx-parameters_onecx-parameters-application-id[onecx.parameters.application-id]` - +a| [[onecx-parameters_onecx-parameters-application-id]] [.property-path]##`onecx.parameters.application-id`## [.description] -- Application ID + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_APPLICATION_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_APPLICATION_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[onecx-parameters_onecx-parameters-instance-id]]`link:#onecx-parameters_onecx-parameters-instance-id[onecx.parameters.instance-id]` - +a| [[onecx-parameters_onecx-parameters-instance-id]] [.property-path]##`onecx.parameters.instance-id`## [.description] -- Instance ID + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_INSTANCE_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_INSTANCE_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[onecx-parameters_onecx-parameters-metrics-enabled]]`link:#onecx-parameters_onecx-parameters-metrics-enabled[onecx.parameters.metrics.enabled]` - +a| [[onecx-parameters_onecx-parameters-metrics-enabled]] [.property-path]##`onecx.parameters.metrics.enabled`## [.description] -- If set to true, the application will send metrics information to the parameter management. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_METRICS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_METRICS_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[onecx-parameters_onecx-parameters-metrics-metrics-interval-in-milliseconds]]`link:#onecx-parameters_onecx-parameters-metrics-metrics-interval-in-milliseconds[onecx.parameters.metrics.metrics-interval-in-milliseconds]` - +a| [[onecx-parameters_onecx-parameters-metrics-metrics-interval-in-milliseconds]] [.property-path]##`onecx.parameters.metrics.metrics-interval-in-milliseconds`## [.description] -- Metrics scheduler configuration + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_METRICS_METRICS_INTERVAL_IN_MILLISECONDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PARAMETERS_METRICS_METRICS_INTERVAL_IN_MILLISECONDS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`20000` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-parameters_onecx.parameters.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-parameters_onecx.parameters.adoc new file mode 100644 index 0000000..3fcdb79 --- /dev/null +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-parameters_onecx.parameters.adoc @@ -0,0 +1,315 @@ +:summaryTableId: onecx-parameters_onecx-parameters +[.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] [[onecx-parameters_onecx-parameters-devservices-enabled]] [.property-path]##`onecx.parameters.devservices.enabled`## + +[.description] +-- +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-log]] [.property-path]##`onecx.parameters.devservices.log`## + +[.description] +-- +Enabled or disable log of the mock-server + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_LOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_LOG+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-image-name]] [.property-path]##`onecx.parameters.devservices.image-name`## + +[.description] +-- +The container image name to use, for container based DevServices providers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-port]] [.property-path]##`onecx.parameters.devservices.port`## + +[.description] +-- +Optional fixed port the dev service will listen to. + +If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-shared]] [.property-path]##`onecx.parameters.devservices.shared`## + +[.description] +-- +Indicates if the MockServer server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MockServer starts a new container. + +The discovery uses the `quarkus-dev-service-mockserver` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-service-name]] [.property-path]##`onecx.parameters.devservices.service-name`## + +[.description] +-- +The value of the `onecx-dev-service-parametersr` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Mockserver looks for a container with the `onecx-dev-service-parameters` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `onecx-dev-service-parameters` label set to the specified value. + +This property is used when you need multiple shared MockServer servers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`onecx-parameters` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-reuse]] [.property-path]##`onecx.parameters.devservices.reuse`## + +[.description] +-- +Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Testcontainers configuration has been explicitly set to allow container reuse. To enable reuse, ass `testcontainers.reuse.enable=true` in your `.testcontainers.properties` file, to be stored in your home. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_REUSE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_REUSE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-import-file]] [.property-path]##`onecx.parameters.devservices.import-file`## + +[.description] +-- +The import data from file during the start. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_IMPORT_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_IMPORT_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-image-name]] [.property-path]##`onecx.parameters.devservices.db.image-name`## + +[.description] +-- +The container image name to use, for unleash database. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_DB_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_DB_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`postgres:15.2` + +a|icon:lock[title=Fixed at build time] [[onecx-parameters_onecx-parameters-devservices-db-service-name]] [.property-path]##`onecx.parameters.devservices.db.service-name`## + +[.description] +-- +The value of the `onecx-dev-service-parameters-db` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Unleash DB looks for a container with the `onecx-dev-service-parameters-db` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `onecx-dev-service-parameters-db` label set to the specified value. + +This property is used when you need multiple shared Unleash DB servers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_DEVSERVICES_DB_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_DEVSERVICES_DB_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`parameters-db` + +a| [[onecx-parameters_onecx-parameters-enabled]] [.property-path]##`onecx.parameters.enabled`## + +[.description] +-- +If set to true, the application will attempt to look up the configuration from Consul + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[onecx-parameters_onecx-parameters-update-interval-in-milliseconds]] [.property-path]##`onecx.parameters.update-interval-in-milliseconds`## + +[.description] +-- +Scheduler configuration + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_UPDATE_INTERVAL_IN_MILLISECONDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_UPDATE_INTERVAL_IN_MILLISECONDS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`30000` + +a| [[onecx-parameters_onecx-parameters-update-at-start]] [.property-path]##`onecx.parameters.update-at-start`## + +[.description] +-- +Pull parameters during start phase + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_UPDATE_AT_START+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_UPDATE_AT_START+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[onecx-parameters_onecx-parameters-application-id]] [.property-path]##`onecx.parameters.application-id`## + +[.description] +-- +Application ID + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_APPLICATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_APPLICATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[onecx-parameters_onecx-parameters-instance-id]] [.property-path]##`onecx.parameters.instance-id`## + +[.description] +-- +Instance ID + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_INSTANCE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_INSTANCE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[onecx-parameters_onecx-parameters-metrics-enabled]] [.property-path]##`onecx.parameters.metrics.enabled`## + +[.description] +-- +If set to true, the application will send metrics information to the parameter management. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_METRICS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_METRICS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[onecx-parameters_onecx-parameters-metrics-metrics-interval-in-milliseconds]] [.property-path]##`onecx.parameters.metrics.metrics-interval-in-milliseconds`## + +[.description] +-- +Metrics scheduler configuration + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PARAMETERS_METRICS_METRICS_INTERVAL_IN_MILLISECONDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PARAMETERS_METRICS_METRICS_INTERVAL_IN_MILLISECONDS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`20000` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc index 63079c6..3914ed0 100644 --- a/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc @@ -1,217 +1,218 @@ - -:summaryTableId: onecx-permissions +:summaryTableId: onecx-permissions_onecx-permissions [.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|[[onecx-permissions_configuration]]link:#onecx-permissions_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[onecx-permissions_onecx-permissions-service-client-url]]`link:#onecx-permissions_onecx-permissions-service-client-url[onecx.permissions.service.client.url]` - +a| [[onecx-permissions_onecx-permissions-service-client-url]] [.property-path]##`onecx.permissions.service.client.url`## [.description] -- Tenant client URL configuration. This property is alias for rest-client generated configuration property `quarkus.rest-client.onecx_permission.url` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_SERVICE_CLIENT_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_SERVICE_CLIENT_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`http://onecx-permission-svc:8080` - -a| [[onecx-permissions_onecx-permissions-enabled]]`link:#onecx-permissions_onecx-permissions-enabled[onecx.permissions.enabled]` - +a| [[onecx-permissions_onecx-permissions-enabled]] [.property-path]##`onecx.permissions.enabled`## [.description] -- Enable interface mapping + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[onecx-permissions_onecx-permissions-cache-enabled]]`link:#onecx-permissions_onecx-permissions-cache-enabled[onecx.permissions.cache-enabled]` - +a| [[onecx-permissions_onecx-permissions-cache-enabled]] [.property-path]##`onecx.permissions.cache-enabled`## [.description] -- Enable interface mapping + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_CACHE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_CACHE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[onecx-permissions_onecx-permissions-allow-all]]`link:#onecx-permissions_onecx-permissions-allow-all[onecx.permissions.allow-all]` - +a| [[onecx-permissions_onecx-permissions-allow-all]] [.property-path]##`onecx.permissions.allow-all`## [.description] -- Allow all permissions + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_ALLOW_ALL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_ALLOW_ALL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[onecx-permissions_onecx-permissions-product-name]]`link:#onecx-permissions_onecx-permissions-product-name[onecx.permissions.product-name]` - +a| [[onecx-permissions_onecx-permissions-product-name]] [.property-path]##`onecx.permissions.product-name`## [.description] -- Product name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_PRODUCT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_PRODUCT_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[onecx-permissions_onecx-permissions-application-id]]`link:#onecx-permissions_onecx-permissions-application-id[onecx.permissions.application-id]` - +a| [[onecx-permissions_onecx-permissions-application-id]] [.property-path]##`onecx.permissions.application-id`## [.description] -- Permissions application ID. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_APPLICATION_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_APPLICATION_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`${quarkus.application.name}` - -a| [[onecx-permissions_onecx-permissions-name]]`link:#onecx-permissions_onecx-permissions-name[onecx.permissions.name]` - +a| [[onecx-permissions_onecx-permissions-name]] [.property-path]##`onecx.permissions.name`## [.description] -- Permissions prefix name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`onecx` - -a| [[onecx-permissions_onecx-permissions-request-token-from-header-param]]`link:#onecx-permissions_onecx-permissions-request-token-from-header-param[onecx.permissions.request-token-from-header-param]` - +a| [[onecx-permissions_onecx-permissions-request-token-from-header-param]] [.property-path]##`onecx.permissions.request-token-from-header-param`## [.description] -- Permissions access token header parameter. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_REQUEST_TOKEN_FROM_HEADER_PARAM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_REQUEST_TOKEN_FROM_HEADER_PARAM+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`Authorization` - -a| [[onecx-permissions_onecx-permissions-token-header-param]]`link:#onecx-permissions_onecx-permissions-token-header-param[onecx.permissions.token-header-param]` - +a| [[onecx-permissions_onecx-permissions-token-header-param]] [.property-path]##`onecx.permissions.token-header-param`## [.description] -- Permissions principal token header parameter. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_TOKEN_HEADER_PARAM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_TOKEN_HEADER_PARAM+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`${tkit.rs.context.token.header-param:apm-principal-token}` - -a| [[onecx-permissions_onecx-permissions-key-separator]]`link:#onecx-permissions_onecx-permissions-key-separator[onecx.permissions.key-separator]` - +a| [[onecx-permissions_onecx-permissions-key-separator]] [.property-path]##`onecx.permissions.key-separator`## [.description] -- Permissions resource action separator. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_KEY_SEPARATOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_KEY_SEPARATOR+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`#` - -a| [[onecx-permissions_onecx-permissions-mock-enabled]]`link:#onecx-permissions_onecx-permissions-mock-enabled[onecx.permissions.mock.enabled]` - +a| [[onecx-permissions_onecx-permissions-mock-enabled]] [.property-path]##`onecx.permissions.mock.enabled`## [.description] -- Enable or disable mock service + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_MOCK_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_MOCK_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[onecx-permissions_onecx-permissions-mock-roles-roles]]`link:#onecx-permissions_onecx-permissions-mock-roles-roles[onecx.permissions.mock.roles."roles"]` - +a| [[onecx-permissions_onecx-permissions-mock-roles-roles]] [.property-path]##`onecx.permissions.mock.roles."roles"`## [.description] -- Mock data for role Map format : . + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_MOCK_ROLES__ROLES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_PERMISSIONS_MOCK_ROLES__ROLES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/util/Map.html[Map] - +-- +|Map>> | -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-permissions_onecx.permissions.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-permissions_onecx.permissions.adoc new file mode 100644 index 0000000..3914ed0 --- /dev/null +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-permissions_onecx.permissions.adoc @@ -0,0 +1,218 @@ +:summaryTableId: onecx-permissions_onecx-permissions +[.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| [[onecx-permissions_onecx-permissions-service-client-url]] [.property-path]##`onecx.permissions.service.client.url`## + +[.description] +-- +Tenant client URL configuration. This property is alias for rest-client generated configuration property `quarkus.rest-client.onecx_permission.url` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_SERVICE_CLIENT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_SERVICE_CLIENT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://onecx-permission-svc:8080` + +a| [[onecx-permissions_onecx-permissions-enabled]] [.property-path]##`onecx.permissions.enabled`## + +[.description] +-- +Enable interface mapping + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[onecx-permissions_onecx-permissions-cache-enabled]] [.property-path]##`onecx.permissions.cache-enabled`## + +[.description] +-- +Enable interface mapping + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_CACHE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_CACHE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[onecx-permissions_onecx-permissions-allow-all]] [.property-path]##`onecx.permissions.allow-all`## + +[.description] +-- +Allow all permissions + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_ALLOW_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_ALLOW_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[onecx-permissions_onecx-permissions-product-name]] [.property-path]##`onecx.permissions.product-name`## + +[.description] +-- +Product name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_PRODUCT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_PRODUCT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[onecx-permissions_onecx-permissions-application-id]] [.property-path]##`onecx.permissions.application-id`## + +[.description] +-- +Permissions application ID. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_APPLICATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_APPLICATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`${quarkus.application.name}` + +a| [[onecx-permissions_onecx-permissions-name]] [.property-path]##`onecx.permissions.name`## + +[.description] +-- +Permissions prefix name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`onecx` + +a| [[onecx-permissions_onecx-permissions-request-token-from-header-param]] [.property-path]##`onecx.permissions.request-token-from-header-param`## + +[.description] +-- +Permissions access token header parameter. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_REQUEST_TOKEN_FROM_HEADER_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_REQUEST_TOKEN_FROM_HEADER_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`Authorization` + +a| [[onecx-permissions_onecx-permissions-token-header-param]] [.property-path]##`onecx.permissions.token-header-param`## + +[.description] +-- +Permissions principal token header parameter. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_TOKEN_HEADER_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_TOKEN_HEADER_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`${tkit.rs.context.token.header-param:apm-principal-token}` + +a| [[onecx-permissions_onecx-permissions-key-separator]] [.property-path]##`onecx.permissions.key-separator`## + +[.description] +-- +Permissions resource action separator. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_KEY_SEPARATOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_KEY_SEPARATOR+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`#` + +a| [[onecx-permissions_onecx-permissions-mock-enabled]] [.property-path]##`onecx.permissions.mock.enabled`## + +[.description] +-- +Enable or disable mock service + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_MOCK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_MOCK_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[onecx-permissions_onecx-permissions-mock-roles-roles]] [.property-path]##`onecx.permissions.mock.roles."roles"`## + +[.description] +-- +Mock data for role Map format : . + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_PERMISSIONS_MOCK_ROLES__ROLES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_PERMISSIONS_MOCK_ROLES__ROLES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map>> +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-security.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-security.adoc index 5a7e5b6..23c7dc2 100644 --- a/docs/modules/onecx-quarkus/pages/includes/onecx-security.adoc +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-security.adoc @@ -1,46 +1,48 @@ - -:summaryTableId: onecx-security +:summaryTableId: onecx-security_onecx-security [.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|[[onecx-security_configuration]]link:#onecx-security_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[onecx-security_onecx-security-mapping-annotation-enabled]]`link:#onecx-security_onecx-security-mapping-annotation-enabled[onecx.security.mapping-annotation.enabled]` - +a|icon:lock[title=Fixed at build time] [[onecx-security_onecx-security-mapping-annotation-enabled]] [.property-path]##`onecx.security.mapping-annotation.enabled`## [.description] -- Enable interface mapping + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_SECURITY_MAPPING_ANNOTATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_SECURITY_MAPPING_ANNOTATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[onecx-security_onecx-security-mapping-annotation-packages]]`link:#onecx-security_onecx-security-mapping-annotation-packages[onecx.security.mapping-annotation.packages]` - +a|icon:lock[title=Fixed at build time] [[onecx-security_onecx-security-mapping-annotation-packages]] [.property-path]##`onecx.security.mapping-annotation.packages`## [.description] -- Mapping includes packages. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_SECURITY_MAPPING_ANNOTATION_PACKAGES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_SECURITY_MAPPING_ANNOTATION_PACKAGES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string |`org.tkit.onecx,gen.org.tkit.onecx` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-security_onecx.security.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-security_onecx.security.adoc new file mode 100644 index 0000000..23c7dc2 --- /dev/null +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-security_onecx.security.adoc @@ -0,0 +1,48 @@ +:summaryTableId: onecx-security_onecx-security +[.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] [[onecx-security_onecx-security-mapping-annotation-enabled]] [.property-path]##`onecx.security.mapping-annotation.enabled`## + +[.description] +-- +Enable interface mapping + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_SECURITY_MAPPING_ANNOTATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_SECURITY_MAPPING_ANNOTATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[onecx-security_onecx-security-mapping-annotation-packages]] [.property-path]##`onecx.security.mapping-annotation.packages`## + +[.description] +-- +Mapping includes packages. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_SECURITY_MAPPING_ANNOTATION_PACKAGES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_SECURITY_MAPPING_ANNOTATION_PACKAGES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`org.tkit.onecx,gen.org.tkit.onecx` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc index 0474072..5e82c2c 100644 --- a/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-tenant.adoc @@ -1,46 +1,48 @@ - -:summaryTableId: onecx-tenant +:summaryTableId: onecx-tenant_onecx-tenant [.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|[[onecx-tenant_configuration]]link:#onecx-tenant_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[onecx-tenant_onecx-tenant-cache-enabled]]`link:#onecx-tenant_onecx-tenant-cache-enabled[onecx.tenant.cache-enabled]` - +a| [[onecx-tenant_onecx-tenant-cache-enabled]] [.property-path]##`onecx.tenant.cache-enabled`## [.description] -- Enable or disable cache for the token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_TENANT_CACHE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_TENANT_CACHE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[onecx-tenant_onecx-tenant-service-client-url]]`link:#onecx-tenant_onecx-tenant-service-client-url[onecx.tenant.service.client.url]` - +a| [[onecx-tenant_onecx-tenant-service-client-url]] [.property-path]##`onecx.tenant.service.client.url`## [.description] -- Tenant client URL configuration. This property is alias for rest-client generated configuration property `quarkus.rest-client.onecx_tenant.url` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++ONECX_TENANT_SERVICE_CLIENT_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++ONECX_TENANT_SERVICE_CLIENT_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`http://onecx-tenant-svc:8080` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/onecx-quarkus/pages/includes/onecx-tenant_onecx.tenant.adoc b/docs/modules/onecx-quarkus/pages/includes/onecx-tenant_onecx.tenant.adoc new file mode 100644 index 0000000..5e82c2c --- /dev/null +++ b/docs/modules/onecx-quarkus/pages/includes/onecx-tenant_onecx.tenant.adoc @@ -0,0 +1,48 @@ +:summaryTableId: onecx-tenant_onecx-tenant +[.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| [[onecx-tenant_onecx-tenant-cache-enabled]] [.property-path]##`onecx.tenant.cache-enabled`## + +[.description] +-- +Enable or disable cache for the token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_TENANT_CACHE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_TENANT_CACHE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[onecx-tenant_onecx-tenant-service-client-url]] [.property-path]##`onecx.tenant.service.client.url`## + +[.description] +-- +Tenant client URL configuration. This property is alias for rest-client generated configuration property `quarkus.rest-client.onecx_tenant.url` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++ONECX_TENANT_SERVICE_CLIENT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++ONECX_TENANT_SERVICE_CLIENT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://onecx-tenant-svc:8080` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 12b67d8..8411d53 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -55,6 +55,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/onecx-quarkus/pages/includes/ + + maven-resources-plugin @@ -67,17 +75,6 @@ modules/onecx-quarkus/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - - - onecx-parameters.adoc - onecx-security.adoc - onecx-permissions.adoc - onecx-tenant.adoc - - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/pom.xml b/pom.xml index 3487ce0..a1baa84 100644 --- a/pom.xml +++ b/pom.xml @@ -48,13 +48,13 @@ ${enforcer.skip} - 3.13.2 - 6.4.4.Final + 3.14.3 + 6.6.0.Final 2.4.7 - 1.11.0 + 1.12.0 - 2.31.0 + 2.32.0 UTF-8 @@ -192,6 +192,11 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + com.googlecode.maven-download-plugin download-maven-plugin