Provider provisioning in Keep allows you to set up and manage data providers dynamically. This feature enables you to configure various data sources that Keep can interact with, such as monitoring systems, databases, or other services.
To provision providers and deduplication rules for them, we can configure via the environment variable. This can be done in two ways:
KEEP_PROVIDERS
environment variable which either contains a JSON string or a path to a JSON file that contains the providers configurations.KEEP_PROVIDERS_DIRECTORY
environment variable which contains a path to a directory that contains the providers configurations (configured via YAML files). This is the recommended approach.Keep does not allow to use both KEEP_PROVIDERS
and KEEP_PROVIDERS_DIRECTORY
environment variables at the same time.
Providers provisioning JSON example:
Spin up Keep with this KEEP_PROVIDERS
value:
Specify the path to the directory containing the providers configurations:
The directory should contain YAML files with the providers configurations.
Example of a provider configuration YAML file:
Keep supports a wide range of provider types. Each provider type has its own specific configuration requirements. To see the full list of supported providers and their detailed configuration options, please refer to our comprehensive provider documentation.
Provider configurations can be updated dynamically by changing the KEEP_PROVIDERS
environment variable.
On every restart, Keep reads this environment variable and determines which providers need to be added or removed.
This process allows for flexible management of data sources without requiring manual intervention. By simply updating the KEEP_PROVIDERS
variable and restarting the application, you can efficiently add new providers, remove existing ones, or modify their configurations.
The high-level provisioning mechanism:
KEEP_PROVIDERS
value.KEEP_PROVIDERS
value, and deletes them.KEEP_PROVIDERS
value.Provider configurations can be updated dynamically by changing the YAML files in the KEEP_PROVIDERS_DIRECTORY
directory.
On every restart, Keep reads the YAML files in the KEEP_PROVIDERS_DIRECTORY
directory and determines which providers need to be added or removed.
The high-level provisioning mechanism:
KEEP_PROVIDERS_DIRECTORY
directory.