From 8461f4b456342229cf4170e0ce4a80becbfe5224 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Mon, 18 Mar 2024 12:05:36 +0100 Subject: [PATCH 01/13] Standardize configuration properties --- app/pom.xml | 4 + .../io/apicurio/registry/auth/AuthConfig.java | 2 +- .../ui/UserInterfaceConfigProperties.java | 2 +- app/src/main/resources/application.properties | 140 ++++++------------ .../auth/AuthTestAnonymousCredentials.java | 2 +- .../auth/AuthTestAuthenticatedReadAccess.java | 2 +- .../registry/auth/AuthTestLocalRoles.java | 2 +- .../registry/auth/AuthTestNoRoles.java | 2 +- ...AuthTestProfileBasicClientCredentials.java | 2 +- .../registry/auth/HeaderRoleSourceTest.java | 2 +- .../apicurio/registry/auth/MojoAuthTest.java | 2 +- .../registry/auth/SimpleAuthTest.java | 2 +- docs/generateAllConfigPartial.java | 2 +- .../ref-registry-all-configs.adoc | 90 +++++------ .../tests/ApicurioRegistryBaseIT.java | 2 +- pom.xml | 3 +- .../registry/utils/tests/JWKSMockServer.java | 12 +- 17 files changed, 118 insertions(+), 155 deletions(-) diff --git a/app/pom.xml b/app/pom.xml index d806a51c59..2c502cb92c 100644 --- a/app/pom.xml +++ b/app/pom.xml @@ -113,6 +113,10 @@ io.quarkus quarkus-oidc + + io.quarkus + quarkus-smallrye-jwt + io.quarkus quarkus-scheduler diff --git a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java index 81eb334db0..195a623b6e 100644 --- a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java +++ b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java @@ -17,7 +17,7 @@ public class AuthConfig { @Inject Logger log; - @ConfigProperty(name = "registry.auth.enabled", defaultValue = "false") + @ConfigProperty(name = "quarkus.oidc.tenant-enabled", defaultValue = "false") boolean authenticationEnabled; @ConfigProperty(name = "registry.auth.role-based-authorization", defaultValue = "false") diff --git a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java index 1858cb1d95..5dcb65936d 100644 --- a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java @@ -19,7 +19,7 @@ public class UserInterfaceConfigProperties { public String docsUrl; - @ConfigProperty(name = "registry.auth.url.configured") + @ConfigProperty(name = "quarkus.oidc.auth-server-url") public String authOidcUrl; @ConfigProperty(name = "registry.ui.auth.oidc.redirectUri", defaultValue = "/") @Info(category = "ui", description = "The OIDC redirectUri", availableSince = "3.0.0") diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index 4623bfc502..71d2d68879 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -13,79 +13,53 @@ registry.version=${project.version} registry.date=${timestamp} ## Legacy mode for ccompat API -registry.ccompat.legacy-id-mode.enabled=${ENABLE_CCOMPAT_LEGACY_ID_MODE:false} +registry.ccompat.legacy-id-mode.enabled=false ## Max # of subjects returned by ccompat API -registry.ccompat.max-subjects=${REGISTRY_CCOMPAT_MAX_SUBJECTS:1000} +registry.ccompat.max-subjects=1000 ## Make ccompat use canonical hash -registry.ccompat.use-canonical-hash=${ENABLE_CCOMPAT_CANONICAL_HASH_MODE:false} +registry.ccompat.use-canonical-hash=false ##Auth - disabled by default - -## Support some legacy ENV variables. -registry-legacy.auth.enabled=${AUTH_ENABLED:false} -registry-legacy.auth.anonymous-read-access.enabled=${ANONYMOUS_READ_ACCESS_ENABLED:false} -registry-legacy.auth.owner-only-authorization=${OWNER_ONLY_AUTHZ_ENABLED:false} -registry-legacy.auth.role-based-authorization=${ROLE_BASED_AUTHZ_ENABLED:false} -registry-legacy.auth.role-source=${ROLE_BASED_AUTHZ_SOURCE:token} - -registry.keycloak.url=${KEYCLOAK_URL:http://localhost:8090/auth} -registry.keycloak.realm=${KEYCLOAK_REALM:apicurio-local} - -registry.auth.url.configured=${registry.keycloak.url}/realms/${registry.keycloak.realm} -registry.auth.token.endpoint=${TOKEN_ENDPOINT:${registry.keycloak.url}/realms/${registry.keycloak.realm}/protocol/openid-connect/token} -registry.auth.client-secret=${KEYCLOAK_API_CLIENT_SECRET:} - -## Consistent naming of auth related ENV vars. -registry.auth.enabled=${REGISTRY_AUTH_ENABLED:${registry-legacy.auth.enabled}} -registry.auth.basic-auth-client-credentials.enabled=${CLIENT_CREDENTIALS_BASIC_AUTH_ENABLED:false} -registry.auth.basic-auth-client-credentials.cache-expiration=${CLIENT_CREDENTIALS_BASIC_CACHE_EXPIRATION:10} -registry.auth.role-based-authorization=${REGISTRY_AUTH_RBAC_ENABLED:${registry-legacy.auth.role-based-authorization}} -registry.auth.owner-only-authorization=${REGISTRY_AUTH_OBAC_ENABLED:${registry-legacy.auth.owner-only-authorization}} -registry.auth.owner-only-authorization.limit-group-access=${REGISTRY_AUTH_OBAC_LIMIT_GROUP_ACCESS:false} -registry.auth.anonymous-read-access.enabled=${REGISTRY_AUTH_ANONYMOUS_READS_ENABLED:${registry-legacy.auth.anonymous-read-access.enabled}} -registry.auth.authenticated-read-access.enabled=${REGISTRY_AUTH_AUTHENTICATED_READS_ENABLED:false} -registry.auth.roles.readonly=${REGISTRY_AUTH_ROLES_READONLY:sr-readonly} -registry.auth.roles.developer=${REGISTRY_AUTH_ROLES_DEVELOPER:sr-developer} -registry.auth.roles.admin=${REGISTRY_AUTH_ROLES_ADMIN:sr-admin} -registry.auth.role-source=${REGISTRY_AUTH_ROLE_SOURCE:${registry-legacy.auth.role-source}} -registry.auth.role-source.header.name=X-Registry-Role - - +### Quarkus own configuration quarkus.oidc.enabled=true -quarkus.oidc.tenant-enabled=${registry.auth.enabled} -quarkus.oidc.auth-server-url=${REGISTRY_AUTH_URL_CONFIGURED:${registry.keycloak.url}/realms/${registry.keycloak.realm} -quarkus.oidc.client-id=${KEYCLOAK_API_CLIENT_ID:registry-api} +quarkus.oidc.tenant-enabled=false +quarkus.oidc.auth-server-url=https://auth.apicur.io/auth/realms/apicurio-local +quarkus.oidc.token-path=https://auth.apicur.io/auth/realms/apicurio-local/protocol/openid-connect/token/ +quarkus.oidc.client-id=registry-api + +### Registry specific configuration +registry.auth.role-based-authorization=false +registry.auth.owner-only-authorization=false +registry.auth.owner-only-authorization.limit-group-access=false +registry.auth.anonymous-read-access.enabled=false +registry.auth.authenticated-read-access.enabled=false +registry.auth.roles.readonly=sr-readonly +registry.auth.roles.developer=sr-developer +registry.auth.roles.admin=sr-admin +registry.auth.role-source=token +registry.auth.role-source.header.name=X-Registry-Role # Admin override indicates whether the existence of a role somewhere # other than the primary role source can override the 'isAdmin' logic. This # is useful when using role-source=application to bypass the DB check when the # user has some existing role or other claim in their token. -registry.auth.admin-override.enabled=${REGISTRY_AUTH_ADMIN_OVERRIDE_ENABLED:false} -registry.auth.admin-override.from=${REGISTRY_AUTH_ADMIN_OVERRIDE_FROM:token} -registry.auth.admin-override.type=${REGISTRY_AUTH_ADMIN_OVERRIDE_TYPE:role} -registry.auth.admin-override.role=${REGISTRY_AUTH_ADMIN_OVERRIDE_ROLE:sr-admin} -registry.auth.admin-override.claim=${REGISTRY_AUTH_ADMIN_OVERRIDE_CLAIM:org-admin} -registry.auth.admin-override.claim-value=${REGISTRY_AUTH_ADMIN_OVERRIDE_CLAIM_VALUE:true} - -registry.ui.config.auth.type=${REGISTRY_UI_AUTH_TYPE:none} - -registry.ui.config.auth.keycloak.url=${registry.keycloak.url} -registry.ui.config.auth.keycloak.realm=${registry.keycloak.realm} -registry.ui.config.auth.keycloak.clientId=${KEYCLOAK_UI_CLIENT_ID:apicurio-registry} -registry.ui.config.auth.keycloak.onLoad=login-required - -registry.ui.config.auth.oidc.url=${REGISTRY_AUTH_URL_CONFIGURED:http://localhost:8090} -registry.ui.config.auth.oidc.client-id=${REGISTRY_OIDC_UI_CLIENT_ID:default_client} -registry.ui.config.auth.oidc.redirect-url=${REGISTRY_OIDC_UI_REDIRECT_URL:http://localhost:8080} +registry.auth.admin-override.enabled=false +registry.auth.admin-override.from=token +registry.auth.admin-override.type=role +registry.auth.admin-override.role=sr-admin +registry.auth.admin-override.claim=org-admin +registry.auth.admin-override.claim-value=true +registry.ui.auth.oidc.clientId=default_client +registry.ui.auth.oidc.redirectUri=http://localhost:8080 quarkus.http.non-application-root-path=/ ## Logging -quarkus.log.console.json=${ENABLE_JSON_LOG:false} -quarkus.log.console.format=%d{YYYY-MM-dd HH:mm:ss} %p [%C] (%t) %m%n +quarkus.log.console.json=false +quarkus.log.console.format=%d{YYYY-MMx-dd HH:mm:ss} %p [%C] (%t) %m%n quarkus.log.console.color=false quarkus.log.min-level=TRACE quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".level=DEBUG @@ -99,7 +73,7 @@ registry.config.refresh.every=1m registry.config.cache.enabled=true ## Dynamic config properties -registry.config.dynamic.allow-all=${REGISTRY_ALLOW_DYNAMIC_CONFIG:true} +registry.config.dynamic.allow-all=true registry.auth.owner-only-authorization.dynamic.allow=${registry.config.dynamic.allow-all} registry.auth.owner-only-authorization.limit-group-access.dynamic.allow=${registry.config.dynamic.allow-all} registry.auth.anonymous-read-access.enabled.dynamic.allow=${registry.config.dynamic.allow-all} @@ -109,39 +83,33 @@ registry.ccompat.max-subjects.dynamic.allow=${registry.config.dynamic.allow-all} registry.download.href.ttl.dynamic.allow=${registry.config.dynamic.allow-all} registry.ui.features.readOnly.dynamic.allow=${registry.config.dynamic.allow-all} registry.rest.artifact.deletion.enabled.dynamic.allow=${registry.config.dynamic.allow-all} +registry.storage.read-only.dynamic.allow=${registry.config.dynamic.allow-all} +apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${registry.config.dynamic.allow-all} # Access logs -quarkus.http.access-log.enabled=${ENABLE_ACCESS_LOG:false} +quarkus.http.access-log.enabled=false quarkus.http.access-log.pattern="apicurio-registry.access method="%{METHOD}" path="%{REQUEST_URL}" response_code="%{RESPONSE_CODE}" response_time="%{RESPONSE_TIME}" remote_ip="%{REMOTE_IP}" remote_user="%{REMOTE_USER}" user_agent="%{i,User-Agent}"" #this property will be used by Quarkus 2.X quarkus.http.access-log.exclude-pattern=/health/.* # Redirects -registry.enable-redirects=${REGISTRY_ENABLE_REDIRECTS:true} -registry.redirects.root=/,${REGISTRY_ROOT_REDIRECT:/apis} +registry.enable-redirects=true +registry.redirects.root=/,/apis -# Override the hostname used for generating externally-accessible URLs. -# The host and port overrides are useful when deploying Registry with HTTPS passthrough Ingress or Route. -# In cases like these, the request URL (and port) that is then re-used for redirection -# does not belong to actual external URL used by the client, because the request is proxied. -# The redirection then fails because the target URL is not reachable. -registry.url.override.host=${REGISTRY_URL_OVERRIDE_HOST} -# Override the port used for generating externally-accessible URLs. -registry.url.override.port=${REGISTRY_URL_OVERRIDE_PORT} -quarkus.http.proxy.proxy-address-forwarding=${REGISTRY_PROXY_ADDRESS_FORWARDING:false} +quarkus.http.proxy.proxy-address-forwarding=false ## A way to disable some of the supported APIs if desired #registry.disable.apis= ## Include or exclude the stack trace in REST API error responses. -registry.api.errors.include-stack-in-response=${REGISTRY_API_ERRORS_INCLUDE_STACKTRACE:false} +registry.api.errors.include-stack-in-response=false ## Enable CORS always quarkus.http.cors=true -quarkus.http.cors.origins=${CORS_ALLOWED_ORIGINS:http://localhost:8888,http://127.0.0.1:8888} -quarkus.http.cors.methods=${CORS_ALLOWED_METHODS:GET,PUT,POST,PATCH,DELETE,OPTIONS} -quarkus.http.cors.headers=${CORS_ALLOWED_HEADERS:x-registry-name,x-registry-name-encoded,x-registry-description,x-registry-description-encoded,x-registry-version,x-registry-artifactid,x-registry-artifacttype,x-registry-hash-algorithm,x-registry-content-hash,access-control-request-method,access-control-allow-credentials,access-control-allow-origin,access-control-allow-headers,authorization,content-type} +quarkus.http.cors.origins=http://localhost:8888,http://127.0.0.1:8888 +quarkus.http.cors.methods=GET,PUT,POST,PATCH,DELETE,OPTIONS +quarkus.http.cors.headers=x-registry-name,x-registry-name-encoded,x-registry-description,x-registry-description-encoded,x-registry-version,x-registry-artifactid,x-registry-artifacttype,x-registry-hash-algorithm,x-registry-content-hash,access-control-request-method,access-control-allow-credentials,access-control-allow-origin,access-control-allow-headers,authorization,content-type ## Disable Quarkus proactive authentication quarkus.http.auth.proactive=false @@ -152,7 +120,7 @@ mp.openapi.servers=/api registry.storage.metrics.cache.check-period=30000 registry.limits.config.cache.check-period=30000 -registry.storage.metrics.cache.max-size=${REGISTRY_STORAGE_METRICS_CACHE_MAX_SIZE:1000} +registry.storage.metrics.cache.max-size=1000 registry.downloads.reaper.every=60s @@ -166,8 +134,6 @@ registry.rest.artifact.download.skipSSLValidation=false # Artifact version deletion registry.rest.artifact.deletion.enabled=false -registry.storage.read-only.dynamic.allow=${registry.config.dynamic.allow-all} - # Api date format registry.apis.v2.date-format=yyyy-MM-dd'T'HH:mm:ss'Z' registry.apis.v2.date-format-timezone=UTC @@ -175,25 +141,17 @@ registry.apis.v2.date-format-timezone=UTC yyyy-MM-dd'T'HH:mm:ss'Z' # Common components properties -app.name=${registry.id} -app.description=${registry.description} -app.version=${registry.version} -app.date=${registry.date} - -app.authn.enabled=${registry.auth.enabled} -app.authn.basic-auth-client-credentials.enabled=${registry.auth.basic-auth-client-credentials.enabled} -app.authn.basic-auth-client-credentials.cache-expiration=${registry.auth.basic-auth-client-credentials.cache-expiration} -app.authn.basic-auth.scope=${registry.auth.basic-auth.scope} -app.authn.audit.log.prefix=registry.audit -app.authn.token.endpoint=${registry.auth.token.endpoint} -app.authn.client-secret=${registry.auth.client-secret} -app.authn.client-id=${quarkus.oidc.client-id} +apicurio.name=${registry.id} +apicurio.description=${registry.description} +apicurio.version=${registry.version} +apicurio.date=${registry.date} -app.authn.basic-auth-client-credentials.enabled.dynamic.allow=${registry.config.dynamic.allow-all} +apicurio.authn.basic-client-credentials.enabled=false +apicurio.authn.basic-client-credentials.cache-expiration=5 +apicurio.authn.audit.log.prefix=registry.audit # Storage properties - registry.storage.kind=sql ## SQL Storage diff --git a/app/src/test/java/io/apicurio/registry/auth/AuthTestAnonymousCredentials.java b/app/src/test/java/io/apicurio/registry/auth/AuthTestAnonymousCredentials.java index 8fd2527509..21228d1ac9 100644 --- a/app/src/test/java/io/apicurio/registry/auth/AuthTestAnonymousCredentials.java +++ b/app/src/test/java/io/apicurio/registry/auth/AuthTestAnonymousCredentials.java @@ -25,7 +25,7 @@ @Tag(ApicurioTestTags.SLOW) public class AuthTestAnonymousCredentials extends AbstractResourceTestBase { - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrl; diff --git a/app/src/test/java/io/apicurio/registry/auth/AuthTestAuthenticatedReadAccess.java b/app/src/test/java/io/apicurio/registry/auth/AuthTestAuthenticatedReadAccess.java index 6222e4d9e1..f9ea953fdb 100644 --- a/app/src/test/java/io/apicurio/registry/auth/AuthTestAuthenticatedReadAccess.java +++ b/app/src/test/java/io/apicurio/registry/auth/AuthTestAuthenticatedReadAccess.java @@ -24,7 +24,7 @@ @Tag(ApicurioTestTags.SLOW) public class AuthTestAuthenticatedReadAccess extends AbstractResourceTestBase { - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrl; diff --git a/app/src/test/java/io/apicurio/registry/auth/AuthTestLocalRoles.java b/app/src/test/java/io/apicurio/registry/auth/AuthTestLocalRoles.java index 838cd790cc..f9b9594484 100644 --- a/app/src/test/java/io/apicurio/registry/auth/AuthTestLocalRoles.java +++ b/app/src/test/java/io/apicurio/registry/auth/AuthTestLocalRoles.java @@ -38,7 +38,7 @@ public class AuthTestLocalRoles extends AbstractResourceTestBase { " \"fields\" : [{\"name\" : \"age\", \"type\" : \"int\"}]\r\n" + "} "; - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrlConfigured; diff --git a/app/src/test/java/io/apicurio/registry/auth/AuthTestNoRoles.java b/app/src/test/java/io/apicurio/registry/auth/AuthTestNoRoles.java index 2c8137bccc..1035a66d3e 100644 --- a/app/src/test/java/io/apicurio/registry/auth/AuthTestNoRoles.java +++ b/app/src/test/java/io/apicurio/registry/auth/AuthTestNoRoles.java @@ -32,7 +32,7 @@ @Tag(ApicurioTestTags.SLOW) public class AuthTestNoRoles extends AbstractResourceTestBase { - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrlConfigured; diff --git a/app/src/test/java/io/apicurio/registry/auth/AuthTestProfileBasicClientCredentials.java b/app/src/test/java/io/apicurio/registry/auth/AuthTestProfileBasicClientCredentials.java index fcda45eb7b..aa99e72115 100644 --- a/app/src/test/java/io/apicurio/registry/auth/AuthTestProfileBasicClientCredentials.java +++ b/app/src/test/java/io/apicurio/registry/auth/AuthTestProfileBasicClientCredentials.java @@ -31,7 +31,7 @@ @Tag(ApicurioTestTags.SLOW) public class AuthTestProfileBasicClientCredentials extends AbstractResourceTestBase { - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrl; diff --git a/app/src/test/java/io/apicurio/registry/auth/HeaderRoleSourceTest.java b/app/src/test/java/io/apicurio/registry/auth/HeaderRoleSourceTest.java index 97641825a8..e3d08f54c5 100644 --- a/app/src/test/java/io/apicurio/registry/auth/HeaderRoleSourceTest.java +++ b/app/src/test/java/io/apicurio/registry/auth/HeaderRoleSourceTest.java @@ -35,7 +35,7 @@ public class HeaderRoleSourceTest extends AbstractResourceTestBase { " \"fields\" : [{\"name\" : \"age\", \"type\" : \"int\"}]\r\n" + "} "; - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrlConfigured; diff --git a/app/src/test/java/io/apicurio/registry/auth/MojoAuthTest.java b/app/src/test/java/io/apicurio/registry/auth/MojoAuthTest.java index 55100bb133..eeafd27239 100644 --- a/app/src/test/java/io/apicurio/registry/auth/MojoAuthTest.java +++ b/app/src/test/java/io/apicurio/registry/auth/MojoAuthTest.java @@ -28,7 +28,7 @@ @Tag(ApicurioTestTags.SLOW) public class MojoAuthTest extends RegistryMojoTestBase { - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrlConfigured; diff --git a/app/src/test/java/io/apicurio/registry/auth/SimpleAuthTest.java b/app/src/test/java/io/apicurio/registry/auth/SimpleAuthTest.java index 24270c53e0..1d07829c30 100644 --- a/app/src/test/java/io/apicurio/registry/auth/SimpleAuthTest.java +++ b/app/src/test/java/io/apicurio/registry/auth/SimpleAuthTest.java @@ -43,7 +43,7 @@ public class SimpleAuthTest extends AbstractResourceTestBase { private static final String ARTIFACT_CONTENT = "{\"name\":\"redhat\"}"; - @ConfigProperty(name = "registry.auth.token.endpoint") + @ConfigProperty(name = "quarkus.oidc.token-path") @Info(category = "auth", description = "Auth token endpoint", availableSince = "2.1.0.Final") String authServerUrlConfigured; diff --git a/docs/generateAllConfigPartial.java b/docs/generateAllConfigPartial.java index f16b41dde0..d4cdc14667 100644 --- a/docs/generateAllConfigPartial.java +++ b/docs/generateAllConfigPartial.java @@ -20,7 +20,7 @@ public class generateAllConfigPartial { private static Map allConfiguration = new HashMap(); - private static Set skipProperties = Set.of("registry.auth.url.configured"); + private static Set skipProperties = Set.of("quarkus.oidc.auth-server-url"); static class Option { final String name; diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index 0c6846f0fb..1c12ed632f 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -43,6 +43,51 @@ The following {registry} configuration options are available for each component |Default |Available from |Description +|`apicurio.authn.audit.log.prefix` +|`string` +|`audit` +|`2.2.6` +|Prefix used for application audit logging. +|`apicurio.authn.basic-client-credentials.cache-expiration` +|`integer` +|`10` +|`2.2.6.Final` +|Default client credentials token expiration time. +|`apicurio.authn.basic-client-credentials.cache-expiration-offset` +|`integer` +|`10` +|`2.5.9.Final` +|Client credentials token expiration offset from JWT expiration. +|`apicurio.authn.basic-client-credentials.enabled` +|`boolean [dynamic]` +|`false` +|`2.1.0.Final` +|Enable basic auth client credentials +|`apicurio.authn.basic.scope` +|`optional` +| +|`2.5.0.Final` +|Client credentials scope. +|`quarkus.oidc.client-id` +|`string` +| +|`2.0.0.Final` +|Client identifier used by the server for authentication. +|`quarkus.oidc.client-secret` +|`optional` +| +|`2.1.0.Final` +|Client secret used by the server for authentication. +|`quarkus.oidc.tenant-enabled` +|`boolean` +|`false` +|`2.0.0.Final` +|Enable auth +|`quarkus.oidc.token-path` +|`string` +| +|`2.1.0.Final` +|Authentication server token endpoint. |`registry.auth.admin-override.claim` |`string` |`org-admin` @@ -83,51 +128,11 @@ The following {registry} configuration options are available for each component |`false` |`2.1.0.Final` |Anonymous read access -|`registry.auth.audit.log.prefix` -|`string` -|`audit` -|`2.2.6` -|Prefix used for application audit logging. |`registry.auth.authenticated-read-access.enabled` |`boolean [dynamic]` |`false` |`2.1.4.Final` |Authenticated read access -|`registry.auth.basic-auth-client-credentials.cache-expiration` -|`integer` -|`10` -|`2.2.6.Final` -|Default client credentials token expiration time. -|`registry.auth.basic-auth-client-credentials.cache-expiration-offset` -|`integer` -|`10` -|`2.5.9.Final` -|Client credentials token expiration offset from JWT expiration. -|`registry.auth.basic-auth-client-credentials.enabled` -|`boolean [dynamic]` -|`false` -|`2.1.0.Final` -|Enable basic auth client credentials -|`registry.auth.basic-auth.scope` -|`optional` -| -|`2.5.0.Final` -|Client credentials scope. -|`registry.auth.client-id` -|`string` -| -|`2.0.0.Final` -|Client identifier used by the server for authentication. -|`registry.auth.client-secret` -|`optional` -| -|`2.1.0.Final` -|Client secret used by the server for authentication. -|`registry.auth.enabled` -|`boolean` -|`false` -|`2.0.0.Final` -|Enable auth |`registry.auth.owner-only-authorization` |`boolean [dynamic]` |`false` @@ -168,11 +173,6 @@ The following {registry} configuration options are available for each component |`sr-readonly` |`2.1.0.Final` |Auth roles readonly -|`registry.auth.token.endpoint` -|`string` -| -|`2.1.0.Final` -|Authentication server url. |=== == cache diff --git a/integration-tests/src/test/java/io/apicurio/tests/ApicurioRegistryBaseIT.java b/integration-tests/src/test/java/io/apicurio/tests/ApicurioRegistryBaseIT.java index 3a55682156..5eb4076cfa 100644 --- a/integration-tests/src/test/java/io/apicurio/tests/ApicurioRegistryBaseIT.java +++ b/integration-tests/src/test/java/io/apicurio/tests/ApicurioRegistryBaseIT.java @@ -79,7 +79,7 @@ protected RegistryClient createRegistryClient() { @BeforeAll void prepareRestAssured() { - authServerUrlConfigured = Optional.ofNullable(ConfigProvider.getConfig().getConfigValue("registry.auth.token.endpoint").getValue()) + authServerUrlConfigured = Optional.ofNullable(ConfigProvider.getConfig().getConfigValue("quarkus.oidc.token-path").getValue()) .orElse("http://localhost:8090/realms/registry/protocol/openid-connect/token"); registryClient = createRegistryClient(); RestAssured.baseURI = getRegistryV3ApiUrl(); diff --git a/pom.xml b/pom.xml index b10d52e0ac..f3d9d717a9 100644 --- a/pom.xml +++ b/pom.xml @@ -188,7 +188,7 @@ 1.2.1.Final 4.5.14 0.1.18.Final - 0.2.7.Final + 1.1.0.CR1 0.15.0 3.6.0 2.2 @@ -629,6 +629,7 @@ io.confluent kafka-avro-serializer ${confluent.version} + test org.glassfish.jersey.ext diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java index df0a759c2b..80b6c6625d 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java @@ -99,20 +99,20 @@ public Map start() { stubForBasicUser(BASIC_USER_B, BASIC_PASSWORD); stubForClientWithWrongCreds(WRONG_CREDS_CLIENT_ID, "test55"); - this.authServerUrl = server.baseUrl() + "/auth"; + this.authServerUrl = server.baseUrl() + "/auth" + "/realms/" + realm; LOGGER.info("Keycloak started in mock mode: {}", authServerUrl); - this.tokenEndpoint = authServerUrl + "/realms/" + realm + "/protocol/openid-connect/token/"; + this.tokenEndpoint = server.baseUrl() + "/auth" + "/realms/" + realm + "/protocol/openid-connect/token/"; Map props = new HashMap<>(); //Set registry properties - props.put("registry.keycloak.url", authServerUrl); - props.put("registry.keycloak.realm", realm); - props.put("registry.auth.enabled", "true"); + props.put("quarkus.oidc.auth-server-url", authServerUrl); + props.put("quarkus.oidc.token-path", tokenEndpoint); + props.put("quarkus.oidc.tenant-enabled", "true"); props.put("registry.auth.role-based-authorization", "true"); props.put("registry.auth.owner-only-authorization", "true"); props.put("registry.auth.admin-override.enabled", "true"); - props.put("registry.auth.basic-auth-client-credentials.enabled", "true"); + props.put("apicurio.authn.basic-client-credentials.enabled", "true"); return props; } From 28f7c16211b263069bf1b42b4ff3fe1646f84312 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Fri, 22 Mar 2024 10:15:24 +0100 Subject: [PATCH 02/13] Refactor application properties files --- app/pom.xml | 2 - .../main/resources/application-dev.properties | 35 --- .../resources/application-prod.properties | 59 ++--- .../resources/application-test.properties | 50 ++--- app/src/main/resources/application.properties | 208 +++++++++--------- pom.xml | 2 +- 6 files changed, 142 insertions(+), 214 deletions(-) delete mode 100644 app/src/main/resources/application-dev.properties diff --git a/app/pom.xml b/app/pom.xml index 2c502cb92c..48a6e206ae 100644 --- a/app/pom.xml +++ b/app/pom.xml @@ -412,7 +412,6 @@ ${project.build.outputDirectory}/application.properties ${project.build.outputDirectory}/application-prod.properties - ${project.build.outputDirectory}/application-dev.properties ${project.build.outputDirectory}/application-test.properties false @@ -429,7 +428,6 @@ ${project.build.outputDirectory}/application.properties ${project.build.outputDirectory}/application-prod.properties - ${project.build.outputDirectory}/application-dev.properties ${project.build.outputDirectory}/application-test.properties true diff --git a/app/src/main/resources/application-dev.properties b/app/src/main/resources/application-dev.properties deleted file mode 100644 index d7d9b39c11..0000000000 --- a/app/src/main/resources/application-dev.properties +++ /dev/null @@ -1,35 +0,0 @@ -# === Dev profile - see README -%dev.quarkus.http.port=${HTTP_PORT:8080} -%dev.quarkus.log.level=${LOG_LEVEL:INFO} -%dev.quarkus.log.category."io.apicurio".level=${REGISTRY_LOG_LEVEL:DEBUG} -%dev.quarkus.log.console.enable=true -%dev.quarkus.package.type=legacy-jar - -# Liveness and Readiness -%dev.registry.liveness.errors.ignored=${LIVENESS_ERRORS_IGNORED:} - -# Eventing -# example -# %dev.registry.events.sink.eventdisplay=http://localhost:8888/ -# compatibility with knative sink binding - -%dev.registry.events.ksink=${K_SINK:} -%dev.registry.events.kafka.config.bootstrap.servers=${bootstrap.servers:localhost:9092} -%dev.registry.events.kafka.config.enable.idempotence=true -%dev.registry.events.kafka.config.retries=3 -%dev.registry.events.kafka.config.acks=all - - - - -# Metrics -%dev.quarkus.micrometer.enabled=true -%dev.quarkus.micrometer.binder.http-server.enabled=false -%dev.quarkus.micrometer.binder.http-client.enabled=false -%dev.quarkus.micrometer.export.prometheus.enabled=true -%dev.quarkus.datasource.metrics.enabled=true -%dev.quarkus.datasource.jdbc.enable-metrics=true - -# Dynamic logging configuration -%dev.registry.logconfigjob.every=5s -%dev.registry.logconfigjob.delayed=1s \ No newline at end of file diff --git a/app/src/main/resources/application-prod.properties b/app/src/main/resources/application-prod.properties index b6d61b6f8a..67de03bcbe 100644 --- a/app/src/main/resources/application-prod.properties +++ b/app/src/main/resources/application-prod.properties @@ -1,47 +1,26 @@ # Readiness and Liveness -%prod.registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=${LIVENESS_ERROR_THRESHOLD:5} -%prod.registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec=${LIVENESS_COUNTER_RESET:30} -%prod.registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec=${LIVENESS_STATUS_RESET:60} -%prod.registry.metrics.ResponseErrorLivenessCheck.errorThreshold=${LIVENESS_ERROR_THRESHOLD:5} -%prod.registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec=${LIVENESS_COUNTER_RESET:30} -%prod.registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec=${LIVENESS_STATUS_RESET:60} +registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=5 +registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec=30 +registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec=60 +registry.metrics.ResponseErrorLivenessCheck.errorThreshold=5 +registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec=30 +registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec=60 -%prod.registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=${READINESS_ERROR_THRESHOLD:5} -%prod.registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec=${READINESS_COUNTER_RESET:30} -%prod.registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec=${READINESS_STATUS_RESET:60} -%prod.registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=${READINESS_TIMEOUT:10} -%prod.registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=${READINESS_ERROR_THRESHOLD:5} -%prod.registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec=${READINESS_COUNTER_RESET:30} -%prod.registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec=${READINESS_STATUS_RESET:60} -%prod.registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec=${READINESS_TIMEOUT:20} +registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=5 +registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec=30 +registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec=60 +registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=10 +registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=5 +registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec=30 +registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec=60 +registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec=20 -%prod.registry.liveness.errors.ignored=${LIVENESS_ERRORS_IGNORED:} +registry.liveness.errors.ignored= # Eventing -%prod.registry.events.ksink=${K_SINK:} -%prod.registry.events.kafka.config.bootstrap.servers=${KAFKA_BOOTSTRAP_SERVERS:} -%prod.registry.events.kafka.config.enable.idempotence=true -%prod.registry.events.kafka.config.retries=3 -%prod.registry.events.kafka.config.acks=all +registry.events.ksink= +registry.events.kafka.config.bootstrap.servers= # Log -%prod.quarkus.log.level=${LOG_LEVEL:INFO} -%prod.quarkus.log.console.enable=true -%prod.quarkus.log.category."io.apicurio".level=${REGISTRY_LOG_LEVEL:INFO} - -# === Prod profile - see README -# HTTP Port -%prod.quarkus.http.port=${HTTP_PORT:8080} -%prod.quarkus.package.type=legacy-jar - -# Metrics -%prod.quarkus.micrometer.enabled=true -%prod.quarkus.micrometer.binder.http-server.enabled=false -%prod.quarkus.micrometer.binder.http-client.enabled=false -%prod.quarkus.micrometer.export.prometheus.enabled=true -%prod.quarkus.datasource.metrics.enabled=true -%prod.quarkus.datasource.jdbc.enable-metrics=true - -# Dynamic logging configuration -%prod.registry.logconfigjob.every=30s -%prod.registry.logconfigjob.delayed=15s \ No newline at end of file +quarkus.log.level=INFO +quarkus.log.category."io.apicurio".level=INFO \ No newline at end of file diff --git a/app/src/main/resources/application-test.properties b/app/src/main/resources/application-test.properties index dfb08e30e2..0ea009d8dc 100644 --- a/app/src/main/resources/application-test.properties +++ b/app/src/main/resources/application-test.properties @@ -1,37 +1,25 @@ -# Test config +## Quarkus +quarkus.log.level=WARN +quarkus.log.category."io.apicurio".level=INFO +quarkus.log.console.enable=true +quarkus.http.test-port=0 +quarkus.test.flat-class-path=true -%test.quarkus.log.level=${LOG_LEVEL:WARN} -%test.quarkus.log.category."io.apicurio".level=${REGISTRY_LOG_LEVEL:INFO} -%test.quarkus.log.console.enable=true -%test.quarkus.http.test-port=0 +## Registry -# Metrics -%test.registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=10000 -%test.registry.metrics.ResponseErrorLivenessCheck.errorThreshold=10000 -%test.registry.metrics.ResponseErrorLivenessCheck.disableLogging=true -%test.registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=10000 -%test.registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=10000 -%test.registry.metrics.PersistenceExceptionLivenessCheck.disableLogging=true - -%test.quarkus.micrometer.enabled=true -%test.quarkus.micrometer.binder.http-server.enabled=false -%test.quarkus.micrometer.binder.http-client.enabled=false -%test.quarkus.micrometer.export.prometheus.enabled=true -%test.quarkus.datasource.metrics.enabled=true -%test.quarkus.datasource.jdbc.enable-metrics=true - -# The ignored error list -%test.registry.liveness.errors.ignored=${LIVENESS_ERRORS_IGNORED:} +# Events +registry.events.kafka.config.bootstrap.servers=localhost:9092 -%test.registry.events.kafka.config.bootstrap.servers=${bootstrap.servers:localhost:9092} -%test.registry.events.kafka.config.enable.idempotence=true -%test.registry.events.kafka.config.retries=3 -%test.registry.events.kafka.config.acks=all +# Metrics +registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=10000 +registry.metrics.ResponseErrorLivenessCheck.errorThreshold=10000 +registry.metrics.ResponseErrorLivenessCheck.disableLogging=true +registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=10000 +registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=10000 +registry.metrics.PersistenceExceptionLivenessCheck.disableLogging=true -%test.registry.logconfigjob.every=1s -%test.registry.logconfigjob.delayed=1s +#Log config +registry.logconfigjob.every=1s # Artifact version deletion -%test.registry.rest.artifact.deletion.enabled=true - -quarkus.test.flat-class-path=true \ No newline at end of file +registry.rest.artifact.deletion.enabled=true diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index 71d2d68879..cf6b60ba00 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -1,35 +1,74 @@ -# Global Properties +## Quarkus properties + +# Authentication +quarkus.oidc.enabled=true +quarkus.oidc.tenant-enabled=false +quarkus.oidc.auth-server-url=https://auth.apicur.io/auth/realms/apicurio-local +quarkus.oidc.token-path=https://auth.apicur.io/auth/realms/apicurio-local/protocol/openid-connect/token/ +quarkus.oidc.client-id=registry-api +quarkus.http.auth.proactive=false + +# HTTP +quarkus.http.port=8080 +quarkus.http.non-application-root-path=/ +## Max HTTP request body size (large files needed to support Import functionality) +## (Set to 50MB) +quarkus.http.limits.max-body-size=52428800 + +quarkus.http.access-log.enabled=false +quarkus.http.access-log.pattern="apicurio-registry.access method="%{METHOD}" path="%{REQUEST_URL}" response_code="%{RESPONSE_CODE}" response_time="%{RESPONSE_TIME}" remote_ip="%{REMOTE_IP}" remote_user="%{REMOTE_USER}" user_agent="%{i,User-Agent}"" +quarkus.http.access-log.exclude-pattern=/health/.* +quarkus.http.proxy.proxy-address-forwarding=false + +quarkus.http.cors=true +quarkus.http.cors.origins=http://localhost:8888,http://127.0.0.1:8888 +quarkus.http.cors.methods=GET,PUT,POST,PATCH,DELETE,OPTIONS +quarkus.http.cors.headers=x-registry-name,x-registry-name-encoded,x-registry-description,x-registry-description-encoded,x-registry-version,x-registry-artifactid,x-registry-artifacttype,x-registry-hash-algorithm,x-registry-content-hash,access-control-request-method,access-control-allow-credentials,access-control-allow-origin,access-control-allow-headers,authorization,content-type + +# Logging +quarkus.log.level=WARN +quarkus.log.category."io.apicurio".level=DEBUG +quarkus.log.console.enable=true +quarkus.log.console.json=false +quarkus.log.console.format=%d{YYYY-MMx-dd HH:mm:ss} %p [%C] (%t) %m%n +quarkus.log.console.color=false +quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".level=DEBUG +quarkus.log.min-level=TRACE + +# Metrics +quarkus.micrometer.enabled=true +quarkus.micrometer.binder.http-server.enabled=false +quarkus.micrometer.binder.http-client.enabled=false +quarkus.micrometer.export.prometheus.enabled=true +quarkus.datasource.metrics.enabled=true +quarkus.datasource.jdbc.enable-metrics=true + +# Native quarkus.native.resources.includes=io/apicurio/registry/storage/impl/sql/h2.ddl,i18n/*.properties,io/apicurio/registry/storage/impl/sql/postgresql.ddl +quarkus.native.additional-build-args=--initialize-at-run-time=org.apache.kafka.common.security.authenticator.SaslClientAuthenticator\\,org.eclipse.jgit\\,org.h2\\,org.postgres\\,com.microsoft.sqlserver\\,\ + --allow-incomplete-classpath -## Additional index dependencies +# Package +quarkus.package.type=legacy-jar quarkus.index-dependency.jaxrs.group-id=jakarta.ws.rs quarkus.index-dependency.jaxrs.artifact-id=jakarta.ws.rs-api -## Name and description -registry.id=apicurio-registry -registry.name=Apicurio Registry (In Memory) -registry.description=High performance, runtime registry for schemas and API designs. -registry.version=${project.version} -registry.date=${timestamp} - -## Legacy mode for ccompat API -registry.ccompat.legacy-id-mode.enabled=false -## Max # of subjects returned by ccompat API -registry.ccompat.max-subjects=1000 +## Registry configuration -## Make ccompat use canonical hash -registry.ccompat.use-canonical-hash=false +# Application +apicurio.app.id=apicurio-registry +apicurio.app.name=Apicurio Registry (In Memory) +apicurio.app.description=High performance, runtime registry for schemas and API designs. +apicurio.app.version=${project.version} +apicurio.app.date=${timestamp} -##Auth - disabled by default -### Quarkus own configuration -quarkus.oidc.enabled=true -quarkus.oidc.tenant-enabled=false -quarkus.oidc.auth-server-url=https://auth.apicur.io/auth/realms/apicurio-local -quarkus.oidc.token-path=https://auth.apicur.io/auth/realms/apicurio-local/protocol/openid-connect/token/ -quarkus.oidc.client-id=registry-api +# Authentication +apicurio.authn.basic-client-credentials.enabled=false +apicurio.authn.basic-client-credentials.cache-expiration=5 +apicurio.authn.audit.log.prefix=registry.audit -### Registry specific configuration +# Authorization registry.auth.role-based-authorization=false registry.auth.owner-only-authorization=false registry.auth.owner-only-authorization.limit-group-access=false @@ -40,7 +79,6 @@ registry.auth.roles.developer=sr-developer registry.auth.roles.admin=sr-admin registry.auth.role-source=token registry.auth.role-source.header.name=X-Registry-Role - # Admin override indicates whether the existence of a role somewhere # other than the primary role source can override the 'isAdmin' logic. This # is useful when using role-source=application to bypass the DB check when the @@ -52,27 +90,25 @@ registry.auth.admin-override.role=sr-admin registry.auth.admin-override.claim=org-admin registry.auth.admin-override.claim-value=true -registry.ui.auth.oidc.clientId=default_client -registry.ui.auth.oidc.redirectUri=http://localhost:8080 +# Cache +registry.storage.metrics.cache.check-period=30000 +registry.storage.metrics.cache.max-size=1000 +registry.limits.config.cache.check-period=30000 -quarkus.http.non-application-root-path=/ +# CCompatibility API -## Logging -quarkus.log.console.json=false -quarkus.log.console.format=%d{YYYY-MMx-dd HH:mm:ss} %p [%C] (%t) %m%n -quarkus.log.console.color=false -quarkus.log.min-level=TRACE -quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".level=DEBUG - -## Max HTTP request body size (large files needed to support Import functionality) -## (Set to 50MB) -quarkus.http.limits.max-body-size=52428800 +registry.ccompat.legacy-id-mode.enabled=false +registry.ccompat.max-subjects=1000 +registry.ccompat.use-canonical-hash=false -## Config properties +# Config registry.config.refresh.every=1m registry.config.cache.enabled=true -## Dynamic config properties +# Downloads +registry.downloads.reaper.every=60s + +# Dynamic config properties registry.config.dynamic.allow-all=true registry.auth.owner-only-authorization.dynamic.allow=${registry.config.dynamic.allow-all} registry.auth.owner-only-authorization.limit-group-access.dynamic.allow=${registry.config.dynamic.allow-all} @@ -86,74 +122,34 @@ registry.rest.artifact.deletion.enabled.dynamic.allow=${registry.config.dynamic. registry.storage.read-only.dynamic.allow=${registry.config.dynamic.allow-all} apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${registry.config.dynamic.allow-all} -# Access logs -quarkus.http.access-log.enabled=false -quarkus.http.access-log.pattern="apicurio-registry.access method="%{METHOD}" path="%{REQUEST_URL}" response_code="%{RESPONSE_CODE}" response_time="%{RESPONSE_TIME}" remote_ip="%{REMOTE_IP}" remote_user="%{REMOTE_USER}" user_agent="%{i,User-Agent}"" -#this property will be used by Quarkus 2.X -quarkus.http.access-log.exclude-pattern=/health/.* - -# Redirects -registry.enable-redirects=true -registry.redirects.root=/,/apis - - -quarkus.http.proxy.proxy-address-forwarding=false - -## A way to disable some of the supported APIs if desired -#registry.disable.apis= - -## Include or exclude the stack trace in REST API error responses. +# Error registry.api.errors.include-stack-in-response=false -## Enable CORS always -quarkus.http.cors=true -quarkus.http.cors.origins=http://localhost:8888,http://127.0.0.1:8888 -quarkus.http.cors.methods=GET,PUT,POST,PATCH,DELETE,OPTIONS -quarkus.http.cors.headers=x-registry-name,x-registry-name-encoded,x-registry-description,x-registry-description-encoded,x-registry-version,x-registry-artifactid,x-registry-artifacttype,x-registry-hash-algorithm,x-registry-content-hash,access-control-request-method,access-control-allow-credentials,access-control-allow-origin,access-control-allow-headers,authorization,content-type - -## Disable Quarkus proactive authentication -quarkus.http.auth.proactive=false +# Events +registry.events.ksink= +registry.events.kafka.config.bootstrap.servers=localhost:9092 +registry.events.kafka.config.enable.idempotence=true +registry.events.kafka.config.retries=3 +registry.events.kafka.config.acks=all -## Disable OpenAPI class scanning -mp.openapi.scan.disable=true -mp.openapi.servers=/api +# Logging +registry.logconfigjob.every=5s +registry.logconfigjob.delayed=1s -registry.storage.metrics.cache.check-period=30000 -registry.limits.config.cache.check-period=30000 -registry.storage.metrics.cache.max-size=1000 - -registry.downloads.reaper.every=60s - -quarkus.native.additional-build-args=--initialize-at-run-time=org.apache.kafka.common.security.authenticator.SaslClientAuthenticator\\,org.eclipse.jgit\\,org.h2\\,org.postgres\\,com.microsoft.sqlserver\\,\ - --allow-incomplete-classpath +# Redirects +registry.enable-redirects=true +registry.redirects.root=/,/apis -# Artifact download +# Rest registry.rest.artifact.download.maxSize=1000000 registry.rest.artifact.download.skipSSLValidation=false - -# Artifact version deletion registry.rest.artifact.deletion.enabled=false - # Api date format registry.apis.v2.date-format=yyyy-MM-dd'T'HH:mm:ss'Z' registry.apis.v2.date-format-timezone=UTC -yyyy-MM-dd'T'HH:mm:ss'Z' - -# Common components properties -apicurio.name=${registry.id} -apicurio.description=${registry.description} -apicurio.version=${registry.version} -apicurio.date=${registry.date} - -apicurio.authn.basic-client-credentials.enabled=false -apicurio.authn.basic-client-credentials.cache-expiration=5 -apicurio.authn.audit.log.prefix=registry.audit - - -# Storage properties +# Storage registry.storage.kind=sql - ## SQL Storage registry.storage.db-kind=h2 registry.datasource.url=jdbc:h2:mem:registry_db @@ -162,19 +158,14 @@ registry.datasource.password=sa registry.datasource.jdbc.initial-size=20 registry.datasource.jdbc.min-size=20 registry.datasource.jdbc.max-size=100 - registry.sql.init=true -quarkus.test.flat-class-path=true - ## Kafka SQL storage - registry.kafkasql.bootstrap.servers=localhost:9092 registry.kafkasql.topic=kafkasql-journal registry.kafkasql.producer.client.id=${registry.id}-producer registry.kafkasql.consumer.poll.timeout=100 registry.kafkasql.consumer.group.id=${registry.id}-${quarkus.uuid} - # Security registry.kafkasql.security.sasl.enabled=false registry.kafkasql.security.sasl.mechanism=OAUTHBEARER @@ -184,7 +175,11 @@ registry.kafkasql.security.sasl.token.endpoint=http://localhost:8090 registry.kafkasql.security.sasl.login.callback.handler.class=io.strimzi.kafka.oauth.client.JaasClientOauthLoginCallbackHandler ## Gitops - +registry.gitops.id=main +registry.gitops.repo.origin.uri=http://localhost +registry.gitops.repo.origin.branch=main +registry.gitops.refresh.every=30s +# Blue datasource registry.datasource.blue.db-kind=h2 registry.datasource.blue.jdbc.url=jdbc:h2:mem:registry_blue registry.datasource.blue.username=sa @@ -192,7 +187,7 @@ registry.datasource.blue.password=sa registry.datasource.blue.jdbc.initial-size=20 registry.datasource.blue.jdbc.min-size=20 registry.datasource.blue.jdbc.max-size=100 - +# Green datasource registry.datasource.green.db-kind=h2 registry.datasource.green.jdbc.url=jdbc:h2:mem:registry_green registry.datasource.green.username=sa @@ -201,7 +196,10 @@ registry.datasource.green.jdbc.initial-size=20 registry.datasource.green.jdbc.min-size=20 registry.datasource.green.jdbc.max-size=100 -registry.gitops.id=main -registry.gitops.repo.origin.uri=http://localhost -registry.gitops.repo.origin.branch=main -registry.gitops.refresh.every=30s +# UI +registry.ui.auth.oidc.clientId=default_client +registry.ui.auth.oidc.redirectUri=http://localhost:8080 + +# Disable OpenAPI class scanning +mp.openapi.scan.disable=true +mp.openapi.servers=/api \ No newline at end of file diff --git a/pom.xml b/pom.xml index f3d9d717a9..38e3692694 100644 --- a/pom.xml +++ b/pom.xml @@ -188,7 +188,7 @@ 1.2.1.Final 4.5.14 0.1.18.Final - 1.1.0.CR1 + 1.1.0.CR2 0.15.0 3.6.0 2.2 From dc370c03265ce67ea03be2195421a9bf6d448651 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Mon, 25 Mar 2024 09:55:37 +0100 Subject: [PATCH 03/13] Make integration tests use the new application properties --- .../ui/UserInterfaceConfigProperties.java | 4 ++-- app/src/main/resources/application.properties | 4 ++-- .../ref-registry-all-configs.adoc | 4 ++-- .../in-memory/registry-in-memory-secured.yml | 14 +++++--------- .../infra/kafka/registry-kafka-secured.yml | 14 +++++--------- .../resources/infra/sql/registry-sql-secured.yml | 16 +++++----------- pom.xml | 5 +++++ 7 files changed, 26 insertions(+), 35 deletions(-) diff --git a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java index 5dcb65936d..644715c610 100644 --- a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java @@ -21,10 +21,10 @@ public class UserInterfaceConfigProperties { @ConfigProperty(name = "quarkus.oidc.auth-server-url") public String authOidcUrl; - @ConfigProperty(name = "registry.ui.auth.oidc.redirectUri", defaultValue = "/") + @ConfigProperty(name = "registry.ui.auth.oidc.redirect-uri", defaultValue = "/") @Info(category = "ui", description = "The OIDC redirectUri", availableSince = "3.0.0") public String authOidcRedirectUri; - @ConfigProperty(name = "registry.ui.auth.oidc.clientId", defaultValue = "apicurio-registry-ui") + @ConfigProperty(name = "registry.ui.auth.oidc.client-id", defaultValue = "apicurio-registry-ui") @Info(category = "ui", description = "The OIDC clientId", availableSince = "3.0.0") public String authOidcClientId; diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index cf6b60ba00..a30d32327f 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -197,8 +197,8 @@ registry.datasource.green.jdbc.min-size=20 registry.datasource.green.jdbc.max-size=100 # UI -registry.ui.auth.oidc.clientId=default_client -registry.ui.auth.oidc.redirectUri=http://localhost:8080 +registry.ui.auth.oidc.client-id=default_client +registry.ui.auth.oidc.redirect-uri=http://localhost:8080 # Disable OpenAPI class scanning mp.openapi.scan.disable=true diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index 1c12ed632f..d029d4d4e7 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -791,12 +791,12 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.ui.auth.oidc.clientId` +|`registry.ui.auth.oidc.client-id` |`string` |`apicurio-registry-ui` |`3.0.0` |The OIDC clientId -|`registry.ui.auth.oidc.redirectUri` +|`registry.ui.auth.oidc.redirect-uri` |`string` |`/` |`3.0.0` diff --git a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml index f067a232a4..417dce0f92 100644 --- a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml +++ b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml @@ -23,23 +23,19 @@ spec: fieldPath: metadata.namespace - name: AUTH_ENABLED value: "true" - - name: KEYCLOAK_API_CLIENT_ID + - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: KEYCLOAK_UI_CLIENT_ID + - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - - name: REGISTRY_UI_CONFIG_AUTH_KEYCLOAK_URL - value: 'http://localhost:8090' - - name: KEYCLOAK_REALM - value: 'registry' - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" - name: QUARKUS_OIDC_TLS_VERIFICATION value: none - - name: TOKEN_ENDPOINT + - name: QUARKUS_OIDC_TOKEN_PATH value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - - name: CLIENT_CREDENTIALS_BASIC_AUTH_ENABLED + - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_RBAC_ENABLED + - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - name: REGISTRY_AUTH_ROLE_SOURCE value: "token" diff --git a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml index 573491417b..8aa6d496c1 100644 --- a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml +++ b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml @@ -27,23 +27,19 @@ spec: value: "kafkasql" - name: AUTH_ENABLED value: "true" - - name: KEYCLOAK_API_CLIENT_ID + - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: KEYCLOAK_UI_CLIENT_ID + - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - - name: REGISTRY_UI_CONFIG_AUTH_KEYCLOAK_URL - value: 'http://localhost:8090' - - name: KEYCLOAK_REALM - value: 'registry' - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" - name: QUARKUS_OIDC_TLS_VERIFICATION value: none - - name: TOKEN_ENDPOINT + - name: QUARKUS_OIDC_TOKEN_PATH value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - - name: CLIENT_CREDENTIALS_BASIC_AUTH_ENABLED + - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_RBAC_ENABLED + - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - name: REGISTRY_AUTH_ROLE_SOURCE value: "token" diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml index 2ad55ad959..12c46d2fc3 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml @@ -29,25 +29,19 @@ spec: value: "apicurio" - name: REGISTRY_DATASOURCE_PASSWORD value: "registry" - - name: AUTH_ENABLED - value: "true" - - name: KEYCLOAK_API_CLIENT_ID + - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: KEYCLOAK_UI_CLIENT_ID + - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - - name: REGISTRY_UI_CONFIG_AUTH_KEYCLOAK_URL - value: 'http://localhost:8090' - - name: KEYCLOAK_REALM - value: 'registry' - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" - name: QUARKUS_OIDC_TLS_VERIFICATION value: none - - name: TOKEN_ENDPOINT + - name: QUARKUS_OIDC_TOKEN_PATH value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - - name: CLIENT_CREDENTIALS_BASIC_AUTH_ENABLED + - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_RBAC_ENABLED + - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - name: REGISTRY_AUTH_ROLE_SOURCE value: "token" diff --git a/pom.xml b/pom.xml index 38e3692694..88516e399a 100644 --- a/pom.xml +++ b/pom.xml @@ -526,6 +526,11 @@ okio-jvm ${okio-jvm.version} + + com.squareup.okio + okhttp + ${ok-http.version} + com.squareup.okio okio-fakefilesystem From ac55ce1e965cbdb72b36133ccc5a784f05413b05 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Tue, 26 Mar 2024 10:09:45 +0100 Subject: [PATCH 04/13] Make integration tests use the vertx client internally --- .../resources/infra/in-memory/registry-in-memory-secured.yml | 2 +- .../src/test/resources/infra/kafka/registry-kafka-secured.yml | 2 +- .../src/test/resources/infra/sql/registry-sql-secured.yml | 2 ++ pom.xml | 3 ++- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml index 417dce0f92..41eed0a2d2 100644 --- a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml +++ b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml @@ -21,7 +21,7 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: AUTH_ENABLED + - name: QUARKUS_OIDC_TENANT_ENABLED value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" diff --git a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml index 8aa6d496c1..adc7e91849 100644 --- a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml +++ b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml @@ -25,7 +25,7 @@ spec: value: kafka-service:9092 - name: REGISTRY_STORAGE_KIND value: "kafkasql" - - name: AUTH_ENABLED + - name: QUARKUS_OIDC_TENANT_ENABLED value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml index 12c46d2fc3..63cc4ed83b 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml @@ -29,6 +29,8 @@ spec: value: "apicurio" - name: REGISTRY_DATASOURCE_PASSWORD value: "registry" + - name: QUARKUS_OIDC_TENANT_ENABLED + value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID diff --git a/pom.xml b/pom.xml index 88516e399a..003944f81e 100644 --- a/pom.xml +++ b/pom.xml @@ -140,6 +140,7 @@ 1.11.3 1.4.0 4.9.9 + 4.12.0 4.9.9 3.9.0 3.9.0 @@ -529,7 +530,7 @@ com.squareup.okio okhttp - ${ok-http.version} + ${okhttp.version} com.squareup.okio From 3bb2945fbaba870da51712dcb3805200922c585b Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Thu, 28 Mar 2024 14:33:08 +0100 Subject: [PATCH 05/13] Make integration tests publish multi arch images --- .github/workflows/integration-tests.yaml | 19 ++++++- .../impl/gitops/GitTestRepositoryManager.java | 2 +- .../test/utils/KafkaTestContainerManager.java | 49 ++++++++++++------- 3 files changed, 50 insertions(+), 20 deletions(-) diff --git a/.github/workflows/integration-tests.yaml b/.github/workflows/integration-tests.yaml index c221ea630b..c0d3172071 100644 --- a/.github/workflows/integration-tests.yaml +++ b/.github/workflows/integration-tests.yaml @@ -38,6 +38,23 @@ jobs: distribution: 'temurin' cache: 'maven' + # Open-Source Machine emulator that allows you to emulate multiple CPU architectures on your machine + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + + # Docker CLI plugin for extended build capabilities with BuildKit + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v1 + + - name: Inspect builder + run: | + echo "Name: ${{ steps.buildx.outputs.name }}" + echo "Endpoint: ${{ steps.buildx.outputs.endpoint }}" + echo "Status: ${{ steps.buildx.outputs.status }}" + echo "Flags: ${{ steps.buildx.outputs.flags }}" + echo "Platforms: ${{ steps.buildx.outputs.platforms }}" + - name: Get maven wrapper run: mvn -N io.takari:maven:wrapper -Dmaven=3.8.2 @@ -46,7 +63,7 @@ jobs: - name: Build and Push Application image run: | - docker build --push -f ./distro/docker/target/docker/Dockerfile.jvm -t ttl.sh/${{ github.sha }}/apicurio/apicurio-registry:1d ./distro/docker/target/docker + docker buildx build --push -f ./distro/docker/target/docker/Dockerfile.jvm -t ttl.sh/${{ github.sha }}/apicurio/apicurio-registry:1d --platform linux/amd64,linux/arm64,linux/s390x,linux/ppc64le ./distro/docker/target/docker prepare-ui-tests: name: Prepare for UI Integration Tests diff --git a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java index f2dfaba46a..13ddaffcb5 100644 --- a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java +++ b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java @@ -10,10 +10,10 @@ public class GitTestRepositoryManager implements QuarkusTestResourceLifecycleMan @Getter private static GitTestRepository testRepository; - @Override public Map start() { testRepository = new GitTestRepository(); + testRepository.initialize(); return Map.of( diff --git a/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java b/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java index acfbf31145..84dee4314c 100644 --- a/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java +++ b/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java @@ -3,9 +3,11 @@ import io.quarkus.test.common.QuarkusTestResourceLifecycleManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.testcontainers.containers.Network; import org.testcontainers.containers.output.Slf4jLogConsumer; import org.testcontainers.redpanda.RedpandaContainer; +import java.util.Collections; import java.util.Map; public class KafkaTestContainerManager implements QuarkusTestResourceLifecycleManager { @@ -15,27 +17,38 @@ public class KafkaTestContainerManager implements QuarkusTestResourceLifecycleMa @Override public Map start() { - log.info("Starting the Kafka Test Container"); - kafka = new RedpandaContainer("docker.redpanda.com/vectorized/redpanda"); - - kafka.addEnv("KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR", "1"); - kafka.addEnv("KAFKA_TRANSACTION_STATE_LOG_MIN_ISR", "1"); - kafka.withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("kafka-testcontainer"))); - kafka.start(); - - String bootstrapServers = kafka.getBootstrapServers(); - - System.setProperty("bootstrap.servers", bootstrapServers); - - return Map.of( - "bootstrap.servers", bootstrapServers, - "registry.events.kafka.config.bootstrap.servers", bootstrapServers, - "registry.kafkasql.bootstrap.servers", bootstrapServers); + if (!Boolean.parseBoolean(System.getProperty("cluster.tests"))) { + + log.info("Starting the Kafka Test Container"); + kafka = new RedpandaContainer("docker.redpanda.com/vectorized/redpanda"); + + kafka.addEnv("KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR", "1"); + kafka.addEnv("KAFKA_TRANSACTION_STATE_LOG_MIN_ISR", "1"); + kafka.withListener(() -> "redpanda:19092"); + kafka.withNetwork(Network.SHARED); + kafka.withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("kafka-testcontainer"))); + kafka.start(); + + String externalBootstrapServers = kafka.getBootstrapServers(); + + String bootstrapServers = "redpanda:19092"; + System.setProperty("bootstrap.servers.internal", bootstrapServers); + System.setProperty("bootstrap.servers.external", externalBootstrapServers); + + return Map.of( + "bootstrap.servers", externalBootstrapServers, + "registry.events.kafka.config.bootstrap.servers", externalBootstrapServers, + "registry.kafkasql.bootstrap.servers", externalBootstrapServers); + } else { + return Collections.emptyMap(); + } } @Override public void stop() { - log.info("Stopping the Kafka Test Container"); - kafka.stop(); + if (kafka != null) { + log.info("Stopping the Kafka Test Container"); + kafka.stop(); + } } } From 30a67ddfe8369395fe32421a0db0ff2fe595448c Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Tue, 2 Apr 2024 18:15:56 +0200 Subject: [PATCH 06/13] Fix go sdk test --- .../registry/storage/impl/gitops/GitTestRepositoryManager.java | 1 - go-sdk/pkg/tests/client_test.go | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java index 13ddaffcb5..91a0fb65fb 100644 --- a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java +++ b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java @@ -13,7 +13,6 @@ public class GitTestRepositoryManager implements QuarkusTestResourceLifecycleMan @Override public Map start() { testRepository = new GitTestRepository(); - testRepository.initialize(); return Map.of( diff --git a/go-sdk/pkg/tests/client_test.go b/go-sdk/pkg/tests/client_test.go index d7936fb233..35257d390e 100644 --- a/go-sdk/pkg/tests/client_test.go +++ b/go-sdk/pkg/tests/client_test.go @@ -90,7 +90,7 @@ func TestAccessSystemInfo(t *testing.T) { info, err := client.System().Info().Get(context.Background(), nil) assert.Nil(t, err) - assert.Equal(t, "apicurio-registry", *info.GetName()) + assert.Equal(t, "Apicurio Registry (In Memory)", *info.GetName()) } func TestCreateAnArtifact(t *testing.T) { From d4769ba051254f363ad663bda65854560d2f002e Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Thu, 11 Apr 2024 13:34:03 +0200 Subject: [PATCH 07/13] Rename registry properties to apicurio properties --- README.md | 16 +- .../io/apicurio/registry/auth/AuthConfig.java | 36 ++-- .../registry/auth/AuthorizedInterceptor.java | 2 +- .../registry/auth/HeaderRoleProvider.java | 2 +- .../ccompat/rest/v7/impl/CCompatConfig.java | 6 +- .../config/RegistryStorageConfigCache.java | 4 +- .../registry/downloads/DownloadReaper.java | 2 +- .../http/HttpEventSinkConfiguration.java | 2 +- .../metrics/health/liveness/LivenessUtil.java | 2 +- .../PersistenceExceptionLivenessCheck.java | 8 +- .../liveness/ResponseErrorLivenessCheck.java | 8 +- .../PersistenceTimeoutReadinessCheck.java | 8 +- .../ResponseTimeoutReadinessCheck.java | 8 +- .../io/apicurio/registry/rest/RestConfig.java | 6 +- .../http/RegistryExceptionMapperService.java | 2 +- .../storage/RegistryStorageProducer.java | 2 +- .../impl/gitops/BlueDatasourceProducer.java | 14 +- .../impl/gitops/GitOpsConfigProperties.java | 6 +- .../impl/gitops/GitOpsRegistryStorage.java | 4 +- .../impl/gitops/GreenDatasourceProducer.java | 14 +- .../impl/kafkasql/KafkaSqlFactory.java | 22 +-- .../impl/sql/AbstractSqlRegistryStorage.java | 2 +- .../impl/sql/RegistryDatasourceProducer.java | 14 +- .../impl/sql/SqlStatementsProducer.java | 2 +- .../storage/metrics/StorageMetricsStore.java | 4 +- .../ui/UserInterfaceConfigProperties.java | 4 +- .../registry/ui/servlets/RedirectFilter.java | 4 +- .../registry/v2/openapi.json | 4 +- .../registry/v3/openapi.json | 4 +- .../resources/application-prod.properties | 34 ++-- .../resources/application-test.properties | 18 +- app/src/main/resources/application.properties | 184 +++++++++--------- .../ccompat/rest/CanonicalModeProfile.java | 2 +- .../registry/rbac/AdminResourceTest.java | 4 +- .../registry/rbac/RegistryClientTest.java | 4 +- .../registry/rest/DisableApisTestProfile.java | 2 +- .../impl/gitops/GitTestRepositoryManager.java | 8 +- .../storage/util/GitopsTestProfile.java | 4 +- .../storage/util/KafkasqlTestProfile.java | 2 +- .../storage/util/MssqlTestProfile.java | 2 +- .../storage/util/PostgresqlTestProfile.java | 2 +- .../rest/JacksonDateTimeCustomizer.java | 4 +- .../main/resources/META-INF/openapi-v2.json | 4 +- .../src/main/resources/META-INF/openapi.json | 4 +- .../proc-configuring-registry-events.adoc | 2 +- ...onfiguring-registry-security-keycloak.adoc | 4 +- .../ref-registry-all-configs.adoc | 170 ++++++++-------- .../ref-registry-kafka-topic-names.adoc | 4 +- .../ref-registry-security-configuration.adoc | 10 +- ...sions_with_version_item_request_builder.go | 4 +- go-sdk/pkg/registryclient-v2/kiota-lock.json | 2 +- ...version_expression_item_request_builder.go | 2 +- .../in-memory/registry-in-memory-secured.yml | 6 +- .../infra/kafka/registry-kafka-secured.yml | 10 +- .../resources/infra/kafka/registry-kafka.yml | 6 +- .../infra/sql/registry-sql-secured.yml | 14 +- .../test/resources/infra/sql/registry-sql.yml | 8 +- .../src/app/pages/settings/SettingsPage.tsx | 14 +- .../test/utils/KafkaTestContainerManager.java | 4 +- .../tests/ApplicationRbacEnabledProfile.java | 4 +- .../AuthTestProfileAnonymousCredentials.java | 2 +- ...uthTestProfileAuthenticatedReadAccess.java | 2 +- .../tests/AuthTestProfileWithHeaderRoles.java | 2 +- .../tests/AuthTestProfileWithLocalRoles.java | 2 +- .../registry/utils/tests/JWKSMockServer.java | 6 +- .../tests/MsSqlEmbeddedTestResource.java | 18 +- .../tests/PostgreSqlEmbeddedTestResource.java | 18 +- 67 files changed, 402 insertions(+), 402 deletions(-) diff --git a/README.md b/README.md index 170222c9cb..9c196446fd 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Which storage variant will be used is determined by the following configuration: |Option|Command argument|Env. variable| |---|---|---| -|Registry Storage Variant|`-Dregistry.storage.kind`|`REGISTRY_STORAGE_KIND`| +|Registry Storage Variant|`-Dapicurio.storage.kind`|`REGISTRY_STORAGE_KIND`| For this property, there are three possible values: - *sql* - for the SQL storage variant. @@ -81,10 +81,10 @@ The following parameters are available for executable files: | Option |Command argument| Env. variable | |---------------------------|---|--------------------------------| -| Registry SQL storage kind |`-Dregistry.storage.db-kind`| `REGISTRY_STORAGE_DB_KIND` | -| Data Source URL |`-Dregistry.datasource.url`| `REGISTRY_DATASOURCE_URL` | -| DS Username |`-Dregistry.datasource.username`| `REGISTRY_DATASOURCE_USERNAME` | -| DS Password |`-Dregistry.datasource.password`| `REGISTRY_DATASOURCE_PASSWORD` | +| Registry SQL storage kind |`-Dapicurio.storage.db-kind`| `REGISTRY_STORAGE_DB_KIND` | +| Data Source URL |`-Dapicurio.datasource.url`| `REGISTRY_DATASOURCE_URL` | +| DS Username |`-Dapicurio.datasource.username`| `REGISTRY_DATASOURCE_USERNAME` | +| DS Password |`-Dapicurio.datasource.password`| `REGISTRY_DATASOURCE_PASSWORD` | To see additional options, visit: - [Data Source config](https://quarkus.io/guides/datasource) @@ -94,9 +94,9 @@ To see additional options, visit: `./mvnw clean install -Pprod -DskipTests` builds the application artifact. The newly built runner can be found in `/app/target` ``` -java Dregistry.storage.kind=kafkasql -jar apicurio-registry-app--SNAPSHOT-runner.jar +java Dapicurio.storage.kind=kafkasql -jar apicurio-registry-app--SNAPSHOT-runner.jar ``` -For using Kafka as the persistent storage for the server information the only required configuration is to set the property *registry.storage.kind*. +For using Kafka as the persistent storage for the server information the only required configuration is to set the property *apicurio.storage.kind*. Should result in Quarkus and the registry starting up, with the ui and APIs available on localhost port 8080. By default, this will look for a kafka instance on `localhost:9092`, see [kafka-quickstart](https://kafka.apache.org/quickstart). @@ -106,7 +106,7 @@ with the necessary details to connect to a kafka instance using a PKCS12 certifi scram-sha-512 credentials for user authorisation. ``` java \ --Dregistry.storage.kind=kafkasql \ +-Dapicurio.storage.kind=kafkasql \ -Dregistry.kafka.common.bootstrap.servers= \ -Dregistry.kafka.common.ssl.truststore.location=\ -Dregistry.kafka.common.ssl.truststore.password= \ diff --git a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java index 195a623b6e..92e4b82522 100644 --- a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java +++ b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java @@ -20,77 +20,77 @@ public class AuthConfig { @ConfigProperty(name = "quarkus.oidc.tenant-enabled", defaultValue = "false") boolean authenticationEnabled; - @ConfigProperty(name = "registry.auth.role-based-authorization", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.role-based-authorization", defaultValue = "false") @Info(category = "auth", description = "Enable role based authorization", availableSince = "2.1.0.Final") boolean roleBasedAuthorizationEnabled; @Dynamic(label = "Artifact owner-only authorization", description = "When selected, Service Registry allows only the artifact owner (creator) to modify an artifact.", requires = "registry.auth.enabled=true") - @ConfigProperty(name = "registry.auth.owner-only-authorization", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.owner-only-authorization", defaultValue = "false") @Info(category = "auth", description = "Artifact owner-only authorization", availableSince = "2.0.0.Final") Supplier ownerOnlyAuthorizationEnabled; @Dynamic(label = "Artifact group owner-only authorization", description = "When selected, Service Registry allows only the artifact group owner (creator) to modify an artifact group.", requires = { "registry.auth.enabled=true", - "registry.auth.owner-only-authorization=true" + "apicurio.auth.owner-only-authorization=true" }) - @ConfigProperty(name = "registry.auth.owner-only-authorization.limit-group-access", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.owner-only-authorization.limit-group-access", defaultValue = "false") @Info(category = "auth", description = "Artifact group owner-only authorization", availableSince = "2.1.0.Final") Supplier ownerOnlyAuthorizationLimitGroupAccess; @Dynamic(label = "Anonymous read access", description = "When selected, requests from anonymous users (requests without any credentials) are granted read-only access.", requires = "registry.auth.enabled=true") - @ConfigProperty(name = "registry.auth.anonymous-read-access.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.anonymous-read-access.enabled", defaultValue = "false") @Info(category = "auth", description = "Anonymous read access", availableSince = "2.1.0.Final") Supplier anonymousReadAccessEnabled; @Dynamic(label = "Authenticated read access", description = "When selected, requests from any authenticated user are granted at least read-only access.", requires = { "registry.auth.enabled=true", - "registry.auth.role-based-authorization=true" + "apicurio.auth.role-based-authorization=true" }) - @ConfigProperty(name = "registry.auth.authenticated-read-access.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.authenticated-read-access.enabled", defaultValue = "false") @Info(category = "auth", description = "Authenticated read access", availableSince = "2.1.4.Final") Supplier authenticatedReadAccessEnabled; - @ConfigProperty(name = "registry.auth.roles.readonly", defaultValue = "sr-readonly") + @ConfigProperty(name = "apicurio.auth.roles.readonly", defaultValue = "sr-readonly") @Info(category = "auth", description = "Auth roles readonly", availableSince = "2.1.0.Final") String readOnlyRole; - @ConfigProperty(name = "registry.auth.roles.developer", defaultValue = "sr-developer") + @ConfigProperty(name = "apicurio.auth.roles.developer", defaultValue = "sr-developer") @Info(category = "auth", description = "Auth roles developer", availableSince = "2.1.0.Final") String developerRole; - @ConfigProperty(name = "registry.auth.roles.admin", defaultValue = "sr-admin") + @ConfigProperty(name = "apicurio.auth.roles.admin", defaultValue = "sr-admin") @Info(category = "auth", description = "Auth roles admin", availableSince = "2.0.0.Final") String adminRole; - @ConfigProperty(name = "registry.auth.role-source", defaultValue = "token") + @ConfigProperty(name = "apicurio.auth.role-source", defaultValue = "token") @Info(category = "auth", description = "Auth roles source", availableSince = "2.1.0.Final") String roleSource; - @ConfigProperty(name = "registry.auth.admin-override.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.auth.admin-override.enabled", defaultValue = "false") @Info(category = "auth", description = "Auth admin override enabled", availableSince = "2.1.0.Final") boolean adminOverrideEnabled; - @ConfigProperty(name = "registry.auth.admin-override.from", defaultValue = "token") + @ConfigProperty(name = "apicurio.auth.admin-override.from", defaultValue = "token") @Info(category = "auth", description = "Auth admin override from", availableSince = "2.1.0.Final") String adminOverrideFrom; - @ConfigProperty(name = "registry.auth.admin-override.type", defaultValue = "role") + @ConfigProperty(name = "apicurio.auth.admin-override.type", defaultValue = "role") @Info(category = "auth", description = "Auth admin override type", availableSince = "2.1.0.Final") String adminOverrideType; - @ConfigProperty(name = "registry.auth.admin-override.role", defaultValue = "sr-admin") + @ConfigProperty(name = "apicurio.auth.admin-override.role", defaultValue = "sr-admin") @Info(category = "auth", description = "Auth admin override role", availableSince = "2.1.0.Final") String adminOverrideRole; - @ConfigProperty(name = "registry.auth.admin-override.claim", defaultValue = "org-admin") + @ConfigProperty(name = "apicurio.auth.admin-override.claim", defaultValue = "org-admin") @Info(category = "auth", description = "Auth admin override claim", availableSince = "2.1.0.Final") String adminOverrideClaim; - @ConfigProperty(name = "registry.auth.admin-override.claim-value", defaultValue = "true") + @ConfigProperty(name = "apicurio.auth.admin-override.claim-value", defaultValue = "true") @Info(category = "auth", description = "Auth admin override claim value", availableSince = "2.1.0.Final") String adminOverrideClaimValue; - @ConfigProperty(name = "registry.auth.admin-override.user", defaultValue = "admin") + @ConfigProperty(name = "apicurio.auth.admin-override.user", defaultValue = "admin") @Info(category = "auth", description = "Auth admin override user name", availableSince = "3.0.0.Final") String adminOverrideUser; diff --git a/app/src/main/java/io/apicurio/registry/auth/AuthorizedInterceptor.java b/app/src/main/java/io/apicurio/registry/auth/AuthorizedInterceptor.java index 2d85efe31e..1e8ab73e1f 100644 --- a/app/src/main/java/io/apicurio/registry/auth/AuthorizedInterceptor.java +++ b/app/src/main/java/io/apicurio/registry/auth/AuthorizedInterceptor.java @@ -80,7 +80,7 @@ public Object authorizeMethod(InvocationContext context) throws Exception { } // Anonymous users are allowed to perform read-only operations, but only if - // registry.auth.anonymous-read-access.enabled is set to 'true' + // apicurio.auth.anonymous-read-access.enabled is set to 'true' if (authConfig.anonymousReadAccessEnabled.get() && annotation.level() == AuthorizedLevel.Read) { log.trace("Anonymous user is being granted access to read-only operation."); return context.proceed(); diff --git a/app/src/main/java/io/apicurio/registry/auth/HeaderRoleProvider.java b/app/src/main/java/io/apicurio/registry/auth/HeaderRoleProvider.java index 817743d32d..5134c7bc75 100644 --- a/app/src/main/java/io/apicurio/registry/auth/HeaderRoleProvider.java +++ b/app/src/main/java/io/apicurio/registry/auth/HeaderRoleProvider.java @@ -12,7 +12,7 @@ @RequestScoped public class HeaderRoleProvider implements RoleProvider { - @ConfigProperty(name = "registry.auth.role-source.header.name") + @ConfigProperty(name = "apicurio.auth.role-source.header.name") @Info(category = "auth", description = "Header authorization name", availableSince = "2.4.3.Final") String roleHeader; diff --git a/app/src/main/java/io/apicurio/registry/ccompat/rest/v7/impl/CCompatConfig.java b/app/src/main/java/io/apicurio/registry/ccompat/rest/v7/impl/CCompatConfig.java index 9675f22e03..a3d4dadfbb 100644 --- a/app/src/main/java/io/apicurio/registry/ccompat/rest/v7/impl/CCompatConfig.java +++ b/app/src/main/java/io/apicurio/registry/ccompat/rest/v7/impl/CCompatConfig.java @@ -13,17 +13,17 @@ public class CCompatConfig { @Dynamic(label = "Legacy ID mode (compatibility API)", description = "When selected, the Schema Registry compatibility API uses global ID instead of content ID for artifact identifiers.") - @ConfigProperty(name = "registry.ccompat.legacy-id-mode.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.ccompat.legacy-id-mode.enabled", defaultValue = "false") @Info(category = "ccompat", description = "Legacy ID mode (compatibility API)", availableSince = "2.0.2.Final") Supplier legacyIdModeEnabled; @Dynamic(label = "Canonical hash mode (compatibility API)", description = "When selected, the Schema Registry compatibility API uses the canonical hash instead of the regular hash of the content.") - @ConfigProperty(name = "registry.ccompat.use-canonical-hash", defaultValue = "false") + @ConfigProperty(name = "apicurio.ccompat.use-canonical-hash", defaultValue = "false") @Info(category = "ccompat", description = "Canonical hash mode (compatibility API)", availableSince = "2.3.0.Final") Supplier canonicalHashModeEnabled; @Dynamic(label = "Maximum number of Subjects returned (compatibility API)", description = "Determines the maximum number of Subjects that will be returned by the ccompat API (for the '/subjects' endpoint).") - @ConfigProperty(name = "registry.ccompat.max-subjects", defaultValue = "1000") + @ConfigProperty(name = "apicurio.ccompat.max-subjects", defaultValue = "1000") @Info(category = "ccompat", description = "Maximum number of Subjects returned (compatibility API)", availableSince = "2.4.2.Final") Supplier maxSubjects; diff --git a/app/src/main/java/io/apicurio/registry/config/RegistryStorageConfigCache.java b/app/src/main/java/io/apicurio/registry/config/RegistryStorageConfigCache.java index 81afe003b3..08a78e3071 100644 --- a/app/src/main/java/io/apicurio/registry/config/RegistryStorageConfigCache.java +++ b/app/src/main/java/io/apicurio/registry/config/RegistryStorageConfigCache.java @@ -27,7 +27,7 @@ public class RegistryStorageConfigCache extends RegistryStorageDecoratorBase imp @Inject Logger log; - @ConfigProperty(name = "registry.config.cache.enabled", defaultValue = "true") + @ConfigProperty(name = "apicurio.config.cache.enabled", defaultValue = "true") @Info(category = "cache", description = "Registry cache enabled", availableSince = "2.2.2.Final") boolean enabled; @@ -79,7 +79,7 @@ private void invalidateCache() { configCache.clear(); } - @Scheduled(concurrentExecution = SKIP, every = "{registry.config.refresh.every}") + @Scheduled(concurrentExecution = SKIP, every = "{apicurio.config.refresh.every}") void run() { if (!enabled) { return; diff --git a/app/src/main/java/io/apicurio/registry/downloads/DownloadReaper.java b/app/src/main/java/io/apicurio/registry/downloads/DownloadReaper.java index 5751349468..466ce407ed 100644 --- a/app/src/main/java/io/apicurio/registry/downloads/DownloadReaper.java +++ b/app/src/main/java/io/apicurio/registry/downloads/DownloadReaper.java @@ -28,7 +28,7 @@ public class DownloadReaper { /** * Minimal granularity is 1 minute. */ - @Scheduled(delay = 2, concurrentExecution = SKIP, every = "{registry.downloads.reaper.every}") + @Scheduled(delay = 2, concurrentExecution = SKIP, every = "{apicurio.downloads.reaper.every}") void run() { try { if(storage.isReady()) { diff --git a/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java b/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java index a740e4bdf7..3f4cb0ab10 100644 --- a/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java +++ b/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java @@ -16,7 +16,7 @@ @ApplicationScoped public class HttpEventSinkConfiguration { - @ConfigProperty(name = "registry.events.ksink") + @ConfigProperty(name = "apicurio.events.ksink") @Info(category = "events", description = "Events Kafka sink enabled", availableSince = "2.0.0.Final") Optional ksink; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/LivenessUtil.java b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/LivenessUtil.java index 5e13b72d59..7f4d12a37b 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/LivenessUtil.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/LivenessUtil.java @@ -20,7 +20,7 @@ public class LivenessUtil { Logger log; @Inject - @ConfigProperty(name = "registry.liveness.errors.ignored") + @ConfigProperty(name = "apicurio.liveness.errors.ignored") @Info(category = "health", description = "Ignored liveness errors", availableSince = "1.2.3.Final") Optional> ignored; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java index 3beee9ee24..c6fb2642cc 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java @@ -29,7 +29,7 @@ public class PersistenceExceptionLivenessCheck extends AbstractErrorCounterHealt * as captured by this interceptor, * before the liveness check fails. */ - @ConfigProperty(name = "registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold", defaultValue = "1") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold", defaultValue = "1") @Info(category = "health", description = "Error threshold of persistence liveness check", availableSince = "1.0.2.Final") Integer configErrorThreshold; @@ -39,18 +39,18 @@ public class PersistenceExceptionLivenessCheck extends AbstractErrorCounterHealt * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of persistence liveness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the liveness status after this time window passes without any further errors. */ - @ConfigProperty(name = "registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of persistence liveness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; - @ConfigProperty(name = "registry.metrics.PersistenceExceptionLivenessCheck.disableLogging", defaultValue = "false") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.disableLogging", defaultValue = "false") @Info(category = "health", description = "Disable logging of persistence liveness check", availableSince = "2.0.0.Final") Boolean disableLogging; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java index e2f90ae31d..9d28b946e8 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java @@ -25,7 +25,7 @@ public class ResponseErrorLivenessCheck extends AbstractErrorCounterHealthCheck * as captured by {@link io.apicurio.registry.rest.RegistryExceptionMapper} * before the liveness check fails. */ - @ConfigProperty(name = "registry.metrics.ResponseErrorLivenessCheck.errorThreshold", defaultValue = "1") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold", defaultValue = "1") @Info(category = "health", description = "Error threshold of response liveness check", availableSince = "1.0.2.Final") Integer configErrorThreshold; @@ -35,18 +35,18 @@ public class ResponseErrorLivenessCheck extends AbstractErrorCounterHealthCheck * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of response liveness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the liveness status after this time window passes without any further errors. */ - @ConfigProperty(name = "registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of response liveness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; - @ConfigProperty(name = "registry.metrics.ResponseErrorLivenessCheck.disableLogging", defaultValue = "false") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.disableLogging", defaultValue = "false") @Info(category = "health", description = "Disable logging of response liveness check", availableSince = "2.0.0.Final") Boolean disableLogging; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java index 9725cfbc09..5537f4c519 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java @@ -30,7 +30,7 @@ public class PersistenceTimeoutReadinessCheck extends AbstractErrorCounterHealth * Maximum number of timeouts as captured by this interceptor, * before the readiness check fails. */ - @ConfigProperty(name = "registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold", defaultValue = "5") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold", defaultValue = "5") @Info(category = "health", description = "Error threshold of persistence readiness check", availableSince = "1.0.2.Final") Integer configErrorThreshold; @@ -40,21 +40,21 @@ public class PersistenceTimeoutReadinessCheck extends AbstractErrorCounterHealth * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of persistence readiness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the readiness status after this time window passes without any further errors. */ - @ConfigProperty(name = "registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of persistence readiness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; /** * Set the operation duration in seconds, after which it's considered an error. */ - @ConfigProperty(name = "registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec", defaultValue = "15") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec", defaultValue = "15") @Info(category = "health", description = "Timeout of persistence readiness check", availableSince = "1.0.2.Final") Integer configTimeoutSec; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java index a8f4c1ab96..8f9cedc8d2 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java @@ -38,7 +38,7 @@ public class ResponseTimeoutReadinessCheck extends AbstractErrorCounterHealthChe * Maximum number of requests taking more than {@link ResponseTimeoutReadinessCheck#configTimeoutSec} seconds, * before the readiness check fails. */ - @ConfigProperty(name = "registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold", defaultValue = "1") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold", defaultValue = "1") @Info(category = "health", description = "Error threshold of response readiness check", availableSince = "1.0.2.Final") Instance configErrorThreshold; @@ -48,14 +48,14 @@ public class ResponseTimeoutReadinessCheck extends AbstractErrorCounterHealthChe * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of response readiness check", availableSince = "1.0.2.Final") Instance configCounterResetWindowDurationSec; /** * If set to a positive value, reset the readiness status after this time window passes without any further errors. */ - @ConfigProperty(name = "registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of response readiness check", availableSince = "1.0.2.Final") Instance configStatusResetWindowDurationSec; @@ -63,7 +63,7 @@ public class ResponseTimeoutReadinessCheck extends AbstractErrorCounterHealthChe * Set the request duration in seconds, after which it's considered an error. * TODO This may be expected on some endpoints. Add a way to ignore those. */ - @ConfigProperty(name = "registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec", defaultValue = "10") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec", defaultValue = "10") @Info(category = "health", description = "Timeout of response readiness check", availableSince = "1.0.2.Final") Instance configTimeoutSec; diff --git a/app/src/main/java/io/apicurio/registry/rest/RestConfig.java b/app/src/main/java/io/apicurio/registry/rest/RestConfig.java index 70012965e2..191ec0d673 100644 --- a/app/src/main/java/io/apicurio/registry/rest/RestConfig.java +++ b/app/src/main/java/io/apicurio/registry/rest/RestConfig.java @@ -10,16 +10,16 @@ @Singleton public class RestConfig { - @ConfigProperty(name = "registry.rest.artifact.download.maxSize", defaultValue = "1000000") + @ConfigProperty(name = "apicurio.rest.artifact.download.maxSize", defaultValue = "1000000") @Info(category = "rest", description = "Max size of the artifact allowed to be downloaded from URL", availableSince = "2.2.6-SNAPSHOT") int downloadMaxSize; - @ConfigProperty(name = "registry.rest.artifact.download.skipSSLValidation", defaultValue = "false") + @ConfigProperty(name = "apicurio.rest.artifact.download.skipSSLValidation", defaultValue = "false") @Info(category = "rest", description = "Skip SSL validation when downloading artifacts from URL", availableSince = "2.2.6-SNAPSHOT") boolean downloadSkipSSLValidation; @Dynamic(label = "Delete artifact version", description = "When selected, users are permitted to delete artifact versions.") - @ConfigProperty(name = "registry.rest.artifact.deletion.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.rest.artifact.deletion.enabled", defaultValue = "false") @Info(category = "rest", description = "Enables artifact version deletion", availableSince = "2.4.2-SNAPSHOT") Supplier artifactVersionDeletionEnabled; diff --git a/app/src/main/java/io/apicurio/registry/services/http/RegistryExceptionMapperService.java b/app/src/main/java/io/apicurio/registry/services/http/RegistryExceptionMapperService.java index 2f18a03aaa..113b5f952d 100644 --- a/app/src/main/java/io/apicurio/registry/services/http/RegistryExceptionMapperService.java +++ b/app/src/main/java/io/apicurio/registry/services/http/RegistryExceptionMapperService.java @@ -51,7 +51,7 @@ public class RegistryExceptionMapperService { @Inject LivenessUtil livenessUtil; - @ConfigProperty(name = "registry.api.errors.include-stack-in-response", defaultValue = "false") + @ConfigProperty(name = "apicurio.api.errors.include-stack-in-response", defaultValue = "false") @Info(category = "api", description = "Include stack trace in errors responses", availableSince = "2.1.4.Final") boolean includeStackTrace; diff --git a/app/src/main/java/io/apicurio/registry/storage/RegistryStorageProducer.java b/app/src/main/java/io/apicurio/registry/storage/RegistryStorageProducer.java index 3175e161f9..78d647b14a 100644 --- a/app/src/main/java/io/apicurio/registry/storage/RegistryStorageProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/RegistryStorageProducer.java @@ -28,7 +28,7 @@ public class RegistryStorageProducer { @Inject Instance decorators; - @ConfigProperty(name = "registry.storage.kind") + @ConfigProperty(name = "apicurio.storage.kind") @Info(category = "storage", description = "Application storage variant, for example, sql, kafkasql, or gitops", availableSince = "3.0.0.Final") String registryStorageType; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/BlueDatasourceProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/BlueDatasourceProducer.java index 1ae8dacd4a..af84dbb5a1 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/BlueDatasourceProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/BlueDatasourceProducer.java @@ -15,31 +15,31 @@ public class BlueDatasourceProducer { - @ConfigProperty(name = "registry.datasource.blue.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.datasource.blue.db-kind", defaultValue = "h2") @Info(category = "storage", description = "Gitops blue datasource db kind", availableSince = "3.0.0.Final") String databaseType; - @ConfigProperty(name = "registry.datasource.blue.jdbc.url", defaultValue = "jdbc:h2:mem:registry_db") + @ConfigProperty(name = "apicurio.datasource.blue.jdbc.url", defaultValue = "jdbc:h2:mem:registry_db") @Info(category = "storage", description = "Gitops blue datasource jdbc url", availableSince = "3.0.0.Final") String jdbcUrl; - @ConfigProperty(name = "registry.datasource.blue.username", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.blue.username", defaultValue = "sa") @Info(category = "storage", description = "Gitops blue datasource username", availableSince = "3.0.0.Final") String username; - @ConfigProperty(name = "registry.datasource.blue.password", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.blue.password", defaultValue = "sa") @Info(category = "storage", description = "Gitops blue datasource password", availableSince = "3.0.0.Final") String password; - @ConfigProperty(name = "registry.datasource.blue.jdbc.initial-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.blue.jdbc.initial-size", defaultValue = "20") @Info(category = "storage", description = "Gitops blue datasource pool initial size", availableSince = "3.0.0.Final") String initialSize; - @ConfigProperty(name = "registry.datasource.blue.jdbc.min-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.blue.jdbc.min-size", defaultValue = "20") @Info(category = "storage", description = "Gitops blue datasource pool minimum size", availableSince = "3.0.0.Final") String minSize; - @ConfigProperty(name = "registry.datasource.blue.jdbc.max-size", defaultValue = "100") + @ConfigProperty(name = "apicurio.datasource.blue.jdbc.max-size", defaultValue = "100") @Info(category = "storage", description = "Gitops blue datasource pool max size", availableSince = "3.0.0.Final") String maxSize; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java index 403c46ec62..674018d81c 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java @@ -8,7 +8,7 @@ @ApplicationScoped public class GitOpsConfigProperties { - @ConfigProperty(name = "registry.gitops.id") + @ConfigProperty(name = "apicurio.gitops.id") @Info(category = "gitops", description = "Identifier of this Registry instance. Only data that references this identifier " + "will be loaded.", availableSince = "3.0.0") @Getter @@ -19,12 +19,12 @@ public class GitOpsConfigProperties { @Getter String workDir; - @ConfigProperty(name = "registry.gitops.repo.origin.uri") + @ConfigProperty(name = "apicurio.gitops.repo.origin.uri") @Info(category = "gitops", description = "URI of the remote git repository containing data to be loaded.", availableSince = "3.0.0") @Getter String originRepoURI; - @ConfigProperty(name = "registry.gitops.repo.origin.branch", defaultValue = "main") + @ConfigProperty(name = "apicurio.gitops.repo.origin.branch", defaultValue = "main") @Info(category = "gitops", description = "Name of the branch in the remote git repository containing data to be loaded.", availableSince = "3.0.0") @Getter String originRepoBranch; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsRegistryStorage.java b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsRegistryStorage.java index 5ac93780a0..598cf3db5d 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsRegistryStorage.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsRegistryStorage.java @@ -53,7 +53,7 @@ public class GitOpsRegistryStorage extends AbstractReadOnlyRegistryStorage { @Inject GitManager gitManager; - @ConfigProperty(name = "registry.storage.kind") + @ConfigProperty(name = "apicurio.storage.kind") @Info(category = "storage", description = "Application storage variant, for example, sql, kafkasql, or gitops", availableSince = "3.0.0.Final") String registryStorageType; @@ -87,7 +87,7 @@ public void initialize() { } } - @Scheduled(concurrentExecution = SKIP, every = "{registry.gitops.refresh.every}") + @Scheduled(concurrentExecution = SKIP, every = "{apicurio.gitops.refresh.every}") void refresh() { if (registryStorageType.equals("gitops")) { log.debug("Running GitOps refresh. Active database is {} and state is {}.", active == green ? "green" : "blue", state); diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GreenDatasourceProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GreenDatasourceProducer.java index 80e4985a6b..096405f606 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GreenDatasourceProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GreenDatasourceProducer.java @@ -15,31 +15,31 @@ public class GreenDatasourceProducer { - @ConfigProperty(name = "registry.datasource.green.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.datasource.green.db-kind", defaultValue = "h2") @Info(category = "storage", description = "Gitops green datasource db kind", availableSince = "3.0.0.Final") String databaseType; - @ConfigProperty(name = "registry.datasource.green.jdbc.url", defaultValue = "jdbc:h2:mem:registry_db") + @ConfigProperty(name = "apicurio.datasource.green.jdbc.url", defaultValue = "jdbc:h2:mem:registry_db") @Info(category = "storage", description = "Gitops green datasource jdbc url", availableSince = "3.0.0.Final") String jdbcUrl; - @ConfigProperty(name = "registry.datasource.green.username", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.green.username", defaultValue = "sa") @Info(category = "storage", description = "Gitops green datasource username", availableSince = "3.0.0.Final") String username; - @ConfigProperty(name = "registry.datasource.green.password", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.green.password", defaultValue = "sa") @Info(category = "storage", description = "Gitops green datasource password", availableSince = "3.0.0.Final") String password; - @ConfigProperty(name = "registry.datasource.green.jdbc.initial-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.green.jdbc.initial-size", defaultValue = "20") @Info(category = "storage", description = "Gitops green datasource pool initial size", availableSince = "3.0.0.Final") String initialSize; - @ConfigProperty(name = "registry.datasource.green.jdbc.min-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.green.jdbc.min-size", defaultValue = "20") @Info(category = "storage", description = "Gitops green datasource pool minimum size", availableSince = "3.0.0.Final") String minSize; - @ConfigProperty(name = "registry.datasource.green.jdbc.max-size", defaultValue = "100") + @ConfigProperty(name = "apicurio.datasource.green.jdbc.max-size", defaultValue = "100") @Info(category = "storage", description = "Gitops green datasource pool max size", availableSince = "3.0.0.Final") String maxSize; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java b/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java index f24a70896a..de5b9949d2 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java @@ -27,27 +27,27 @@ public class KafkaSqlFactory { @Inject - @ConfigProperty(name = "registry.kafkasql.bootstrap.servers") + @ConfigProperty(name = "apicurio.kafkasql.bootstrap.servers") @Info(category = "storage", description = "Kafka sql storage bootstrap servers") String bootstrapServers; @Inject - @ConfigProperty(name = "registry.kafkasql.topic", defaultValue = "kafkasql-journal") + @ConfigProperty(name = "apicurio.kafkasql.topic", defaultValue = "kafkasql-journal") @Info(category = "storage", description = "Kafka sql storage topic name") String topic; @Inject - @RegistryProperties(value = "registry.kafkasql.topic") + @RegistryProperties(value = "apicurio.kafkasql.topic") @Info(category = "storage", description = "Kafka sql storage topic properties") Properties topicProperties; @Inject - @ConfigProperty(name = "registry.kafkasql.topic.auto-create", defaultValue = "true") + @ConfigProperty(name = "apicurio.kafkasql.topic.auto-create", defaultValue = "true") @Info(category = "storage", description = "Kafka sql storage topic auto create") Boolean topicAutoCreate; @Inject - @ConfigProperty(name = "registry.kafkasql.consumer.poll.timeout", defaultValue = "1000") + @ConfigProperty(name = "apicurio.kafkasql.consumer.poll.timeout", defaultValue = "1000") @Info(category = "storage", description = "Kafka sql storage consumer poll timeout") Integer pollTimeout; @@ -77,7 +77,7 @@ public class KafkaSqlFactory { ) Properties adminProperties; - @ConfigProperty(name = "registry.kafkasql.security.sasl.enabled", defaultValue = "false") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.enabled", defaultValue = "false") @Info(category = "storage", description = "Kafka sql storage sasl enabled") boolean saslEnabled; @@ -85,23 +85,23 @@ public class KafkaSqlFactory { @Info(category = "storage", description = "Kafka sql storage security protocol") Optional protocol; - @ConfigProperty(name = "registry.kafkasql.security.sasl.mechanism", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.mechanism", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage sasl mechanism") String saslMechanism; - @ConfigProperty(name = "registry.kafkasql.security.sasl.client-id", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.client-id", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage sasl client identifier") String clientId; - @ConfigProperty(name = "registry.kafkasql.security.sasl.client-secret", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.client-secret", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage sasl client secret") String clientSecret; - @ConfigProperty(name = "registry.kafkasql.security.sasl.token.endpoint", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.token.endpoint", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage sasl token endpoint") String tokenEndpoint; - @ConfigProperty(name = "registry.kafkasql.security.sasl.login.callback.handler.class", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.sasl.login.callback.handler.class", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage sasl login callback handler") String loginCallbackHandler; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java b/app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java index 7ed0cc22f7..f534777985 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java @@ -188,7 +188,7 @@ protected SqlStatements sqlStatements() { return sqlStatements; } - @ConfigProperty(name = "registry.sql.init", defaultValue = "true") + @ConfigProperty(name = "apicurio.sql.init", defaultValue = "true") @Info(category = "storage", description = "SQL init", availableSince = "2.0.0.Final") boolean initDB; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java index 71321cd7a6..6ce534fa3c 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java @@ -19,31 +19,31 @@ public class RegistryDatasourceProducer { @Inject Logger log; - @ConfigProperty(name = "registry.storage.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.storage.db-kind", defaultValue = "h2") @Info(category = "storage", description = "Application datasource database type", availableSince = "3.0.0.Final") String databaseType; - @ConfigProperty(name = "registry.datasource.url", defaultValue = "jdbc:h2:mem:registry_db") + @ConfigProperty(name = "apicurio.datasource.url", defaultValue = "jdbc:h2:mem:registry_db") @Info(category = "storage", description = "Application datasource jdbc url", availableSince = "3.0.0.Final") String jdbcUrl; - @ConfigProperty(name = "registry.datasource.username", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.username", defaultValue = "sa") @Info(category = "storage", description = "Application datasource username", availableSince = "3.0.0.Final") String username; - @ConfigProperty(name = "registry.datasource.password", defaultValue = "sa") + @ConfigProperty(name = "apicurio.datasource.password", defaultValue = "sa") @Info(category = "storage", description = "Application datasource password", availableSince = "3.0.0.Final") String password; - @ConfigProperty(name = "registry.datasource.jdbc.initial-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.jdbc.initial-size", defaultValue = "20") @Info(category = "storage", description = "Application datasource pool initial size", availableSince = "3.0.0.Final") String initialSize; - @ConfigProperty(name = "registry.datasource.jdbc.min-size", defaultValue = "20") + @ConfigProperty(name = "apicurio.datasource.jdbc.min-size", defaultValue = "20") @Info(category = "storage", description = "Application datasource pool minimum size", availableSince = "3.0.0.Final") String minSize; - @ConfigProperty(name = "registry.datasource.jdbc.max-size", defaultValue = "100") + @ConfigProperty(name = "apicurio.datasource.jdbc.max-size", defaultValue = "100") @Info(category = "storage", description = "Application datasource pool maximum size", availableSince = "3.0.0.Final") String maxSize; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java index 53f7495bfa..7caec94a0d 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java @@ -13,7 +13,7 @@ public class SqlStatementsProducer { @Inject Logger log; - @ConfigProperty(name = "registry.storage.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.storage.db-kind", defaultValue = "h2") @Info(category = "storage", description = "Datasource Db kind", availableSince = "2.0.0.Final") String databaseType; diff --git a/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java b/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java index 175ab84ee4..2faab91f0e 100644 --- a/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java +++ b/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java @@ -37,12 +37,12 @@ public class StorageMetricsStore { Logger log; @Inject - @ConfigProperty(defaultValue = "30000", name = "registry.storage.metrics.cache.check-period") + @ConfigProperty(defaultValue = "30000", name = "apicurio.storage.metrics.cache.check-period") @Info(category = "health", description = "Storage metrics cache check period", availableSince = "2.1.0.Final") Long limitsCheckPeriod; @Inject - @ConfigProperty(defaultValue = "1000", name = "registry.storage.metrics.cache.max-size") + @ConfigProperty(defaultValue = "1000", name = "apicurio.storage.metrics.cache.max-size") @Info(category = "limits", description = "Storage metrics cache max size.", availableSince = "2.4.1.Final") Long cacheMaxSize; diff --git a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java index 644715c610..1cc12a9535 100644 --- a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java @@ -21,10 +21,10 @@ public class UserInterfaceConfigProperties { @ConfigProperty(name = "quarkus.oidc.auth-server-url") public String authOidcUrl; - @ConfigProperty(name = "registry.ui.auth.oidc.redirect-uri", defaultValue = "/") + @ConfigProperty(name = "apicurio.ui.auth.oidc.redirect-uri", defaultValue = "/") @Info(category = "ui", description = "The OIDC redirectUri", availableSince = "3.0.0") public String authOidcRedirectUri; - @ConfigProperty(name = "registry.ui.auth.oidc.client-id", defaultValue = "apicurio-registry-ui") + @ConfigProperty(name = "apicurio.ui.auth.oidc.client-id", defaultValue = "apicurio-registry-ui") @Info(category = "ui", description = "The OIDC clientId", availableSince = "3.0.0") public String authOidcClientId; diff --git a/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java b/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java index 78a1d5f5a3..1542829744 100644 --- a/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java +++ b/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java @@ -18,11 +18,11 @@ @ApplicationScoped public class RedirectFilter implements Filter { - @ConfigProperty(name = "registry.enable-redirects") + @ConfigProperty(name = "apicurio.enable-redirects") @Info(category = "redirects", description = "Enable redirects", availableSince = "2.1.2.Final") Boolean redirectsEnabled; - @ConfigProperty(name = "registry.redirects") + @ConfigProperty(name = "apicurio.redirects") @Info(category = "redirects", description = "Registry redirects", availableSince = "2.1.2.Final") Map redirectsConfig; Map redirects = new HashMap<>(); diff --git a/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json b/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json index 36bbcd8a4a..b4db450471 100644 --- a/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json +++ b/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json @@ -822,7 +822,7 @@ }, "operationId": "deleteArtifactVersion", "summary": "Delete artifact version", - "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" + "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" }, "parameters": [ { @@ -3997,7 +3997,7 @@ } }, "example": { - "name": "registry.auth.owner-only-authorization", + "name": "apicurio.auth.owner-only-authorization", "value": "true", "type": "boolean", "label": "Owner Only Authorization", diff --git a/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json b/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json index a86916e8d6..69e0339b7d 100644 --- a/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json +++ b/app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json @@ -719,7 +719,7 @@ }, "operationId": "deleteArtifactVersion", "summary": "Delete artifact version", - "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" + "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" }, "parameters": [ { @@ -3731,7 +3731,7 @@ } }, "example": { - "name": "registry.auth.owner-only-authorization", + "name": "apicurio.auth.owner-only-authorization", "value": "true", "type": "boolean", "label": "Owner Only Authorization", diff --git a/app/src/main/resources/application-prod.properties b/app/src/main/resources/application-prod.properties index 67de03bcbe..7ccb6194bb 100644 --- a/app/src/main/resources/application-prod.properties +++ b/app/src/main/resources/application-prod.properties @@ -1,25 +1,25 @@ # Readiness and Liveness -registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=5 -registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec=30 -registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec=60 -registry.metrics.ResponseErrorLivenessCheck.errorThreshold=5 -registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec=30 -registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold=5 +apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec=30 +apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold=5 +apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec=30 +apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec=60 -registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=5 -registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec=30 -registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec=60 -registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=10 -registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=5 -registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec=30 -registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec=60 -registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec=20 +apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=5 +apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec=30 +apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=10 +apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold=5 +apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec=30 +apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec=20 -registry.liveness.errors.ignored= +apicurio.liveness.errors.ignored= # Eventing -registry.events.ksink= -registry.events.kafka.config.bootstrap.servers= +apicurio.events.ksink= +apicurio.events.kafka.config.bootstrap.servers= # Log quarkus.log.level=INFO diff --git a/app/src/main/resources/application-test.properties b/app/src/main/resources/application-test.properties index 0ea009d8dc..6859606182 100644 --- a/app/src/main/resources/application-test.properties +++ b/app/src/main/resources/application-test.properties @@ -8,18 +8,18 @@ quarkus.test.flat-class-path=true ## Registry # Events -registry.events.kafka.config.bootstrap.servers=localhost:9092 +apicurio.events.kafka.config.bootstrap.servers=localhost:9092 # Metrics -registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold=10000 -registry.metrics.ResponseErrorLivenessCheck.errorThreshold=10000 -registry.metrics.ResponseErrorLivenessCheck.disableLogging=true -registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=10000 -registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold=10000 -registry.metrics.PersistenceExceptionLivenessCheck.disableLogging=true +apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold=10000 +apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold=10000 +apicurio.metrics.ResponseErrorLivenessCheck.disableLogging=true +apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=10000 +apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold=10000 +apicurio.metrics.PersistenceExceptionLivenessCheck.disableLogging=true #Log config -registry.logconfigjob.every=1s +apicurio.logconfigjob.every=1s # Artifact version deletion -registry.rest.artifact.deletion.enabled=true +apicurio.rest.artifact.deletion.enabled=true diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index a30d32327f..7385af6445 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -69,136 +69,136 @@ apicurio.authn.basic-client-credentials.cache-expiration=5 apicurio.authn.audit.log.prefix=registry.audit # Authorization -registry.auth.role-based-authorization=false -registry.auth.owner-only-authorization=false -registry.auth.owner-only-authorization.limit-group-access=false -registry.auth.anonymous-read-access.enabled=false -registry.auth.authenticated-read-access.enabled=false -registry.auth.roles.readonly=sr-readonly -registry.auth.roles.developer=sr-developer -registry.auth.roles.admin=sr-admin -registry.auth.role-source=token -registry.auth.role-source.header.name=X-Registry-Role +apicurio.auth.role-based-authorization=false +apicurio.auth.owner-only-authorization=false +apicurio.auth.owner-only-authorization.limit-group-access=false +apicurio.auth.anonymous-read-access.enabled=false +apicurio.auth.authenticated-read-access.enabled=false +apicurio.auth.roles.readonly=sr-readonly +apicurio.auth.roles.developer=sr-developer +apicurio.auth.roles.admin=sr-admin +apicurio.auth.role-source=token +apicurio.auth.role-source.header.name=X-Registry-Role # Admin override indicates whether the existence of a role somewhere # other than the primary role source can override the 'isAdmin' logic. This # is useful when using role-source=application to bypass the DB check when the # user has some existing role or other claim in their token. -registry.auth.admin-override.enabled=false -registry.auth.admin-override.from=token -registry.auth.admin-override.type=role -registry.auth.admin-override.role=sr-admin -registry.auth.admin-override.claim=org-admin -registry.auth.admin-override.claim-value=true +apicurio.auth.admin-override.enabled=false +apicurio.auth.admin-override.from=token +apicurio.auth.admin-override.type=role +apicurio.auth.admin-override.role=sr-admin +apicurio.auth.admin-override.claim=org-admin +apicurio.auth.admin-override.claim-value=true # Cache -registry.storage.metrics.cache.check-period=30000 -registry.storage.metrics.cache.max-size=1000 -registry.limits.config.cache.check-period=30000 +apicurio.storage.metrics.cache.check-period=30000 +apicurio.storage.metrics.cache.max-size=1000 +apicurio.limits.config.cache.check-period=30000 # CCompatibility API -registry.ccompat.legacy-id-mode.enabled=false -registry.ccompat.max-subjects=1000 -registry.ccompat.use-canonical-hash=false +apicurio.ccompat.legacy-id-mode.enabled=false +apicurio.ccompat.max-subjects=1000 +apicurio.ccompat.use-canonical-hash=false # Config -registry.config.refresh.every=1m -registry.config.cache.enabled=true +apicurio.config.refresh.every=1m +apicurio.config.cache.enabled=true # Downloads -registry.downloads.reaper.every=60s +apicurio.downloads.reaper.every=60s # Dynamic config properties -registry.config.dynamic.allow-all=true -registry.auth.owner-only-authorization.dynamic.allow=${registry.config.dynamic.allow-all} -registry.auth.owner-only-authorization.limit-group-access.dynamic.allow=${registry.config.dynamic.allow-all} -registry.auth.anonymous-read-access.enabled.dynamic.allow=${registry.config.dynamic.allow-all} -registry.ccompat.legacy-id-mode.enabled.dynamic.allow=${registry.config.dynamic.allow-all} -registry.ccompat.use-canonical-hash.dynamic.allow=${registry.config.dynamic.allow-all} -registry.ccompat.max-subjects.dynamic.allow=${registry.config.dynamic.allow-all} -registry.download.href.ttl.dynamic.allow=${registry.config.dynamic.allow-all} -registry.ui.features.readOnly.dynamic.allow=${registry.config.dynamic.allow-all} -registry.rest.artifact.deletion.enabled.dynamic.allow=${registry.config.dynamic.allow-all} -registry.storage.read-only.dynamic.allow=${registry.config.dynamic.allow-all} -apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${registry.config.dynamic.allow-all} +apicurio.config.dynamic.allow-all=true +apicurio.auth.owner-only-authorization.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.auth.owner-only-authorization.limit-group-access.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.auth.anonymous-read-access.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.ccompat.legacy-id-mode.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.ccompat.use-canonical-hash.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.ccompat.max-subjects.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.download.href.ttl.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.ui.features.readOnly.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.rest.artifact.deletion.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.storage.read-only.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} # Error -registry.api.errors.include-stack-in-response=false +apicurio.api.errors.include-stack-in-response=false # Events -registry.events.ksink= -registry.events.kafka.config.bootstrap.servers=localhost:9092 -registry.events.kafka.config.enable.idempotence=true -registry.events.kafka.config.retries=3 -registry.events.kafka.config.acks=all +apicurio.events.ksink= +apicurio.events.kafka.config.bootstrap.servers=localhost:9092 +apicurio.events.kafka.config.enable.idempotence=true +apicurio.events.kafka.config.retries=3 +apicurio.events.kafka.config.acks=all # Logging -registry.logconfigjob.every=5s -registry.logconfigjob.delayed=1s +apicurio.logconfigjob.every=5s +apicurio.logconfigjob.delayed=1s # Redirects -registry.enable-redirects=true -registry.redirects.root=/,/apis +apicurio.enable-redirects=true +apicurio.redirects.root=/,/apis # Rest -registry.rest.artifact.download.maxSize=1000000 -registry.rest.artifact.download.skipSSLValidation=false -registry.rest.artifact.deletion.enabled=false +apicurio.rest.artifact.download.maxSize=1000000 +apicurio.rest.artifact.download.skipSSLValidation=false +apicurio.rest.artifact.deletion.enabled=false # Api date format -registry.apis.v2.date-format=yyyy-MM-dd'T'HH:mm:ss'Z' -registry.apis.v2.date-format-timezone=UTC +apicurio.apis.v2.date-format=yyyy-MM-dd'T'HH:mm:ss'Z' +apicurio.apis.v2.date-format-timezone=UTC # Storage -registry.storage.kind=sql +apicurio.storage.kind=sql ## SQL Storage -registry.storage.db-kind=h2 -registry.datasource.url=jdbc:h2:mem:registry_db -registry.datasource.username=sa -registry.datasource.password=sa -registry.datasource.jdbc.initial-size=20 -registry.datasource.jdbc.min-size=20 -registry.datasource.jdbc.max-size=100 -registry.sql.init=true +apicurio.storage.db-kind=h2 +apicurio.datasource.url=jdbc:h2:mem:registry_db +apicurio.datasource.username=sa +apicurio.datasource.password=sa +apicurio.datasource.jdbc.initial-size=20 +apicurio.datasource.jdbc.min-size=20 +apicurio.datasource.jdbc.max-size=100 +apicurio.sql.init=true ## Kafka SQL storage -registry.kafkasql.bootstrap.servers=localhost:9092 -registry.kafkasql.topic=kafkasql-journal -registry.kafkasql.producer.client.id=${registry.id}-producer -registry.kafkasql.consumer.poll.timeout=100 -registry.kafkasql.consumer.group.id=${registry.id}-${quarkus.uuid} +apicurio.kafkasql.bootstrap.servers=localhost:9092 +apicurio.kafkasql.topic=kafkasql-journal +apicurio.kafkasql.producer.client.id=${registry.id}-producer +apicurio.kafkasql.consumer.poll.timeout=100 +apicurio.kafkasql.consumer.group.id=${registry.id}-${quarkus.uuid} # Security -registry.kafkasql.security.sasl.enabled=false -registry.kafkasql.security.sasl.mechanism=OAUTHBEARER -registry.kafkasql.security.sasl.client-id=sa -registry.kafkasql.security.sasl.client-secret=sa -registry.kafkasql.security.sasl.token.endpoint=http://localhost:8090 -registry.kafkasql.security.sasl.login.callback.handler.class=io.strimzi.kafka.oauth.client.JaasClientOauthLoginCallbackHandler +apicurio.kafkasql.security.sasl.enabled=false +apicurio.kafkasql.security.sasl.mechanism=OAUTHBEARER +apicurio.kafkasql.security.sasl.client-id=sa +apicurio.kafkasql.security.sasl.client-secret=sa +apicurio.kafkasql.security.sasl.token.endpoint=http://localhost:8090 +apicurio.kafkasql.security.sasl.login.callback.handler.class=io.strimzi.kafka.oauth.client.JaasClientOauthLoginCallbackHandler ## Gitops -registry.gitops.id=main -registry.gitops.repo.origin.uri=http://localhost -registry.gitops.repo.origin.branch=main -registry.gitops.refresh.every=30s +apicurio.gitops.id=main +apicurio.gitops.repo.origin.uri=http://localhost +apicurio.gitops.repo.origin.branch=main +apicurio.gitops.refresh.every=30s # Blue datasource -registry.datasource.blue.db-kind=h2 -registry.datasource.blue.jdbc.url=jdbc:h2:mem:registry_blue -registry.datasource.blue.username=sa -registry.datasource.blue.password=sa -registry.datasource.blue.jdbc.initial-size=20 -registry.datasource.blue.jdbc.min-size=20 -registry.datasource.blue.jdbc.max-size=100 +apicurio.datasource.blue.db-kind=h2 +apicurio.datasource.blue.jdbc.url=jdbc:h2:mem:registry_blue +apicurio.datasource.blue.username=sa +apicurio.datasource.blue.password=sa +apicurio.datasource.blue.jdbc.initial-size=20 +apicurio.datasource.blue.jdbc.min-size=20 +apicurio.datasource.blue.jdbc.max-size=100 # Green datasource -registry.datasource.green.db-kind=h2 -registry.datasource.green.jdbc.url=jdbc:h2:mem:registry_green -registry.datasource.green.username=sa -registry.datasource.green.password=sa -registry.datasource.green.jdbc.initial-size=20 -registry.datasource.green.jdbc.min-size=20 -registry.datasource.green.jdbc.max-size=100 +apicurio.datasource.green.db-kind=h2 +apicurio.datasource.green.jdbc.url=jdbc:h2:mem:registry_green +apicurio.datasource.green.username=sa +apicurio.datasource.green.password=sa +apicurio.datasource.green.jdbc.initial-size=20 +apicurio.datasource.green.jdbc.min-size=20 +apicurio.datasource.green.jdbc.max-size=100 # UI -registry.ui.auth.oidc.client-id=default_client -registry.ui.auth.oidc.redirect-uri=http://localhost:8080 +apicurio.ui.auth.oidc.client-id=default_client +apicurio.ui.auth.oidc.redirect-uri=http://localhost:8080 # Disable OpenAPI class scanning mp.openapi.scan.disable=true diff --git a/app/src/test/java/io/apicurio/registry/ccompat/rest/CanonicalModeProfile.java b/app/src/test/java/io/apicurio/registry/ccompat/rest/CanonicalModeProfile.java index ad39cad705..eb8bb29caf 100644 --- a/app/src/test/java/io/apicurio/registry/ccompat/rest/CanonicalModeProfile.java +++ b/app/src/test/java/io/apicurio/registry/ccompat/rest/CanonicalModeProfile.java @@ -8,6 +8,6 @@ public class CanonicalModeProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("registry.ccompat.use-canonical-hash", "true"); + return Map.of("apicurio.ccompat.use-canonical-hash", "true"); } } diff --git a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java index 3caf3c68a8..c42772833b 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java @@ -788,8 +788,8 @@ public void testRoleMappingPaging() throws Exception { @Test public void testConfigProperties() throws Exception { - String property1Name = "registry.ccompat.legacy-id-mode.enabled"; - String property2Name = "registry.rest.artifact.deletion.enabled"; + String property1Name = "apicurio.ccompat.legacy-id-mode.enabled"; + String property2Name = "apicurio.rest.artifact.deletion.enabled"; // Start with default mappings given() diff --git a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java index 41d0373c75..d484842672 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java @@ -1558,8 +1558,8 @@ public void testRoleMappings() throws Exception { @Test public void testConfigProperties() throws Exception { - String property1Name = "registry.ccompat.legacy-id-mode.enabled"; - String property2Name = "registry.rest.artifact.deletion.enabled"; + String property1Name = "apicurio.ccompat.legacy-id-mode.enabled"; + String property2Name = "apicurio.rest.artifact.deletion.enabled"; // Start with all default values List configProperties = clientV3.admin().config().properties().get(); diff --git a/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java b/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java index f77f798c66..5af17b6d93 100644 --- a/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java @@ -11,7 +11,7 @@ public class DisableApisTestProfile implements QuarkusTestProfile { public Map getConfigOverrides() { Map props = new HashMap<>(); props.put("registry.disable.apis","/apis/ccompat/v7/subjects/[^/]+/versions.*,/ui/.*"); - props.put("registry.rest.artifact.deletion.enabled", "false"); + props.put("apicurio.rest.artifact.deletion.enabled", "false"); return props; } diff --git a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java index 91a0fb65fb..d3f09e5437 100644 --- a/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java +++ b/app/src/test/java/io/apicurio/registry/storage/impl/gitops/GitTestRepositoryManager.java @@ -16,10 +16,10 @@ public Map start() { testRepository.initialize(); return Map.of( - "registry.gitops.id", "test", - "registry.gitops.repo.origin.uri", testRepository.getGitRepoUrl(), - "registry.gitops.repo.origin.branch", testRepository.getGitRepoBranch(), - "registry.gitops.refresh.every", "5s" + "apicurio.gitops.id", "test", + "apicurio.gitops.repo.origin.uri", testRepository.getGitRepoUrl(), + "apicurio.gitops.repo.origin.branch", testRepository.getGitRepoBranch(), + "apicurio.gitops.refresh.every", "5s" ); } diff --git a/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java index 9c328d49aa..2d422d090e 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java @@ -10,8 +10,8 @@ public class GitopsTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("registry.storage.db-kind", "h2", - "registry.storage.kind", "gitops"); + return Map.of("apicurio.storage.db-kind", "h2", + "apicurio.storage.kind", "gitops"); } @Override diff --git a/app/src/test/java/io/apicurio/registry/storage/util/KafkasqlTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/KafkasqlTestProfile.java index 90345304f3..8afa9ced35 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/KafkasqlTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/KafkasqlTestProfile.java @@ -11,7 +11,7 @@ public class KafkasqlTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("registry.storage.kind", "kafkasql"); + return Collections.singletonMap("apicurio.storage.kind", "kafkasql"); } @Override diff --git a/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java index 35c341fac1..7e4eff13e5 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java @@ -11,7 +11,7 @@ public class MssqlTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("registry.storage.db-kind", "mssql"); + return Collections.singletonMap("apicurio.storage.db-kind", "mssql"); } @Override diff --git a/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java index ecf22e5e88..4417186bd9 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java @@ -11,7 +11,7 @@ public class PostgresqlTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("registry.storage.db-kind", "postgresql"); + return Collections.singletonMap("apicurio.storage.db-kind", "postgresql"); } @Override diff --git a/common/src/main/java/io/apicurio/registry/rest/JacksonDateTimeCustomizer.java b/common/src/main/java/io/apicurio/registry/rest/JacksonDateTimeCustomizer.java index da6e4256a8..2c3a362ad4 100644 --- a/common/src/main/java/io/apicurio/registry/rest/JacksonDateTimeCustomizer.java +++ b/common/src/main/java/io/apicurio/registry/rest/JacksonDateTimeCustomizer.java @@ -24,10 +24,10 @@ public class JacksonDateTimeCustomizer implements ObjectMapperCustomizer { private static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'"; private static final String DEFAULT_DATE_TIME_FORMAT_TZ = "UTC"; - @ConfigProperty(name = "registry.apis.v2.date-format", defaultValue = DEFAULT_DATE_TIME_FORMAT) + @ConfigProperty(name = "apicurio.apis.v2.date-format", defaultValue = DEFAULT_DATE_TIME_FORMAT) @Info(category = "api", description = "API date format", availableSince = "2.4.3.Final") String dateFormat; - @ConfigProperty(name = "registry.apis.v2.date-format-timezone", defaultValue = DEFAULT_DATE_TIME_FORMAT_TZ) + @ConfigProperty(name = "apicurio.apis.v2.date-format-timezone", defaultValue = DEFAULT_DATE_TIME_FORMAT_TZ) @Info(category = "api", description = "API date format (TZ)", availableSince = "2.4.3.Final") String timezone; diff --git a/common/src/main/resources/META-INF/openapi-v2.json b/common/src/main/resources/META-INF/openapi-v2.json index 36bbcd8a4a..b4db450471 100644 --- a/common/src/main/resources/META-INF/openapi-v2.json +++ b/common/src/main/resources/META-INF/openapi-v2.json @@ -822,7 +822,7 @@ }, "operationId": "deleteArtifactVersion", "summary": "Delete artifact version", - "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" + "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" }, "parameters": [ { @@ -3997,7 +3997,7 @@ } }, "example": { - "name": "registry.auth.owner-only-authorization", + "name": "apicurio.auth.owner-only-authorization", "value": "true", "type": "boolean", "label": "Owner Only Authorization", diff --git a/common/src/main/resources/META-INF/openapi.json b/common/src/main/resources/META-INF/openapi.json index 83f1157858..f8948ad296 100644 --- a/common/src/main/resources/META-INF/openapi.json +++ b/common/src/main/resources/META-INF/openapi.json @@ -655,7 +655,7 @@ }, "operationId": "deleteArtifactVersion", "summary": "Delete artifact version", - "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" + "description": "Deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`\nare needed. If this is the only version of the artifact, this operation is the same as \ndeleting the entire artifact.\n\nThis feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:\n\n* No artifact with this `artifactId` exists (HTTP error `404`)\n* No version with this `version` exists (HTTP error `404`)\n * Feature is disabled (HTTP error `405`)\n * A server error occurred (HTTP error `500`)\n" }, "parameters": [ { @@ -3731,7 +3731,7 @@ } }, "example": { - "name": "registry.auth.owner-only-authorization", + "name": "apicurio.auth.owner-only-authorization", "value": "true", "type": "boolean", "label": "Owner Only Authorization", diff --git a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-events.adoc b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-events.adoc index 95882707d2..3eab7ef60b 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-events.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-events.adoc @@ -66,7 +66,7 @@ The example in this section shows a Kafka topic named `my-registry-events` runni ** `KAFKA_BOOTSTRAP_SERVERS=my-kafka-host:9092` + Alternatively, you can set the properties for the kafka producer by using the `registry.events.kafka.config` prefix, for example: -`registry.events.kafka.config.bootstrap.servers=my-kafka-host:9092` +`apicurio.events.kafka.config.bootstrap.servers=my-kafka-host:9092` . If required, you can also set the Kafka topic partition to use to produce events: ** `registry.events.kafka.topic-partition=1` diff --git a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc index 79f1ef7e6e..8d978c9716 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc @@ -103,7 +103,7 @@ TIP: For an example of setting environment variables on OpenShift, see xref:conf |Type |Default value |`ROLE_BASED_AUTHZ_ENABLED` -|`registry.auth.role-based-authorization` +|`apicurio.auth.role-based-authorization` |Boolean |`false` |=== @@ -145,7 +145,7 @@ TIP: For an example of setting environment variables on OpenShift, see xref:conf |Type |Default value |`REGISTRY_AUTH_OBAC_ENABLED` -|`registry.auth.owner-only-authorization` +|`apicurio.auth.owner-only-authorization` |Boolean |`false` |=== diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index d029d4d4e7..e2341fde08 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -12,7 +12,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.api.errors.include-stack-in-response` +|`apicurio.api.errors.include-stack-in-response` |`boolean` |`false` |`2.1.4.Final` @@ -88,87 +88,87 @@ The following {registry} configuration options are available for each component | |`2.1.0.Final` |Authentication server token endpoint. -|`registry.auth.admin-override.claim` +|`apicurio.auth.admin-override.claim` |`string` |`org-admin` |`2.1.0.Final` |Auth admin override claim -|`registry.auth.admin-override.claim-value` +|`apicurio.auth.admin-override.claim-value` |`string` |`true` |`2.1.0.Final` |Auth admin override claim value -|`registry.auth.admin-override.enabled` +|`apicurio.auth.admin-override.enabled` |`boolean` |`false` |`2.1.0.Final` |Auth admin override enabled -|`registry.auth.admin-override.from` +|`apicurio.auth.admin-override.from` |`string` |`token` |`2.1.0.Final` |Auth admin override from -|`registry.auth.admin-override.role` +|`apicurio.auth.admin-override.role` |`string` |`sr-admin` |`2.1.0.Final` |Auth admin override role -|`registry.auth.admin-override.type` +|`apicurio.auth.admin-override.type` |`string` |`role` |`2.1.0.Final` |Auth admin override type -|`registry.auth.admin-override.user` +|`apicurio.auth.admin-override.user` |`string` |`admin` |`3.0.0.Final` |Auth admin override user name -|`registry.auth.anonymous-read-access.enabled` +|`apicurio.auth.anonymous-read-access.enabled` |`boolean [dynamic]` |`false` |`2.1.0.Final` |Anonymous read access -|`registry.auth.authenticated-read-access.enabled` +|`apicurio.auth.authenticated-read-access.enabled` |`boolean [dynamic]` |`false` |`2.1.4.Final` |Authenticated read access -|`registry.auth.owner-only-authorization` +|`apicurio.auth.owner-only-authorization` |`boolean [dynamic]` |`false` |`2.0.0.Final` |Artifact owner-only authorization -|`registry.auth.owner-only-authorization.limit-group-access` +|`apicurio.auth.owner-only-authorization.limit-group-access` |`boolean [dynamic]` |`false` |`2.1.0.Final` |Artifact group owner-only authorization -|`registry.auth.role-based-authorization` +|`apicurio.auth.role-based-authorization` |`boolean` |`false` |`2.1.0.Final` |Enable role based authorization -|`registry.auth.role-source` +|`apicurio.auth.role-source` |`string` |`token` |`2.1.0.Final` |Auth roles source -|`registry.auth.role-source.header.name` +|`apicurio.auth.role-source.header.name` |`string` | |`2.4.3.Final` |Header authorization name -|`registry.auth.roles.admin` +|`apicurio.auth.roles.admin` |`string` |`sr-admin` |`2.0.0.Final` |Auth roles admin -|`registry.auth.roles.developer` +|`apicurio.auth.roles.developer` |`string` |`sr-developer` |`2.1.0.Final` |Auth roles developer -|`registry.auth.roles.readonly` +|`apicurio.auth.roles.readonly` |`string` |`sr-readonly` |`2.1.0.Final` @@ -184,7 +184,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.config.cache.enabled` +|`apicurio.config.cache.enabled` |`boolean` |`true` |`2.2.2.Final` @@ -200,17 +200,17 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.ccompat.legacy-id-mode.enabled` +|`apicurio.ccompat.legacy-id-mode.enabled` |`boolean [dynamic]` |`false` |`2.0.2.Final` |Legacy ID mode (compatibility API) -|`registry.ccompat.max-subjects` +|`apicurio.ccompat.max-subjects` |`integer [dynamic]` |`1000` |`2.4.2.Final` |Maximum number of Subjects returned (compatibility API) -|`registry.ccompat.use-canonical-hash` +|`apicurio.ccompat.use-canonical-hash` |`boolean [dynamic]` |`false` |`2.3.0.Final` @@ -242,7 +242,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.events.ksink` +|`apicurio.events.ksink` |`optional` | |`2.0.0.Final` @@ -258,17 +258,17 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.gitops.id` +|`apicurio.gitops.id` |`string` | |`3.0.0` |Identifier of this Registry instance. Only data that references this identifier will be loaded. -|`registry.gitops.repo.origin.branch` +|`apicurio.gitops.repo.origin.branch` |`string` |`main` |`3.0.0` |Name of the branch in the remote git repository containing data to be loaded. -|`registry.gitops.repo.origin.uri` +|`apicurio.gitops.repo.origin.uri` |`string` | |`3.0.0` @@ -289,92 +289,92 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.liveness.errors.ignored` +|`apicurio.liveness.errors.ignored` |`optional>` | |`1.2.3.Final` |Ignored liveness errors -|`registry.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec` +|`apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec` |`integer` |`60` |`1.0.2.Final` |Counter reset window duration of persistence liveness check -|`registry.metrics.PersistenceExceptionLivenessCheck.disableLogging` +|`apicurio.metrics.PersistenceExceptionLivenessCheck.disableLogging` |`boolean` |`false` |`2.0.0.Final` |Disable logging of persistence liveness check -|`registry.metrics.PersistenceExceptionLivenessCheck.errorThreshold` +|`apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold` |`integer` |`1` |`1.0.2.Final` |Error threshold of persistence liveness check -|`registry.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec` +|`apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec` |`integer` |`300` |`1.0.2.Final` |Status reset window duration of persistence liveness check -|`registry.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec` +|`apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec` |`integer` |`60` |`1.0.2.Final` |Counter reset window duration of persistence readiness check -|`registry.metrics.PersistenceTimeoutReadinessCheck.errorThreshold` +|`apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold` |`integer` |`5` |`1.0.2.Final` |Error threshold of persistence readiness check -|`registry.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec` +|`apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec` |`integer` |`300` |`1.0.2.Final` |Status reset window duration of persistence readiness check -|`registry.metrics.PersistenceTimeoutReadinessCheck.timeoutSec` +|`apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec` |`integer` |`15` |`1.0.2.Final` |Timeout of persistence readiness check -|`registry.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec` +|`apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec` |`integer` |`60` |`1.0.2.Final` |Counter reset window duration of response liveness check -|`registry.metrics.ResponseErrorLivenessCheck.disableLogging` +|`apicurio.metrics.ResponseErrorLivenessCheck.disableLogging` |`boolean` |`false` |`2.0.0.Final` |Disable logging of response liveness check -|`registry.metrics.ResponseErrorLivenessCheck.errorThreshold` +|`apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold` |`integer` |`1` |`1.0.2.Final` |Error threshold of response liveness check -|`registry.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec` +|`apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec` |`integer` |`300` |`1.0.2.Final` |Status reset window duration of response liveness check -|`registry.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec` +|`apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec` |`instance` |`60` |`1.0.2.Final` |Counter reset window duration of response readiness check -|`registry.metrics.ResponseTimeoutReadinessCheck.errorThreshold` +|`apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold` |`instance` |`1` |`1.0.2.Final` |Error threshold of response readiness check -|`registry.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec` +|`apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec` |`instance` |`300` |`1.0.2.Final` |Status reset window duration of response readiness check -|`registry.metrics.ResponseTimeoutReadinessCheck.timeoutSec` +|`apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec` |`instance` |`10` |`1.0.2.Final` |Timeout of response readiness check -|`registry.storage.metrics.cache.check-period` +|`apicurio.storage.metrics.cache.check-period` |`long` |`30000` |`2.1.0.Final` @@ -487,7 +487,7 @@ The following {registry} configuration options are available for each component |`-1` |`2.1.0.Final` |Max versions per artifacts -|`registry.storage.metrics.cache.max-size` +|`apicurio.storage.metrics.cache.max-size` |`long` |`1000` |`2.4.1.Final` @@ -503,12 +503,12 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.enable-redirects` +|`apicurio.enable-redirects` |`boolean` | |`2.1.2.Final` |Enable redirects -|`registry.redirects` +|`apicurio.redirects` |`map` | |`2.1.2.Final` @@ -534,17 +534,17 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.rest.artifact.deletion.enabled` +|`apicurio.rest.artifact.deletion.enabled` |`boolean [dynamic]` |`false` |`2.4.2-SNAPSHOT` |Enables artifact version deletion -|`registry.rest.artifact.download.maxSize` +|`apicurio.rest.artifact.download.maxSize` |`int` |`1000000` |`2.2.6-SNAPSHOT` |Max size of the artifact allowed to be downloaded from URL -|`registry.rest.artifact.download.skipSSLValidation` +|`apicurio.rest.artifact.download.skipSSLValidation` |`boolean` |`false` |`2.2.6-SNAPSHOT` @@ -565,112 +565,112 @@ The following {registry} configuration options are available for each component |`true` |`2.4.2-SNAPSHOT` |Skip artifact versions with DISABLED state when retrieving latest artifact version -|`registry.datasource.blue.db-kind` +|`apicurio.datasource.blue.db-kind` |`string` |`h2` |`3.0.0.Final` |Gitops blue datasource db kind -|`registry.datasource.blue.jdbc.initial-size` +|`apicurio.datasource.blue.jdbc.initial-size` |`string` |`20` |`3.0.0.Final` |Gitops blue datasource pool initial size -|`registry.datasource.blue.jdbc.max-size` +|`apicurio.datasource.blue.jdbc.max-size` |`string` |`100` |`3.0.0.Final` |Gitops blue datasource pool max size -|`registry.datasource.blue.jdbc.min-size` +|`apicurio.datasource.blue.jdbc.min-size` |`string` |`20` |`3.0.0.Final` |Gitops blue datasource pool minimum size -|`registry.datasource.blue.jdbc.url` +|`apicurio.datasource.blue.jdbc.url` |`string` |`jdbc:h2:mem:registry_db` |`3.0.0.Final` |Gitops blue datasource jdbc url -|`registry.datasource.blue.password` +|`apicurio.datasource.blue.password` |`string` |`sa` |`3.0.0.Final` |Gitops blue datasource password -|`registry.datasource.blue.username` +|`apicurio.datasource.blue.username` |`string` |`sa` |`3.0.0.Final` |Gitops blue datasource username -|`registry.datasource.green.db-kind` +|`apicurio.datasource.green.db-kind` |`string` |`h2` |`3.0.0.Final` |Gitops green datasource db kind -|`registry.datasource.green.jdbc.initial-size` +|`apicurio.datasource.green.jdbc.initial-size` |`string` |`20` |`3.0.0.Final` |Gitops green datasource pool initial size -|`registry.datasource.green.jdbc.max-size` +|`apicurio.datasource.green.jdbc.max-size` |`string` |`100` |`3.0.0.Final` |Gitops green datasource pool max size -|`registry.datasource.green.jdbc.min-size` +|`apicurio.datasource.green.jdbc.min-size` |`string` |`20` |`3.0.0.Final` |Gitops green datasource pool minimum size -|`registry.datasource.green.jdbc.url` +|`apicurio.datasource.green.jdbc.url` |`string` |`jdbc:h2:mem:registry_db` |`3.0.0.Final` |Gitops green datasource jdbc url -|`registry.datasource.green.password` +|`apicurio.datasource.green.password` |`string` |`sa` |`3.0.0.Final` |Gitops green datasource password -|`registry.datasource.green.username` +|`apicurio.datasource.green.username` |`string` |`sa` |`3.0.0.Final` |Gitops green datasource username -|`registry.datasource.jdbc.initial-size` +|`apicurio.datasource.jdbc.initial-size` |`string` |`20` |`3.0.0.Final` |Application datasource pool initial size -|`registry.datasource.jdbc.max-size` +|`apicurio.datasource.jdbc.max-size` |`string` |`100` |`3.0.0.Final` |Application datasource pool maximum size -|`registry.datasource.jdbc.min-size` +|`apicurio.datasource.jdbc.min-size` |`string` |`20` |`3.0.0.Final` |Application datasource pool minimum size -|`registry.datasource.password` +|`apicurio.datasource.password` |`string` |`sa` |`3.0.0.Final` |Application datasource password -|`registry.datasource.url` +|`apicurio.datasource.url` |`string` |`jdbc:h2:mem:registry_db` |`3.0.0.Final` |Application datasource jdbc url -|`registry.datasource.username` +|`apicurio.datasource.username` |`string` |`sa` |`3.0.0.Final` |Application datasource username -|`registry.kafkasql.bootstrap.servers` +|`apicurio.kafkasql.bootstrap.servers` |`string` | | |Kafka sql storage bootstrap servers -|`registry.kafkasql.consumer.poll.timeout` +|`apicurio.kafkasql.consumer.poll.timeout` |`integer` |`1000` | @@ -685,32 +685,32 @@ The following {registry} configuration options are available for each component | | |Kafka sql storage security protocol -|`registry.kafkasql.security.sasl.client-id` +|`apicurio.kafkasql.security.sasl.client-id` |`string` | | |Kafka sql storage sasl client identifier -|`registry.kafkasql.security.sasl.client-secret` +|`apicurio.kafkasql.security.sasl.client-secret` |`string` | | |Kafka sql storage sasl client secret -|`registry.kafkasql.security.sasl.enabled` +|`apicurio.kafkasql.security.sasl.enabled` |`boolean` |`false` | |Kafka sql storage sasl enabled -|`registry.kafkasql.security.sasl.login.callback.handler.class` +|`apicurio.kafkasql.security.sasl.login.callback.handler.class` |`string` | | |Kafka sql storage sasl login callback handler -|`registry.kafkasql.security.sasl.mechanism` +|`apicurio.kafkasql.security.sasl.mechanism` |`string` | | |Kafka sql storage sasl mechanism -|`registry.kafkasql.security.sasl.token.endpoint` +|`apicurio.kafkasql.security.sasl.token.endpoint` |`string` | | @@ -750,27 +750,27 @@ The following {registry} configuration options are available for each component | | |Kafka sql storage ssl truststore password -|`registry.kafkasql.topic` +|`apicurio.kafkasql.topic` |`string` |`kafkasql-journal` | |Kafka sql storage topic name -|`registry.kafkasql.topic.auto-create` +|`apicurio.kafkasql.topic.auto-create` |`boolean` |`true` | |Kafka sql storage topic auto create -|`registry.sql.init` +|`apicurio.sql.init` |`boolean` |`true` |`2.0.0.Final` |SQL init -|`registry.storage.db-kind` +|`apicurio.storage.db-kind` |`string` |`h2` |`3.0.0.Final` |Application datasource database type -|`registry.storage.kind` +|`apicurio.storage.kind` |`string` | |`3.0.0.Final` @@ -791,12 +791,12 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.ui.auth.oidc.client-id` +|`apicurio.ui.auth.oidc.client-id` |`string` |`apicurio-registry-ui` |`3.0.0` |The OIDC clientId -|`registry.ui.auth.oidc.redirect-uri` +|`apicurio.ui.auth.oidc.redirect-uri` |`string` |`/` |`3.0.0` diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc index f9a7d4010e..12833ed24b 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-kafka-topic-names.adoc @@ -14,9 +14,9 @@ The default Kafka topic name that {registry} uses to store data is `kafkasql-jou |Java system property |Default value | `REGISTRY_KAFKASQL_TOPIC` -| `registry.kafkasql.topic` +| `apicurio.kafkasql.topic` | `kafkasql-journal` | `REGISTRY_KAFKASQL_TOPIC_AUTO_CREATE` -| `registry.kafkasql.topic.auto-create` +| `apicurio.kafkasql.topic.auto-create` | `true` |=== diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc index 47ff68b90a..1a226a87ce 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc @@ -120,7 +120,7 @@ You can set the following options to `true` to enable role-based authorization i |Boolean |`false` |`ROLE_BASED_AUTHZ_ENABLED` -|`registry.auth.role-based-authorization` +|`apicurio.auth.role-based-authorization` |Boolean |`false` |=== @@ -273,12 +273,12 @@ You can set the following options to `true` to enable owner-only authorization f |`false` |`REGISTRY_AUTH_OBAC_ENABLED` -|`registry.auth.owner-only-authorization` +|`apicurio.auth.owner-only-authorization` |Boolean |`false` |`REGISTRY_AUTH_OBAC_LIMIT_GROUP_ACCESS` -|`registry.auth.owner-only-authorization.limit-group-access` +|`apicurio.auth.owner-only-authorization.limit-group-access` |Boolean |`false` |=== @@ -307,7 +307,7 @@ To enable authenticated read access, you must first enable role-based authorizat |Boolean |`false` |`REGISTRY_AUTH_AUTHENTICATED_READS_ENABLED` -|`registry.auth.authenticated-read-access.enabled` +|`apicurio.auth.authenticated-read-access.enabled` |Boolean |`false` |=== @@ -336,7 +336,7 @@ calls to the REST API, set the following options to `true`: |Boolean |`false` |`REGISTRY_AUTH_ANONYMOUS_READ_ACCESS_ENABLED` -|`registry.auth.anonymous-read-access.enabled` +|`apicurio.auth.anonymous-read-access.enabled` |Boolean |`false` |=== diff --git a/go-sdk/pkg/registryclient-v2/groups/item_artifacts_item_versions_with_version_item_request_builder.go b/go-sdk/pkg/registryclient-v2/groups/item_artifacts_item_versions_with_version_item_request_builder.go index 4b3b0c1e8d..ae801fa7d5 100644 --- a/go-sdk/pkg/registryclient-v2/groups/item_artifacts_item_versions_with_version_item_request_builder.go +++ b/go-sdk/pkg/registryclient-v2/groups/item_artifacts_item_versions_with_version_item_request_builder.go @@ -58,7 +58,7 @@ func NewItemArtifactsItemVersionsWithVersionItemRequestBuilder(rawUrl string, re return NewItemArtifactsItemVersionsWithVersionItemRequestBuilderInternal(urlParams, requestAdapter) } -// Delete deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) +// Delete deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) func (m *ItemArtifactsItemVersionsWithVersionItemRequestBuilder) Delete(ctx context.Context, requestConfiguration *ItemArtifactsItemVersionsWithVersionItemRequestBuilderDeleteRequestConfiguration) error { requestInfo, err := m.ToDeleteRequestInformation(ctx, requestConfiguration) if err != nil { @@ -111,7 +111,7 @@ func (m *ItemArtifactsItemVersionsWithVersionItemRequestBuilder) State() *ItemAr return NewItemArtifactsItemVersionsItemStateRequestBuilderInternal(m.BaseRequestBuilder.PathParameters, m.BaseRequestBuilder.RequestAdapter) } -// ToDeleteRequestInformation deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) +// ToDeleteRequestInformation deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) func (m *ItemArtifactsItemVersionsWithVersionItemRequestBuilder) ToDeleteRequestInformation(ctx context.Context, requestConfiguration *ItemArtifactsItemVersionsWithVersionItemRequestBuilderDeleteRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error) { requestInfo := i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.NewRequestInformationWithMethodAndUrlTemplateAndPathParameters(i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DELETE, m.BaseRequestBuilder.UrlTemplate, m.BaseRequestBuilder.PathParameters) if requestConfiguration != nil { diff --git a/go-sdk/pkg/registryclient-v2/kiota-lock.json b/go-sdk/pkg/registryclient-v2/kiota-lock.json index e3a90c0bbb..3cbcb96c89 100644 --- a/go-sdk/pkg/registryclient-v2/kiota-lock.json +++ b/go-sdk/pkg/registryclient-v2/kiota-lock.json @@ -1,5 +1,5 @@ { - "descriptionHash": "4BF9FACAE444F75DCBC45110401ACD7D833D52A475C53556F689C1EC836C2D1A058764A4ED8EA1A292B0CDC0B142BD5E406F136F2753F7B639B107AE6A7FA759", + "descriptionHash": "5D4A96E378FDD9902A0416A7CC1FB1122A442B6686FD56C10AA30FF6EAE28EE88BC45F3F2A0BD3A6D8BEC2A16039FF0114F54A86017763CC2BCA2E2AD3A1F48F", "descriptionLocation": "../../v2.json", "lockFileVersion": "1.0.0", "kiotaVersion": "1.10.1", diff --git a/go-sdk/pkg/registryclient-v3/groups/item_artifacts_item_versions_with_version_expression_item_request_builder.go b/go-sdk/pkg/registryclient-v3/groups/item_artifacts_item_versions_with_version_expression_item_request_builder.go index 633dc6d53b..411c543060 100644 --- a/go-sdk/pkg/registryclient-v3/groups/item_artifacts_item_versions_with_version_expression_item_request_builder.go +++ b/go-sdk/pkg/registryclient-v3/groups/item_artifacts_item_versions_with_version_expression_item_request_builder.go @@ -123,7 +123,7 @@ func (m *ItemArtifactsItemVersionsWithVersionExpressionItemRequestBuilder) Refer return NewItemArtifactsItemVersionsItemReferencesRequestBuilderInternal(m.BaseRequestBuilder.PathParameters, m.BaseRequestBuilder.RequestAdapter) } -// ToDeleteRequestInformation deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `registry.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) +// ToDeleteRequestInformation deletes a single version of the artifact. Parameters `groupId`, `artifactId` and the unique `version`are needed. If this is the only version of the artifact, this operation is the same as deleting the entire artifact.This feature is disabled by default and it's discouraged for normal usage. To enable it, set the `apicurio.rest.artifact.deletion.enabled` property to true. This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`) * Feature is disabled (HTTP error `405`) * A server error occurred (HTTP error `500`) func (m *ItemArtifactsItemVersionsWithVersionExpressionItemRequestBuilder) ToDeleteRequestInformation(ctx context.Context, requestConfiguration *ItemArtifactsItemVersionsWithVersionExpressionItemRequestBuilderDeleteRequestConfiguration) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error) { requestInfo := i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.NewRequestInformationWithMethodAndUrlTemplateAndPathParameters(i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DELETE, m.BaseRequestBuilder.UrlTemplate, m.BaseRequestBuilder.PathParameters) if requestConfiguration != nil { diff --git a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml index 41eed0a2d2..91a819441e 100644 --- a/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml +++ b/integration-tests/src/test/resources/infra/in-memory/registry-in-memory-secured.yml @@ -25,7 +25,7 @@ spec: value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID + - name: APICURIO_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" @@ -35,9 +35,9 @@ spec: value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION + - name: APICURIO_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - - name: REGISTRY_AUTH_ROLE_SOURCE + - name: APICURIO_AUTH_ROLE_SOURCE value: "token" image: registry-image imagePullPolicy: Always diff --git a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml index adc7e91849..623ecb8c2d 100644 --- a/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml +++ b/integration-tests/src/test/resources/infra/kafka/registry-kafka-secured.yml @@ -21,15 +21,15 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: REGISTRY_KAFKASQL_BOOTSTRAP_SERVERS + - name: APICURIO_KAFKASQL_BOOTSTRAP_SERVERS value: kafka-service:9092 - - name: REGISTRY_STORAGE_KIND + - name: APICURIO_STORAGE_KIND value: "kafkasql" - name: QUARKUS_OIDC_TENANT_ENABLED value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID + - name: APICURIO_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" @@ -39,9 +39,9 @@ spec: value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION + - name: APICURIO_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - - name: REGISTRY_AUTH_ROLE_SOURCE + - name: APICURIO_AUTH_ROLE_SOURCE value: "token" image: registry-image imagePullPolicy: Always diff --git a/integration-tests/src/test/resources/infra/kafka/registry-kafka.yml b/integration-tests/src/test/resources/infra/kafka/registry-kafka.yml index f23f3d0fe9..807891ab17 100644 --- a/integration-tests/src/test/resources/infra/kafka/registry-kafka.yml +++ b/integration-tests/src/test/resources/infra/kafka/registry-kafka.yml @@ -21,11 +21,11 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: REGISTRY_KAFKASQL_BOOTSTRAP_SERVERS + - name: APICURIO_KAFKASQL_BOOTSTRAP_SERVERS value: kafka-service:9092 - - name: REGISTRY_STORAGE_KIND + - name: APICURIO_STORAGE_KIND value: "kafkasql" - - name: REGISTRY_LOG_LEVEL + - name: APICURIO_LOG_LEVEL value: "DEBUG" image: registry-image imagePullPolicy: Always diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml index 63cc4ed83b..de93e131ef 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml @@ -21,19 +21,19 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: REGISTRY_STORAGE_DB_KIND + - name: APICURIO_STORAGE_DB_KIND value: "postgresql" - - name: REGISTRY_DATASOURCE_URL + - name: APICURIO_DATASOURCE_URL value: jdbc:postgresql://postgresql-service:5432/registry - - name: REGISTRY_DATASOURCE_USERNAME + - name: APICURIO_DATASOURCE_USERNAME value: "apicurio" - - name: REGISTRY_DATASOURCE_PASSWORD + - name: APICURIO_DATASOURCE_PASSWORD value: "registry" - name: QUARKUS_OIDC_TENANT_ENABLED value: "true" - name: QUARKUS_OIDC_CLIENT_ID value: "registry-api" - - name: REGISTRY_UI_AUTH_OIDC_CLIENT_ID + - name: APICURIO_UI_AUTH_OIDC_CLIENT_ID value: apicurio-registry - name: QUARKUS_OIDC_AUTH_SERVER_URL value: "http://keycloak-service:8090/realms/registry" @@ -43,9 +43,9 @@ spec: value: "http://keycloak-service:8090/realms/registry/protocol/openid-connect/token" - name: APICURIO_AUTHN_BASIC_CLIENT_CREDENTIALS_ENABLED value: "true" - - name: REGISTRY_AUTH_ROLE_BASED_AUTHORIZATION + - name: APICURIO_AUTH_ROLE_BASED_AUTHORIZATION value: "true" - - name: REGISTRY_AUTH_ROLE_SOURCE + - name: APICURIO_AUTH_ROLE_SOURCE value: "token" image: registry-image imagePullPolicy: Always diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql.yml b/integration-tests/src/test/resources/infra/sql/registry-sql.yml index 3ae316003e..3fa9ba651f 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql.yml @@ -21,13 +21,13 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: REGISTRY_STORAGE_DB_KIND + - name: APICURIO_STORAGE_DB_KIND value: "postgresql" - - name: REGISTRY_DATASOURCE_URL + - name: APICURIO_DATASOURCE_URL value: jdbc:postgresql://postgresql-service:5432/registry - - name: REGISTRY_DATASOURCE_USERNAME + - name: APICURIO_DATASOURCE_USERNAME value: "apicurio" - - name: REGISTRY_DATASOURCE_PASSWORD + - name: APICURIO_DATASOURCE_PASSWORD value: "registry" image: registry-image imagePullPolicy: Always diff --git a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx index e8d7c35c35..ee89bbc8c0 100644 --- a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx +++ b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx @@ -36,19 +36,19 @@ const PROPERTY_GROUPS: PropertyGroup[] = [ id: "authz", label: "Authorization settings", propertyNames: [ - "registry.auth.owner-only-authorization", - "registry.auth.owner-only-authorization.limit-group-access", - "registry.auth.anonymous-read-access.enabled", - "registry.auth.authenticated-read-access.enabled", + "apicurio.auth.owner-only-authorization", + "apicurio.auth.owner-only-authorization.limit-group-access", + "apicurio.auth.anonymous-read-access.enabled", + "apicurio.auth.authenticated-read-access.enabled", ] }, { id: "compatibility", label: "Compatibility settings", propertyNames: [ - "registry.ccompat.legacy-id-mode.enabled", - "registry.ccompat.use-canonical-hash", - "registry.ccompat.max-subjects", + "apicurio.ccompat.legacy-id-mode.enabled", + "apicurio.ccompat.use-canonical-hash", + "apicurio.ccompat.max-subjects", ] }, { diff --git a/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java b/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java index 84dee4314c..d8872047f8 100644 --- a/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java +++ b/utils/kafka/src/test/java/io/apicurio/registry/test/utils/KafkaTestContainerManager.java @@ -37,8 +37,8 @@ public Map start() { return Map.of( "bootstrap.servers", externalBootstrapServers, - "registry.events.kafka.config.bootstrap.servers", externalBootstrapServers, - "registry.kafkasql.bootstrap.servers", externalBootstrapServers); + "apicurio.events.kafka.config.bootstrap.servers", externalBootstrapServers, + "apicurio.kafkasql.bootstrap.servers", externalBootstrapServers); } else { return Collections.emptyMap(); } diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/ApplicationRbacEnabledProfile.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/ApplicationRbacEnabledProfile.java index 042beb1d81..4b82b0e204 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/ApplicationRbacEnabledProfile.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/ApplicationRbacEnabledProfile.java @@ -12,8 +12,8 @@ public Map getConfigOverrides() { Map props = new HashMap<>(); // Note: we need to enable these properties so that we can access the role mapping REST API // If these are not set, then the role mapping REST API will fail with a 403 - props.put("registry.auth.role-based-authorization", "true"); - props.put("registry.auth.role-source", "application"); + props.put("apicurio.auth.role-based-authorization", "true"); + props.put("apicurio.auth.role-source", "application"); return props; } } diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAnonymousCredentials.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAnonymousCredentials.java index 95cd7b57da..45136651a7 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAnonymousCredentials.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAnonymousCredentials.java @@ -10,7 +10,7 @@ public class AuthTestProfileAnonymousCredentials implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("registry.auth.anonymous-read-access.enabled", "true", "smallrye.jwt.sign.key.location", "privateKey.jwk"); + return Map.of("apicurio.auth.anonymous-read-access.enabled", "true", "smallrye.jwt.sign.key.location", "privateKey.jwk"); } @Override diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAuthenticatedReadAccess.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAuthenticatedReadAccess.java index 2da581db10..2e89a6ef60 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAuthenticatedReadAccess.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileAuthenticatedReadAccess.java @@ -10,7 +10,7 @@ public class AuthTestProfileAuthenticatedReadAccess implements QuarkusTestProfil @Override public Map getConfigOverrides() { - return Map.of("registry.auth.authenticated-read-access.enabled", "true", "smallrye.jwt.sign.key.location", "privateKey.jwk"); + return Map.of("apicurio.auth.authenticated-read-access.enabled", "true", "smallrye.jwt.sign.key.location", "privateKey.jwk"); } @Override diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithHeaderRoles.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithHeaderRoles.java index 7903d9d3b9..b1a0829e66 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithHeaderRoles.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithHeaderRoles.java @@ -10,7 +10,7 @@ public class AuthTestProfileWithHeaderRoles implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("smallrye.jwt.sign.key.location", "privateKey.jwk", "registry.auth.role-source", "header"); + return Map.of("smallrye.jwt.sign.key.location", "privateKey.jwk", "apicurio.auth.role-source", "header"); } @Override diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithLocalRoles.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithLocalRoles.java index 682a636760..6a8e8f13b7 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithLocalRoles.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/AuthTestProfileWithLocalRoles.java @@ -10,7 +10,7 @@ public class AuthTestProfileWithLocalRoles implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("smallrye.jwt.sign.key.location", "privateKey.jwk", "registry.auth.role-source", "application"); + return Map.of("smallrye.jwt.sign.key.location", "privateKey.jwk", "apicurio.auth.role-source", "application"); } @Override diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java index 80b6c6625d..fca4bcde75 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/JWKSMockServer.java @@ -109,9 +109,9 @@ public Map start() { props.put("quarkus.oidc.auth-server-url", authServerUrl); props.put("quarkus.oidc.token-path", tokenEndpoint); props.put("quarkus.oidc.tenant-enabled", "true"); - props.put("registry.auth.role-based-authorization", "true"); - props.put("registry.auth.owner-only-authorization", "true"); - props.put("registry.auth.admin-override.enabled", "true"); + props.put("apicurio.auth.role-based-authorization", "true"); + props.put("apicurio.auth.owner-only-authorization", "true"); + props.put("apicurio.auth.admin-override.enabled", "true"); props.put("apicurio.authn.basic-client-credentials.enabled", "true"); return props; diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java index f4c048a47f..f525b20eca 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java @@ -38,10 +38,10 @@ public Map start() { if ("mas".equals(currentEnv)) { Map props = new HashMap<>(); - props.put("registry.storage.db-kind", "mssql"); - props.put("registry.datasource.url", "jdbc:sqlserver://mssql;"); - props.put("registry.datasource.username", "test"); - props.put("registry.datasource.password", "test"); + props.put("apicurio.storage.db-kind", "mssql"); + props.put("apicurio.datasource.url", "jdbc:sqlserver://mssql;"); + props.put("apicurio.datasource.username", "test"); + props.put("apicurio.datasource.password", "test"); return props; } else { return startMsSql(); @@ -51,7 +51,7 @@ public Map start() { } private static boolean isMssqlStorage() { - return ConfigProvider.getConfig().getValue("registry.storage.db-kind", String.class).equals("mssql"); + return ConfigProvider.getConfig().getValue("apicurio.storage.db-kind", String.class).equals("mssql"); } private Map startMsSql() { @@ -60,10 +60,10 @@ private Map startMsSql() { String datasourceUrl = database.getJdbcUrl(); Map props = new HashMap<>(); - props.put("registry.storage.db-kind", "mssql"); - props.put("registry.datasource.url", datasourceUrl); - props.put("registry.datasource.username", "SA"); - props.put("registry.datasource.password", DB_PASSWORD); + props.put("apicurio.storage.db-kind", "mssql"); + props.put("apicurio.datasource.url", datasourceUrl); + props.put("apicurio.datasource.username", "SA"); + props.put("apicurio.datasource.password", DB_PASSWORD); return props; } diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java index cef444c3c5..72c6d520cf 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java @@ -25,10 +25,10 @@ public Map start() { if (currentEnv != null && "mas".equals(currentEnv)) { Map props = new HashMap<>(); - props.put("registry.storage.db-kind", "postgresql"); - props.put("registry.datasource.url", "jdbc:postgresql://localhost:5432/test"); - props.put("registry.datasource.username", "test"); - props.put("registry.datasource.password", "test"); + props.put("apicurio.storage.db-kind", "postgresql"); + props.put("apicurio.datasource.url", "jdbc:postgresql://localhost:5432/test"); + props.put("apicurio.datasource.username", "test"); + props.put("apicurio.datasource.password", "test"); return props; } else { return startPostgresql(); @@ -38,7 +38,7 @@ public Map start() { } private static boolean isPostgresqlStorage() { - return ConfigProvider.getConfig().getValue("registry.storage.db-kind", String.class).equals("postgresql"); + return ConfigProvider.getConfig().getValue("apicurio.storage.db-kind", String.class).equals("postgresql"); } private Map startPostgresql() { @@ -51,10 +51,10 @@ private Map startPostgresql() { String datasourceUrl = database.getJdbcUrl("postgres", "postgres"); Map props = new HashMap<>(); - props.put("registry.storage.db-kind", "postgresql"); - props.put("registry.datasource.url", datasourceUrl); - props.put("registry.datasource.username", "postgres"); - props.put("registry.datasource.password", "postgres"); + props.put("apicurio.storage.db-kind", "postgresql"); + props.put("apicurio.datasource.url", datasourceUrl); + props.put("apicurio.datasource.username", "postgres"); + props.put("apicurio.datasource.password", "postgres"); return props; } From 73146e09a6fc1ed130ffc63becc21bd049211d43 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Fri, 12 Apr 2024 09:57:14 +0200 Subject: [PATCH 08/13] Fix ui configuration page --- ui/ui-app/src/app/pages/settings/SettingsPage.tsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx index ee89bbc8c0..e94622cfc2 100644 --- a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx +++ b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx @@ -29,7 +29,7 @@ const PROPERTY_GROUPS: PropertyGroup[] = [ id: "authn", label: "Authentication settings", propertyNames: [ - "registry.auth.basic-auth-client-credentials.enabled", + "apicurio.authn.basic-client-credentials.enabled", ] }, { @@ -55,8 +55,8 @@ const PROPERTY_GROUPS: PropertyGroup[] = [ id: "console", label: "Web console settings", propertyNames: [ - "registry.download.href.ttl", - "registry.ui.features.readOnly" + "apicurio.download.href.ttl", + "apicurio.ui.features.readOnly" ] }, ]; From 26f4316deb0222220a64d65eaddbd20f56517f90 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Fri, 12 Apr 2024 10:16:41 +0200 Subject: [PATCH 09/13] Rename missing properties --- .../registry/ImportLifecycleBean.java | 2 +- .../io/apicurio/registry/auth/AuthConfig.java | 8 +++---- .../http/HttpEventSinkConfiguration.java | 2 +- .../registry/events/kafka/KafkaEventSink.java | 6 ++--- .../RegistryLimitsConfigurationProducer.java | 24 +++++++++---------- .../rest/v2/AbstractResourceImpl.java | 2 +- .../rest/v3/AbstractResourceImpl.java | 2 +- .../registry/rules/RulesConfiguration.java | 2 +- .../services/DisabledApisMatcherService.java | 2 +- .../ReadOnlyRegistryStorageDecorator.java | 2 +- .../impl/gitops/GitOpsConfigProperties.java | 2 +- .../impl/kafkasql/KafkaSqlFactory.java | 24 +++++++++---------- .../java/io/apicurio/registry/ui/URLUtil.java | 4 ++-- .../ui/UserInterfaceConfigProperties.java | 12 +++++----- .../io/apicurio/registry/util/DtoUtil.java | 4 ++-- .../ImportLifecycleBeanTestProfile.java | 2 +- .../registry/events/HttpEventsProfile.java | 2 +- .../events/KafkaEventsTestResource.java | 2 +- .../registry/limits/LimitsTestProfile.java | 18 +++++++------- .../storage/AbstractRegistryStorageTest.java | 12 +++++----- .../registry/rest/DisableApisTestProfile.java | 2 +- .../MultipleRequestFiltersTestProfile.java | 2 +- .../readonly/ReadOnlyRegistryStorageTest.java | 2 +- .../registry/utils/PropertiesUtil.java | 2 +- docs/generateAllConfigPartial.java | 4 ++-- ...-managing-artifacts-using-client-code.adoc | 2 +- .../proc-registry-serdes-register.adoc | 2 +- .../example/debezium/kafka/KafkaFactory.java | 2 +- scripts/validate-files.sh | 2 +- .../registry/maven/AbstractRegistryMojo.java | 2 +- 30 files changed, 78 insertions(+), 78 deletions(-) diff --git a/app/src/main/java/io/apicurio/registry/ImportLifecycleBean.java b/app/src/main/java/io/apicurio/registry/ImportLifecycleBean.java index 5509a1786d..09e0d09418 100644 --- a/app/src/main/java/io/apicurio/registry/ImportLifecycleBean.java +++ b/app/src/main/java/io/apicurio/registry/ImportLifecycleBean.java @@ -33,7 +33,7 @@ public class ImportLifecycleBean { @Current RegistryStorage storage; - @ConfigProperty(name = "registry.import.url") + @ConfigProperty(name = "apicurio.import.url") @Info(category = "import", description = "The import URL", availableSince = "2.1.0.Final") Optional registryImportUrlProp; diff --git a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java index 92e4b82522..9ac6393849 100644 --- a/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java +++ b/app/src/main/java/io/apicurio/registry/auth/AuthConfig.java @@ -24,26 +24,26 @@ public class AuthConfig { @Info(category = "auth", description = "Enable role based authorization", availableSince = "2.1.0.Final") boolean roleBasedAuthorizationEnabled; - @Dynamic(label = "Artifact owner-only authorization", description = "When selected, Service Registry allows only the artifact owner (creator) to modify an artifact.", requires = "registry.auth.enabled=true") + @Dynamic(label = "Artifact owner-only authorization", description = "When selected, Service Registry allows only the artifact owner (creator) to modify an artifact.", requires = "apicurio.auth.enabled=true") @ConfigProperty(name = "apicurio.auth.owner-only-authorization", defaultValue = "false") @Info(category = "auth", description = "Artifact owner-only authorization", availableSince = "2.0.0.Final") Supplier ownerOnlyAuthorizationEnabled; @Dynamic(label = "Artifact group owner-only authorization", description = "When selected, Service Registry allows only the artifact group owner (creator) to modify an artifact group.", requires = { - "registry.auth.enabled=true", + "apicurio.auth.enabled=true", "apicurio.auth.owner-only-authorization=true" }) @ConfigProperty(name = "apicurio.auth.owner-only-authorization.limit-group-access", defaultValue = "false") @Info(category = "auth", description = "Artifact group owner-only authorization", availableSince = "2.1.0.Final") Supplier ownerOnlyAuthorizationLimitGroupAccess; - @Dynamic(label = "Anonymous read access", description = "When selected, requests from anonymous users (requests without any credentials) are granted read-only access.", requires = "registry.auth.enabled=true") + @Dynamic(label = "Anonymous read access", description = "When selected, requests from anonymous users (requests without any credentials) are granted read-only access.", requires = "apicurio.auth.enabled=true") @ConfigProperty(name = "apicurio.auth.anonymous-read-access.enabled", defaultValue = "false") @Info(category = "auth", description = "Anonymous read access", availableSince = "2.1.0.Final") Supplier anonymousReadAccessEnabled; @Dynamic(label = "Authenticated read access", description = "When selected, requests from any authenticated user are granted at least read-only access.", requires = { - "registry.auth.enabled=true", + "apicurio.auth.enabled=true", "apicurio.auth.role-based-authorization=true" }) @ConfigProperty(name = "apicurio.auth.authenticated-read-access.enabled", defaultValue = "false") diff --git a/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java b/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java index 3f4cb0ab10..2350a43a47 100644 --- a/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java +++ b/app/src/main/java/io/apicurio/registry/events/http/HttpEventSinkConfiguration.java @@ -21,7 +21,7 @@ public class HttpEventSinkConfiguration { Optional ksink; @Produces - public HttpSinksConfiguration sinkConfig(@RegistryProperties(value = {"registry.events.sink"}) Properties properties) { + public HttpSinksConfiguration sinkConfig(@RegistryProperties(value = {"apicurio.events.sink"}) Properties properties) { List httpSinks = properties.stringPropertyNames().stream() .map(key -> new HttpSinkConfiguration(key, properties.getProperty(key))) .collect(Collectors.toList()); diff --git a/app/src/main/java/io/apicurio/registry/events/kafka/KafkaEventSink.java b/app/src/main/java/io/apicurio/registry/events/kafka/KafkaEventSink.java index 7e51752947..5b6af694a0 100644 --- a/app/src/main/java/io/apicurio/registry/events/kafka/KafkaEventSink.java +++ b/app/src/main/java/io/apicurio/registry/events/kafka/KafkaEventSink.java @@ -30,7 +30,7 @@ public class KafkaEventSink implements EventSink { @Inject @RegistryProperties( - value = {"registry.events.kafka.config"}, + value = {"apicurio.events.kafka.config"}, empties = {"ssl.endpoint.identification.algorithm="} ) Properties producerProperties; @@ -38,11 +38,11 @@ public class KafkaEventSink implements EventSink { private ProducerActions producer; private Integer partition; - @ConfigProperty(name = "registry.events.kafka.topic") + @ConfigProperty(name = "apicurio.events.kafka.topic") @Info(category = "kafka", description = "Events Kafka topic", availableSince = "2.0.0.Final") Optional eventsTopic; - @ConfigProperty(name = "registry.events.kafka.topic-partition") + @ConfigProperty(name = "apicurio.events.kafka.topic-partition") @Info(category = "kafka", description = "Events Kafka topic partition", availableSince = "2.0.0.Final") Optional eventsTopicPartition; diff --git a/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java b/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java index b46a19b444..6876d9822f 100644 --- a/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java +++ b/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java @@ -15,58 +15,58 @@ public class RegistryLimitsConfigurationProducer { //All limits to -1 , which means by default all limits are disabled @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-total-schemas") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-total-schemas") @Info(category = "limits", description = "Max total schemas", availableSince = "2.1.0.Final") Long defaultMaxTotalSchemas; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-schema-size-bytes") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-schema-size-bytes") @Info(category = "limits", description = "Max schema size (bytes)", availableSince = "2.2.3.Final") Long defaultMaxSchemaSizeBytes; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-artifacts") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-artifacts") @Info(category = "limits", description = "Max artifacts", availableSince = "2.1.0.Final") Long defaultMaxArtifacts; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-versions-per-artifact") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-versions-per-artifact") @Info(category = "limits", description = "Max versions per artifacts", availableSince = "2.1.0.Final") Long defaultMaxVersionsPerArtifact; //TODO content size @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-artifact-properties") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-artifact-properties") @Info(category = "limits", description = "Max artifact properties", availableSince = "2.1.0.Final") Long defaultMaxArtifactProperties; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-property-key-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-key-size") @Info(category = "limits", description = "Max artifact property key size", availableSince = "2.1.0.Final") Long defaultMaxPropertyKeyBytesSize; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-property-value-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-value-size") @Info(category = "limits", description = "Max artifact property value size", availableSince = "2.1.0.Final") Long defaultMaxPropertyValueBytesSize; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-artifact-labels") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-artifact-labels") @Info(category = "limits", description = "Max artifact labels", availableSince = "2.2.3.Final") Long defaultMaxArtifactLabels; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-label-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-label-size") @Info(category = "limits", description = "Max artifact label size", availableSince = "2.1.0.Final") Long defaultMaxLabelBytesSize; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-name-length") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-name-length") @Info(category = "limits", description = "Max artifact name length", availableSince = "2.1.0.Final") Long defaultMaxNameLength; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-description-length") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-description-length") @Info(category = "limits", description = "Max artifact description length", availableSince = "2.1.0.Final") Long defaultMaxDescriptionLength; @Inject - @ConfigProperty(defaultValue = "-1", name = "registry.limits.config.max-requests-per-second") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-requests-per-second") @Info(category = "limits", description = "Max artifact requests per second", availableSince = "2.2.3.Final") Long defaultMaxRequestsPerSecond; diff --git a/app/src/main/java/io/apicurio/registry/rest/v2/AbstractResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v2/AbstractResourceImpl.java index 2df8703960..1c1705b031 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v2/AbstractResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v2/AbstractResourceImpl.java @@ -42,7 +42,7 @@ public abstract class AbstractResourceImpl { @Context HttpServletRequest request; - @ConfigProperty(name = "registry.apis.v2.base-href", defaultValue = "_") + @ConfigProperty(name = "apicurio.apis.v2.base-href", defaultValue = "_") @Info(category = "api", description = "API base href (URI)", availableSince = "2.5.0.Final") String apiBaseHref; diff --git a/app/src/main/java/io/apicurio/registry/rest/v3/AbstractResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v3/AbstractResourceImpl.java index ac241c87a4..e73ab8793b 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v3/AbstractResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v3/AbstractResourceImpl.java @@ -42,7 +42,7 @@ public abstract class AbstractResourceImpl { @Context HttpServletRequest request; - @ConfigProperty(name = "registry.apis.v3.base-href", defaultValue = "_") + @ConfigProperty(name = "apicurio.apis.v3.base-href", defaultValue = "_") @Info(category = "api", description = "API base href (URI)", availableSince = "2.5.0.Final") String apiBaseHref; diff --git a/app/src/main/java/io/apicurio/registry/rules/RulesConfiguration.java b/app/src/main/java/io/apicurio/registry/rules/RulesConfiguration.java index 3143ad07e0..b5c952047c 100644 --- a/app/src/main/java/io/apicurio/registry/rules/RulesConfiguration.java +++ b/app/src/main/java/io/apicurio/registry/rules/RulesConfiguration.java @@ -11,7 +11,7 @@ public class RulesConfiguration { @Produces @ApplicationScoped - public RulesProperties rulesProperties(@RegistryProperties(value = {"registry.rules.global"}) Properties properties) { + public RulesProperties rulesProperties(@RegistryProperties(value = {"apicurio.rules.global"}) Properties properties) { return new RulesPropertiesImpl(properties); } diff --git a/app/src/main/java/io/apicurio/registry/services/DisabledApisMatcherService.java b/app/src/main/java/io/apicurio/registry/services/DisabledApisMatcherService.java index efe9a43053..6d91342cfd 100644 --- a/app/src/main/java/io/apicurio/registry/services/DisabledApisMatcherService.java +++ b/app/src/main/java/io/apicurio/registry/services/DisabledApisMatcherService.java @@ -25,7 +25,7 @@ public class DisabledApisMatcherService { private final List disabledPatternsList = new ArrayList<>(); @Inject - @ConfigProperty(name = "registry.disable.apis") + @ConfigProperty(name = "apicurio.disable.apis") @Info(category = "api", description = "Disable APIs", availableSince = "2.0.0.Final") Optional> disableRegexps; diff --git a/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java b/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java index 8ed206e0f7..ffba257038 100644 --- a/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java +++ b/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java @@ -47,7 +47,7 @@ @ApplicationScoped public class ReadOnlyRegistryStorageDecorator extends RegistryStorageDecoratorReadOnlyBase implements RegistryStorageDecorator { - public static final String READ_ONLY_MODE_ENABLED_PROPERTY_NAME = "registry.storage.read-only"; + public static final String READ_ONLY_MODE_ENABLED_PROPERTY_NAME = "apicurio.storage.read-only"; @Dynamic(label = "Storage read-only mode", description = "When selected, " + diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java index 674018d81c..b902ad56e6 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/gitops/GitOpsConfigProperties.java @@ -14,7 +14,7 @@ public class GitOpsConfigProperties { @Getter String registryId; - @ConfigProperty(name = "registry.gitops.workdir", defaultValue = "/tmp/apicurio-registry-gitops") + @ConfigProperty(name = "apicurio.gitops.workdir", defaultValue = "/tmp/apicurio-registry-gitops") @Info(category = "gitops", description = "Path to GitOps working directory, which is used to store the local git repository.", availableSince = "3.0.0") @Getter String workDir; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java b/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java index de5b9949d2..699852f2b8 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/kafkasql/KafkaSqlFactory.java @@ -52,27 +52,27 @@ public class KafkaSqlFactory { Integer pollTimeout; @Inject - @ConfigProperty(name = "registry.kafkasql.coordinator.response-timeout", defaultValue = "30000") + @ConfigProperty(name = "apicurio.kafkasql.coordinator.response-timeout", defaultValue = "30000") @Info(category = "storage", description = "Kafka sql storage coordinator response timeout") Integer responseTimeout; @Inject @RegistryProperties( - value = {"registry.kafka.common", "registry.kafkasql.producer"}, + value = {"apicurio.kafka.common", "apicurio.kafkasql.producer"}, empties = {"ssl.endpoint.identification.algorithm="} ) Properties producerProperties; @Inject @RegistryProperties( - value = {"registry.kafka.common", "registry.kafkasql.consumer"}, + value = {"apicurio.kafka.common", "apicurio.kafkasql.consumer"}, empties = {"ssl.endpoint.identification.algorithm="} ) Properties consumerProperties; @Inject @RegistryProperties( - value = {"registry.kafka.common", "registry.kafkasql.admin"}, + value = {"apicurio.kafka.common", "apicurio.kafkasql.admin"}, empties = {"ssl.endpoint.identification.algorithm="} ) Properties adminProperties; @@ -81,7 +81,7 @@ public class KafkaSqlFactory { @Info(category = "storage", description = "Kafka sql storage sasl enabled") boolean saslEnabled; - @ConfigProperty(name = "registry.kafkasql.security.protocol", defaultValue = "") + @ConfigProperty(name = "apicurio.kafkasql.security.protocol", defaultValue = "") @Info(category = "storage", description = "Kafka sql storage security protocol") Optional protocol; @@ -105,31 +105,31 @@ public class KafkaSqlFactory { @Info(category = "storage", description = "Kafka sql storage sasl login callback handler") String loginCallbackHandler; - @ConfigProperty(name = "registry.kafkasql.security.ssl.truststore.location") + @ConfigProperty(name = "apicurio.kafkasql.security.ssl.truststore.location") @Info(category = "storage", description = "Kafka sql storage ssl truststore location") Optional trustStoreLocation; - @ConfigProperty(name = "registry.kafkasql.security.ssl.truststore.type") + @ConfigProperty(name = "apicurio.kafkasql.security.ssl.truststore.type") @Info(category = "storage", description = "Kafka sql storage ssl truststore type") Optional trustStoreType; - @ConfigProperty(name = "registry.kafkasql.ssl.truststore.password") + @ConfigProperty(name = "apicurio.kafkasql.ssl.truststore.password") @Info(category = "storage", description = "Kafka sql storage ssl truststore password") Optional trustStorePassword; - @ConfigProperty(name = "registry.kafkasql.ssl.keystore.location") + @ConfigProperty(name = "apicurio.kafkasql.ssl.keystore.location") @Info(category = "storage", description = "Kafka sql storage ssl keystore location") Optional keyStoreLocation; - @ConfigProperty(name = "registry.kafkasql.ssl.keystore.type") + @ConfigProperty(name = "apicurio.kafkasql.ssl.keystore.type") @Info(category = "storage", description = "Kafka sql storage ssl keystore type") Optional keyStoreType; - @ConfigProperty(name = "registry.kafkasql.ssl.keystore.password") + @ConfigProperty(name = "apicurio.kafkasql.ssl.keystore.password") @Info(category = "storage", description = "Kafka sql storage ssl keystore password") Optional keyStorePassword; - @ConfigProperty(name = "registry.kafkasql.ssl.key.password") + @ConfigProperty(name = "apicurio.kafkasql.ssl.key.password") @Info(category = "storage", description = "Kafka sql storage ssl key password") Optional keyPassword; diff --git a/app/src/main/java/io/apicurio/registry/ui/URLUtil.java b/app/src/main/java/io/apicurio/registry/ui/URLUtil.java index dbd6eae2a6..1963858e6c 100644 --- a/app/src/main/java/io/apicurio/registry/ui/URLUtil.java +++ b/app/src/main/java/io/apicurio/registry/ui/URLUtil.java @@ -18,7 +18,7 @@ @ApplicationScoped public class URLUtil { - @ConfigProperty(name = "registry.url.override.host") + @ConfigProperty(name = "apicurio.url.override.host") @Info(category = "redirects", description = "Override the hostname used for generating externally-accessible URLs. " + "The host and port overrides are useful when deploying Registry with HTTPS passthrough Ingress or Route. " + "In cases like these, the request URL (and port) that is then re-used for redirection " + @@ -26,7 +26,7 @@ public class URLUtil { "The redirection then fails because the target URL is not reachable.", availableSince = "2.5.0.Final") Optional urlOverrideHost; - @ConfigProperty(name = "registry.url.override.port") + @ConfigProperty(name = "apicurio.url.override.port") @Info(category = "redirects", description = "Override the port used for generating externally-accessible URLs.", availableSince = "2.5.0.Final") Optional urlOverridePort; diff --git a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java index 1cc12a9535..b86d5dfc3a 100644 --- a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java @@ -8,13 +8,13 @@ @Singleton public class UserInterfaceConfigProperties { - @ConfigProperty(name = "registry.ui.contextPath", defaultValue = "/") + @ConfigProperty(name = "apicurio.ui.contextPath", defaultValue = "/") @Info(category = "ui", description = "Context path of the UI", availableSince = "3.0.0") public String contextPath; - @ConfigProperty(name = "registry.ui.navPrefixPath", defaultValue = "/") + @ConfigProperty(name = "apicurio.ui.navPrefixPath", defaultValue = "/") @Info(category = "ui", description = "Navigation prefix for all UI paths", availableSince = "3.0.0") public String navPrefixPath; - @ConfigProperty(name = "registry.ui.docsUrl", defaultValue = "/docs/") + @ConfigProperty(name = "apicurio.ui.docsUrl", defaultValue = "/docs/") @Info(category = "ui", description = "URL of the Documentation component", availableSince = "3.0.0") public String docsUrl; @@ -29,13 +29,13 @@ public class UserInterfaceConfigProperties { public String authOidcClientId; - @ConfigProperty(name = "registry.ui.features.readOnly", defaultValue = "false") + @ConfigProperty(name = "apicurio.ui.features.readOnly", defaultValue = "false") @Info(category = "ui", description = "Enabled to set the UI to read-only mode", availableSince = "3.0.0") public String featureReadOnly; - @ConfigProperty(name = "registry.ui.features.breadcrumbs", defaultValue = "true") + @ConfigProperty(name = "apicurio.ui.features.breadcrumbs", defaultValue = "true") @Info(category = "ui", description = "Enabled to show breadcrumbs in the UI", availableSince = "3.0.0") public String featureBreadcrumbs; - @ConfigProperty(name = "registry.ui.features.settings", defaultValue = "true") + @ConfigProperty(name = "apicurio.ui.features.settings", defaultValue = "true") @Info(category = "ui", description = "Enabled to show the Settings tab in the UI", availableSince = "3.0.0") public String featureSettings; diff --git a/app/src/main/java/io/apicurio/registry/util/DtoUtil.java b/app/src/main/java/io/apicurio/registry/util/DtoUtil.java index a984b23ef6..5212069f0f 100644 --- a/app/src/main/java/io/apicurio/registry/util/DtoUtil.java +++ b/app/src/main/java/io/apicurio/registry/util/DtoUtil.java @@ -26,11 +26,11 @@ public static final ArtifactMetaDataDto setEditableMetaDataInArtifact(ArtifactMe } public static String registryAuthPropertyToApp(String propertyName) { - return propertyName.replace("registry.auth.", "app.authn."); + return propertyName.replace("apicurio.auth.", "app.authn."); } public static String appAuthPropertyToRegistry(String propertyName) { - return propertyName.replace("app.authn.", "registry.auth."); + return propertyName.replace("app.authn.", "apicurio.auth."); } } diff --git a/app/src/test/java/io/apicurio/registry/ImportLifecycleBeanTestProfile.java b/app/src/test/java/io/apicurio/registry/ImportLifecycleBeanTestProfile.java index f419151191..67af9ba4ab 100644 --- a/app/src/test/java/io/apicurio/registry/ImportLifecycleBeanTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/ImportLifecycleBeanTestProfile.java @@ -9,7 +9,7 @@ public class ImportLifecycleBeanTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("registry.import.url", getClass().getResource("rest/v3/export.zip").toExternalForm()); + return Collections.singletonMap("apicurio.import.url", getClass().getResource("rest/v3/export.zip").toExternalForm()); } } diff --git a/app/src/test/java/io/apicurio/registry/events/HttpEventsProfile.java b/app/src/test/java/io/apicurio/registry/events/HttpEventsProfile.java index 6f3de9a8c5..32229028be 100644 --- a/app/src/test/java/io/apicurio/registry/events/HttpEventsProfile.java +++ b/app/src/test/java/io/apicurio/registry/events/HttpEventsProfile.java @@ -9,7 +9,7 @@ public class HttpEventsProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("registry.events.sink.testsink", "http://localhost:8976/"); + return Collections.singletonMap("apicurio.events.sink.testsink", "http://localhost:8976/"); } } \ No newline at end of file diff --git a/app/src/test/java/io/apicurio/registry/events/KafkaEventsTestResource.java b/app/src/test/java/io/apicurio/registry/events/KafkaEventsTestResource.java index bb01b11278..57d66ce2e1 100644 --- a/app/src/test/java/io/apicurio/registry/events/KafkaEventsTestResource.java +++ b/app/src/test/java/io/apicurio/registry/events/KafkaEventsTestResource.java @@ -12,7 +12,7 @@ public class KafkaEventsTestResource implements QuarkusTestResourceLifecycleMana */ @Override public Map start() { - return Collections.singletonMap("registry.events.kafka.topic", KafkaEventsProfile.EVENTS_TOPIC); + return Collections.singletonMap("apicurio.events.kafka.topic", KafkaEventsProfile.EVENTS_TOPIC); } /** diff --git a/app/src/test/java/io/apicurio/registry/limits/LimitsTestProfile.java b/app/src/test/java/io/apicurio/registry/limits/LimitsTestProfile.java index 0731406d74..1fd4d2d180 100644 --- a/app/src/test/java/io/apicurio/registry/limits/LimitsTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/limits/LimitsTestProfile.java @@ -10,17 +10,17 @@ public class LimitsTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { Map props = new HashMap<>(); - props.put("registry.limits.config.max-total-schemas", "2"); - props.put("registry.limits.config.max-artifact-properties", "2"); - props.put("registry.limits.config.max-property-key-size", "4"); //use text test - props.put("registry.limits.config.max-property-value-size", "4"); - props.put("registry.limits.config.max-artifact-labels", "2"); - props.put("registry.limits.config.max-label-size", "4"); - props.put("registry.limits.config.max-name-length", "512"); - props.put("registry.limits.config.max-description-length", "1024"); + props.put("apicurio.limits.config.max-total-schemas", "2"); + props.put("apicurio.limits.config.max-artifact-properties", "2"); + props.put("apicurio.limits.config.max-property-key-size", "4"); //use text test + props.put("apicurio.limits.config.max-property-value-size", "4"); + props.put("apicurio.limits.config.max-artifact-labels", "2"); + props.put("apicurio.limits.config.max-label-size", "4"); + props.put("apicurio.limits.config.max-name-length", "512"); + props.put("apicurio.limits.config.max-description-length", "1024"); //this will do nothing, no server will be available, it's just to test the usage of two decorators at the same time - props.put("registry.events.sink.testsink", "http://localhost:8888/thisisfailingonpurpose"); + props.put("apicurio.events.sink.testsink", "http://localhost:8888/thisisfailingonpurpose"); return props; } diff --git a/app/src/test/java/io/apicurio/registry/noprofile/storage/AbstractRegistryStorageTest.java b/app/src/test/java/io/apicurio/registry/noprofile/storage/AbstractRegistryStorageTest.java index ab2760e9c9..0b48746c0d 100644 --- a/app/src/test/java/io/apicurio/registry/noprofile/storage/AbstractRegistryStorageTest.java +++ b/app/src/test/java/io/apicurio/registry/noprofile/storage/AbstractRegistryStorageTest.java @@ -945,18 +945,18 @@ public void testConfigProperties() throws Exception { Assertions.assertNotNull(properties); Assertions.assertTrue(properties.isEmpty()); - storage().setConfigProperty(new DynamicConfigPropertyDto("registry.test.property-string", "test-value")); - storage().setConfigProperty(new DynamicConfigPropertyDto("registry.test.property-boolean", "true")); - storage().setConfigProperty(new DynamicConfigPropertyDto("registry.test.property-long", "12345")); + storage().setConfigProperty(new DynamicConfigPropertyDto("apicurio.test.property-string", "test-value")); + storage().setConfigProperty(new DynamicConfigPropertyDto("apicurio.test.property-boolean", "true")); + storage().setConfigProperty(new DynamicConfigPropertyDto("apicurio.test.property-long", "12345")); properties = storage().getConfigProperties(); Assertions.assertNotNull(properties); Assertions.assertFalse(properties.isEmpty()); Assertions.assertEquals(3, properties.size()); - DynamicConfigPropertyDto stringProp = getProperty(properties, "registry.test.property-string"); - DynamicConfigPropertyDto boolProp = getProperty(properties, "registry.test.property-boolean"); - DynamicConfigPropertyDto longProp = getProperty(properties, "registry.test.property-long"); + DynamicConfigPropertyDto stringProp = getProperty(properties, "apicurio.test.property-string"); + DynamicConfigPropertyDto boolProp = getProperty(properties, "apicurio.test.property-boolean"); + DynamicConfigPropertyDto longProp = getProperty(properties, "apicurio.test.property-long"); Assertions.assertNotNull(stringProp); Assertions.assertNotNull(boolProp); diff --git a/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java b/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java index 5af17b6d93..fc79ca4786 100644 --- a/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/rest/DisableApisTestProfile.java @@ -10,7 +10,7 @@ public class DisableApisTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { Map props = new HashMap<>(); - props.put("registry.disable.apis","/apis/ccompat/v7/subjects/[^/]+/versions.*,/ui/.*"); + props.put("apicurio.disable.apis","/apis/ccompat/v7/subjects/[^/]+/versions.*,/ui/.*"); props.put("apicurio.rest.artifact.deletion.enabled", "false"); return props; } diff --git a/app/src/test/java/io/apicurio/registry/rest/MultipleRequestFiltersTestProfile.java b/app/src/test/java/io/apicurio/registry/rest/MultipleRequestFiltersTestProfile.java index 34af2e3f1e..28e7684619 100644 --- a/app/src/test/java/io/apicurio/registry/rest/MultipleRequestFiltersTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/rest/MultipleRequestFiltersTestProfile.java @@ -10,7 +10,7 @@ public class MultipleRequestFiltersTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { Map props = new HashMap<>(); - props.put("registry.disable.apis", "/apis/ccompat/v7/subjects/[^/]+/versions.*,/ui/.*"); + props.put("apicurio.disable.apis", "/apis/ccompat/v7/subjects/[^/]+/versions.*,/ui/.*"); return props; } diff --git a/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java b/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java index 9342b8f5f8..e95c018da5 100644 --- a/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java +++ b/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java @@ -159,7 +159,7 @@ public class ReadOnlyRegistryStorageTest { void readOnlyTest() { notEnabled(); var dto = new DynamicConfigPropertyDto(); - dto.setName("registry.storage.read-only"); + dto.setName("apicurio.storage.read-only"); dto.setValue("true"); storage.setConfigProperty(dto); enabled(); diff --git a/common/src/main/java/io/apicurio/registry/utils/PropertiesUtil.java b/common/src/main/java/io/apicurio/registry/utils/PropertiesUtil.java index dca52292e7..75dd589b8c 100644 --- a/common/src/main/java/io/apicurio/registry/utils/PropertiesUtil.java +++ b/common/src/main/java/io/apicurio/registry/utils/PropertiesUtil.java @@ -18,7 +18,7 @@ public class PropertiesUtil { private static final Logger log = LoggerFactory.getLogger(PropertiesUtil.class); // explicit debug, since properties can have unresolved env vars - private static final boolean debug = Boolean.getBoolean("registry.debug"); + private static final boolean debug = Boolean.getBoolean("apicurio.debug"); /** * Filter/strip prefixes from configuration properties. diff --git a/docs/generateAllConfigPartial.java b/docs/generateAllConfigPartial.java index d4cdc14667..8831c70dce 100644 --- a/docs/generateAllConfigPartial.java +++ b/docs/generateAllConfigPartial.java @@ -158,7 +158,7 @@ public static Map extractConfigurations(String jarFile, Map v.value().toString()).orElse(""); @@ -247,7 +247,7 @@ public static void main(String... args) throws Exception { opt.getAvailableFrom() )); } else { - if (key.startsWith("registry.")) { + if (key.startsWith("apicurio.")) { allConfiguration.put(key, new Option( key, diff --git a/docs/modules/ROOT/partials/getting-started/proc-managing-artifacts-using-client-code.adoc b/docs/modules/ROOT/partials/getting-started/proc-managing-artifacts-using-client-code.adoc index 43c5bc95d4..3b2ff3e149 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-managing-artifacts-using-client-code.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-managing-artifacts-using-client-code.adoc @@ -18,7 +18,7 @@ You can also manage artifacts stored in {registry} using a Java client applicati + [source,java,subs="+quotes,attributes"] ---- -String registryUrl_node1 = PropertiesUtil.property(clientProperties, "registry.url.node1", +String registryUrl_node1 = PropertiesUtil.property(clientProperties, "apicurio.url.node1", "http://my-cluster-service-registry-myproject.example.com/api"); <1> try (RegistryService service = RegistryClient.create(registryUrl_node1)) { diff --git a/docs/modules/ROOT/partials/getting-started/proc-registry-serdes-register.adoc b/docs/modules/ROOT/partials/getting-started/proc-registry-serdes-register.adoc index 1b8ef35463..5942eb90a6 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-registry-serdes-register.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-registry-serdes-register.adoc @@ -95,7 +95,7 @@ endif::[] [source,java,subs="+quotes,attributes"] ---- -String registryUrl_node1 = PropertiesUtil.property(clientProperties, "registry.url.node1", +String registryUrl_node1 = PropertiesUtil.property(clientProperties, "apicurio.url.node1", "https://my-cluster-service-registry-myproject.example.com/apis/registry/v2"); <1> try (RegistryService service = RegistryClient.create(registryUrl_node1)) { String artifactId = ApplicationImpl.INPUT_TOPIC + "-value"; diff --git a/examples/debezium-openshift/src/main/java/io/apicurio/example/debezium/kafka/KafkaFactory.java b/examples/debezium-openshift/src/main/java/io/apicurio/example/debezium/kafka/KafkaFactory.java index 9e2543db77..febb0e6bc5 100644 --- a/examples/debezium-openshift/src/main/java/io/apicurio/example/debezium/kafka/KafkaFactory.java +++ b/examples/debezium-openshift/src/main/java/io/apicurio/example/debezium/kafka/KafkaFactory.java @@ -23,7 +23,7 @@ public class KafkaFactory { @ConfigProperty(name = "kafka.bootstrap.servers") String bootstrapServers; - @ConfigProperty(name = "registry.url") + @ConfigProperty(name = "apicurio.url") String registryUrl; public KafkaConsumer createKafkaConsumer() { diff --git a/scripts/validate-files.sh b/scripts/validate-files.sh index c8cbff311c..445011ed06 100755 --- a/scripts/validate-files.sh +++ b/scripts/validate-files.sh @@ -1,6 +1,6 @@ #!/bin/bash -# DB_VERSION_BUILD=$(yq .project.properties."registry.sql.storage.db-version" app/pom.xml -r) +# DB_VERSION_BUILD=$(yq .project.properties."apicurio.sql.storage.db-version" app/pom.xml -r) DB_VERSION_BUILD=$(cat app/src/main/resources/io/apicurio/registry/storage/impl/sql/db-version) echo "Build's DB version is $DB_VERSION_BUILD" diff --git a/utils/maven-plugin/src/main/java/io/apicurio/registry/maven/AbstractRegistryMojo.java b/utils/maven-plugin/src/main/java/io/apicurio/registry/maven/AbstractRegistryMojo.java index 92c81f4eb2..2ef758658d 100644 --- a/utils/maven-plugin/src/main/java/io/apicurio/registry/maven/AbstractRegistryMojo.java +++ b/utils/maven-plugin/src/main/java/io/apicurio/registry/maven/AbstractRegistryMojo.java @@ -28,7 +28,7 @@ public abstract class AbstractRegistryMojo extends AbstractMojo { * The registry's url. * e.g. http://localhost:8080/api/v3 */ - @Parameter(required = true, property = "registry.url") + @Parameter(required = true, property = "apicurio.url") String registryUrl; @Parameter(property = "auth.server.url") From 8650f4458f92b8962aa0a5f9fde1dc0023b403cf Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Wed, 24 Apr 2024 10:57:23 +0200 Subject: [PATCH 10/13] Fix download ttl property name --- .../registry/rest/v2/AdminResourceImpl.java | 2 +- .../registry/rest/v3/AdminResourceImpl.java | 2 +- .../registry/rbac/AdminResourceTest.java | 2 +- .../registry/rbac/RegistryClientTest.java | 2 +- .../ref-registry-all-configs.adoc | 176 +++++++++--------- 5 files changed, 92 insertions(+), 92 deletions(-) diff --git a/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java index efbbc1879b..86302de4e1 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java @@ -86,7 +86,7 @@ public class AdminResourceImpl implements AdminResource { HttpServletRequest request; @Dynamic(label = "Download link expiry", description = "The number of seconds that a generated link to a .zip download file is active before expiring.") - @ConfigProperty(name = "registry.download.href.ttl", defaultValue = "30") + @ConfigProperty(name = "apicurio.download.href.ttl", defaultValue = "30") @Info(category = "download", description = "Download link expiry", availableSince = "2.1.2.Final") Supplier downloadHrefTtl; diff --git a/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java index 237acd1771..3cc548719e 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java @@ -105,7 +105,7 @@ public class AdminResourceImpl implements AdminResource { HttpServletRequest request; @Dynamic(label = "Download link expiry", description = "The number of seconds that a generated link to a .zip download file is active before expiring.") - @ConfigProperty(name = "registry.download.href.ttl", defaultValue = "30") + @ConfigProperty(name = "apicurio.download.href.ttl", defaultValue = "30") @Info(category = "download", description = "Download link expiry", availableSince = "2.1.2.Final") Supplier downloadHrefTtl; diff --git a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java index c42772833b..a918784db4 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java @@ -926,7 +926,7 @@ public void testConfigProperties() throws Exception { given() .when() .contentType(CT_JSON).body(update) - .pathParam("propertyName", "registry.download.href.ttl") + .pathParam("propertyName", "apicurio.download.href.ttl") .put("/registry/v3/admin/config/properties/{propertyName}") .then() .statusCode(400); diff --git a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java index d484842672..3cff52635e 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java @@ -1636,7 +1636,7 @@ public void testConfigProperties() throws Exception { // Try to set a Long property to "foobar" (should be invalid type) var exception2 = Assertions.assertThrows(ApiException.class, () -> { updateProp.setValue("foobar"); - clientV3.admin().config().properties().byPropertyName("registry.download.href.ttl").put(updateProp); + clientV3.admin().config().properties().byPropertyName("apicurio.download.href.ttl").put(updateProp); }); // InvalidPropertyValueException Assertions.assertEquals(400, exception2.getResponseStatusCode()); diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index e2341fde08..e09af1a4a3 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -17,17 +17,17 @@ The following {registry} configuration options are available for each component |`false` |`2.1.4.Final` |Include stack trace in errors responses -|`registry.apis.v2.base-href` +|`apicurio.apis.v2.base-href` |`string` |`_` |`2.5.0.Final` |API base href (URI) -|`registry.apis.v3.base-href` +|`apicurio.apis.v3.base-href` |`string` |`_` |`2.5.0.Final` |API base href (URI) -|`registry.disable.apis` +|`apicurio.disable.apis` |`optional>` | |`2.0.0.Final` @@ -43,51 +43,6 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`apicurio.authn.audit.log.prefix` -|`string` -|`audit` -|`2.2.6` -|Prefix used for application audit logging. -|`apicurio.authn.basic-client-credentials.cache-expiration` -|`integer` -|`10` -|`2.2.6.Final` -|Default client credentials token expiration time. -|`apicurio.authn.basic-client-credentials.cache-expiration-offset` -|`integer` -|`10` -|`2.5.9.Final` -|Client credentials token expiration offset from JWT expiration. -|`apicurio.authn.basic-client-credentials.enabled` -|`boolean [dynamic]` -|`false` -|`2.1.0.Final` -|Enable basic auth client credentials -|`apicurio.authn.basic.scope` -|`optional` -| -|`2.5.0.Final` -|Client credentials scope. -|`quarkus.oidc.client-id` -|`string` -| -|`2.0.0.Final` -|Client identifier used by the server for authentication. -|`quarkus.oidc.client-secret` -|`optional` -| -|`2.1.0.Final` -|Client secret used by the server for authentication. -|`quarkus.oidc.tenant-enabled` -|`boolean` -|`false` -|`2.0.0.Final` -|Enable auth -|`quarkus.oidc.token-path` -|`string` -| -|`2.1.0.Final` -|Authentication server token endpoint. |`apicurio.auth.admin-override.claim` |`string` |`org-admin` @@ -173,6 +128,51 @@ The following {registry} configuration options are available for each component |`sr-readonly` |`2.1.0.Final` |Auth roles readonly +|`apicurio.authn.audit.log.prefix` +|`string` +|`audit` +|`2.2.6` +|Prefix used for application audit logging. +|`apicurio.authn.basic-client-credentials.cache-expiration` +|`integer` +|`10` +|`2.2.6.Final` +|Default client credentials token expiration time. +|`apicurio.authn.basic-client-credentials.cache-expiration-offset` +|`integer` +|`10` +|`2.5.9.Final` +|Client credentials token expiration offset from JWT expiration. +|`apicurio.authn.basic-client-credentials.enabled` +|`boolean [dynamic]` +|`false` +|`2.1.0.Final` +|Enable basic auth client credentials +|`apicurio.authn.basic.scope` +|`optional` +| +|`2.5.0.Final` +|Client credentials scope. +|`quarkus.oidc.client-id` +|`string` +| +|`2.0.0.Final` +|Client identifier used by the server for authentication. +|`quarkus.oidc.client-secret` +|`optional` +| +|`2.1.0.Final` +|Client secret used by the server for authentication. +|`quarkus.oidc.tenant-enabled` +|`boolean` +|`false` +|`2.0.0.Final` +|Enable auth +|`quarkus.oidc.token-path` +|`string` +| +|`2.1.0.Final` +|Authentication server token endpoint. |=== == cache @@ -226,7 +226,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.download.href.ttl` +|`apicurio.download.href.ttl` |`long [dynamic]` |`30` |`2.1.2.Final` @@ -273,7 +273,7 @@ The following {registry} configuration options are available for each component | |`3.0.0` |URI of the remote git repository containing data to be loaded. -|`registry.gitops.workdir` +|`apicurio.gitops.workdir` |`string` |`/tmp/apicurio-registry-gitops` |`3.0.0` @@ -390,7 +390,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.import.url` +|`apicurio.import.url` |`optional` | |`2.1.0.Final` @@ -406,12 +406,12 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.events.kafka.topic` +|`apicurio.events.kafka.topic` |`optional` | |`2.0.0.Final` |Events Kafka topic -|`registry.events.kafka.topic-partition` +|`apicurio.events.kafka.topic-partition` |`optional` | |`2.0.0.Final` @@ -427,62 +427,62 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`registry.limits.config.max-artifact-labels` +|`apicurio.limits.config.max-artifact-labels` |`long` |`-1` |`2.2.3.Final` |Max artifact labels -|`registry.limits.config.max-artifact-properties` +|`apicurio.limits.config.max-artifact-properties` |`long` |`-1` |`2.1.0.Final` |Max artifact properties -|`registry.limits.config.max-artifacts` +|`apicurio.limits.config.max-artifacts` |`long` |`-1` |`2.1.0.Final` |Max artifacts -|`registry.limits.config.max-description-length` +|`apicurio.limits.config.max-description-length` |`long` |`-1` |`2.1.0.Final` |Max artifact description length -|`registry.limits.config.max-label-size` +|`apicurio.limits.config.max-label-size` |`long` |`-1` |`2.1.0.Final` |Max artifact label size -|`registry.limits.config.max-name-length` +|`apicurio.limits.config.max-name-length` |`long` |`-1` |`2.1.0.Final` |Max artifact name length -|`registry.limits.config.max-property-key-size` +|`apicurio.limits.config.max-property-key-size` |`long` |`-1` |`2.1.0.Final` |Max artifact property key size -|`registry.limits.config.max-property-value-size` +|`apicurio.limits.config.max-property-value-size` |`long` |`-1` |`2.1.0.Final` |Max artifact property value size -|`registry.limits.config.max-requests-per-second` +|`apicurio.limits.config.max-requests-per-second` |`long` |`-1` |`2.2.3.Final` |Max artifact requests per second -|`registry.limits.config.max-schema-size-bytes` +|`apicurio.limits.config.max-schema-size-bytes` |`long` |`-1` |`2.2.3.Final` |Max schema size (bytes) -|`registry.limits.config.max-total-schemas` +|`apicurio.limits.config.max-total-schemas` |`long` |`-1` |`2.1.0.Final` |Max total schemas -|`registry.limits.config.max-versions-per-artifact` +|`apicurio.limits.config.max-versions-per-artifact` |`long` |`-1` |`2.1.0.Final` @@ -513,12 +513,12 @@ The following {registry} configuration options are available for each component | |`2.1.2.Final` |Registry redirects -|`registry.url.override.host` +|`apicurio.url.override.host` |`optional` | |`2.5.0.Final` |Override the hostname used for generating externally-accessible URLs. The host and port overrides are useful when deploying Registry with HTTPS passthrough Ingress or Route. In cases like these, the request URL (and port) that is then re-used for redirection does not belong to actual external URL used by the client, because the request is proxied. The redirection then fails because the target URL is not reachable. -|`registry.url.override.port` +|`apicurio.url.override.port` |`optional` | |`2.5.0.Final` @@ -560,11 +560,6 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`artifacts.skip.disabled.latest` -|`boolean` -|`true` -|`2.4.2-SNAPSHOT` -|Skip artifact versions with DISABLED state when retrieving latest artifact version |`apicurio.datasource.blue.db-kind` |`string` |`h2` @@ -675,12 +670,12 @@ The following {registry} configuration options are available for each component |`1000` | |Kafka sql storage consumer poll timeout -|`registry.kafkasql.coordinator.response-timeout` +|`apicurio.kafkasql.coordinator.response-timeout` |`integer` |`30000` | |Kafka sql storage coordinator response timeout -|`registry.kafkasql.security.protocol` +|`apicurio.kafkasql.security.protocol` |`optional` | | @@ -715,37 +710,37 @@ The following {registry} configuration options are available for each component | | |Kafka sql storage sasl token endpoint -|`registry.kafkasql.security.ssl.truststore.location` +|`apicurio.kafkasql.security.ssl.truststore.location` |`optional` | | |Kafka sql storage ssl truststore location -|`registry.kafkasql.security.ssl.truststore.type` +|`apicurio.kafkasql.security.ssl.truststore.type` |`optional` | | |Kafka sql storage ssl truststore type -|`registry.kafkasql.ssl.key.password` +|`apicurio.kafkasql.ssl.key.password` |`optional` | | |Kafka sql storage ssl key password -|`registry.kafkasql.ssl.keystore.location` +|`apicurio.kafkasql.ssl.keystore.location` |`optional` | | |Kafka sql storage ssl keystore location -|`registry.kafkasql.ssl.keystore.password` +|`apicurio.kafkasql.ssl.keystore.password` |`optional` | | |Kafka sql storage ssl keystore password -|`registry.kafkasql.ssl.keystore.type` +|`apicurio.kafkasql.ssl.keystore.type` |`optional` | | |Kafka sql storage ssl keystore type -|`registry.kafkasql.ssl.truststore.password` +|`apicurio.kafkasql.ssl.truststore.password` |`optional` | | @@ -775,11 +770,16 @@ The following {registry} configuration options are available for each component | |`3.0.0.Final` |Application storage variant, for example, sql, kafkasql, or gitops -|`registry.storage.read-only` +|`apicurio.storage.read-only` |`boolean [dynamic]` |`false` |`2.5.0.Final` |Enable Registry storage read-only mode +|`artifacts.skip.disabled.latest` +|`boolean` +|`true` +|`2.4.2-SNAPSHOT` +|Skip artifact versions with DISABLED state when retrieving latest artifact version |=== == ui @@ -801,32 +801,32 @@ The following {registry} configuration options are available for each component |`/` |`3.0.0` |The OIDC redirectUri -|`registry.ui.contextPath` +|`apicurio.ui.contextPath` |`string` |`/` |`3.0.0` |Context path of the UI -|`registry.ui.docsUrl` +|`apicurio.ui.docsUrl` |`string` |`/docs/` |`3.0.0` |URL of the Documentation component -|`registry.ui.features.breadcrumbs` +|`apicurio.ui.features.breadcrumbs` |`string` |`true` |`3.0.0` |Enabled to show breadcrumbs in the UI -|`registry.ui.features.readOnly` +|`apicurio.ui.features.readOnly` |`string` |`false` |`3.0.0` |Enabled to set the UI to read-only mode -|`registry.ui.features.settings` +|`apicurio.ui.features.settings` |`string` |`true` |`3.0.0` |Enabled to show the Settings tab in the UI -|`registry.ui.navPrefixPath` +|`apicurio.ui.navPrefixPath` |`string` |`/` |`3.0.0` From 1048d1ecbaa8ceccdc7e64eedfe0d7710efcb4be Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Wed, 24 Apr 2024 13:05:13 +0200 Subject: [PATCH 11/13] Align configuration properties --- README.md | 44 +++++++++---------- app/pom.xml | 4 ++ .../RegistryLimitsConfigurationProducer.java | 8 ++-- .../PersistenceExceptionLivenessCheck.java | 6 +-- .../liveness/ResponseErrorLivenessCheck.java | 6 +-- .../PersistenceTimeoutReadinessCheck.java | 4 +- .../ResponseTimeoutReadinessCheck.java | 4 +- .../io/apicurio/registry/rest/RestConfig.java | 4 +- .../registry/rest/v2/AdminResourceImpl.java | 2 +- .../registry/rest/v3/AdminResourceImpl.java | 2 +- .../impl/sql/RegistryDatasourceProducer.java | 2 +- .../impl/sql/SqlStatementsProducer.java | 2 +- .../storage/metrics/StorageMetricsStore.java | 2 +- .../ui/UserInterfaceConfigProperties.java | 2 +- .../registry/ui/servlets/RedirectFilter.java | 2 +- .../resources/application-prod.properties | 16 +++---- .../resources/application-test.properties | 4 +- app/src/main/resources/application.properties | 14 +++--- .../registry/rbac/AdminResourceTest.java | 2 +- .../registry/rbac/RegistryClientTest.java | 2 +- .../storage/util/GitopsTestProfile.java | 2 +- .../storage/util/MssqlTestProfile.java | 2 +- .../storage/util/PostgresqlTestProfile.java | 2 +- ...c-configuring-registry-security-azure.adoc | 2 +- ...onfiguring-registry-security-keycloak.adoc | 2 +- .../ref-registry-all-configs.adoc | 14 +++--- .../ref-registry-security-configuration.adoc | 2 +- .../src/app/pages/settings/SettingsPage.tsx | 4 +- .../tests/MsSqlEmbeddedTestResource.java | 6 +-- .../tests/PostgreSqlEmbeddedTestResource.java | 6 +-- 30 files changed, 89 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index 9c196446fd..c594a98d67 100644 --- a/README.md +++ b/README.md @@ -79,12 +79,12 @@ The following parameters are available for executable files: - By default, the application expects an H2 server running at `jdbc:h2:tcp://localhost:9123/mem:registry`. - For configuring the database kind and the datasource values, the following configuration options are available: -| Option |Command argument| Env. variable | -|---------------------------|---|--------------------------------| -| Registry SQL storage kind |`-Dapicurio.storage.db-kind`| `REGISTRY_STORAGE_DB_KIND` | -| Data Source URL |`-Dapicurio.datasource.url`| `REGISTRY_DATASOURCE_URL` | -| DS Username |`-Dapicurio.datasource.username`| `REGISTRY_DATASOURCE_USERNAME` | -| DS Password |`-Dapicurio.datasource.password`| `REGISTRY_DATASOURCE_PASSWORD` | +| Option | Command argument | Env. variable | +|---------------------------|---------------------------------|--------------------------------| +| Registry SQL storage kind | `-Dapicurio.storage.sql.kind` | `APICURIO_STORAGE_SQL_KIND` | +| Data Source URL | `-Dapicurio.datasource.url` | `APICURIO_DATASOURCE_URL` | +| DS Username | `-Dapicurio.datasource.username` | `APICURIO_DATASOURCE_USERNAME` | +| DS Password | `-Dapicurio.datasource.password` | `APICURIO_DATASOURCE_PASSWORD` | To see additional options, visit: - [Data Source config](https://quarkus.io/guides/datasource) @@ -107,13 +107,13 @@ scram-sha-512 credentials for user authorisation. ``` java \ -Dapicurio.storage.kind=kafkasql \ --Dregistry.kafka.common.bootstrap.servers= \ --Dregistry.kafka.common.ssl.truststore.location=\ --Dregistry.kafka.common.ssl.truststore.password= \ --Dregistry.kafka.common.ssl.truststore.type=PKCS12 \ --Dregistry.kafka.common.security.protocol=SASL_SSL \ --Dregistry.kafka.common.sasl.mechanism=SCRAM-SHA-512 \ --Dregistry.kafka.common.sasl.jaas.config='org.apache.kafka.common.security.scram.ScramLoginModule required username="" password="";' \ +-Dapicurio.kafka.common.bootstrap.servers= \ +-Dapicurio.kafka.common.ssl.truststore.location=\ +-Dapicurio.kafka.common.ssl.truststore.password= \ +-Dapicurio.kafka.common.ssl.truststore.type=PKCS12 \ +-Dapicurio.kafka.common.security.protocol=SASL_SSL \ +-Dapicurio.kafka.common.sasl.mechanism=SCRAM-SHA-512 \ +-Dapicurio.kafka.common.sasl.jaas.config='org.apache.kafka.common.security.scram.ScramLoginModule required username="" password="";' \ -jar app/target/apicurio-registry-app-3.0.0-SNAPSHOT-runner.jar ``` This will start up the registry with the persistence managed by the external kafka cluster. @@ -176,11 +176,11 @@ services: ports: - 8080:8080 environment: - REGISTRY_STORAGE_KIND: 'sql' - REGISTRY_STORAGE_DB_KIND: 'postgresql' - REGISTRY_DATASOURCE_URL: 'jdbc:postgresql://postgres/apicurio-registry' - REGISTRY_DATASOURCE_USERNAME: apicurio-registry - REGISTRY_DATASOURCE_PASSWORD: password + APICURIO_STORAGE_KIND: 'sql' + APICURIO_STORAGE_DB_KIND: 'postgresql' + APICURIO_DATASOURCE_URL: 'jdbc:postgresql://postgres/apicurio-registry' + APICURIO_DATASOURCE_USERNAME: apicurio-registry + APICURIO_DATASOURCE_PASSWORD: password ``` - Run `docker-compose -f test.yml up` @@ -205,10 +205,10 @@ In order no enable this integration, you will need to set the following environm |Option|Env. variable| |---|---| -|`REGISTRY_AUTH_TYPE`|Set to `oidc` (default is `none`)| -|`REGISTRY_AUTH_URL`|OIDC auth URL| -|`REGISTRY_AUTH_REDIRECT_URL`|OIDC redirect URL| -|`REGISTRY_AUTH_CLIENT_ID`|The client for the UI| +|`APICURIO_AUTH_TYPE`|Set to `oidc` (default is `none`)| +|`APICURIO_AUTH_URL`|OIDC auth URL| +|`APICURIO_AUTH_REDIRECT_URL`|OIDC redirect URL| +|`APICURIO_AUTH_CLIENT_ID`|The client for the UI| Note that you will need to have everything configured in your OIDC provider, before starting the application (the realm and the two clients). diff --git a/app/pom.xml b/app/pom.xml index 48a6e206ae..80ef07e490 100644 --- a/app/pom.xml +++ b/app/pom.xml @@ -113,6 +113,10 @@ io.quarkus quarkus-oidc + + io.quarkus + quarkus-elytron-security-properties-file + io.quarkus quarkus-smallrye-jwt diff --git a/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java b/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java index 6876d9822f..12f5ce6b5d 100644 --- a/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java +++ b/app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfigurationProducer.java @@ -20,7 +20,7 @@ public class RegistryLimitsConfigurationProducer { Long defaultMaxTotalSchemas; @Inject - @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-schema-size-bytes") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-schema-size.bytes") @Info(category = "limits", description = "Max schema size (bytes)", availableSince = "2.2.3.Final") Long defaultMaxSchemaSizeBytes; @@ -39,11 +39,11 @@ public class RegistryLimitsConfigurationProducer { @Info(category = "limits", description = "Max artifact properties", availableSince = "2.1.0.Final") Long defaultMaxArtifactProperties; @Inject - @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-key-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-key-size.bytes") @Info(category = "limits", description = "Max artifact property key size", availableSince = "2.1.0.Final") Long defaultMaxPropertyKeyBytesSize; @Inject - @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-value-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-property-value-size.bytes") @Info(category = "limits", description = "Max artifact property value size", availableSince = "2.1.0.Final") Long defaultMaxPropertyValueBytesSize; @@ -52,7 +52,7 @@ public class RegistryLimitsConfigurationProducer { @Info(category = "limits", description = "Max artifact labels", availableSince = "2.2.3.Final") Long defaultMaxArtifactLabels; @Inject - @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-label-size") + @ConfigProperty(defaultValue = "-1", name = "apicurio.limits.config.max-label-size.bytes") @Info(category = "limits", description = "Max artifact label size", availableSince = "2.1.0.Final") Long defaultMaxLabelBytesSize; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java index c6fb2642cc..da993e48a6 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/PersistenceExceptionLivenessCheck.java @@ -39,18 +39,18 @@ public class PersistenceExceptionLivenessCheck extends AbstractErrorCounterHealt * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDuration.seconds", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of persistence liveness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the liveness status after this time window passes without any further errors. */ - @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDuration.seconds", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of persistence liveness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; - @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.disableLogging", defaultValue = "false") + @ConfigProperty(name = "apicurio.metrics.PersistenceExceptionLivenessCheck.logging.disabled", defaultValue = "false") @Info(category = "health", description = "Disable logging of persistence liveness check", availableSince = "2.0.0.Final") Boolean disableLogging; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java index 9d28b946e8..ecbae6ad6b 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/liveness/ResponseErrorLivenessCheck.java @@ -35,18 +35,18 @@ public class ResponseErrorLivenessCheck extends AbstractErrorCounterHealthCheck * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDuration.seconds", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of response liveness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the liveness status after this time window passes without any further errors. */ - @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDuration.seconds", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of response liveness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; - @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.disableLogging", defaultValue = "false") + @ConfigProperty(name = "apicurio.metrics.ResponseErrorLivenessCheck.logging.disabled", defaultValue = "false") @Info(category = "health", description = "Disable logging of response liveness check", availableSince = "2.0.0.Final") Boolean disableLogging; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java index 5537f4c519..1ec031c158 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java @@ -40,14 +40,14 @@ public class PersistenceTimeoutReadinessCheck extends AbstractErrorCounterHealth * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDuration.seconds", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of persistence readiness check", availableSince = "1.0.2.Final") Integer configCounterResetWindowDurationSec; /** * If set to a positive value, reset the readiness status after this time window passes without any further errors. */ - @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDuration.seconds", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of persistence readiness check", availableSince = "1.0.2.Final") Integer configStatusResetWindowDurationSec; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java index 8f9cedc8d2..18ae7aa571 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java @@ -48,14 +48,14 @@ public class ResponseTimeoutReadinessCheck extends AbstractErrorCounterHealthChe * to 60. * TODO report the absolute count as a metric? */ - @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec", defaultValue = "60") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDuration.seconds", defaultValue = "60") @Info(category = "health", description = "Counter reset window duration of response readiness check", availableSince = "1.0.2.Final") Instance configCounterResetWindowDurationSec; /** * If set to a positive value, reset the readiness status after this time window passes without any further errors. */ - @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec", defaultValue = "300") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDuration.seconds", defaultValue = "300") @Info(category = "health", description = "Status reset window duration of response readiness check", availableSince = "1.0.2.Final") Instance configStatusResetWindowDurationSec; diff --git a/app/src/main/java/io/apicurio/registry/rest/RestConfig.java b/app/src/main/java/io/apicurio/registry/rest/RestConfig.java index 191ec0d673..5d04d275aa 100644 --- a/app/src/main/java/io/apicurio/registry/rest/RestConfig.java +++ b/app/src/main/java/io/apicurio/registry/rest/RestConfig.java @@ -10,11 +10,11 @@ @Singleton public class RestConfig { - @ConfigProperty(name = "apicurio.rest.artifact.download.maxSize", defaultValue = "1000000") + @ConfigProperty(name = "apicurio.rest.artifact.download.maxSize.bytes", defaultValue = "1000000") @Info(category = "rest", description = "Max size of the artifact allowed to be downloaded from URL", availableSince = "2.2.6-SNAPSHOT") int downloadMaxSize; - @ConfigProperty(name = "apicurio.rest.artifact.download.skipSSLValidation", defaultValue = "false") + @ConfigProperty(name = "apicurio.rest.artifact.download.sslValidation.disabled", defaultValue = "false") @Info(category = "rest", description = "Skip SSL validation when downloading artifacts from URL", availableSince = "2.2.6-SNAPSHOT") boolean downloadSkipSSLValidation; diff --git a/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java index 86302de4e1..c6407467db 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v2/AdminResourceImpl.java @@ -86,7 +86,7 @@ public class AdminResourceImpl implements AdminResource { HttpServletRequest request; @Dynamic(label = "Download link expiry", description = "The number of seconds that a generated link to a .zip download file is active before expiring.") - @ConfigProperty(name = "apicurio.download.href.ttl", defaultValue = "30") + @ConfigProperty(name = "apicurio.download.href.ttl.seconds", defaultValue = "30") @Info(category = "download", description = "Download link expiry", availableSince = "2.1.2.Final") Supplier downloadHrefTtl; diff --git a/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java index 3cc548719e..513783a8be 100644 --- a/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java +++ b/app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java @@ -105,7 +105,7 @@ public class AdminResourceImpl implements AdminResource { HttpServletRequest request; @Dynamic(label = "Download link expiry", description = "The number of seconds that a generated link to a .zip download file is active before expiring.") - @ConfigProperty(name = "apicurio.download.href.ttl", defaultValue = "30") + @ConfigProperty(name = "apicurio.download.href.ttl.seconds", defaultValue = "30") @Info(category = "download", description = "Download link expiry", availableSince = "2.1.2.Final") Supplier downloadHrefTtl; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java index 6ce534fa3c..0205e5972a 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/sql/RegistryDatasourceProducer.java @@ -19,7 +19,7 @@ public class RegistryDatasourceProducer { @Inject Logger log; - @ConfigProperty(name = "apicurio.storage.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.storage.sql.kind", defaultValue = "h2") @Info(category = "storage", description = "Application datasource database type", availableSince = "3.0.0.Final") String databaseType; diff --git a/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java b/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java index 7caec94a0d..b636bba948 100644 --- a/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java +++ b/app/src/main/java/io/apicurio/registry/storage/impl/sql/SqlStatementsProducer.java @@ -13,7 +13,7 @@ public class SqlStatementsProducer { @Inject Logger log; - @ConfigProperty(name = "apicurio.storage.db-kind", defaultValue = "h2") + @ConfigProperty(name = "apicurio.storage.sql.kind", defaultValue = "h2") @Info(category = "storage", description = "Datasource Db kind", availableSince = "2.0.0.Final") String databaseType; diff --git a/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java b/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java index 2faab91f0e..cca844d8b1 100644 --- a/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java +++ b/app/src/main/java/io/apicurio/registry/storage/metrics/StorageMetricsStore.java @@ -37,7 +37,7 @@ public class StorageMetricsStore { Logger log; @Inject - @ConfigProperty(defaultValue = "30000", name = "apicurio.storage.metrics.cache.check-period") + @ConfigProperty(defaultValue = "30000", name = "apicurio.storage.metrics.cache.check-period.ms") @Info(category = "health", description = "Storage metrics cache check period", availableSince = "2.1.0.Final") Long limitsCheckPeriod; diff --git a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java index b86d5dfc3a..ce4407d400 100644 --- a/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java +++ b/app/src/main/java/io/apicurio/registry/ui/UserInterfaceConfigProperties.java @@ -29,7 +29,7 @@ public class UserInterfaceConfigProperties { public String authOidcClientId; - @ConfigProperty(name = "apicurio.ui.features.readOnly", defaultValue = "false") + @ConfigProperty(name = "apicurio.ui.features.read-only.enabled", defaultValue = "false") @Info(category = "ui", description = "Enabled to set the UI to read-only mode", availableSince = "3.0.0") public String featureReadOnly; @ConfigProperty(name = "apicurio.ui.features.breadcrumbs", defaultValue = "true") diff --git a/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java b/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java index 1542829744..8c5ba11004 100644 --- a/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java +++ b/app/src/main/java/io/apicurio/registry/ui/servlets/RedirectFilter.java @@ -18,7 +18,7 @@ @ApplicationScoped public class RedirectFilter implements Filter { - @ConfigProperty(name = "apicurio.enable-redirects") + @ConfigProperty(name = "apicurio.redirects.enabled") @Info(category = "redirects", description = "Enable redirects", availableSince = "2.1.2.Final") Boolean redirectsEnabled; diff --git a/app/src/main/resources/application-prod.properties b/app/src/main/resources/application-prod.properties index 7ccb6194bb..1e64eb99f9 100644 --- a/app/src/main/resources/application-prod.properties +++ b/app/src/main/resources/application-prod.properties @@ -1,18 +1,18 @@ # Readiness and Liveness apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold=5 -apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDurationSec=30 -apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.PersistenceExceptionLivenessCheck.counterResetWindowDuration.seconds=30 +apicurio.metrics.PersistenceExceptionLivenessCheck.statusResetWindowDuration.seconds=60 apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold=5 -apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDurationSec=30 -apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.ResponseErrorLivenessCheck.counterResetWindowDuration.seconds=30 +apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDuration.seconds=60 apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=5 -apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDurationSec=30 -apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDuration.seconds=30 +apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDuration.seconds=60 apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=10 apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold=5 -apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDurationSec=30 -apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDurationSec=60 +apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDuration.seconds=30 +apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDuration.seconds=60 apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec=20 apicurio.liveness.errors.ignored= diff --git a/app/src/main/resources/application-test.properties b/app/src/main/resources/application-test.properties index 6859606182..dc3cbc1328 100644 --- a/app/src/main/resources/application-test.properties +++ b/app/src/main/resources/application-test.properties @@ -13,10 +13,10 @@ apicurio.events.kafka.config.bootstrap.servers=localhost:9092 # Metrics apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold=10000 apicurio.metrics.ResponseErrorLivenessCheck.errorThreshold=10000 -apicurio.metrics.ResponseErrorLivenessCheck.disableLogging=true +apicurio.metrics.ResponseErrorLivenessCheck.logging.disabled=true apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=10000 apicurio.metrics.PersistenceExceptionLivenessCheck.errorThreshold=10000 -apicurio.metrics.PersistenceExceptionLivenessCheck.disableLogging=true +apicurio.metrics.PersistenceExceptionLivenessCheck.logging.disabled=true #Log config apicurio.logconfigjob.every=1s diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index 7385af6445..3626e0b6d5 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -91,7 +91,7 @@ apicurio.auth.admin-override.claim=org-admin apicurio.auth.admin-override.claim-value=true # Cache -apicurio.storage.metrics.cache.check-period=30000 +apicurio.storage.metrics.cache.check-period.ms=30000 apicurio.storage.metrics.cache.max-size=1000 apicurio.limits.config.cache.check-period=30000 @@ -116,8 +116,8 @@ apicurio.auth.anonymous-read-access.enabled.dynamic.allow=${apicurio.config.dyna apicurio.ccompat.legacy-id-mode.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.ccompat.use-canonical-hash.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.ccompat.max-subjects.dynamic.allow=${apicurio.config.dynamic.allow-all} -apicurio.download.href.ttl.dynamic.allow=${apicurio.config.dynamic.allow-all} -apicurio.ui.features.readOnly.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.download.href.ttl.seconds.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.ui.features.read-only.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.rest.artifact.deletion.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.storage.read-only.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} @@ -137,12 +137,12 @@ apicurio.logconfigjob.every=5s apicurio.logconfigjob.delayed=1s # Redirects -apicurio.enable-redirects=true +apicurio.redirects.enabled=true apicurio.redirects.root=/,/apis # Rest -apicurio.rest.artifact.download.maxSize=1000000 -apicurio.rest.artifact.download.skipSSLValidation=false +apicurio.rest.artifact.download.maxSize.bytes=1000000 +apicurio.rest.artifact.download.sslValidation.disabled=false apicurio.rest.artifact.deletion.enabled=false # Api date format apicurio.apis.v2.date-format=yyyy-MM-dd'T'HH:mm:ss'Z' @@ -151,7 +151,7 @@ apicurio.apis.v2.date-format-timezone=UTC # Storage apicurio.storage.kind=sql ## SQL Storage -apicurio.storage.db-kind=h2 +apicurio.storage.sql.kind=h2 apicurio.datasource.url=jdbc:h2:mem:registry_db apicurio.datasource.username=sa apicurio.datasource.password=sa diff --git a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java index a918784db4..a7f71cf134 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/AdminResourceTest.java @@ -926,7 +926,7 @@ public void testConfigProperties() throws Exception { given() .when() .contentType(CT_JSON).body(update) - .pathParam("propertyName", "apicurio.download.href.ttl") + .pathParam("propertyName", "apicurio.download.href.ttl.seconds") .put("/registry/v3/admin/config/properties/{propertyName}") .then() .statusCode(400); diff --git a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java index 3cff52635e..b948d58596 100644 --- a/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java +++ b/app/src/test/java/io/apicurio/registry/rbac/RegistryClientTest.java @@ -1636,7 +1636,7 @@ public void testConfigProperties() throws Exception { // Try to set a Long property to "foobar" (should be invalid type) var exception2 = Assertions.assertThrows(ApiException.class, () -> { updateProp.setValue("foobar"); - clientV3.admin().config().properties().byPropertyName("apicurio.download.href.ttl").put(updateProp); + clientV3.admin().config().properties().byPropertyName("apicurio.download.href.ttl.seconds").put(updateProp); }); // InvalidPropertyValueException Assertions.assertEquals(400, exception2.getResponseStatusCode()); diff --git a/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java index 2d422d090e..a71d608278 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/GitopsTestProfile.java @@ -10,7 +10,7 @@ public class GitopsTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Map.of("apicurio.storage.db-kind", "h2", + return Map.of("apicurio.storage.sql.kind", "h2", "apicurio.storage.kind", "gitops"); } diff --git a/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java index 7e4eff13e5..7cd393a8a9 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/MssqlTestProfile.java @@ -11,7 +11,7 @@ public class MssqlTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("apicurio.storage.db-kind", "mssql"); + return Collections.singletonMap("apicurio.storage.sql.kind", "mssql"); } @Override diff --git a/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java b/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java index 4417186bd9..1182617f5e 100644 --- a/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java +++ b/app/src/test/java/io/apicurio/registry/storage/util/PostgresqlTestProfile.java @@ -11,7 +11,7 @@ public class PostgresqlTestProfile implements QuarkusTestProfile { @Override public Map getConfigOverrides() { - return Collections.singletonMap("apicurio.storage.db-kind", "postgresql"); + return Collections.singletonMap("apicurio.storage.sql.kind", "postgresql"); } @Override diff --git a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-azure.adoc b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-azure.adoc index 9956b32cc8..ce706365af 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-azure.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-azure.adoc @@ -76,7 +76,7 @@ IMPORTANT: You must register your {registry} application host as a *Redirect URI |`REGISTRY_OIDC_UI_REDIRECT_URL` |The host for your {registry} web console. |For example: `\https://test-registry.com/ui` -|`ROLE_BASED_AUTHZ_ENABLED` +|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION` |Enables role-based authorization in {registry}. |`true` |`QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH` diff --git a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc index 8d978c9716..117bcfd798 100644 --- a/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc +++ b/docs/modules/ROOT/partials/getting-started/proc-configuring-registry-security-keycloak.adoc @@ -102,7 +102,7 @@ TIP: For an example of setting environment variables on OpenShift, see xref:conf |Java system property |Type |Default value -|`ROLE_BASED_AUTHZ_ENABLED` +|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION` |`apicurio.auth.role-based-authorization` |Boolean |`false` diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index e09af1a4a3..9a651cf9a1 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -226,7 +226,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`apicurio.download.href.ttl` +|`apicurio.download.href.ttl.seconds` |`long [dynamic]` |`30` |`2.1.2.Final` @@ -374,7 +374,7 @@ The following {registry} configuration options are available for each component |`10` |`1.0.2.Final` |Timeout of response readiness check -|`apicurio.storage.metrics.cache.check-period` +|`apicurio.storage.metrics.cache.check-period.ms` |`long` |`30000` |`2.1.0.Final` @@ -503,7 +503,7 @@ The following {registry} configuration options are available for each component |Default |Available from |Description -|`apicurio.enable-redirects` +|`apicurio.redirects.enabled` |`boolean` | |`2.1.2.Final` @@ -539,12 +539,12 @@ The following {registry} configuration options are available for each component |`false` |`2.4.2-SNAPSHOT` |Enables artifact version deletion -|`apicurio.rest.artifact.download.maxSize` +|`apicurio.rest.artifact.download.maxSize.bytes` |`int` |`1000000` |`2.2.6-SNAPSHOT` |Max size of the artifact allowed to be downloaded from URL -|`apicurio.rest.artifact.download.skipSSLValidation` +|`apicurio.rest.artifact.download.sslValidation.disabled` |`boolean` |`false` |`2.2.6-SNAPSHOT` @@ -760,7 +760,7 @@ The following {registry} configuration options are available for each component |`true` |`2.0.0.Final` |SQL init -|`apicurio.storage.db-kind` +|`apicurio.storage.sql.kind` |`string` |`h2` |`3.0.0.Final` @@ -816,7 +816,7 @@ The following {registry} configuration options are available for each component |`true` |`3.0.0` |Enabled to show breadcrumbs in the UI -|`apicurio.ui.features.readOnly` +|`apicurio.ui.features.read-only.enabled` |`string` |`false` |`3.0.0` diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc index 1a226a87ce..9be84f94ce 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-security-configuration.adoc @@ -119,7 +119,7 @@ You can set the following options to `true` to enable role-based authorization i |`registry.auth.enabled` |Boolean |`false` -|`ROLE_BASED_AUTHZ_ENABLED` +|`APICURIO_AUTH_ROLE_BASED_AUTHORIZATION` |`apicurio.auth.role-based-authorization` |Boolean |`false` diff --git a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx index e94622cfc2..0bc76b615d 100644 --- a/ui/ui-app/src/app/pages/settings/SettingsPage.tsx +++ b/ui/ui-app/src/app/pages/settings/SettingsPage.tsx @@ -55,8 +55,8 @@ const PROPERTY_GROUPS: PropertyGroup[] = [ id: "console", label: "Web console settings", propertyNames: [ - "apicurio.download.href.ttl", - "apicurio.ui.features.readOnly" + "apicurio.download.href.ttl.seconds", + "apicurio.ui.features.read-only.enabled" ] }, ]; diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java index f525b20eca..fe5ca28534 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/MsSqlEmbeddedTestResource.java @@ -38,7 +38,7 @@ public Map start() { if ("mas".equals(currentEnv)) { Map props = new HashMap<>(); - props.put("apicurio.storage.db-kind", "mssql"); + props.put("apicurio.storage.sql.kind", "mssql"); props.put("apicurio.datasource.url", "jdbc:sqlserver://mssql;"); props.put("apicurio.datasource.username", "test"); props.put("apicurio.datasource.password", "test"); @@ -51,7 +51,7 @@ public Map start() { } private static boolean isMssqlStorage() { - return ConfigProvider.getConfig().getValue("apicurio.storage.db-kind", String.class).equals("mssql"); + return ConfigProvider.getConfig().getValue("apicurio.storage.sql.kind", String.class).equals("mssql"); } private Map startMsSql() { @@ -60,7 +60,7 @@ private Map startMsSql() { String datasourceUrl = database.getJdbcUrl(); Map props = new HashMap<>(); - props.put("apicurio.storage.db-kind", "mssql"); + props.put("apicurio.storage.sql.kind", "mssql"); props.put("apicurio.datasource.url", datasourceUrl); props.put("apicurio.datasource.username", "SA"); props.put("apicurio.datasource.password", DB_PASSWORD); diff --git a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java index 72c6d520cf..3be01b36fe 100644 --- a/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java +++ b/utils/tests/src/main/java/io/apicurio/registry/utils/tests/PostgreSqlEmbeddedTestResource.java @@ -25,7 +25,7 @@ public Map start() { if (currentEnv != null && "mas".equals(currentEnv)) { Map props = new HashMap<>(); - props.put("apicurio.storage.db-kind", "postgresql"); + props.put("apicurio.storage.sql.kind", "postgresql"); props.put("apicurio.datasource.url", "jdbc:postgresql://localhost:5432/test"); props.put("apicurio.datasource.username", "test"); props.put("apicurio.datasource.password", "test"); @@ -38,7 +38,7 @@ public Map start() { } private static boolean isPostgresqlStorage() { - return ConfigProvider.getConfig().getValue("apicurio.storage.db-kind", String.class).equals("postgresql"); + return ConfigProvider.getConfig().getValue("apicurio.storage.sql.kind", String.class).equals("postgresql"); } private Map startPostgresql() { @@ -51,7 +51,7 @@ private Map startPostgresql() { String datasourceUrl = database.getJdbcUrl("postgres", "postgres"); Map props = new HashMap<>(); - props.put("apicurio.storage.db-kind", "postgresql"); + props.put("apicurio.storage.sql.kind", "postgresql"); props.put("apicurio.datasource.url", datasourceUrl); props.put("apicurio.datasource.username", "postgres"); props.put("apicurio.datasource.password", "postgres"); From 9fe9a0f6cf1de77749e99dc2f66c0ce95c03c3bf Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Wed, 24 Apr 2024 17:44:37 +0200 Subject: [PATCH 12/13] Fix sql storage kind in integration tests --- .../src/test/resources/infra/sql/registry-sql-secured.yml | 2 +- integration-tests/src/test/resources/infra/sql/registry-sql.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml index de93e131ef..3b7ff47d9a 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql-secured.yml @@ -21,7 +21,7 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: APICURIO_STORAGE_DB_KIND + - name: APICURIO_STORAGE_SQL_KIND value: "postgresql" - name: APICURIO_DATASOURCE_URL value: jdbc:postgresql://postgresql-service:5432/registry diff --git a/integration-tests/src/test/resources/infra/sql/registry-sql.yml b/integration-tests/src/test/resources/infra/sql/registry-sql.yml index 3fa9ba651f..8d15d959e9 100644 --- a/integration-tests/src/test/resources/infra/sql/registry-sql.yml +++ b/integration-tests/src/test/resources/infra/sql/registry-sql.yml @@ -21,7 +21,7 @@ spec: valueFrom: fieldRef: fieldPath: metadata.namespace - - name: APICURIO_STORAGE_DB_KIND + - name: APICURIO_STORAGE_SQL_KIND value: "postgresql" - name: APICURIO_DATASOURCE_URL value: jdbc:postgresql://postgresql-service:5432/registry From 95f54a82a0624f2cb2bcd82b55ec7fdd670066b3 Mon Sep 17 00:00:00 2001 From: Carles Arnal Date: Thu, 25 Apr 2024 10:30:54 +0200 Subject: [PATCH 13/13] Fix remaining properties issues --- README.md | 6 +++--- .../health/readiness/PersistenceTimeoutReadinessCheck.java | 2 +- .../health/readiness/ResponseTimeoutReadinessCheck.java | 2 +- .../storage/decorator/ReadOnlyRegistryStorageDecorator.java | 2 +- app/src/main/resources/application-prod.properties | 4 ++-- app/src/main/resources/application.properties | 2 +- .../storage/impl/readonly/ReadOnlyRegistryStorageTest.java | 2 +- .../partials/getting-started/ref-registry-all-configs.adoc | 6 +++--- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c594a98d67..a6c9f6347d 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ Starting with Apicurio Registry 3.0, we now produce a single artifact suitable f Which storage variant will be used is determined by the following configuration: -|Option|Command argument|Env. variable| -|---|---|---| -|Registry Storage Variant|`-Dapicurio.storage.kind`|`REGISTRY_STORAGE_KIND`| +|Option|Command argument| Env. variable | +|---|---|-------------------------| +|Registry Storage Variant|`-Dapicurio.storage.kind`| `APICURIO_STORAGE_KIND` | For this property, there are three possible values: - *sql* - for the SQL storage variant. diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java index 1ec031c158..5c0c9005ea 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/PersistenceTimeoutReadinessCheck.java @@ -54,7 +54,7 @@ public class PersistenceTimeoutReadinessCheck extends AbstractErrorCounterHealth /** * Set the operation duration in seconds, after which it's considered an error. */ - @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec", defaultValue = "15") + @ConfigProperty(name = "apicurio.metrics.PersistenceTimeoutReadinessCheck.timeout.seconds", defaultValue = "15") @Info(category = "health", description = "Timeout of persistence readiness check", availableSince = "1.0.2.Final") Integer configTimeoutSec; diff --git a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java index 18ae7aa571..cd3ea60895 100644 --- a/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java +++ b/app/src/main/java/io/apicurio/registry/metrics/health/readiness/ResponseTimeoutReadinessCheck.java @@ -63,7 +63,7 @@ public class ResponseTimeoutReadinessCheck extends AbstractErrorCounterHealthChe * Set the request duration in seconds, after which it's considered an error. * TODO This may be expected on some endpoints. Add a way to ignore those. */ - @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec", defaultValue = "10") + @ConfigProperty(name = "apicurio.metrics.ResponseTimeoutReadinessCheck.timeout.seconds", defaultValue = "10") @Info(category = "health", description = "Timeout of response readiness check", availableSince = "1.0.2.Final") Instance configTimeoutSec; diff --git a/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java b/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java index ffba257038..529455a0c2 100644 --- a/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java +++ b/app/src/main/java/io/apicurio/registry/storage/decorator/ReadOnlyRegistryStorageDecorator.java @@ -47,7 +47,7 @@ @ApplicationScoped public class ReadOnlyRegistryStorageDecorator extends RegistryStorageDecoratorReadOnlyBase implements RegistryStorageDecorator { - public static final String READ_ONLY_MODE_ENABLED_PROPERTY_NAME = "apicurio.storage.read-only"; + public static final String READ_ONLY_MODE_ENABLED_PROPERTY_NAME = "apicurio.storage.read-only.enabled"; @Dynamic(label = "Storage read-only mode", description = "When selected, " + diff --git a/app/src/main/resources/application-prod.properties b/app/src/main/resources/application-prod.properties index 1e64eb99f9..af407c11d3 100644 --- a/app/src/main/resources/application-prod.properties +++ b/app/src/main/resources/application-prod.properties @@ -9,11 +9,11 @@ apicurio.metrics.ResponseErrorLivenessCheck.statusResetWindowDuration.seconds=60 apicurio.metrics.PersistenceTimeoutReadinessCheck.errorThreshold=5 apicurio.metrics.PersistenceTimeoutReadinessCheck.counterResetWindowDuration.seconds=30 apicurio.metrics.PersistenceTimeoutReadinessCheck.statusResetWindowDuration.seconds=60 -apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec=10 +apicurio.metrics.PersistenceTimeoutReadinessCheck.timeout.seconds=10 apicurio.metrics.ResponseTimeoutReadinessCheck.errorThreshold=5 apicurio.metrics.ResponseTimeoutReadinessCheck.counterResetWindowDuration.seconds=30 apicurio.metrics.ResponseTimeoutReadinessCheck.statusResetWindowDuration.seconds=60 -apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec=20 +apicurio.metrics.ResponseTimeoutReadinessCheck.timeout.seconds=20 apicurio.liveness.errors.ignored= diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties index 3626e0b6d5..f3d6949177 100644 --- a/app/src/main/resources/application.properties +++ b/app/src/main/resources/application.properties @@ -119,7 +119,7 @@ apicurio.ccompat.max-subjects.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.download.href.ttl.seconds.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.ui.features.read-only.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.rest.artifact.deletion.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} -apicurio.storage.read-only.dynamic.allow=${apicurio.config.dynamic.allow-all} +apicurio.storage.read-only.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} apicurio.authn.basic-client-credentials.enabled.dynamic.allow=${apicurio.config.dynamic.allow-all} # Error diff --git a/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java b/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java index e95c018da5..0794de2bf3 100644 --- a/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java +++ b/app/src/test/java/io/apicurio/registry/storage/impl/readonly/ReadOnlyRegistryStorageTest.java @@ -159,7 +159,7 @@ public class ReadOnlyRegistryStorageTest { void readOnlyTest() { notEnabled(); var dto = new DynamicConfigPropertyDto(); - dto.setName("apicurio.storage.read-only"); + dto.setName("apicurio.storage.read-only.enabled"); dto.setValue("true"); storage.setConfigProperty(dto); enabled(); diff --git a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc index 9a651cf9a1..f02bc2a480 100644 --- a/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc +++ b/docs/modules/ROOT/partials/getting-started/ref-registry-all-configs.adoc @@ -329,7 +329,7 @@ The following {registry} configuration options are available for each component |`300` |`1.0.2.Final` |Status reset window duration of persistence readiness check -|`apicurio.metrics.PersistenceTimeoutReadinessCheck.timeoutSec` +|`apicurio.metrics.PersistenceTimeoutReadinessCheck.timeout.seconds` |`integer` |`15` |`1.0.2.Final` @@ -369,7 +369,7 @@ The following {registry} configuration options are available for each component |`300` |`1.0.2.Final` |Status reset window duration of response readiness check -|`apicurio.metrics.ResponseTimeoutReadinessCheck.timeoutSec` +|`apicurio.metrics.ResponseTimeoutReadinessCheck.timeout.seconds` |`instance` |`10` |`1.0.2.Final` @@ -770,7 +770,7 @@ The following {registry} configuration options are available for each component | |`3.0.0.Final` |Application storage variant, for example, sql, kafkasql, or gitops -|`apicurio.storage.read-only` +|`apicurio.storage.read-only.enabled` |`boolean [dynamic]` |`false` |`2.5.0.Final`