@spec astarte_instance(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Name of the Kubernetes instance of astarte which Flow will connect to

Calling Astarte.Flow.Config.astarte_instance() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_ASTARTE_INSTANCE"
• Type: :binary
• Default: "astarte"
• Required: false
• Cached: true

@spec astarte_instance!(Skogsra.Env.namespace()) :: binary() | no_return()

Name of the Kubernetes instance of astarte which Flow will connect to

Bang version of Astarte.Flow.Config.astarte_instance/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection!() :: [options()]

Returns the default amqp connection parameters

@spec default_amqp_connection_host(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Default RabbitMQ connection host

Calling Astarte.Flow.Config.default_amqp_connection_host() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_HOST"
• Type: :binary
• Default: "astarte"
• Required: false
• Cached: true

@spec default_amqp_connection_host!(Skogsra.Env.namespace()) :: binary() | no_return()

Default RabbitMQ connection host

Bang version of Astarte.Flow.Config.default_amqp_connection_host/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_password(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Default RabbitMQ connection password

Calling Astarte.Flow.Config.default_amqp_connection_password() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_PASSWORD"
• Type: :binary
• Default: "astarte"
• Required: false
• Cached: true

@spec default_amqp_connection_password!(Skogsra.Env.namespace()) ::
  binary() | no_return()

Default RabbitMQ connection password

Bang version of Astarte.Flow.Config.default_amqp_connection_password/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_port(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Default RabbitMQ connection port

Calling Astarte.Flow.Config.default_amqp_connection_port() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_PORT"
• Type: :integer
• Default: 5672
• Required: false
• Cached: true

@spec default_amqp_connection_port!(Skogsra.Env.namespace()) ::
  integer() | no_return()

Default RabbitMQ connection port

Bang version of Astarte.Flow.Config.default_amqp_connection_port/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_ssl_ca_file(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Specifies the certificates of the root Certificate Authorities to be trusted. When not specified, the bundled cURL certificate bundle will be used.

Calling Astarte.Flow.Config.default_amqp_connection_ssl_ca_file() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_SSL_CA_FILE"
• Type: :binary
• Default: nil
• Required: false
• Cached: true

@spec default_amqp_connection_ssl_ca_file!(Skogsra.Env.namespace()) ::
  (nil | binary()) | no_return()

Specifies the certificates of the root Certificate Authorities to be trusted. When not specified, the bundled cURL certificate bundle will be used.

Bang version of Astarte.Flow.Config.default_amqp_connection_ssl_ca_file/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_ssl_custom_sni(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Specify the hostname to be used in TLS Server Name Indication extension. If not specified, the amqp host will be used. This value is used only if Server Name Indication is enabled.

Calling Astarte.Flow.Config.default_amqp_connection_ssl_custom_sni() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_SSL_CUSTOM_SNI"
• Type: :binary
• Default: nil
• Required: false
• Cached: true

@spec default_amqp_connection_ssl_custom_sni!(Skogsra.Env.namespace()) ::
  (nil | binary()) | no_return()

Specify the hostname to be used in TLS Server Name Indication extension. If not specified, the amqp host will be used. This value is used only if Server Name Indication is enabled.

Bang version of Astarte.Flow.Config.default_amqp_connection_ssl_custom_sni/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_ssl_disable_sni(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Disable Server Name Indication. Defaults to false.

Calling Astarte.Flow.Config.default_amqp_connection_ssl_disable_sni() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_SSL_DISABLE_SNI"
• Type: :boolean
• Default: false
• Required: false
• Cached: true

@spec default_amqp_connection_ssl_disable_sni!(Skogsra.Env.namespace()) ::
  boolean() | no_return()

Disable Server Name Indication. Defaults to false.

Bang version of Astarte.Flow.Config.default_amqp_connection_ssl_disable_sni/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_ssl_enabled(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Enable SSL. If not specified SSL is disabled.

Calling Astarte.Flow.Config.default_amqp_connection_ssl_enabled() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_SSL_ENABLED"
• Type: :boolean
• Default: false
• Required: false
• Cached: true

@spec default_amqp_connection_ssl_enabled!(Skogsra.Env.namespace()) ::
  boolean() | no_return()

Enable SSL. If not specified SSL is disabled.

Bang version of Astarte.Flow.Config.default_amqp_connection_ssl_enabled/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_username(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Default RabbitMQ connection username

Calling Astarte.Flow.Config.default_amqp_connection_username() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_USERNAME"
• Type: :binary
• Default: "astarte"
• Required: false
• Cached: true

@spec default_amqp_connection_username!(Skogsra.Env.namespace()) ::
  binary() | no_return()

Default RabbitMQ connection username

Bang version of Astarte.Flow.Config.default_amqp_connection_username/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_connection_virtual_host(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Default RabbitMQ connection virtual host

Calling Astarte.Flow.Config.default_amqp_connection_virtual_host() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_CONNECTION_VIRTUAL_HOST"
• Type: :binary
• Default: "/"
• Required: false
• Cached: true

@spec default_amqp_connection_virtual_host!(Skogsra.Env.namespace()) ::
  binary() | no_return()

Default RabbitMQ connection virtual host

Bang version of Astarte.Flow.Config.default_amqp_connection_virtual_host/0 (fails on error). Optionally, receives the namespace for the variable.

@spec default_amqp_prefetch_count(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Default RabbitMQ prefetch count for each channel

Calling Astarte.Flow.Config.default_amqp_prefetch_count() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DEFAULT_AMQP_PREFETCH_COUNT"
• Type: :integer
• Default: 100
• Required: false
• Cached: true

@spec default_amqp_prefetch_count!(Skogsra.Env.namespace()) :: integer() | no_return()

Default RabbitMQ prefetch count for each channel

Bang version of Astarte.Flow.Config.default_amqp_prefetch_count/0 (fails on error). Optionally, receives the namespace for the variable.

@spec disable_authentication(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Calling Astarte.Flow.Config.disable_authentication() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_DISABLE_AUTHENTICATION"
• Type: :boolean
• Default: false
• Required: false
• Cached: true

@spec disable_authentication!(Skogsra.Env.namespace()) :: boolean() | no_return()

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Bang version of Astarte.Flow.Config.disable_authentication/0 (fails on error). Optionally, receives the namespace for the variable.

@spec persistency_dir(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

The directory where Flow will persist its dets tables

Calling Astarte.Flow.Config.persistency_dir() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_PERSISTENCY_DIR"
• Type: :binary
• Default: ""
• Required: false
• Cached: true

@spec persistency_dir!(Skogsra.Env.namespace()) :: binary() | no_return()

The directory where Flow will persist its dets tables

Bang version of Astarte.Flow.Config.persistency_dir/0 (fails on error). Optionally, receives the namespace for the variable.

@spec put_astarte_instance(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.astarte_instance/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_host(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_host/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_password(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_password/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_port(integer(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_port/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_ssl_ca_file(nil | binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_ssl_ca_file/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_ssl_custom_sni(
  nil | binary(),
  Skogsra.Env.namespace()
) :: :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_ssl_custom_sni/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_ssl_disable_sni(boolean(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_ssl_disable_sni/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_ssl_enabled(boolean(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_ssl_enabled/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_username(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_username/0. Optionally, receives the namespace.

@spec put_default_amqp_connection_virtual_host(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_connection_virtual_host/0. Optionally, receives the namespace.

@spec put_default_amqp_prefetch_count(integer(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.default_amqp_prefetch_count/0. Optionally, receives the namespace.

@spec put_disable_authentication(boolean(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.disable_authentication/0. Optionally, receives the namespace.

@spec put_persistency_dir(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.persistency_dir/0. Optionally, receives the namespace.

@spec put_realm_public_key_provider(
  nil | Astarte.Flow.Auth.RealmPublicKeyProvider.t(),
  Skogsra.Env.namespace()
) :: :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.realm_public_key_provider/0. Optionally, receives the namespace.

@spec put_realm_public_keys_dir(nil | binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.realm_public_keys_dir/0. Optionally, receives the namespace.

@spec put_target_namespace(binary(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.target_namespace/0. Optionally, receives the namespace.

@spec put_xandra_nodes(
  nil | Astarte.Flow.Config.XandraNodes.t(),
  Skogsra.Env.namespace()
) :: :ok | {:error, binary()}

Puts the value to Astarte.Flow.Config.xandra_nodes/0. Optionally, receives the namespace.

@spec realm_public_key_provider(Skogsra.Env.namespace()) ::
  {:ok, nil | Astarte.Flow.Auth.RealmPublicKeyProvider.t()} | {:error, binary()}

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Calling Astarte.Flow.Config.realm_public_key_provider() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_REALM_PUBLIC_KEY_PROVIDER"
• Type: Astarte.Flow.Auth.RealmPublicKeyProvider
• Default: nil
• Required: false
• Cached: true

@spec realm_public_key_provider!(Skogsra.Env.namespace()) ::
  (nil | Astarte.Flow.Auth.RealmPublicKeyProvider.t()) | no_return()

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Bang version of Astarte.Flow.Config.realm_public_key_provider/0 (fails on error). Optionally, receives the namespace for the variable.

@spec realm_public_keys_dir(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Calling Astarte.Flow.Config.realm_public_keys_dir() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_REALM_PUBLIC_KEYS_DIR"
• Type: :binary
• Default: nil
• Required: false
• Cached: true

@spec realm_public_keys_dir!(Skogsra.Env.namespace()) ::
  (nil | binary()) | no_return()

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Bang version of Astarte.Flow.Config.realm_public_keys_dir/0 (fails on error). Optionally, receives the namespace for the variable.

@spec reload_astarte_instance(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.astarte_instance/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_host(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_host/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_password(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_password/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_port(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_port/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_ssl_ca_file(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_ssl_ca_file/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_ssl_custom_sni(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_ssl_custom_sni/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_ssl_disable_sni(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_ssl_disable_sni/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_ssl_enabled(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_ssl_enabled/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_username(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_username/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_connection_virtual_host(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_connection_virtual_host/0. Optionally, receives the namespace for the variable.

@spec reload_default_amqp_prefetch_count(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.default_amqp_prefetch_count/0. Optionally, receives the namespace for the variable.

@spec reload_disable_authentication(Skogsra.Env.namespace()) ::
  {:ok, boolean()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.disable_authentication/0. Optionally, receives the namespace for the variable.

@spec reload_persistency_dir(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.persistency_dir/0. Optionally, receives the namespace for the variable.

@spec reload_realm_public_key_provider(Skogsra.Env.namespace()) ::
  {:ok, nil | Astarte.Flow.Auth.RealmPublicKeyProvider.t()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.realm_public_key_provider/0. Optionally, receives the namespace for the variable.

@spec reload_realm_public_keys_dir(Skogsra.Env.namespace()) ::
  {:ok, nil | binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.realm_public_keys_dir/0. Optionally, receives the namespace for the variable.

@spec reload_target_namespace(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.target_namespace/0. Optionally, receives the namespace for the variable.

@spec reload_xandra_nodes(Skogsra.Env.namespace()) ::
  {:ok, nil | Astarte.Flow.Config.XandraNodes.t()} | {:error, binary()}

Reloads the value for Astarte.Flow.Config.xandra_nodes/0. Optionally, receives the namespace for the variable.

@spec target_namespace(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Kubernetes namespace where Flow will deploy its containers

Calling Astarte.Flow.Config.target_namespace() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "FLOW_TARGET_NAMESPACE"
• Type: :binary
• Default: "astarte"
• Required: false
• Cached: true

@spec target_namespace!(Skogsra.Env.namespace()) :: binary() | no_return()

Kubernetes namespace where Flow will deploy its containers

Bang version of Astarte.Flow.Config.target_namespace/0 (fails on error). Optionally, receives the namespace for the variable.

@spec template(Path.t(), keyword()) :: :ok | {:error, File.posix()}

Creates a template for OS environment variables given a filename. Additionally, it can receive a list of options:

• type: What kind of file it will generate (:elixir, :unix, :windows).
• namespace: Namespace for the variables.

@spec validate(Skogsra.Env.namespace()) :: :ok | {:error, [binary()]}

Validates that all required variables are present. Returns :ok if they are, {:error, errors} if they are not. errors will be a list of all errors encountered while getting required variables.

It is possible to provide a namespace as argument (defaults to nil).

@spec validate!(Skogsra.Env.namespace()) :: :ok | no_return()

Validates that all required variables are present. Returns :ok if they are, raises if they're not.

It is possible to provide a namespace as argument (defaults to nil).

@spec xandra_nodes(Skogsra.Env.namespace()) ::
  {:ok, nil | Astarte.Flow.Config.XandraNodes.t()} | {:error, binary()}

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Calling Astarte.Flow.Config.xandra_nodes() will ensure the following:

• Binding order: [:system, :config]
• OS environment variable: "CASSANDRA_NODES"
• Type: Astarte.Flow.Config.XandraNodes
• Default: nil
• Required: false
• Cached: true

@spec xandra_nodes!(Skogsra.Env.namespace()) ::
  (nil | Astarte.Flow.Config.XandraNodes.t()) | no_return()

Disables the authentication. CHANGING IT TO TRUE IS GENERALLY A REALLY BAD IDEA IN A PRODUCTION ENVIRONMENT, IF YOU DON'T KNOW WHAT YOU ARE DOING."

Bang version of Astarte.Flow.Config.xandra_nodes/0 (fails on error). Optionally, receives the namespace for the variable.