diff --git a/.gitignore b/.gitignore index ad7e072..eca7b7c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ vault *.tar.gz -roles/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..43dee7f --- /dev/null +++ b/.gitmodules @@ -0,0 +1,9 @@ +[submodule "roles/ericomeehan.eom"] + path = roles/ericomeehan.eom + url = https://git.eom.dev/ansible-role-eom +[submodule "roles/ericomeehan.debian"] + path = roles/ericomeehan.debian + url = https://git.eom.dev/ansible-role-debian +[submodule "roles/ericomeehan.gondwana"] + path = roles/ericomeehan.gondwana + url = https://git.eom.dev/ansible-role-gondwana diff --git a/eom.yaml b/eom.yaml index cc02024..e4fe2ec 100644 --- a/eom.yaml +++ b/eom.yaml @@ -5,6 +5,6 @@ vars: target_namespace: prod vars_files: - - vars/secrets.yaml + - ../secrets.yaml roles: - role: ericomeehan.eom diff --git a/mobile-command.yaml b/mobile-command.yaml index 623a798..d75bde9 100644 --- a/mobile-command.yaml +++ b/mobile-command.yaml @@ -24,6 +24,7 @@ - certbot - curl - davfs2 + - gimp - git - gphoto2 - gpsd diff --git a/roles/ericomeehan.debian b/roles/ericomeehan.debian new file mode 160000 index 0000000..0236cdd --- /dev/null +++ b/roles/ericomeehan.debian @@ -0,0 +1 @@ +Subproject commit 0236cddce716b4f7c8275648365ed753a7f1b4c7 diff --git a/roles/ericomeehan.eom b/roles/ericomeehan.eom new file mode 160000 index 0000000..2d39534 --- /dev/null +++ b/roles/ericomeehan.eom @@ -0,0 +1 @@ +Subproject commit 2d395340236352edaeb15cea56a9e65cc740453a diff --git a/roles/ericomeehan.ericomeehan/README.md b/roles/ericomeehan.ericomeehan/README.md deleted file mode 100644 index 225dd44..0000000 --- a/roles/ericomeehan.ericomeehan/README.md +++ /dev/null @@ -1,38 +0,0 @@ -Role Name -========= - -A brief description of the role goes here. - -Requirements ------------- - -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. - -Role Variables --------------- - -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. - -Dependencies ------------- - -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. - -Example Playbook ----------------- - -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } - -License -------- - -BSD - -Author Information ------------------- - -An optional section for the role authors to include contact information, or a website (HTML is not allowed). diff --git a/roles/ericomeehan.ericomeehan/defaults/main.yml b/roles/ericomeehan.ericomeehan/defaults/main.yml deleted file mode 100644 index 9368625..0000000 --- a/roles/ericomeehan.ericomeehan/defaults/main.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -# defaults file for ericomeehan.ericomeehan diff --git a/roles/ericomeehan.ericomeehan/files/gitconfig b/roles/ericomeehan.ericomeehan/files/gitconfig deleted file mode 100644 index 3e50819..0000000 --- a/roles/ericomeehan.ericomeehan/files/gitconfig +++ /dev/null @@ -1,5 +0,0 @@ -[user] - email = eric@eom.dev - name = eric o meehan -[init] - defaultBranch = main diff --git a/roles/ericomeehan.ericomeehan/files/init.lua b/roles/ericomeehan.ericomeehan/files/init.lua deleted file mode 100644 index 0ca93f1..0000000 --- a/roles/ericomeehan.ericomeehan/files/init.lua +++ /dev/null @@ -1,13 +0,0 @@ -vim.cmd([[ - set nowrap - set number - set scrolloff=5 - set colorcolumn=128 - colorscheme elflord - hi ColorColumn ctermbg=lightgrey guibg=lightgrey - ]]) - -vim.keymap.set('n', '', '', { silent = true }) -vim.keymap.set('n', '', '', { silent = true }) -vim.keymap.set('n', '', '', { silent = true }) -vim.keymap.set('n', '', '', { silent = true }) diff --git a/roles/ericomeehan.ericomeehan/files/prompt_eric_setup b/roles/ericomeehan.ericomeehan/files/prompt_eric_setup deleted file mode 100644 index 35655a6..0000000 --- a/roles/ericomeehan.ericomeehan/files/prompt_eric_setup +++ /dev/null @@ -1,50 +0,0 @@ -# Generic large colour fade-bar prompt theme from bashprompt -# Created by James Manning -# Changed by Spidey 08/06 -# Converted to zsh prompt theme by - -prompt_bigfade_help () { - cat < [ [ []]]] - -where the parameters are the colors for the fade-bar, user@host text, -date text, and current working directory respectively. The default -colors are blue, white, white, and yellow. This theme works best with -a dark background. - - -Recommended fonts for this theme: either UTF-8, or nexus or vga or similar. -If you don't have any of these, the 8-bit characters will probably look -stupid. -EOH -} - -prompt_bigfade_setup () { - local fadebar=${1:-'cyan'} - local userhost=${2:-'white'} - local date=${3:-'white'} - local cwd=${4:-'cyan'} - - local -A schars - autoload -Uz prompt_special_chars - prompt_special_chars - - PS1="%B%F{$fadebar}$schars[333]$schars[262]$schars[261]$schars[260]%B%F{$userhost}%K{$fadebar}%n@%m%b%k%f%F{$fadebar}%K{black}$schars[260]$schars[261]$schars[262]$schars[333]%b%f%k%F{$fadebar}%K{black}$schars[333]$schars[262]$schars[261]$schars[260]%B%F{$date}%b%f%k %D{%a %b %d} %D{%I:%M:%S%P} %B%F{$cwd}%d$prompt_newline> " - PS2="%B%F{$fadebar}>%b%f%k " - - prompt_opts=(cr subst percent) -} - -prompt_bigfade_preview () { - if (( ! $#* )); then - prompt_preview_theme bigfade - print - prompt_preview_theme bigfade red white grey white - else - prompt_preview_theme bigfade "$@" - fi -} - -prompt_bigfade_setup "$@" diff --git a/roles/ericomeehan.ericomeehan/files/tmux.conf b/roles/ericomeehan.ericomeehan/files/tmux.conf deleted file mode 100644 index 1250279..0000000 --- a/roles/ericomeehan.ericomeehan/files/tmux.conf +++ /dev/null @@ -1,6 +0,0 @@ -bind '"' split-window -c "#{pane_current_path}" -bind '%' split-window -h -c "#{pane_current_path}" - -set-option -g pane-active-border-style fg=black,bg=cyan - -set-option -g status-style fg=black,bg=cyan diff --git a/roles/ericomeehan.ericomeehan/files/zshrc b/roles/ericomeehan.ericomeehan/files/zshrc deleted file mode 100644 index fab027c..0000000 --- a/roles/ericomeehan.ericomeehan/files/zshrc +++ /dev/null @@ -1,43 +0,0 @@ -# Aliases -alias ls='ls --color=auto' -alias ll='ls -lah --color=auto' -alias grep='grep --color=auto' -export PS2='> ' - -# Keep 5000 lines of history within the shell and save it to ~/.zsh_history: -HISTSIZE=5000 -SAVEHIST=5000 -HISTFILE=~/.zsh_history -setopt histignorealldups sharehistory - -# Set the prompt -autoload -Uz promptinit -promptinit -prompt eric - -# Use modern completion system -autoload -Uz compinit -compinit - -# zplug - manage plugins -source /usr/share/zplug/init.zsh -zplug "plugins/git", from:oh-my-zsh -zplug "plugins/sudo", from:oh-my-zsh -zplug "plugins/command-not-found", from:oh-my-zsh -zplug "zsh-users/zsh-syntax-highlighting" -zplug "zsh-users/zsh-autosuggestions" -zplug "zsh-users/zsh-history-substring-search" -zplug "zsh-users/zsh-completions" - -# zplug - install/load new plugins when zsh is started or reloaded -if ! zplug check; then - printf "Install? [y/N]: " - if read -q; then - echo; zplug install - fi -fi -zplug load - -if [ -x "$(command -v tmux)" ] && [ -n "${DISPLAY}" ] && [ -z "${TMUX}" ]; then - exec tmux new-session -A -s ${USER} >/dev/null 2>&1 -fi diff --git a/roles/ericomeehan.ericomeehan/handlers/main.yml b/roles/ericomeehan.ericomeehan/handlers/main.yml deleted file mode 100644 index 677d5f4..0000000 --- a/roles/ericomeehan.ericomeehan/handlers/main.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -# handlers file for ericomeehan.ericomeehan diff --git a/roles/ericomeehan.ericomeehan/meta/main.yml b/roles/ericomeehan.ericomeehan/meta/main.yml deleted file mode 100644 index c572acc..0000000 --- a/roles/ericomeehan.ericomeehan/meta/main.yml +++ /dev/null @@ -1,52 +0,0 @@ -galaxy_info: - author: your name - description: your role description - company: your company (optional) - - # If the issue tracker for your role is not on github, uncomment the - # next line and provide a value - # issue_tracker_url: http://example.com/issue/tracker - - # Choose a valid license ID from https://spdx.org - some suggested licenses: - # - BSD-3-Clause (default) - # - MIT - # - GPL-2.0-or-later - # - GPL-3.0-only - # - Apache-2.0 - # - CC-BY-4.0 - license: license (GPL-2.0-or-later, MIT, etc) - - min_ansible_version: 2.1 - - # If this a Container Enabled role, provide the minimum Ansible Container version. - # min_ansible_container_version: - - # - # Provide a list of supported platforms, and for each platform a list of versions. - # If you don't wish to enumerate all versions for a particular platform, use 'all'. - # To view available platforms and versions (or releases), visit: - # https://galaxy.ansible.com/api/v1/platforms/ - # - # platforms: - # - name: Fedora - # versions: - # - all - # - 25 - # - name: SomePlatform - # versions: - # - all - # - 1.0 - # - 7 - # - 99.99 - - galaxy_tags: [] - # List tags for your role here, one per line. A tag is a keyword that describes - # and categorizes the role. Users find roles by searching for tags. Be sure to - # remove the '[]' above, if you add tags to this list. - # - # NOTE: A tag is limited to a single word comprised of alphanumeric characters. - # Maximum 20 tags per role. - -dependencies: [] - # List your role dependencies here, one per line. Be sure to remove the '[]' above, - # if you add dependencies to this list. diff --git a/roles/ericomeehan.ericomeehan/tasks/main.yml b/roles/ericomeehan.ericomeehan/tasks/main.yml deleted file mode 100644 index ae7ca7f..0000000 --- a/roles/ericomeehan.ericomeehan/tasks/main.yml +++ /dev/null @@ -1,43 +0,0 @@ ---- -# tasks file for ericomeehan.ericomeehan -- name: Install user environment packages - apt: - name: - - zplug - - zsh - state: present - -- name: Set default shell to zsh - user: - name: eric - shell: /bin/zsh - -- name: Copy zsh configuration - copy: - src: zshrc - dest: /home/eric/.zshrc - -- name: Install custom zsh prompt - copy: - src: prompt_eric_setup - dest: /usr/share/zsh/functions/Prompts/prompt_eric_setup - -- name: Copy tmux configuration - copy: - src: tmux.conf - dest: /home/eric/.tmux.conf - -- name: Copy git configuration - copy: - src: gitconfig - dest: /home/eric/.gitconfig - -- name: Create local configuration directory - file: - path: /home/eric/.config/nvim - state: directory - -- name: Copy neovim configuration - copy: - src: init.lua - dest: /home/eric/.config/nvim/init.lua diff --git a/roles/ericomeehan.ericomeehan/tasks/mobile-command.yml b/roles/ericomeehan.ericomeehan/tasks/mobile-command.yml deleted file mode 100644 index 239f75b..0000000 --- a/roles/ericomeehan.ericomeehan/tasks/mobile-command.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -# tasks file for mobile-command.yml diff --git a/roles/ericomeehan.ericomeehan/tests/inventory b/roles/ericomeehan.ericomeehan/tests/inventory deleted file mode 100644 index 878877b..0000000 --- a/roles/ericomeehan.ericomeehan/tests/inventory +++ /dev/null @@ -1,2 +0,0 @@ -localhost - diff --git a/roles/ericomeehan.ericomeehan/tests/test.yml b/roles/ericomeehan.ericomeehan/tests/test.yml deleted file mode 100644 index e42bc80..0000000 --- a/roles/ericomeehan.ericomeehan/tests/test.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -- hosts: localhost - remote_user: root - roles: - - ericomeehan.ericomeehan diff --git a/roles/ericomeehan.ericomeehan/vars/main.yml b/roles/ericomeehan.ericomeehan/vars/main.yml deleted file mode 100644 index 6a2236c..0000000 --- a/roles/ericomeehan.ericomeehan/vars/main.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -# vars file for ericomeehan.ericomeehan diff --git a/roles/ericomeehan.gondwana b/roles/ericomeehan.gondwana new file mode 160000 index 0000000..0ca51b4 --- /dev/null +++ b/roles/ericomeehan.gondwana @@ -0,0 +1 @@ +Subproject commit 0ca51b452a430820c15bb0a8424c6d65eb7db349 diff --git a/roles/geerlingguy.docker/.ansible-lint b/roles/geerlingguy.docker/.ansible-lint new file mode 100644 index 0000000..2cd8c9f --- /dev/null +++ b/roles/geerlingguy.docker/.ansible-lint @@ -0,0 +1,4 @@ +skip_list: + - 'yaml' + - 'risky-shell-pipe' + - 'role-name' diff --git a/roles/geerlingguy.docker/.github/FUNDING.yml b/roles/geerlingguy.docker/.github/FUNDING.yml new file mode 100644 index 0000000..96b4938 --- /dev/null +++ b/roles/geerlingguy.docker/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# These are supported funding model platforms +--- +github: geerlingguy +patreon: geerlingguy diff --git a/roles/geerlingguy.docker/.github/workflows/ci.yml b/roles/geerlingguy.docker/.github/workflows/ci.yml new file mode 100644 index 0000000..bb4b327 --- /dev/null +++ b/roles/geerlingguy.docker/.github/workflows/ci.yml @@ -0,0 +1,73 @@ +--- +name: CI +'on': + pull_request: + push: + branches: + - master + schedule: + - cron: "0 7 * * 0" + +defaults: + run: + working-directory: 'geerlingguy.docker' + +jobs: + + lint: + name: Lint + runs-on: ubuntu-latest + steps: + - name: Check out the codebase. + uses: actions/checkout@v4 + with: + path: 'geerlingguy.docker' + + - name: Set up Python 3. + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install test dependencies. + run: pip3 install yamllint + + - name: Lint code. + run: | + yamllint . + + molecule: + name: Molecule + runs-on: ubuntu-latest + strategy: + matrix: + distro: + - rockylinux9 + - rockylinux8 + - ubuntu2404 + - ubuntu2204 + - ubuntu2004 + - debian12 + - debian11 + - debian10 + - fedora39 + + steps: + - name: Check out the codebase. + uses: actions/checkout@v4 + with: + path: 'geerlingguy.docker' + + - name: Set up Python 3. + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install test dependencies. + run: pip3 install ansible molecule molecule-plugins[docker] docker + + - name: Run Molecule tests. + run: molecule test + env: + PY_COLORS: '1' + ANSIBLE_FORCE_COLOR: '1' + MOLECULE_DISTRO: ${{ matrix.distro }} diff --git a/roles/geerlingguy.docker/.github/workflows/release.yml b/roles/geerlingguy.docker/.github/workflows/release.yml new file mode 100644 index 0000000..c9faaea --- /dev/null +++ b/roles/geerlingguy.docker/.github/workflows/release.yml @@ -0,0 +1,40 @@ +--- +# This workflow requires a GALAXY_API_KEY secret present in the GitHub +# repository or organization. +# +# See: https://github.com/marketplace/actions/publish-ansible-role-to-galaxy +# See: https://github.com/ansible/galaxy/issues/46 + +name: Release +'on': + push: + tags: + - '*' + +defaults: + run: + working-directory: 'geerlingguy.docker' + +jobs: + + release: + name: Release + runs-on: ubuntu-latest + steps: + - name: Check out the codebase. + uses: actions/checkout@v4 + with: + path: 'geerlingguy.docker' + + - name: Set up Python 3. + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install Ansible. + run: pip3 install ansible-core + + - name: Trigger a new import on Galaxy. + run: >- + ansible-galaxy role import --api-key ${{ secrets.GALAXY_API_KEY }} + $(echo ${{ github.repository }} | cut -d/ -f1) $(echo ${{ github.repository }} | cut -d/ -f2) diff --git a/roles/geerlingguy.docker/.github/workflows/stale.yml b/roles/geerlingguy.docker/.github/workflows/stale.yml new file mode 100644 index 0000000..5a2fd42 --- /dev/null +++ b/roles/geerlingguy.docker/.github/workflows/stale.yml @@ -0,0 +1,34 @@ +--- +name: Close inactive issues +'on': + schedule: + - cron: "55 6 * * 1" # semi-random time + +jobs: + close-issues: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + steps: + - uses: actions/stale@v8 + with: + days-before-stale: 120 + days-before-close: 60 + exempt-issue-labels: bug,pinned,security,planned + exempt-pr-labels: bug,pinned,security,planned + stale-issue-label: "stale" + stale-pr-label: "stale" + stale-issue-message: | + This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution! + + Please read [this blog post](https://www.jeffgeerling.com/blog/2020/enabling-stale-issue-bot-on-my-github-repositories) to see the reasons why I mark issues as stale. + close-issue-message: | + This issue has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details. + stale-pr-message: | + This pr has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution! + + Please read [this blog post](https://www.jeffgeerling.com/blog/2020/enabling-stale-issue-bot-on-my-github-repositories) to see the reasons why I mark issues as stale. + close-pr-message: | + This pr has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details. + repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/roles/geerlingguy.docker/.gitignore b/roles/geerlingguy.docker/.gitignore new file mode 100644 index 0000000..8840c8f --- /dev/null +++ b/roles/geerlingguy.docker/.gitignore @@ -0,0 +1,5 @@ +*.retry +*/__pycache__ +*.pyc +.cache + diff --git a/roles/geerlingguy.docker/.yamllint b/roles/geerlingguy.docker/.yamllint new file mode 100644 index 0000000..4dd9139 --- /dev/null +++ b/roles/geerlingguy.docker/.yamllint @@ -0,0 +1,10 @@ +--- +extends: default + +rules: + line-length: + max: 200 + level: warning + +ignore: | + .github/workflows/stale.yml diff --git a/roles/geerlingguy.docker/LICENSE b/roles/geerlingguy.docker/LICENSE new file mode 100644 index 0000000..4275cf3 --- /dev/null +++ b/roles/geerlingguy.docker/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2017 Jeff Geerling + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/roles/geerlingguy.docker/README.md b/roles/geerlingguy.docker/README.md new file mode 100644 index 0000000..e679eb4 --- /dev/null +++ b/roles/geerlingguy.docker/README.md @@ -0,0 +1,165 @@ +# Ansible Role: Docker + +[![CI](https://github.com/geerlingguy/ansible-role-docker/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/ansible-role-docker/actions?query=workflow%3ACI) + +An Ansible Role that installs [Docker](https://www.docker.com) on Linux. + +## Requirements + +None. + +## Role Variables + +Available variables are listed below, along with default values (see `defaults/main.yml`): + +```yaml +# Edition can be one of: 'ce' (Community Edition) or 'ee' (Enterprise Edition). +docker_edition: 'ce' +docker_packages: + - "docker-{{ docker_edition }}" + - "docker-{{ docker_edition }}-cli" + - "docker-{{ docker_edition }}-rootless-extras" +docker_packages_state: present +``` + +The `docker_edition` should be either `ce` (Community Edition) or `ee` (Enterprise Edition). +You can also specify a specific version of Docker to install using the distribution-specific format: +Red Hat/CentOS: `docker-{{ docker_edition }}-` (Note: you have to add this to all packages); +Debian/Ubuntu: `docker-{{ docker_edition }}=` (Note: you have to add this to all packages). + +You can control whether the package is installed, uninstalled, or at the latest version by setting `docker_packages_state` to `present`, `absent`, or `latest`, respectively. Note that the Docker daemon will be automatically restarted if the Docker package is updated. This is a side effect of flushing all handlers (running any of the handlers that have been notified by this and any other role up to this point in the play). + +```yaml +docker_obsolete_packages: + - docker + - docker.io + - docker-engine + - podman-docker + - containerd + - runc +``` + +A list of packages to be uninstalled prior to running this role. See [Docker's installation instructions](https://docs.docker.com/engine/install/debian/#uninstall-old-versions) for an up-to-date list of old packages that should be removed. + +```yaml +docker_service_manage: true +docker_service_state: started +docker_service_enabled: true +docker_restart_handler_state: restarted +``` + +Variables to control the state of the `docker` service, and whether it should start on boot. If you're installing Docker inside a Docker container without systemd or sysvinit, you should set `docker_service_manage` to `false`. + +```yaml +docker_install_compose_plugin: false +docker_compose_package: docker-compose-plugin +docker_compose_package_state: present +``` + +Docker Compose Plugin installation options. These differ from the below in that docker-compose is installed as a docker plugin (and used with `docker compose`) instead of a standalone binary. + +```yaml +docker_install_compose: true +docker_compose_version: "1.26.0" +docker_compose_arch: "{{ ansible_architecture }}" +docker_compose_path: /usr/local/bin/docker-compose +``` + +Docker Compose installation options. + +```yaml +docker_add_repo: true +``` + +Controls whether this role will add the official Docker repository. Set to `false` if you want to use the default docker packages for your system or manage the package repository on your own. + +```yaml +docker_repo_url: https://download.docker.com/linux +``` + +The main Docker repo URL, common between Debian and RHEL systems. + +```yaml +docker_apt_release_channel: stable +docker_apt_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'amd64' }}" +docker_apt_repository: "deb [arch={{ docker_apt_arch }}] {{ docker_repo_url }}/{{ ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}" +docker_apt_ignore_key_error: True +docker_apt_gpg_key: "{{ docker_repo_url }}/{{ ansible_distribution | lower }}/gpg" +docker_apt_filename: "docker" +``` + +(Used only for Debian/Ubuntu.) You can switch the channel to `nightly` if you want to use the Nightly release. + +You can change `docker_apt_gpg_key` to a different url if you are behind a firewall or provide a trustworthy mirror. +Usually in combination with changing `docker_apt_repository` as well. `docker_apt_filename` controls the name of the source list file created in `sources.list.d`. If you are upgrading from an older (<7.0.0) version of this role, you should change this to the name of the existing file (e.g. `download_docker_com_linux_debian` on Debian) to avoid conflicting lists. + +```yaml +docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo" +docker_yum_repo_enable_nightly: '0' +docker_yum_repo_enable_test: '0' +docker_yum_gpg_key: "{{ docker_repo_url }}/centos/gpg" +``` + +(Used only for RedHat/CentOS.) You can enable the Nightly or Test repo by setting the respective vars to `1`. + +You can change `docker_yum_gpg_key` to a different url if you are behind a firewall or provide a trustworthy mirror. +Usually in combination with changing `docker_yum_repository` as well. + +```yaml +docker_users: + - user1 + - user2 +``` + +A list of system users to be added to the `docker` group (so they can use Docker on the server). + +```yaml +docker_daemon_options: + storage-driver: "devicemapper" + log-opts: + max-size: "100m" +``` + +Custom `dockerd` options can be configured through this dictionary representing the json file `/etc/docker/daemon.json`. + +## Use with Ansible (and `docker` Python library) + +Many users of this role wish to also use Ansible to then _build_ Docker images and manage Docker containers on the server where Docker is installed. In this case, you can easily add in the `docker` Python library using the `geerlingguy.pip` role: + +```yaml +- hosts: all + + vars: + pip_install_packages: + - name: docker + + roles: + - geerlingguy.pip + - geerlingguy.docker +``` + +## Dependencies + +None. + +## Example Playbook + +```yaml +- hosts: all + roles: + - geerlingguy.docker +``` + +## License + +MIT / BSD + +## Sponsors + +* [We Manage](https://we-manage.de): Helping start-ups and grown-ups scaling their infrastructure in a sustainable way. + +The above sponsor(s) are supporting Jeff Geerling on [GitHub Sponsors](https://github.com/sponsors/geerlingguy). You can sponsor Jeff's work too, to help him continue improving these Ansible open source projects! + +## Author Information + +This role was created in 2017 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/). diff --git a/roles/geerlingguy.docker/defaults/main.yml b/roles/geerlingguy.docker/defaults/main.yml new file mode 100644 index 0000000..7449b5b --- /dev/null +++ b/roles/geerlingguy.docker/defaults/main.yml @@ -0,0 +1,65 @@ +--- +# Edition can be one of: 'ce' (Community Edition) or 'ee' (Enterprise Edition). +docker_edition: 'ce' +docker_packages: + - "docker-{{ docker_edition }}" + - "docker-{{ docker_edition }}-cli" + - "docker-{{ docker_edition }}-rootless-extras" + - "containerd.io" + - docker-buildx-plugin +docker_packages_state: present +docker_obsolete_packages: + - docker + - docker.io + - docker-engine + - podman-docker + - containerd + - runc + +# Service options. +docker_service_manage: true +docker_service_state: started +docker_service_enabled: true +docker_restart_handler_state: restarted + +# Docker Compose Plugin options. +docker_install_compose_plugin: true +docker_compose_package: docker-compose-plugin +docker_compose_package_state: present + +# Docker Compose options. +docker_install_compose: false +docker_compose_version: "v2.11.1" +docker_compose_arch: "{{ ansible_architecture }}" +docker_compose_url: "https://github.com/docker/compose/releases/download/{{ docker_compose_version }}/docker-compose-linux-{{ docker_compose_arch }}" +docker_compose_path: /usr/local/bin/docker-compose + +# Enable repo setup +docker_add_repo: true + +# Docker repo URL. +docker_repo_url: https://download.docker.com/linux + +# Used only for Debian/Ubuntu/Pop!_OS/Linux Mint. Switch 'stable' to 'nightly' if needed. +docker_apt_release_channel: stable +# docker_apt_ansible_distribution is a workaround for Ubuntu variants which can't be identified as such by Ansible, +# and is only necessary until Docker officially supports them. +docker_apt_ansible_distribution: "{{ 'ubuntu' if ansible_distribution in ['Pop!_OS', 'Linux Mint'] else ansible_distribution }}" +docker_apt_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'armhf' if ansible_architecture == 'armv7l' else 'amd64' }}" +docker_apt_repository: "deb [arch={{ docker_apt_arch }} signed-by=/etc/apt/keyrings/docker.asc] {{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}" +docker_apt_ignore_key_error: true +docker_apt_gpg_key: "{{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }}/gpg" +docker_apt_gpg_key_checksum: "sha256:1500c1f56fa9e26b9b8f42452a553675796ade0807cdce11975eb98170b3a570" +docker_apt_filename: "docker" + +# Used only for RedHat/CentOS/Fedora. +docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo" +docker_yum_repo_enable_nightly: '0' +docker_yum_repo_enable_test: '0' +docker_yum_gpg_key: "{{ docker_repo_url }}/centos/gpg" + +# A list of users who will be added to the docker group. +docker_users: [] + +# Docker daemon options as a dict +docker_daemon_options: {} diff --git a/roles/geerlingguy.docker/handlers/main.yml b/roles/geerlingguy.docker/handlers/main.yml new file mode 100644 index 0000000..72594c8 --- /dev/null +++ b/roles/geerlingguy.docker/handlers/main.yml @@ -0,0 +1,7 @@ +--- +- name: restart docker + service: + name: docker + state: "{{ docker_restart_handler_state }}" + ignore_errors: "{{ ansible_check_mode }}" + when: docker_service_manage | bool diff --git a/roles/geerlingguy.docker/meta/.galaxy_install_info b/roles/geerlingguy.docker/meta/.galaxy_install_info new file mode 100644 index 0000000..107e8f6 --- /dev/null +++ b/roles/geerlingguy.docker/meta/.galaxy_install_info @@ -0,0 +1,2 @@ +install_date: 'Tue 30 Jul 2024 06:47:56 PM ' +version: 7.3.0 diff --git a/roles/geerlingguy.docker/meta/main.yml b/roles/geerlingguy.docker/meta/main.yml new file mode 100644 index 0000000..a492efe --- /dev/null +++ b/roles/geerlingguy.docker/meta/main.yml @@ -0,0 +1,38 @@ +--- +dependencies: [] + +galaxy_info: + role_name: docker + author: geerlingguy + description: Docker for Linux. + company: "Midwestern Mac, LLC" + license: "license (BSD, MIT)" + min_ansible_version: 2.10 + platforms: + - name: Fedora + versions: + - all + - name: Debian + versions: + - buster + - bullseye + - bookworm + - name: Ubuntu + versions: + - bionic + - focal + - jammy + - name: Alpine + version: + - all + - name: ArchLinux + versions: + - all + galaxy_tags: + - web + - system + - containers + - docker + - orchestration + - compose + - server diff --git a/roles/geerlingguy.docker/molecule/default/converge.yml b/roles/geerlingguy.docker/molecule/default/converge.yml new file mode 100644 index 0000000..629095b --- /dev/null +++ b/roles/geerlingguy.docker/molecule/default/converge.yml @@ -0,0 +1,24 @@ +--- +- name: Converge + hosts: all + become: true + + pre_tasks: + - name: Update apt cache. + apt: update_cache=yes cache_valid_time=600 + when: ansible_os_family == 'Debian' + + - name: Wait for systemd to complete initialization. # noqa 303 + command: systemctl is-system-running + register: systemctl_status + until: > + 'running' in systemctl_status.stdout or + 'degraded' in systemctl_status.stdout + retries: 30 + delay: 5 + when: ansible_service_mgr == 'systemd' + changed_when: false + failed_when: systemctl_status.rc > 1 + + roles: + - role: geerlingguy.docker diff --git a/roles/geerlingguy.docker/molecule/default/molecule.yml b/roles/geerlingguy.docker/molecule/default/molecule.yml new file mode 100644 index 0000000..147da5d --- /dev/null +++ b/roles/geerlingguy.docker/molecule/default/molecule.yml @@ -0,0 +1,21 @@ +--- +role_name_check: 1 +dependency: + name: galaxy + options: + ignore-errors: true +driver: + name: docker +platforms: + - name: instance + image: "geerlingguy/docker-${MOLECULE_DISTRO:-rockylinux8}-ansible:latest" + command: ${MOLECULE_DOCKER_COMMAND:-""} + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:rw + cgroupns_mode: host + privileged: true + pre_build_image: true +provisioner: + name: ansible + playbooks: + converge: ${MOLECULE_PLAYBOOK:-converge.yml} diff --git a/roles/geerlingguy.docker/tasks/docker-compose.yml b/roles/geerlingguy.docker/tasks/docker-compose.yml new file mode 100644 index 0000000..53a4482 --- /dev/null +++ b/roles/geerlingguy.docker/tasks/docker-compose.yml @@ -0,0 +1,31 @@ +--- +- name: Check current docker-compose version. + command: "{{ docker_compose_path }} --version" + register: docker_compose_vsn + check_mode: false + changed_when: false + failed_when: false + +- set_fact: + docker_compose_current_version: "{{ docker_compose_vsn.stdout | regex_search('(\\d+(\\.\\d+)+)') }}" + when: > + docker_compose_vsn.stdout is defined + and (docker_compose_vsn.stdout | length > 0) + +- name: Delete existing docker-compose version if it's different. + file: + path: "{{ docker_compose_path }}" + state: absent + when: > + docker_compose_current_version is defined + and (docker_compose_version | regex_replace('v', '')) not in docker_compose_current_version + +- name: Install Docker Compose (if configured). + get_url: + url: "{{ docker_compose_url }}" + dest: "{{ docker_compose_path }}" + mode: 0755 + when: > + (docker_compose_current_version is not defined) + or (docker_compose_current_version | length == 0) + or (docker_compose_current_version is version((docker_compose_version | regex_replace('v', '')), '<')) diff --git a/roles/geerlingguy.docker/tasks/docker-users.yml b/roles/geerlingguy.docker/tasks/docker-users.yml new file mode 100644 index 0000000..6e387e6 --- /dev/null +++ b/roles/geerlingguy.docker/tasks/docker-users.yml @@ -0,0 +1,10 @@ +--- +- name: Ensure docker users are added to the docker group. + user: + name: "{{ item }}" + groups: docker + append: true + with_items: "{{ docker_users }}" + +- name: Reset ssh connection to apply user changes. + meta: reset_connection diff --git a/roles/geerlingguy.docker/tasks/main.yml b/roles/geerlingguy.docker/tasks/main.yml new file mode 100644 index 0000000..dcd47de --- /dev/null +++ b/roles/geerlingguy.docker/tasks/main.yml @@ -0,0 +1,98 @@ +--- +- name: Load OS-specific vars. + include_vars: "{{ lookup('first_found', params) }}" + vars: + params: + files: + - '{{ansible_distribution}}.yml' + - '{{ansible_os_family}}.yml' + - main.yml + paths: + - 'vars' + +- include_tasks: setup-RedHat.yml + when: ansible_os_family == 'RedHat' + +- include_tasks: setup-Debian.yml + when: ansible_os_family == 'Debian' + +- name: Install Docker packages. + package: + name: "{{ docker_packages }}" + state: "{{ docker_packages_state }}" + notify: restart docker + ignore_errors: "{{ ansible_check_mode }}" + when: "ansible_version.full is version_compare('2.12', '<') or ansible_os_family not in ['RedHat', 'Debian']" + +- name: Install Docker packages (with downgrade option). + package: + name: "{{ docker_packages }}" + state: "{{ docker_packages_state }}" + allow_downgrade: true + notify: restart docker + ignore_errors: "{{ ansible_check_mode }}" + when: "ansible_version.full is version_compare('2.12', '>=') and ansible_os_family in ['RedHat', 'Debian']" + +- name: Install docker-compose plugin. + package: + name: "{{ docker_compose_package }}" + state: "{{ docker_compose_package_state }}" + notify: restart docker + ignore_errors: "{{ ansible_check_mode }}" + when: "docker_install_compose_plugin | bool == true and (ansible_version.full is version_compare('2.12', '<') or ansible_os_family not in ['RedHat', 'Debian'])" + +- name: Install docker-compose-plugin (with downgrade option). + package: + name: "{{ docker_compose_package }}" + state: "{{ docker_compose_package_state }}" + allow_downgrade: true + notify: restart docker + ignore_errors: "{{ ansible_check_mode }}" + when: "docker_install_compose_plugin | bool == true and ansible_version.full is version_compare('2.12', '>=') and ansible_os_family in ['RedHat', 'Debian']" + +- name: Ensure /etc/docker/ directory exists. + file: + path: /etc/docker + state: directory + mode: 0755 + when: docker_daemon_options.keys() | length > 0 + +- name: Configure Docker daemon options. + copy: + content: "{{ docker_daemon_options | to_nice_json }}" + dest: /etc/docker/daemon.json + mode: 0644 + when: docker_daemon_options.keys() | length > 0 + notify: restart docker + +- name: Ensure Docker is started and enabled at boot. + service: + name: docker + state: "{{ docker_service_state }}" + enabled: "{{ docker_service_enabled }}" + ignore_errors: "{{ ansible_check_mode }}" + when: docker_service_manage | bool + +- name: Ensure handlers are notified now to avoid firewall conflicts. + meta: flush_handlers + +- include_tasks: docker-compose.yml + when: docker_install_compose | bool + +- name: Get docker group info using getent. + getent: + database: group + key: docker + split: ':' + when: docker_users | length > 0 + +- name: Check if there are any users to add to the docker group. + set_fact: + at_least_one_user_to_modify: true + when: + - docker_users | length > 0 + - item not in ansible_facts.getent_group["docker"][2] + with_items: "{{ docker_users }}" + +- include_tasks: docker-users.yml + when: at_least_one_user_to_modify is defined diff --git a/roles/geerlingguy.docker/tasks/setup-Debian.yml b/roles/geerlingguy.docker/tasks/setup-Debian.yml new file mode 100644 index 0000000..a864b3f --- /dev/null +++ b/roles/geerlingguy.docker/tasks/setup-Debian.yml @@ -0,0 +1,48 @@ +--- +- # See https://docs.docker.com/engine/install/debian/#uninstall-old-versions + name: Ensure old versions of Docker are not installed. + package: + name: "{{ docker_obsolete_packages }}" + state: absent + +- name: Ensure dependencies are installed. + apt: + name: + - apt-transport-https + - ca-certificates + state: present + when: docker_add_repo | bool + +- name: Ensure directory exists for /etc/apt/keyrings + file: + path: /etc/apt/keyrings + state: directory + mode: '0755' + +- name: Add Docker apt key. + ansible.builtin.get_url: + url: "{{ docker_apt_gpg_key }}" + dest: /etc/apt/keyrings/docker.asc + mode: '0644' + force: false + checksum: "{{ docker_apt_gpg_key_checksum | default(omit) }}" + register: add_repository_key + ignore_errors: "{{ docker_apt_ignore_key_error }}" + when: docker_add_repo | bool + +- name: Ensure curl is present (on older systems without SNI). + package: name=curl state=present + when: add_repository_key is failed and docker_add_repo | bool + +- name: Add Docker apt key (alternative for older systems without SNI). + shell: > + curl -sSL {{ docker_apt_gpg_key }} | apt-key add - + when: add_repository_key is failed and docker_add_repo | bool + +- name: Add Docker repository. + apt_repository: + repo: "{{ docker_apt_repository }}" + state: present + filename: "{{ docker_apt_filename }}" + update_cache: true + when: docker_add_repo | bool diff --git a/roles/geerlingguy.docker/tasks/setup-RedHat.yml b/roles/geerlingguy.docker/tasks/setup-RedHat.yml new file mode 100644 index 0000000..d49316e --- /dev/null +++ b/roles/geerlingguy.docker/tasks/setup-RedHat.yml @@ -0,0 +1,61 @@ +--- +- name: Ensure old versions of Docker are not installed. + package: + name: + - docker + - docker-common + - docker-engine + state: absent + +- name: Add Docker GPG key. + rpm_key: + key: "{{ docker_yum_gpg_key }}" + state: present + when: docker_add_repo | bool + +- name: Add Docker repository. + get_url: + url: "{{ docker_yum_repo_url }}" + dest: '/etc/yum.repos.d/docker-{{ docker_edition }}.repo' + owner: root + group: root + mode: 0644 + when: docker_add_repo | bool + +- name: Configure Docker Nightly repo. + ini_file: + dest: '/etc/yum.repos.d/docker-{{ docker_edition }}.repo' + section: 'docker-{{ docker_edition }}-nightly' + option: enabled + value: '{{ docker_yum_repo_enable_nightly }}' + mode: 0644 + no_extra_spaces: true + when: docker_add_repo | bool + +- name: Configure Docker Test repo. + ini_file: + dest: '/etc/yum.repos.d/docker-{{ docker_edition }}.repo' + section: 'docker-{{ docker_edition }}-test' + option: enabled + value: '{{ docker_yum_repo_enable_test }}' + mode: 0644 + no_extra_spaces: true + when: docker_add_repo | bool + +- name: Configure containerd on RHEL 8. + block: + - name: Ensure runc is not installed. + package: + name: runc + state: absent + + - name: Ensure container-selinux is installed. + package: + name: container-selinux + state: present + + - name: Ensure containerd.io is installed. + package: + name: containerd.io + state: present + when: ansible_distribution_major_version | int == 8 diff --git a/roles/geerlingguy.docker/vars/Alpine.yml b/roles/geerlingguy.docker/vars/Alpine.yml new file mode 100755 index 0000000..b81917a --- /dev/null +++ b/roles/geerlingguy.docker/vars/Alpine.yml @@ -0,0 +1,2 @@ +--- +docker_packages: "docker" diff --git a/roles/geerlingguy.docker/vars/Archlinux.yml b/roles/geerlingguy.docker/vars/Archlinux.yml new file mode 100644 index 0000000..f68d962 --- /dev/null +++ b/roles/geerlingguy.docker/vars/Archlinux.yml @@ -0,0 +1,3 @@ +--- +docker_packages: "docker" +docker_compose_package: docker-compose diff --git a/roles/geerlingguy.docker/vars/main.yml b/roles/geerlingguy.docker/vars/main.yml new file mode 100755 index 0000000..805232b --- /dev/null +++ b/roles/geerlingguy.docker/vars/main.yml @@ -0,0 +1,2 @@ +--- +# Empty file