ansible-role-luks/README.md

71 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2019-03-16 22:51:50 +00:00
# Ansible role: Luks
2021-09-12 21:58:11 +00:00
2024-07-05 08:07:03 +00:00
[![Version](https://img.shields.io/badge/latest_version-2.0.0-green.svg)](https://code.waks.be/nishiki/ansible-role-luks/releases)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://code.waks.be/nishiki/ansible-role-luks/src/branch/main/LICENSE)
2019-03-16 22:51:50 +00:00
Encrypt device with luks and mount this encrypted device
2019-03-16 22:51:50 +00:00
## Requirements
2024-07-05 06:31:35 +00:00
- Ansible >= 2.9
- Debian
- Bookworm
2019-03-16 22:51:50 +00:00
## Role variables
2024-07-05 06:31:35 +00:00
- `luks_devices` - array with the devices to encrypt
2019-03-16 22:51:50 +00:00
```yaml
- name: data_encrypted
device: /dev/sdx2
mount_point: /mnt/data_decrypted
fstype: ext4
cipher: aes
hash: sha256
passphrase: secret
2019-03-16 22:51:50 +00:00
```
## How to use
```yaml
2019-03-16 22:51:50 +00:00
- hosts: data
roles:
- luks
vars:
luks_devices:
- name: data_encrypted
device: /dev/loop0
fstype: ext4
mount_point: /mnt/data_decrypted
passphrase: secret
2019-03-16 22:51:50 +00:00
```
## Development
2021-09-12 21:58:11 +00:00
### Test with molecule and docker
2019-03-16 22:51:50 +00:00
2024-07-05 06:31:35 +00:00
- install libvirt on debian `apt install libvirt-dev qemu-system libvirt-clients libvirt-daemon-system`
- install [vagrant](https://www.vagrantup.com/docs/installation)
- install vagrant libvirt plusin `vagrant plugin install vagrant-libvirt`
- install `python3` and `python3-pip`
- install molecule and dependencies `pip3 install molecule python-vagrant molecule-vagrant ansible-lint pytest-testinfra yamllint`
- run `molecule test`
2019-03-16 22:51:50 +00:00
## License
```
Copyright (c) 2019 Adrien Waksberg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```