Ansible Role: Oh My Zsh

Role to download, install and configure Oh-My-Zsh.

Requirements

Ansible >= 5 (Ansible Core >= 2.12)
Linux Distribution
- Debian Family
  - Debian
    - Stretch (9)
    - Buster (10)
    - Bullseye (11)
  - Ubuntu
    - Bionic (18.04)
    - Focal (20.04)
- RedHat Family
  - Rocky Linux
    - 8
  - Fedora
    - 35
- SUSE Family
  - openSUSE
    - 15.3
- Note: other versions are likely to work but have not been tested.

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# Default theme
oh_my_zsh_theme: robbyrussell

# Default plugins
oh_my_zsh_plugins:
  - git

# Whether to install by default for all specified users.
# May be overridden by `oh_my_zsh: install:` under each user.
oh_my_zsh_install: true

# Default update mode for Oh-My-Zsh
# accepted values are:
# disabled (default)
# auto
# reminder
oh_my_zsh_update_mode: disabled

# Default update frequency in days. When the update mode is set to a value other
# than "disabled", this is the frequency (in days) to check for a new version.
# The value 0 will check every time a new shell session starts.
oh_my_zsh_update_frequency: 13

# Whether to write the ~/.zshrc file
# May be overridden by `oh_my_zsh: write_zshrc:` under each user.
oh_my_zsh_write_zshrc: true

# User configuration
# Important: oh-my-zsh is installed per user so you need to specify the users to install it for.
users:
  - username: example1
    oh_my_zsh:
      theme: robbyrussell
      plugins:
        - git
      update_mode: reminder
      update_frequency: 3
      write_zshrc: false
  - username: example2
    oh_my_zsh:
      theme: robbyrussell
      plugins:
        - git
        - mvn
      update_mode: auto
      update_frequency: 10
  - username: example3
    oh_my_zsh:
      install: false

Example Playbook

- hosts: servers
  roles:
    - role: gantsign.oh-my-zsh
      users:
        - username: example

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

Linux (e.g. Ubuntu)
Docker
Python (including python-pip)
Ansible
Molecule

Because the above can be tricky to install, this project includes Molecule Wrapper. Molecule Wrapper is a shell script that installs Molecule and it's dependencies (apart from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the project root:

./moleculew test

Note: some of the dependencies need sudo permission to install.

License

MIT

Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)

roib20/ansible-role-oh-my-zsh