diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..440d2c5 --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,3 @@ +name: onecx-welcome +title: Welcome Bff +version: latest \ No newline at end of file diff --git a/docs/modules/onecx-welcome-bff/nav.adoc b/docs/modules/onecx-welcome-bff/nav.adoc new file mode 100644 index 0000000..069f442 --- /dev/null +++ b/docs/modules/onecx-welcome-bff/nav.adoc @@ -0,0 +1 @@ +* xref:onecx-welcome-bff:index.adoc[Welcome Bff] \ No newline at end of file diff --git a/docs/modules/onecx-welcome-bff/pages/index.adoc b/docs/modules/onecx-welcome-bff/pages/index.adoc new file mode 100644 index 0000000..a80c49e --- /dev/null +++ b/docs/modules/onecx-welcome-bff/pages/index.adoc @@ -0,0 +1,8 @@ +include::onecx-welcome-bff-attributes.adoc[opts=optional] + +== onecx-welcome-bff + +include::docs.adoc[opts=optional] + + +include::onecx-welcome-bff-docs.adoc[opts=optional] diff --git a/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-attributes.adoc b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-attributes.adoc new file mode 100644 index 0000000..7532735 --- /dev/null +++ b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-attributes.adoc @@ -0,0 +1,5 @@ + +:docker-registry: https://github.com/onecx/onecx-welcome-bff/pkgs/container/onecx-welcome-bff +:helm-registry: https://github.com/onecx/onecx-welcome-bff/pkgs/container/charts%2Fonecx-welcome-bff +:properties-file: src/main/resources/application.properties +:helm-file: src/main/helm/values.yaml \ No newline at end of file diff --git a/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-docs.adoc b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-docs.adoc new file mode 100644 index 0000000..ce73223 --- /dev/null +++ b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-docs.adoc @@ -0,0 +1,62 @@ + +include::onecx-welcome-bff-attributes.adoc[opts=optional] + +=== Default properties + +.{properties-file} +[%collapsible%open] +==== +[source,properties,subs=attributes+] +---- +quarkus.http.auth.permission.health.paths=/q/* +quarkus.http.auth.permission.health.policy=permit +quarkus.http.auth.permission.default.paths=/* +quarkus.http.auth.permission.default.policy=authenticated +onecx.permissions.application-id=${quarkus.application.name} +org.eclipse.microprofile.rest.client.propagateHeaders=apm-principal-token +%prod.quarkus.rest-client.onecx_welcome_internal.url=http://onecx-welcome-svc:8080 +%prod.quarkus.oidc-client.client-id=${quarkus.application.name} +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.config-key=onecx_welcome_internal +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.base-package=gen.org.tkit.onecx.welcome.client +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.return-response=true +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.additional-api-type-annotations=@org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders; +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.type-mappings.File=byte[] +quarkus.openapi-generator.codegen.spec.onecx_welcome_internal_yaml.additional-model-type-annotations=@io.quarkus.runtime.annotations.RegisterForReflection; +quarkus.openapi-generator.codegen.input-base-dir=target/tmp/openapi +---- +==== + +=== Extensions + +include::onecx-welcome-bff-extensions.adoc[opts=optional] + +=== Container + +{docker-registry}[Docker registry] + + +=== Helm + +{helm-registry}[Helm registry] + +Default values + +.{helm-file} +[source,yaml] +---- +app: + name: bff + image: + repository: "onecx/onecx-welcome-bff" + operator: + # Permission + permission: + enabled: true + spec: + permissions: + image: + read: permission on all GET requests and POST search + write: permission on PUT, POST, PATCH requests, where objects are saved or updated + delete: permission on all DELETE requests +---- + diff --git a/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-extensions.adoc b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-extensions.adoc new file mode 100644 index 0000000..21f0179 --- /dev/null +++ b/docs/modules/onecx-welcome-bff/pages/onecx-welcome-bff-extensions.adoc @@ -0,0 +1,145 @@ + +include::onecx-welcome-bff-attributes.adoc[opts=optional] + +[.extension.table.searchable, cols="50,.^15,.^15,.^20"] +|=== +h| Extensions +h| Documentation +h| Configuration +h| Version + +| quarkus-rest + +| https://quarkus.io/guides/rest[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-rest.adoc[Link] +| 3.9.3 + +| quarkus-smallrye-openapi + +| https://quarkus.io/guides/openapi-swaggerui[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc[Link] +| 3.9.3 + +| quarkus-rest-jackson + +| https://quarkus.io/guides/rest-json[Link] +| +| 3.9.3 + +| quarkus-smallrye-health + +| https://quarkus.io/guides/smallrye-health[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-health.adoc[Link] +| 3.9.3 + +| quarkus-opentelemetry + +| https://quarkus.io/guides/opentelemetry[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-opentelemetry.adoc[Link] +| 3.9.3 + +| quarkus-micrometer-registry-prometheus + +| https://quarkus.io/guides/telemetry-micrometer[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-micrometer-registry-prometheus.adoc[Link] +| 3.9.3 + +| quarkus-openapi-generator + +| https://docs.quarkiverse.io/quarkus-openapi-generator/dev/index.html[Link] +| https://github.com/quarkiverse/quarkus-openapi-generator/blob/2.4.1/docs/modules/ROOT/pages/includes/quarkus-openapi-generator.adoc[Link] +| 2.4.1 + +| quarkus-rest-client-reactive-jackson + +| https://quarkus.io/guides/rest-client[Link] +| +| 3.9.3 + +| tkit-quarkus-log-cdi + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-cdi.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-cdi.adoc[Link] +| 2.22.0 + +| tkit-quarkus-log-rs + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-rs.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-rs.adoc[Link] +| 2.22.0 + +| tkit-quarkus-log-json + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-json.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-json.adoc[Link] +| 2.22.0 + +| tkit-quarkus-rest + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest.adoc[Link] +| 2.22.0 + +| tkit-quarkus-rest-context + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest-context.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest-context.adoc[Link] +| 2.22.0 + +| tkit-quarkus-jpa + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-jpa.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-jpa.adoc[Link] +| 2.22.0 + +| quarkus-hibernate-validator + +| https://quarkus.io/guides/validation[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-validator.adoc[Link] +| 3.9.3 + +| onecx-permissions + +| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-permissions.html[Link] +| https://github.com/onecx/onecx-quarkus/blob/0.17.0/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc[Link] +| 0.17.0 + +| quarkus-oidc + +| https://quarkus.io/guides/security-oidc-bearer-token-authentication-tutorial[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc.adoc[Link] +| 3.9.3 + +| quarkus-oidc-client-reactive-filter + +| https://quarkus.io/guides/security-openid-connect-client-reference[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc-client-reactive-filter.adoc[Link] +| 3.9.3 + +| tkit-quarkus-security + +| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-security.html[Link] +| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-security.adoc[Link] +| 2.22.0 + +| onecx-core + +| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-core.html[Link] +| +| 0.17.0 + +| quarkus-arc + +| https://quarkus.io/guides/cdi-reference[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-arc.adoc[Link] +| 3.9.3 + +| quarkus-container-image-docker + +| https://quarkus.io/guides/container-image[Link] +| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-container-image-docker.adoc[Link] +| 3.9.3 + + + +|=== \ No newline at end of file diff --git a/pom.xml b/pom.xml index 1a8fa61..d751431 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.tkit.onecx onecx-quarkus3-parent - 0.37.0 + 0.47.0 onecx-welcome-bff @@ -15,7 +15,7 @@ io.quarkus - quarkus-resteasy-reactive + quarkus-rest io.quarkus @@ -23,7 +23,7 @@ io.quarkus - quarkus-resteasy-reactive-jackson + quarkus-rest-jackson io.quarkus