tooling/wsl-setup.org

# -*- ii: ii; -*-
#+TITLE: Windows Subsystem for Linux Setup
#+AUTHOR: James Blair
#+EMAIL: mail@jamesblair.net
#+DATE: <2020-09-26 Sat 08:20>


This guide will walk through setting up [[https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux][Windows Subsystem for Linux]] on Windows 10.  This particular setup contains my opinionated view of a good foundation and layers on some pairing and development orientated tooling over top.

*Caveats:* Please note this guide is written for the [[https://www.microsoft.com/store/productId/9NBLGGH4MSV6][Ubuntu WSL distribution]].

*Acknowledgements:* Large elements of this wsl setup came about through collaboration with the great people at [[https://ii.coop][ii.coop]].  I encourage you to explore and contribute to their work on [[https://gitlab.ii.coop][gitlab]] as many elements form a core part of this setup and workflow.


** Step 1 - Setup home folder structure

After installing the Ubuntu WSL distribution no folders are present in your home folder.
   
In this section we create some quick standard folders to keep our home folder somewhat organised.

#+NAME: Setup home folder strucuture
#+BEGIN_SRC shell
# Ensure we are in our home folder
cd ~/
   
# Create a documents folder for our git repositories
mkdir Documents

# Create a downloads folder for temporary objects
mkdir Downloads
#+END_SRC


** Step 2 - Update and install packages

To get started we ensure the package manager is up to date.

#+NAME: Update system packages
#+BEGIN_SRC shell
sudo apt-get update && sudo apt-get upgrade
#+END_SRC


Next we install a series of standard packages that form part of our workflow or are dependencies for other tools in our environment.

#+NAME: Install standard packages
#+BEGIN_SRC shell
sudo apt-get install -y git locales curl wget xclip xsel tmux tmate net-tools less wget htop screenfetch zip openssh-client dictd knockd python3-pip emacs apt-transport-https software-properties-common ca-certificates dirmngr xterm xtermcontrol jq
#+END_SRC


We use [[https://docker.io][docker]] to run containers or kind (kubernetes in docker) locally.

#+NAME: Install docker
#+begin_src shell
# Download and add Docker's official public PGP key.
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Add the `stable` channel's Docker upstream repository.
sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"

# Update the apt package list and install docker packages.
sudo apt-get update -y && sudo apt-get install -y docker-ce docker-ce-cli containerd.io

# Allow your user to access the Docker CLI without needing root access.
sudo usermod -aG docker $USER

# Ensure the docker service is started
sudo service docker start
#+end_src


For additional package management namely ~bitwarden~ we use [[https://www.npmjs.com/][node package manager]]. The code below installs node ~16.x~, which is the latest stable release as of <2021-10-02 Sat>.

#+NAME: Install node
#+BEGIN_SRC shell
# Curl down the shell script for adding version 12 of nodejs to apt
sudo curl  -sL https://deb.nodesource.com/setup_16.x | sudo bash -
   
# Install the nodejs package via apt
sudo apt-get install -y nodejs
#+END_SRC

  
For managing secrets we use [[https://bitwarden.com/][bitwarden]] which provides a great [[https://github.com/bitwarden/cli][cli utility]].

This section should be expanded in future to cover setting alias for common bitwarden tasks.

#+NAME: Install bitwarden and login
#+BEGIN_SRC shell
# Install the bitwarden cli via node package manager
sudo npm install -g @bitwarden/cli

# Test login to bitwarden
bw login mail@jamesblair.net
#+END_SRC


For working with google cloud platform we use the [[https://cloud.google.com/sdk/][GCP SDK]], which provides our cli tools.

#+NAME: Install google cloud sdk
#+BEGIN_SRC shell
# Download the sdk archive
curl -o gcpsdk.tar -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-311.0.0-linux-x86_64.tar.gz

# Extract to a folder in path
sudo tar xvf gcpsdk.tar -C /usr/local/

# Correct folder permissions
sudo chown -R $USER:$USER /usr/local/google-cloud-sdk

# Run the install script
/usr/local/google-cloud-sdk/install.sh
#+END_SRC


For working with [[https://azure.microsoft.com/en-us/][Microsoft Azure]] we need the [[https://docs.microsoft.com/en-us/cli/azure/][Azure CLI]].

#+NAME: Install azure cli
#+begin_src shell
# Modify your sources list so that the Microsoft repository is registered
AZ_REPO=$(lsb_release -cs)
echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $AZ_REPO main" | \
sudo tee /etc/apt/sources.list.d/azure-cli.list

# Import the encryption key for the Microsoft Ubuntu repository.
curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -

# Install the Azure CLI.
sudo apt-get update && sudo apt-get install azure-cli
#+end_src


For working with [[https://aws.com][Amazon Web Services]] we need the [[https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-linux.html][AWS CLI]].

#+NAME: Install amazon web services cli
#+BEGIN_SRC shell
# Download the binary
cd ~/Downloads/
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"

# Install
unzip awscliv2.zip
sudo ./aws/install

# Clean up
rm -rf ~/Downloads/aws*
#+END_SRC


For cloud infrastructure deployments we use [[https://www.terraform.io/][terraforms]].

#+NAME: Install hashicorp terraforms
#+BEGIN_SRC shell
# Download the binary
wget 'https://releases.hashicorp.com/terraform/0.12.24/terraform_0.12.24_linux_amd64.zip'

# Unzip it
unzip *.zip

# Move the binary to path
sudo mv terraform /usr/local/bin/

# Clean up
rm *amd64.zip
#+END_SRC


For ad-hoc system administration we use [[https://deb.nodesource.com/setup_12.x ][ansible]]. We install ansible via ~pip~ to ensure any modules or additional packages required at a later date can be easily managed.

For significant ansible or python projects a virtual environment for python is suggested to keep project packages separate from system python packages.

#+NAME: Install ansible via pip
#+BEGIN_SRC shell
pip3 install ansible
#+END_SRC


** Step 3 - Setup environment dotfiles

Within wsl we can use .dotfiles to further customise our environment. The script below restores my versions of key dotfiles automatically.
   
*Note:* The git clone below relies on having permission to clone the repository referenced.  For me this means having an ssh key present which has been added to gitlab.

*** Obtain ssh keys from bitwarden

In order to be able to clone the repository in the next step we need to obtain our ssh keys from bitwarden. Given we have installed the bitwarden cli we can mostly automte this process minus the initial login to bitwarden.

#+NAME: Obtain ssh keys from bitwarden
#+begin_src shell
# Ensure we have an ssh-agent running
eval `ssh-agent`

# Generate a new blank key to overwrite
ssh-keygen -t rsa -f ~/.ssh/james -q -P ""

# Ensure we have an active bitwarden session
export BW_SESSION=$(bw unlock --raw > ~/.bw_session && cat ~/.bw_session)

# Export both keys
export key=$(bw get item desktop --pretty | grep notes)

# Extract private key
export private=${key:12}
export private=${private/END RSA*/END RSA PRIVATE KEY-----}
echo $private | awk '{gsub(/\\n/,"\n")}1' > ~/.ssh/james

# Extract public key
export public=${key/*ssh-rsa/ssh-rsa} && echo ${public::-2} | awk '{gsub(/\\n/,"\n")}1' > ~/.ssh/james.pub
#+end_src


*** Clone and restore dotfiles

Once our keys are available to us we can clone down our dotfiles and get back to our comfortable normal terminal environment.

#+NAME: Clone and restore the dotfiles
#+BEGIN_SRC shell
# Remove the interactive host prompt
ssh-keyscan -p 2224 gitlab.jamma.life >> ~/.ssh/known_hosts

# Clone down this repository
git clone ssh://git@gitlab.jamma.life:2224/jmhbnz/tooling.git ~/Documents/tooling/
   
# Restore all dotfiles
cp ~/Documents/tooling/.* ~/
   
# Reload bashrc with updated version
source ~/.bashrc
#+END_SRC


** Step 4 - Install humacs editor

An integral part of our pair development workflow is [[https://github.com/humacs/humacs][humacs]]. Below are the instructions to install this directly in WSL, note there are other options to install in the documentation linked above.

#+NAME: Install and configure humacs
#+BEGIN_SRC shell
# Clone down humacs
git clone --recursive https://github.com/humacs/humacs /home/$USER/


# Need to ensure environment variables are set for load path
export EMACSLOADPATH=/home/$USER/humacs
#+END_SRC


** Step 5 - Setup mutt email client

For reading email we ideally use a cli based client for fast searching and lightweight mail reading.

The [[https://gitlab.com/muttmua/mutt/][mutt]] mail client fills these roles well for imap mailboxes.

The first step to setup mutt is to ensure it is installed.

#+NAME: Install mutt
#+BEGIN_SRC tmate
sudo apt-get install -y mutt urlscan
#+END_SRC

After installing mutt we then need to create configuration directories and files.

#+NAME: Create mutt config files
#+BEGIN_SRC tmate
mkdir -p ~/.mutt/cache/headers
mkdir ~/.mutt/cache/bodies
touch ~/.mutt/certificates
#+END_SRC

One configuration folders and files exist we just need to populate our user mutt configuration file with a configuration for our particular mail provider.

The example provided in this repository utilises the ~bitwarden~ cli utility for secrets to ensure these are securely gathered at runtime and not stored in the file.