FerricStore.ManagementCapabilities behaviour (ferricstore v0.5.4)

Copy Markdown View Source

Public management capability contract.

Control-plane clients should use FERRICSTORE.CAPABILITIES over the SDK/native protocol. Deployments can override this module through application config.

Summary

Types

capabilities()

Callbacks

capabilities(keyword)

Functions

capabilities(opts \\ [])

Returns the configured server management capabilities.

default()

Returns the OSS baseline capability map.

Types

capabilities()

@type capabilities() :: %{
  :sdk => boolean(),
  :health => boolean(),
  :telemetry => boolean(),
  :acl_management => boolean(),
  :namespace_management => boolean(),
  :quota_management => boolean(),
  :flow_observability => boolean(),
  optional(atom() | binary()) => term()
}

Callbacks

capabilities(keyword)

@callback capabilities(keyword()) :: capabilities()

Functions

capabilities(opts \\ [])

@spec capabilities(keyword()) :: capabilities()

Returns the configured server management capabilities.

default()

@spec default() :: capabilities()

Returns the OSS baseline capability map.