diff --git a/README.md b/README.md deleted file mode 100644 index d1f1ab0..0000000 --- a/README.md +++ /dev/null @@ -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 -``` diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bbecca4 --- /dev/null +++ b/README.rst @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 5f4e095..5612822 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ~~~~~~~~~~~~~~~~~