Ansible Playbook for configuring Ubuntu Desktop

Introduction

This is a collection of roles and configuarions I use for my Ubuntu desktop/laptop deployment.

This Playbook is designed and tested for Ubunutu 24.04 LTS. This playbook may not work on older versions of Ubuntu without modification.

Requirements

1. Basic knowledge of Ansible

2. Ubuntu 24.04 (may work on other apt based distros with modification)

3. Software: ansible, git, openssh-server, vim-gtk3 (vim or vim-gtk3 is not strictly required, but is required if the vim role is executed)

4. Ensure ansible community modules are installed. See below for instructions.

Instructions

This assumes a new/fresh installation and the execution of this playbook is on the target machine (localhost). Of course, this playbook can be executed to a remote host, if needed. This also assumes the user indicated below by <username> belongs to the sudo group. Additionally, this assumes the user's primary group on the host and target machine(s) are the same.

1. Install required software for this playbook.
   sudo apt update && sudo apt install ansible git openssh-server vim-gtk3 -y ansible-galaxy collection install community.general

2. Clone ansible-desktop-ubuntu repo.
   git clone https://github.com/richlamdev/ansible-desktop-ubuntu.git

3. Generate SSH key pair for localhost.
   cd ansible-desktop-ubuntu/scripts

The following script will generate a new SSH key pair for localhost and copy the public key to ~/.ssh/authorized_keys. This will allow authentication via SSH key.
./gen_ssh_keys.sh

Alternatively, if password authentication is preferred, install sshpass.
sudo apt install sshpass

** *Limit use of sshpass for setup only, due to potential security issues. * **

Note: Be aware the /role/base/tasks/authentication.yml will update the /etc/ssh/sshd_config, which will disable SSH password authentication; consequently, making SSH key authentication a hard requirement.

4. Amend inventory file if needed, default target is localhost.

5. Amend main.yml file for roles (software) desired.

• The majority of third party packages are separated into roles, this was setup this way to allow convenient inclusion/exclusion of roles as needed by commenting/uncommenting roles in main.yml at the root level of the repo.

6. To run the playbook use the following command:
   ansible-playbook main.yml -bKu <username> --private-key ~/.ssh/<ssh-key>

• enter SUDO password. (assumes user is a member of the sudo user group)

To run the playbook using SSH password authentication, use the following command:
ansible-playbook main.yml -bkKu <username>

• enter SSH password
• enter SUDO password. (assumes user is a member of the sudo user group)

7. Where privilege escalation is not required, the packages or configuration is installed on the target host(s) in the context of <username> indicated.

Role Information

The majority of roles are self explantory in terms of what they install.

Additional information for the following roles:

• auto-update

  • force dpkg to accept default settings during updates
  • add cron to run apt update and dist-upgrade daily
  • add cron to run snap update daily
  • technically there are built-in methods to run apt and snap update daily (unattended-upgrades), however, none of those methods seem to work. This primitive implementation achieves a similar effect.
  • This role is for any desktop/laptop that requires operating 24/7.
  • unfortunately there is no method to ensure reboots are triggered when required

• aws

  • installs AWS CLI v2 and AWS SAM CLI via zip archive from aws
  • this majority of this role ignores changes; it's not truly idempotent, due to not using a built-in ansible module to handle installation
  • refer to System Updates section for manual (script) updating

• base

  • packages.yml - list of packages to install via apt
  • dev-packages.yml - list of development packages to install via apt and pipx
    • some of the development packages are installed using pipx where possible due to PEP 668
    • primarily installs pipx binary packages for coding/development
      • bandit
      • black (needed for VIM ALE plugin)
      • flake8 (needed for VIM ALE plugin)
      • glances
      • pre-commit
      • pytest
      • ruff (needed for VIM ALE plugin)
      • yamllint (needed for VIM ALE plugin)
      • yamlfix (needed for VIM ALE plugin)
      • yamlfmt (needed for VIM ALE plugin)
  • keychron.yml - enables keychron keyboard shortcuts
  • autostart.yml - enables autostart of applications
  • authentication.yml - configures ssh server and client. disables password authentication

• disable-local-dns

  • disables local dns on the target host (again this is a personal preference, as my network DNS server handles DNS lookup and filtering)
  • this role is executed last, as a dns service restart is required; the restart will take too long and cause the following playbook role(s) to fail (a delay could be added, but that adds unnecessary execution time for the playbook)

NB: install either docker-cli-only OR docker-desktop depending on your requirements

• docker-cli-only

  • installs all docker engine requirements for CLI use only. You may experience conflicts if you install docker-desktop as well.
  • installs following:
    • docker-ce-cli
    • containerd.io
    • docker-compose
    • docker-compose-plugin
  • creates docker group and adds the current user to it

• docker-desktop-dependency

  • installs docker-ce-cli (required for Docker Desktop)

  • creates docker group and adds the current user to it

  • install docker-desktop for remainder of local docker setup

  • NOTE: At the time of this writing, Docker is not yet officially supported on Ubuntu 24.04 LTS. Follow the instructions under the prerequisites section

    Short version, either execute this on each reboot, before executing Docker Desktop sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0 or edit (create) this file /etc/sysctl.d/99-docker.conf echo "kernel.apparmor_restrict_unprivileged_userns=0" > /etc/sysctl.d/99-docker.conf

    Apply the change immediately by executing sudo sysctl --system or reboot

  • The kernel.apparmor_restrict_unprivileged_userns=0 setting is now applied with the docker role

  • Additional references:

    • Github Issue #209
    • reddit thread
    • restricted unprivileged user namespace

• env

  • setups personal preferences for bash shell
  • fzf is required for fzf.vim
  • .bashrc -bash function se is for fast directory navigation at the CLI refer to fzf explorer (this is slightly different from the built in alt-c command provided with fzf)
  • refer to System Updates section for manual (script) updating of fzf

• ufw

  • disables incoming ports, except port 22 (limit inbound connections port 22)

• vim

  • installs customization only, does not install vim

    • compile and install vim with this script
    • Note: Vim >9.0 is required for codeium plugin below, at the time of the writing of this playbook, Vim 9.x was not available in the official Ubuntu repos

  • if codeium is not needed, disable codeium in the status line within .vimrc that is deployed with this role:

    • comment out this line

    set statusline+=\{…\}%3{codeium#GetStatusString()} " codeium status

    If this is not disabled before codeium.vim is uninstalled, vim will freeze on startup. (you'll have to edit .vimrc with an alternative editor,and/ or disable loading of .vimrc then comment the above line indicated)

    • remove codeium.vim from $HOME/.vim/pack: rm -rf ~/.vim/pack/Exafunction

  • installs following plugins:

    • ALE
    • codeium
    • fzf.vim
    • Github copilot (use codeium)
    • hashivim
    • indentLine
    • monokai colorscheme
    • nerdtree
    • tagbar
    • vim-commentary
    • vim-unimpaired
    • vimwiki
    • personal/custom .vimrc

System Updates

The commands used to keep your system up to date are:

1. sudo apt update && sudo apt upgrade -y
2. sudo apt autoremove -y (not really an update, but removes old packages)
3. sudo snap refresh*
4. pipx upgrade-all

*while snap package mangement is controversial - tradeoff of manual updates and convenience...

Upgrade specific packages, not upraded via apt or snap:

1. execute scripts/aws_upgrade.sh
2. execute scripts/sam_upgrade.sh
3. execute scripts/fzf_upgrade.sh (alternatively delete the ~/.fzf folder and re-run ansible)
4. If Docker Desktop, is installed. Start Docker Desktop, click "Settings", then "Software updates", then "Check for updates", then Download and install updated Docker Desktop. sudo apt update && sudo apt install ./docker-desktop-<version>-<arch>.deb

Idempotency

The majority of this playbook is idempotent. Minimal use of Ansible shell or command is used.

AWS CLI, AWS SAM CLI, and fzf are not idempotent. While fzf could be installed and maintained via apt, I prefer to update fzf more frequently and therefore perform the upgrades manually (by script). Refer to above System Updates section for updates beyond package management.

Scripts

1. gen_ssh_keys.sh - generates a new SSH key pair for localhost and copies the public key to ~/.ssh/authorized_keys.

2. desktop-setup.sh - restore dconf settings. (instructions within this file to save dconf settings)

3. check_ssh_auth.sh - checks for SSH authentication methods against a host Eg: ./check_ssh_auth.sh localhost

4. multipass-test.sh

• basic script to test ansible roles with multipass Ubuntu virtual machines
• open the file for documentation and usage
• multipass credentials saved in the file; naturally not a concern given it's an ephemeral VM
• to launch a multipass vm: cd scripts ./multipass-test.sh
• to launch a multipass vm with desktop setup: cd scripts ./multipass-test.sh desktop

Random Notes, General Information & Considerations

1. For further information regarding command line switches and arguments above, please see the Ansible documentation, alternatively read my ansible-misc github repo

2. Review the base role for potential unwanted software installation/ configuration. The majority of the software within the base role is software available via the default apt repositories. Other software are some git repos, keychron keyboard setup, and screen blanking short-cut key enablement. Furthermore the roles env and vim are personal preferences.

3. Appropriate GPG keys are added to /usr/share/keyrings/ folder for third party apt packages, and referenced within repos, per deprecation of apt-key as of Ubuntu 22.04.

4. The organization of this ansible repo has become a little messier than preferred. TODO: Clean it up to be more organized / readable / reusable.