diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..05c0349 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# changelog + +## 0.2.0 +* [role] ⚠️ rename `set_locale` to `locale_config` along with the variable names (prefix) +* [playbook] add `test_connection.yml` playbook which tests the connection to a target host including `become` +* [docs] update [README](README.md) to reflect the latest changes +* [docs] add READMEs for all roles +* [dev] changes regarding the development environment: + * add setup script + * add pip requirements files + * add vscode workspace file + +## 0.1.4 +anything before 0.2.0 see [commit history](https://gitea.wululu.de/dede/ansible-common/commits/branch/main) diff --git a/README.md b/README.md index d3116aa..eab4b32 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# Ansible Collection - dede.common +# Ansible Collection - `dede.common` +``` + _ _ + __| | ___ __| | ___ ___ ___ _ __ ___ _ __ ___ ___ _ __ + / _` |/ _ \/ _` |/ _ \ / __/ _ \| '_ ` _ \| '_ ` _ \ / _ \| '_ \ +| (_| | __/ (_| | __/| (_| (_) | | | | | | | | | | | (_) | | | | + \__,_|\___|\__,_|\___(_)___\___/|_| |_| |_|_| |_| |_|\___/|_| |_| +``` this ansible collection primarily aims to provide common roles that i've been building for either my home or the wululu web network and systems. @@ -8,17 +15,25 @@ please mind that everything in this collection mainly focuses debian as a server thus i will not add features specific to other operating systems unless i really need to. if you have any questions or suggestions feel free to get in touch with me. -## roles +## contents -* **test** – a simple role to test ansible or just this collection - it will run a debug task printing 'hello world' -* **config_locale** – role to configure system locale and language settings - you should set `system_locale` and `system_language` if you want to deviate from the default: - ``` - system_locale: 'de_DE.UTF-8' - system_language: 'en_US.UTF-8' - ``` -* **docker** – a docker install role that can install docker-ce engine in two ways: - 1. from the official docker repository (recommended by docker) - 2. from your distribution - you can switch to the distribution method by setting `docker_use_dist_repo` to `true` (defaults to `false`). +### roles +* **test** – a simple test role which runs a `debug` task printing 'hello world' +* **locale_config** – role to configure system locale and language settings [🠞README](roles/locale_config/README.md) +* **docker** – a docker install role to install docker-ce engine [🠞README](roles/docker/README.md) + +### playbooks +* **test_connection.yml** – a playbook to test ansible and connectivity by running the `test` and the role + +## usage +to use a **playbook** provided with this collection you can use `import_playbook`: +```yaml +- ansible.builtin.import_playbook: dede.common.test_connection.yml +``` + +to use a **role** provided with this collection just reference it using the collection name as a prefix: +```yaml +- hosts: all + roles: + - dede.common.test +``` diff --git a/galaxy.yml b/galaxy.yml index 1ea0a68..bfa7420 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -8,7 +8,7 @@ namespace: dede name: common # The version of the collection. Must be compatible with semantic versioning -version: 0.1.4 +version: 0.2.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md @@ -46,7 +46,7 @@ dependencies: {} repository: https://gitea.wululu.de/dede/ansible-common # The URL to any online docs -documentation: https://gitea.wululu.de/dede/ansible-common/wiki +documentation: https://gitea.wululu.de/dede/ansible-common/src/branch/main/README.md # The URL to the homepage of the collection/project homepage: https://gitea.wululu.de/dede/ansible-common @@ -66,4 +66,3 @@ build_ignore: [] # 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive # with 'build_ignore' # manifest: null - diff --git a/roles/docker/README.md b/roles/docker/README.md index 58f49e3..f97266d 100644 --- a/roles/docker/README.md +++ b/roles/docker/README.md @@ -1,5 +1,5 @@ -# docker role +# dede.common.docker -this role will simply install the docker engine (community edition) from the official docker repositories. +this role will simply ensure the docker engine (community edition) is installed from the official docker repositories. source: https://docs.docker.com/engine/install/debian/#install-using-the-repository diff --git a/roles/locale_config/README.md b/roles/locale_config/README.md new file mode 100644 index 0000000..7fd02eb --- /dev/null +++ b/roles/locale_config/README.md @@ -0,0 +1,9 @@ +# dede.common.locale_config + +this role will ensure the system locale and language settings +you can modify `system_locale` and `system_language` if you want to deviate from the default, which is: + +```yaml +locale_config_locale: 'de_DE.UTF-8' +locale_config_language: 'en_US.UTF-8' +``` diff --git a/roles/locale_config/defaults/main.yml b/roles/locale_config/defaults/main.yml new file mode 100644 index 0000000..c2c7b56 --- /dev/null +++ b/roles/locale_config/defaults/main.yml @@ -0,0 +1,3 @@ +--- +locale_config_locale: 'de_DE.UTF-8' +locale_config_language: 'en_US.UTF-8' diff --git a/roles/set_locale/tasks/main.yml b/roles/locale_config/tasks/main.yml similarity index 100% rename from roles/set_locale/tasks/main.yml rename to roles/locale_config/tasks/main.yml diff --git a/roles/set_locale/defaults/main.yml b/roles/set_locale/defaults/main.yml deleted file mode 100644 index 7861c03..0000000 --- a/roles/set_locale/defaults/main.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -set_locale_locale: 'de_DE.UTF-8' -set_locale_language: 'en_US.UTF-8' diff --git a/roles/test/README.md b/roles/test/README.md new file mode 100644 index 0000000..dbe6fd0 --- /dev/null +++ b/roles/test/README.md @@ -0,0 +1,3 @@ +# dede.common.test + +a role that simply will print 'hello world!' diff --git a/test_connection.yml b/test_connection.yml new file mode 100644 index 0000000..a2504ff --- /dev/null +++ b/test_connection.yml @@ -0,0 +1,14 @@ +--- +- name: test play + hosts: "{{ target | default([]) }}" + tasks: + - name: say hello to the world + ansible.builtin.debug: + msg: hello world! + + - name: check connection using ping + ansible.builtin.ping: + + - name: check become using ping + become: true + ansible.builtin.ping: