ansible-role-luks/README.md

72 lines
1.7 KiB
Markdown
Raw Normal View History

2019-03-16 22:51:50 +00:00
# Ansible role: Luks
2019-03-16 22:53:25 +00:00
[![Version](https://img.shields.io/badge/latest_version-1.0.0-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-luks/releases)
2019-03-16 22:51:50 +00:00
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-luks/src/branch/master/LICENSE)
Encrypt device with luks
## Requirements
* Ansible >= 2.5
* Debian Stretch
## Role variables
* `luks_devices` - array with the devices to encrypt
```
- name: data_encrypted
device: /dev/sdx2
mount_point: /mnt/data_decrypted
fstype: ext4
cipher: aes-xts-plain
size: 256
key: secret
```
## How to use
```
- hosts: data
roles:
- luks
```
## Development
### Test syntax with yamllint
* install `python` and `python-pip`
* install yamllint `pip install yamllint`
* run `yamllint .`
### Test syntax with ansible-lint
* install `python` and `python-pip`
* install yamllint `pip install ansible-lint`
* run `ansible-lint .`
### Tests with docker
* install [docker](https://docs.docker.com/engine/installation/)
* install ruby
* install bundler `gem install bundler`
* install dependencies `bundle install`
* run the tests `kitchen test`
## 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.
```