HQ
This page describe the Lenses Agent configuration.
Last updated
This page describe the Lenses Agent configuration.
Last updated
2024 © Lenses.io Ltd. Apache, Apache Kafka, Kafka and associated open source project names are trademarks of the Apache Software Foundation.
HQ's configuration is defined in the config.yaml file
To accept the Lenses , set the following in the lenses.conf file:
Without accepting the EULA the Agent will not start! See .
It has the following top level groups:
| Name | Required | Default | Type | Description |
|---|
Configures authentication and authorisation.
It has the following fields:
| Name | Required | Default | Type | Description |
|---|
Lists the names of the principals (users, service accounts) that have root access. Access control allows any API operation performed by such principals. Optional. If not set, it will default to [].
Configures everything involving the HTTP.
It has the following fields:
Sets the address the HTTP server listens at.
Example value: 127.0.0.1:80.
Sets the value of the "Access-Control-Allow-Origin" header. This is only relevant when serving the backend from a different origin than the UI. Optional. If not set, it will default to ["*"].
Sets the value of the "Access-Control-Allow-Credentials" header. This is only relevant when serving the backend from a different origin than the UI. Optional. If not set, it will default to false.
Sets the "Secure" attribute on authentication session cookies. When set, a browser sends such cookies not over unsecured HTTP (expect for localhost). If running Lenses HQ over unsecured HTTP, set this to false. Optional. If not set, it will default to true.
Contains TLS configuration. Please refer here for its structure.
Contains SAML2 IdP configuration.
It has the following fields:
Contains the IdP issued XML metadata blob.
Example value: <?xml version="1.0" ... (big blob of xml) </md:EntityDescriptor>.
Defines the base URL of Lenses HQ; the IdP redirects back to here on success.
Example value: https://hq.example.com.
Controls where the backend redirects to after having received a valid SAML2 assertion. Optional. If not set, it will default to /.
Example value: /.
Defines the Entity ID.
Example value: https://hq.example.com.
Sets the attribute name from which group names are extracted in the SAML2 assertions. Different providers use different names. Okta, Keycloak and Google use "groups". OneLogin uses "roles". Azure uses "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups". Optional. If not set, it will default to groups.
Example value: groups.
Controls how the creation of users should be handled in relation to SSO information. With the 'manual' mode, only users that currently exist in HQ can login. Users that do not exist are rejected. With the 'sso' mode, users that do not exist are automatically created. Allowed values are manual or sso. Optional. If not set, it will default to manual.
Controls how the management of a user's group membership should be handled in relation to SSO information. With the 'manual' mode, the information about the group membership returned from an Identity Provider will not be used and a user will only be a member of groups that were explicitly assigned to him locally. With the 'sso' mode, group information from Identity Provider (IdP) will be used. On login, a user's group membership is set to the groups listed in the IdP. Groups that do not exist in HQ are ignored. Allowed values are manual or sso. Optional. If not set, it will default to manual.
Controls the agent handling.
It has the following fields:
Sets the address the agent server listens at.
Example value: 127.0.0.1:3000.
Contains TLS configuration. Please refer here for its structure.
Contains TLS configuration.
It has the following fields:
Enables or disables TLS.
Example value: false.
Sets the PEM formatted public certificate. Optional. If not set, it will default to ``.
Example value: -----BEGIN CERTIFICATE----- EXampLeRanDoM ... -----END CERTIFICATE----- .
Sets the PEM formatted private key. Optional. If not set, it will default to ``.
Example value: -----BEGIN PRIVATE KEY----- ExAmPlErAnDoM ... -----END PRIVATE KEY----- .
Enables additional logging of TLS settings and events at debug level. The information presented might be a bit too much for day to day use but can provide extra information for troubleshooting TLS configuration. Optional. If not set, it will default to false.
Configures database settings.
It has the following fields:
Sets the name of the host to connect to. A comma-separated list of host names is also accepted; each host name in the list is tried in order.
Example value: postgres:5432.
Sets the username to authenticate as. Optional. If not set, it will default to ``.
Example value: johhnybingo.
Sets the password to authenticate as. Optional. If not set, it will default to ``.
Example value: my-password.
Sets the database to use.
Example value: my-database.
Sets the schema to use. Optional. If not set, it will default to ``.
Example value: my-schema.
Enables TLS. In PostgreSQL connection string terms, setting TLS to false corresponds to sslmode=disable; setting TLS to true corresponds to sslmode=verify-full. For more fine-grained control, specify sslmode in the params which takes precedence. Optional. If not set, it will default to false.
Example value: true.
Example value: {"application_name":"example"}.
Sets the logger behaviour.
It has the following fields:
Controls the format of the logger's output. Allowed values are text or json.
Controls the level of the logger. Allowed values are info or debug. Optional. If not set, it will default to info.
Controls the metrics settings.
It has the following fields:
Sets the address at which Prometheus metrics are served. Optional. If not set, it will default to :9090.
Holds the license key.
It has the following fields:
Sets the license key. An HQ key starts with "licensekey".
Accepts the Lenses EULA.
Contains SAML2 IdP configuration. Please refer for its structure.
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|
Contains connection string parameters as key/values pairs. It allow fine-grained control of connection settings. The parameters can be found here: Optional. If not set, it will default to {}.
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|
| Name | Required | Default | Type | Description |
|---|