From e1290089e7e58cf89263d1ba08609e14e8d50be2 Mon Sep 17 00:00:00 2001 From: Maxim Burgerhout Date: Sat, 24 Feb 2024 18:01:00 +0100 Subject: [PATCH] Some updated docs, bumping to 2.0.1 --- README.md | 3 +++ galaxy.yml | 2 +- roles/atuin_client/README.md | 10 ++++++++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e8260e..768d2b0 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,9 @@ This role is used in the following way in a playbook: - hosts: atuin_clients vars: + atuin_client_users: + - johnc + - joeb atuin_client_version: 18.0.1 roles: diff --git a/galaxy.yml b/galaxy.yml index 9236e81..eee9f8e 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -8,7 +8,7 @@ namespace: wzzrd name: atuin # The version of the collection. Must be compatible with semantic versioning -version: "2.0.0" +version: "2.0.1" # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/roles/atuin_client/README.md b/roles/atuin_client/README.md index 5abfa01..cf125b8 100644 --- a/roles/atuin_client/README.md +++ b/roles/atuin_client/README.md @@ -20,6 +20,7 @@ Role Variables | atuin_client_version | None | Version of atuin to install | true | | atuin_client_bin_dir | /usr/local/bin | Location for the atuin binary | false | | atuin_client_libc_variant | gnu | Which libc implementation to download a binary for | false | +| atuin_client_users | None | List of users to create a configuration file for | false | The `atuin_client_libc_variant` expects one of two options: musl or gnu. Choosing gnu will make the role download the atuin binary compiled for an OS with a recent build of glibc. Choosing musl will download a binary compiled and statically linked to the musl libc implementation. This allows you to run atuin on systems with incompatible versions of glibc. @@ -27,6 +28,12 @@ Mind that the musl build (at the time of writing) is only available for x86_64 L The only resort in that case is to use cargo to install atuin. I might implement that in a future version of this role. +The `atuin_client_users` variable can be used to pass a list of usernames to the role. +The role will iterate over this list and create a configuration file based for each +user. This configuration file is based on the values provided to this role and the +contents of `templates/config.toml.j2`. If the user changes this file, subsequent runs +of this role will *not* overwrite it. + Please see the `defaults/main.yml` file for the other configurable variables, their default values and an explanation of what they are for. @@ -48,6 +55,9 @@ This role is used in the following way in a playbook: ```yaml - hosts: atuin_clients vars: + atuin_client_users: + - johnc + - joeb atuin_client_version: 18.0.1 roles: