mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
64 lines
2.2 KiB
ReStructuredText
64 lines
2.2 KiB
ReStructuredText
.. _sdb:
|
|
|
|
===============================
|
|
Storing Data in Other Databases
|
|
===============================
|
|
The SDB interface is designed to store and retrieve data that, unlike pillars
|
|
and grains, is not necessarily minion-specific. The initial design goal was to
|
|
allow passwords to be stored in a secure database, such as one managed by the
|
|
keyring package, rather than as plain-text files. However, as a generic database
|
|
interface, it could conceptually be used for a number of other purposes.
|
|
|
|
SDB was added to Salt in version Helium.
|
|
|
|
SDB Configuration
|
|
================
|
|
In order to use the SDB interface, a configuration profile must be set up in
|
|
either the master or minion configuration file. The configuration stanza
|
|
includes the name/ID that the profile will be referred to as, a ``driver``
|
|
setting, and any other arguments that are necessary for the SDB module that will
|
|
be used. For instance, a profile called ``mykeyring``, which uses the
|
|
``system`` service in the ``keyring`` module would look like:
|
|
|
|
.. code-block:: yaml
|
|
|
|
mykeyring:
|
|
driver: keyring
|
|
service: system
|
|
|
|
It is recommended to keep the name of the profile simple, as it is used in the
|
|
SDB URI as well.
|
|
|
|
|
|
SDB URIs
|
|
========
|
|
SDB is designed to make small database queries (hence the name, SDB) using a
|
|
compact URL. This allows users to reference a database value quickly inside
|
|
a number of Salt configuration areas, without a lot of overhead. The basic
|
|
format of an SDB URI is:
|
|
|
|
.. code-block:: yaml
|
|
|
|
sdb://<profile>/<args>
|
|
|
|
The profile refers to the configuration profile defined in either the master or
|
|
the minion configuration file. The args are specific to the module referred to
|
|
in the profile, but will typically only need to refer to the key of a
|
|
key/value pair inside the database. This is because the profile itself should
|
|
define as many other parameters as possible.
|
|
|
|
For example, a profile might be set up to reference credentials for a specific
|
|
OpenStack account. The profile might look like:
|
|
|
|
.. code-block:: yaml
|
|
|
|
kevinopenstack:
|
|
driver: keyring
|
|
service salt.cloud.openstack.kevin
|
|
|
|
And the URI used to reference the password might look like:
|
|
|
|
.. code-block:: yaml
|
|
|
|
sdb://kevinopenstack/password
|