Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertdebock/ansible-role-luks

Create encrypted devices using luks and open them at boot.
https://github.com/robertdebock/ansible-role-luks

ansible crypto luks molecule playbook system tox

Last synced: 7 days ago
JSON representation

Create encrypted devices using luks and open them at boot.

Host: GitHub
URL: https://github.com/robertdebock/ansible-role-luks
Owner: robertdebock
License: apache-2.0
Created: 2021-01-18T15:16:52.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-04-26T13:59:49.000Z (7 months ago)
Last Synced: 2024-05-02T02:19:52.547Z (7 months ago)
Topics: ansible, crypto, luks, molecule, playbook, system, tox
Homepage: https://robertdebock.nl/
Size: 83 KB
Stars: 6
Watchers: 3
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # [Ansible role luks](#luks)

Create encrypted devices using luks and open them at boot.

|GitHub|GitLab|Downloads|Version|

|------|------|---------|-------|

|[![github](https://github.com/robertdebock/ansible-role-luks/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-luks/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-luks/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-luks)|[![downloads](https://img.shields.io/ansible/role/d/robertdebock/luks)](https://galaxy.ansible.com/robertdebock/luks)|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-luks.svg)](https://github.com/robertdebock/ansible-role-luks/releases/)|

## [Example Playbook](#example-playbook)

This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-luks/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.

```yaml

---

- name: Converge

  hosts: all

  become: true

  gather_facts: true

  roles:

    - role: robertdebock.luks

```

The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-luks/blob/master/molecule/default/prepare.yml):

```yaml

---

- name: Prepare

  hosts: all

  become: true

  gather_facts: false

  roles:

    - role: robertdebock.bootstrap

```

Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.

## [Role Variables](#role-variables)

The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-luks/blob/master/defaults/main.yml):

```yaml

---

# defaults file for luks

# The state of luks devices if not mentioned specifically.

luks_default_state: opened

# A list of devices to encrypt.

luks_devices: []

# For example:

# luks_devices:

#   - device: /dev/loop0

#     name: luksdisk0

#     keyfile: /etc/luksdisk0.keyfile

```

## [Requirements](#requirements)

- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-luks/blob/master/requirements.txt).

## [State of used roles](#state-of-used-roles)

The following roles are used to prepare a system. You can prepare your system in another way.

| Requirement | GitHub | GitLab |

|-------------|--------|--------|

|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|

## [Context](#context)

This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.

Here is an overview of related roles:

![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-luks/png/requirements.png "Dependencies")

## [Compatibility](#compatibility)

This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):

|container|tags|

|---------|----|

|[Alpine](https://hub.docker.com/r/robertdebock/alpine)|all|

|[Amazon](https://hub.docker.com/r/robertdebock/amazonlinux)|Candidate|

|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|

|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|

|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|

|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|

The minimum version of Ansible required is 2.12, tests have been done to:

- The previous version.

- The current version.

- The development version.

If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-luks/issues).

## [License](#license)

[Apache-2.0](https://github.com/robertdebock/ansible-role-luks/blob/master/LICENSE).

## [Author Information](#author-information)

[robertdebock](https://robertdebock.nl/)

Please consider [sponsoring me](https://github.com/sponsors/robertdebock).