api

services.scl.api.enable#

Whether to enable SCL API service with etcd.

Type: boolean

Default: false

Example: true

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.mtls.enable#

Whether to enable Enables mTLS client authentication for the database.

Type: boolean

Default: false

Example: true

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.mtls.cert#

Path of the PEM-encoded mTLS client cert

Type: null or absolute path

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.mtls.key#

Path of the PEM-encoded mTLS client key

Type: null or string

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.tls.cert#

Path of the PEM-encoded etcd TLS certificate

Type: null or absolute path

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.tls.key#

Path of the PEM-encoded etcd TLS key

Type: null or string

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.db.url#

DB URI. Make sure to specify http / https according to your setup

Type: string

Default: "https://api.seven.example:2379"

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.ip#

IP address of the SCL API.

Type: string

Default: "0.0.0.0"

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.logLevel#

Any of OFF ERROR WARN INFO DEBUG TRACE

Type: one of “OFF”, “ERROR”, “WARN”, “INFO”, “DEBUG”, “TRACE”

Default: "INFO"

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.openFirewall#

Open the configured TCP port of the SCL API service in the firewall.

Type: boolean

Default: false

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.port#

TCP port of the SCL API

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8008

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.tls.caCert#

Path of the PEM-encoded CA certificate

Type: null or absolute path

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.tls.cert#

Path of the PEM-encoded SCL API TLS certificate

Type: null or absolute path

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.tls.crlFile#

Path of the PEM-encoded certificate revocation list (CRL) file

Type: null or absolute path

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.tls.key#

Path of the PEM-encoded SCL API TLS key

Type: null or string

Default: null

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix

services.scl.api.tls.mtls#

Enforce mTLS client authentication

Type: boolean

Default: true

Declared by: - /builds/alasca.cloud/scl/scl-management/nix/modules/scl-api.nix