Complete update README

Change-Id: Icf300b02b71680c0f443506444d13b3cc06d45e2
This commit is contained in:
Ivan Anfimov
2025-05-02 19:21:56 +00:00
parent d497a37e79
commit d808b6fe49
3 changed files with 31 additions and 52 deletions

View File

@@ -1,49 +0,0 @@
#### Ansible systemd_mount
This Ansible role configures systemd mount files.
This role requires the ``ansible-config_template`` collection to be available
on your local system.
To get collection you can use use the ``ansible-galaxy`` command on the
``requirements.yml`` file.. You need to install collection **before**
running this role.
``` bash
# ansible-galaxy install -r requirements.yml
```
Release notes for the project can be found at:
https://docs.openstack.org/releasenotes/ansible-role-systemd_mount
----
###### Example playbook
> See the "defaults.yml" file for a full list of all available options.
``` yaml
- name: Create a systemd mount file for Mount1 and 2
hosts: localhost
become: true
roles:
- role: "systemd_mount"
systemd_mounts:
- what: '/var/lib/machines.raw'
where: '/var/lib/machines'
type: 'btrfs'
options: 'loop'
unit:
ConditionPathExists:
- '/var/lib/machines.raw'
state: 'started'
enabled: true
- config_overrides: {}
what: "10.1.10.1:/srv/nfs"
where: "/var/lib/glance/images"
type: "nfs"
options: "_netdev,auto"
unit:
After:
- network.target
```

20
README.rst Normal file
View File

@@ -0,0 +1,20 @@
========================================
systemd_mount role for OpenStack-Ansible
========================================
This role will configure Systemd units.
Documentation for the project can be found at:
https://docs.openstack.org/ansible-role-systemd_mount/latest
Release notes for the project can be found at:
https://docs.openstack.org/releasenotes/ansible-role-systemd_mount/
The project source code repository is located at:
https://opendev.org/openstack/ansible-role-systemd_mount
The project home is at:
https://launchpad.net/openstack-ansible
The project bug tracker is located at:
https://bugs.launchpad.net/openstack-ansible

View File

@@ -2,11 +2,19 @@
systemd_mount role for OpenStack-Ansible
========================================
:tags: openstack, systemd_mount, cloud, ansible
:category: \*nix
This role will configure Systemd units:
This role requires the ``ansible-config_template`` collection to be available
on your local system.
To get collection you can use use the ``ansible-galaxy`` command on the
``requirements.yml`` file. You need to install collection **before**
running this role.
.. code-block:: bash
ansible-galaxy install -r requirements.yml
Default variables
~~~~~~~~~~~~~~~~~