Configclient

Classes

ConfigClient

ConfigClient(
    rucio_host=None,
    auth_host=None,
    account=None,
    ca_cert=None,
    auth_type=None,
    creds=None,
    timeout=600,
    user_agent="rucio-clients",
    vo=None,
    logger=LOG,
)

Client class for working with the configuration

Functions

get_config

get_config(section=None, option=None)

Sends the request to get the matching configuration.

PARAMETER	DESCRIPTION
section	The name of the section. TYPE: Optional[str] DEFAULT: None
option	The option within the section. TYPE: Optional[str] DEFAULT: None

set_config_option

set_config_option(
    section, option, value, use_body_for_params=True
)

Sends the request to create or set an option within a section. Missing sections will be created.

PARAMETER	DESCRIPTION
section	The name of the section. TYPE: str
option	The name of the option. TYPE: str
value	The value to set on the config option. TYPE: Any
use_body_for_params	Send parameters in a json-encoded request body instead of url-encoded. TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
bool	True if option was set successfully.

Note:

The format of the /config endpoint was recently changed. We migrated from performing a PUT on "/config/

//" to sending the parameters using a json-encoded body. This was done to fix multiple un-wanted side effects related to how the middleware treats values encoded in a path. For a smooth transition, we allow both cases for now, but we should migrate to only passing values via the request body.

delete_config_option

delete_config_option(section, option)

Sends the request to remove an option from a section.

PARAMETER	DESCRIPTION
section	The name of the section. TYPE: str
option	The name of the option. TYPE: str

RETURNS	DESCRIPTION
True if option was removed successfully.

Functions