22

✏️ Editing: openstack_config.py

"""
Modify, retrieve, or delete values from OpenStack configuration files.

:maintainer: Jeffrey C. Ollie <jeff@ocjtech.us>
:maturity: new
:depends:
:platform: linux

"""

import shlex

import salt.exceptions
import salt.utils.decorators.path

# Don't shadow built-in's.
__func_alias__ = {"set_": "set"}

def __virtual__():
    return True

def _fallback(*args, **kw):
    return (
        'The "openstack-config" command needs to be installed for this function to'
        ' work.  Typically this is included in the "openstack-utils" package.'
    )

@salt.utils.decorators.path.which("openstack-config")
def set_(filename, section, parameter, value):
    """
    Set a value in an OpenStack configuration file.

filename
        The full path to the configuration file

section
        The section in which the parameter will be set

parameter
        The parameter to change

value
        The value to set

CLI Example:

.. code-block:: bash

salt-call openstack_config.set /etc/keystone/keystone.conf sql connection foo
    """

filename = shlex.quote(filename)
    section = shlex.quote(section)
    parameter = shlex.quote(parameter)
    value = shlex.quote(str(value))

result = __salt__["cmd.run_all"](
        "openstack-config --set {} {} {} {}".format(
            filename, section, parameter, value
        ),
        python_shell=False,
    )

if result["retcode"] == 0:
        return result["stdout"]
    else:
        raise salt.exceptions.CommandExecutionError(result["stderr"])

@salt.utils.decorators.path.which("openstack-config")
def get(filename, section, parameter):
    """
    Get a value from an OpenStack configuration file.

filename
        The full path to the configuration file

section
        The section from which to search for the parameter

parameter
        The parameter to return

CLI Example:

.. code-block:: bash

salt-call openstack_config.get /etc/keystone/keystone.conf sql connection

"""

filename = shlex.quote(filename)
    section = shlex.quote(section)
    parameter = shlex.quote(parameter)

result = __salt__["cmd.run_all"](
        f"openstack-config --get {filename} {section} {parameter}",
        python_shell=False,
    )

if result["retcode"] == 0:
        return result["stdout"]
    else:
        raise salt.exceptions.CommandExecutionError(result["stderr"])

@salt.utils.decorators.path.which("openstack-config")
def delete(filename, section, parameter):
    """
    Delete a value from an OpenStack configuration file.

filename
        The full path to the configuration file

section
        The section from which to delete the parameter

parameter
        The parameter to delete

CLI Example:

.. code-block:: bash

salt-call openstack_config.delete /etc/keystone/keystone.conf sql connection
    """

filename = shlex.quote(filename)
    section = shlex.quote(section)
    parameter = shlex.quote(parameter)

result = __salt__["cmd.run_all"](
        f"openstack-config --del {filename} {section} {parameter}",
        python_shell=False,
    )

if result["retcode"] == 0:
        return result["stdout"]
    else:
        raise salt.exceptions.CommandExecutionError(result["stderr"])

MR SKB