Apply Payloads

chaos.lib.args.dataclasses.ApplyPayload

Bases: BasePayload

Payload for orchestrating the apply lifecycle of Ch-aOS.

This represents the core orchestration data structure required to resolve roles, configurations, secrets, and execute them on hosts.

Attributes:

Name	Type	Description
update_plugins	bool	If True, forces a refresh of the plugin cache before starting orchestration.
i_know_what_im_doing	bool	If True, bypasses all interactive confirmation prompts before execution.
dry	bool	If True, runs pyinfra in dry-run mode, calculating but not executing operations.
verbose	int	The verbosity level for Pyinfra output (1=Warning, 2=Info, 3=Debug).
v	int	An alias for the verbosity level.
tags	list[str]	The list of role tags or aliases to apply to the target hosts.
chobolo	str | None	Optional path to explicitly override the Ch-obolo configuration file to use.
limani	str | None	Optional Limani plugin name to use for the Logbook database.
logbook	bool	If True, enables telemetry and execution recording into the Logbook.
fleet	bool	If True, parses the fleet configuration and orchestrates changes across all remote hosts defined.
sudo_password_file	str | None	Optional path to a file containing the sudo password.
password	str | None	Optional string containing the sudo password.
secrets	bool	If True, signals that the operations require secrets and that they must be decrypted.
serial	bool	If True, executes pyinfra operations serially across the fleet instead of in parallel.
no_wait	bool	If True, executes pyinfra operations concurrently without waiting for slow hosts.
export_logs	bool	If True, exports the telemetry logbook to a JSON file after the run finishes.
secrets_context	SecretsContext | dict[str, Any]	The context containing secret file paths and provider configurations.
confirmed_password	str	Internal state holding the verified sudo password if gathered interactively.
pyinfra_state	State | None	Internal state storing the initialized pyinfra State object after setup.
target_hosts	list | None	Internal state containing the parsed list of hosts to apply the roles to.
is_fleet_active	bool	Internal state tracking whether a remote fleet is actively being targeted.
parallelism	int	Internal state tracking the maximum number of concurrent hosts to apply changes to.
fallback_to_local	bool	Internal state tracking if fleet failed to resolve and fallback to local was permitted.
decrypted_secrets	dict[str, Any] | None	Internal state caching the decrypted YAML/JSON secrets dictionary for role consumption.
global_config	dict[str, Any] | None	Internal state caching the global ~/.config/chaos/config.yml data.

chaos.lib.args.dataclasses.Delta

Bases: BasePayload

Delta Payload, used as return by the Role.delta() method.

Attributes:

Name	Type	Description
to_add(dict[str,	Any]	prettified dict for showing what is being changed as an ADDITION in CLI
to_remove(dict[str,	Any]	prettified dict for showing what is being changed as an REMOVAL in CLI
metadata(dict[str,	Any]	Other data (will not be shown in CLI)