Skip to content

Latest commit

 

History

History
663 lines (499 loc) · 25.2 KB

quarkus-authzed.adoc

File metadata and controls

663 lines (499 loc) · 25.2 KB

[lock] Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in 'dev' or 'test' mode.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_ENABLED

boolean

true

The container image name to use, for container based DevServices providers.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_IMAGE_NAME

string

Indicates if the Authzed instance managed by Quarkus DevServices is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, DevServices for Authzed starts a new container. The discovery uses the quarkus-dev-service-openfga label. The value is configured using the service-name property. Container sharing is only used in 'dev' mode.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_SHARED

boolean

true

The value of the quarkus-dev-service-authzed label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, DevServices for Authzed looks for a container with the quarkus-dev-service-openfga label set to the configured value. If found, it will use this container instead of starting a new one, otherwise it starts a new container with the quarkus-dev-service-openfga label set to the specified value. This property is used when you need multiple shared Authzed instances.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_SERVICE_NAME

string

authzed

Schema to upload during DevServices initialization.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_SCHEMA

string

Location of schema file to upload during DevServices initialization. The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_SCHEMA_LOCATION

string

Authorization tuples to upload during DevServices initialization.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_AUTHORIZATION_TUPLES

string

Location of authorization tuples file to upload during DevServices initialization. The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_AUTHORIZATION_TUPLES_LOCATION

string

Flag to enable grpc (defaults to true)

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_ENABLED

boolean

true

The container port the grpc will be bound to.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_PORT

int

50051

Optional host port the grpc will be bound to. If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_HOST_PORT

int

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_TLS_CERT_PATH

string

The path to the TLS key.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_TLS_KEY_PATH

string

The preshared key used to initalize the server. Corresponds to the value passed to the --grpc-preshared-key argument of the serve command.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_GRPC_PRESHARED_KEY

string

test

Flag to enable dashboard (defaults to true)

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_DASHBOARD_ENABLED

boolean

true

The container port the dashboard will be bound to.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_DASHBOARD_PORT

int

8443

Optional host port the dashboard will be bound to. If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_DASHBOARD_HOST_PORT

int

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_DASHBOARD_TLS_CERT_PATH

string

The path to the TLS key.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_DASHBOARD_TLS_KEY_PATH

string

Flag to enable http (defaults to true)

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_HTTP_ENABLED

boolean

true

The container port the http will be bound to.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_HTTP_PORT

int

8080

Optional host port the http will be bound to. If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_HTTP_HOST_PORT

int

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_HTTP_TLS_CERT_PATH

string

The path to the TLS key.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_HTTP_TLS_KEY_PATH

string

Flag to enable http (defaults to true)

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_METRICS_ENABLED

boolean

true

The container port the http will be bound to.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_METRICS_PORT

int

9090

Optional host port the http will be bound to. If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_METRICS_HOST_PORT

int

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_METRICS_TLS_CERT_PATH

string

The path to the TLS key.

Environment variable: QUARKUS_AUTHZED_DEVSERVICES_METRICS_TLS_KEY_PATH

string

Authzed URL. Example: http://authzed:50051

Environment variable: QUARKUS_AUTHZED_URL

URL

required [exclamation circle]

The token to use to connect.

Environment variable: QUARKUS_AUTHZED_TLS_ENABLED

boolean

false

The path to the file that holds certificates from Certified Authorities.

Environment variable: QUARKUS_AUTHZED_TLS_CA_CERT_PATH

string

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_TLS_CERT_PATH

string

The path to the TLS certificate.

Environment variable: QUARKUS_AUTHZED_TLS_KEY_PATH

string

The TLS key file passphrase.

Environment variable: QUARKUS_AUTHZED_TLS_KEY_PASSPHRASE

string

The TLS key file passphrase.

Environment variable: QUARKUS_AUTHZED_TLS_KEY_ALGO

string

The token to use to connect.

Environment variable: QUARKUS_AUTHZED_TOKEN

string

required [exclamation circle]

Time in mills to wait without read activity before sending the keep alive ping.

Environment variable: QUARKUS_AUTHZED_KEEP_ALIVE_TIME

int

Time in mills to wait without read activity after sending the keep alive ping.

Environment variable: QUARKUS_AUTHZED_KEEP_ALIVE_TIMEOUT

int

Time in mills to wait before going to idle mode.

Environment variable: QUARKUS_AUTHZED_IDLE_TIMEOUT

int