community.sops.sops vars – Loading sops-encrypted vars files
Note
This vars plugin is part of the community.sops collection (version 1.6.7).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.sops.
To use it in a playbook, specify: community.sops.sops.
New in community.sops 0.1.0
Synopsis
Load encrypted YAML files into corresponding groups/hosts in group_vars/ and host_vars/ directories.
Files are encrypted prior to reading, making this plugin an effective companion to host_group_vars plugin.
Files are restricted to .sops.yaml, .sops.yml, .sops.json extensions.
Hidden files are ignored.
Parameters
Parameter |
Comments |
|---|---|
Temporarily disable this plugin. Useful if ansible-inventory is supposed to be run without decrypting secrets (in AWX for instance). Choices:
Configuration:
|
|
Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these. This affects vars_files, include_vars, inventory and vars plugins among others. Default: |
|
One or more age private keys that can be used to decrypt encrypted files. Will be set as the Configuration:
|
|
The file containing the age private keys that sops can use to decrypt encrypted files. Will be set as the By default, sops looks for Configuration:
|
|
The AWS access key ID to use for requests to AWS. Sets the environment variable Configuration:
|
|
The AWS profile to use for requests to AWS. This corresponds to the sops Configuration:
|
|
The AWS secret access key to use for requests to AWS. Sets the environment variable Configuration:
|
|
The AWS session token to use for requests to AWS. Sets the environment variable Configuration:
|
|
Whether to cache decrypted files or not. If the cache is disabled, the files will be decrypted for almost every task. This is very slow! Only disable caching if you modify the variable files during a playbook run and want the updated result to be available from the next task on. Note that setting Choices:
Configuration:
|
|
Path to the sops configuration file. If not set, sops will recursively search for the config file starting at the file that is encrypted or decrypted. This corresponds to the sops Configuration:
|
|
Tell sops to use local key service. This corresponds to the sops Choices:
Configuration:
|
|
Specify key services to use next to the local one. A key service must be specified in the form This corresponds to the sops Configuration:
|
|
Path to the sops binary. By default uses Configuration:
|
|
Control when this vars plugin may be executed. Setting this option to Setting this option to Setting this option to If this option is omitted, the global RUN_VARS_PLUGINS configuration is used to determine when to execute the vars plugin. Choices:
Configuration:
|
See Also
See also
- community.sops.sops lookup plugin
The sops lookup can be used decrypt sops-encrypted files.
- community.sops.decrypt filter plugin
The decrypt filter can be used to descrypt sops-encrypted in-memory data.
- community.sops.load_vars
Load sops-encrypted variables from files, dynamically within a task.