DevXP Linux bootstrap script (devxp-linux)

Sunset

[!WARNING] This setup is sunset and about to be replaced by devxp-wsl, which is a simpler setup based on Ubuntu 24.04.

About

The devxp-linux script is used to bootstrap Ubuntu WSL on an Elhub developer PC. It ensures that all the required tools, SDKs and scripts are installed and set up correctly. In addition, it is also used to upgrade an existing developer PC setup; when rerun, the scripts will validate existing installations and upgrade tools and scripts as appropriate.

Getting Started

To install Windows Subsystem for Linux, run this command inside Windows PowerShell or Windows Command Prompt:

wsl --install -d Ubuntu-22.04

Automatic Setup (Recommended)

Step 1: Clone Repository

The devxp-linux repository will automatically clone itself under $HOME/.local/devxp once executed, so where you initially clone it is not crucial. Execute the following command to clone the repository:

git clone git@github.com:elhub/devxp-linux.git

Step 2: Install Developer Tools with Weekly Update Reminders

To install necessary developer tools and receive weekly update reminders, execute the following command:

./auto-setup.sh

The script will ask for your sudo password and then your BECOME password. Those are both the same password, which is your Ubuntu WSL password.

After completing the auto-setup, the reminder frequency can be adjusted by adding a line to the $HOME/.local/devxp/config.yml file. Simply include a line like cooldown: 8, where the number represents the desired number of days between reminders. Note that the config.yml file starts empty, so you need to add this line yourself. By default, the reminder cooldown is set to 7 days.

Once the script has finished, you should see an output similar to:

First time setup is complete

---

Manual Setup (Discouraged)

Note: Manual setup is discouraged because it requires you to remember to pull new commits and re-run the setup script periodically. Failure to do so can pose a security risk as updates may contain important fixes and enhancements.

Step 1: Clone Repository

Determine where you will install the git-repository devxp-linux (we suggest $HOME/workspace/git) on the file system inside Ubuntu in WSL (using cd to navigate to your preferred directory and/or use mkdir to create a new one), and then clone this repository in that location by executing:

git clone git@github.com:elhub/devxp-linux.git

Step 2: Start Bootstrap Script

Start the bootstrap script by executing the following command after navigating to the directory where the repository was cloned to.

./bootstrap.sh

The script will ask for your sudo password and then your BECOME password. Those are both the same password, which is your Ubuntu WSL password.

Remember to pull new commits (git pull) and re-run the setup script from time to time to update your setup with new scripts and tools.

The script will prompt you for your Ubuntu WSL sudo password while it is executing. Once completed, you should see an output similar to:

PLAY RECAP *********************************************************************
localhost                  : ok=88   changed=53   unreachable=0    failed=0    skipped=3    rescued=0    ignored=0

You can (and should) pull new commits (using git pull) and re-run this script from time to time to update your setup with new scripts and tools.

---

Post-Installation

You should also set up the environment variable $EDITOR with your default text editor of your choice, if you haven't already done so. This can be done by executing:

sudo update-alternatives --config editor

Usage

This project install a large number of tools, scripts, SDKs, and applications used for day-to-day development.

It installs the following programming languages/SDKs:

• Ansible
• Java
• Kotlin
• Node/Javascript
• Python

Oracle Java vs OpenJDK

Oracle Weblogic 12.2.1.4, that is needed for elhub-sp-web-api, requires Oracle Java to be downloaded and manually installed from oracle.com.

adr

This is a Java implementation of the adr script-based toold by Nat Pryce. It allows for the simple creation and maintenance of light-weight architecture decision records.

arcanist

Arcanist is the command-line tool for Phabricator. It installs our arcanist extensions and sets up a global arcconfig file. The global arcconfig contains a number of useful aliases:

• cleanup: Cleans up the directory. Be careful (in particular, don't use it with terraform projects).
• init: Use with parameters "none", "maven", or "gradle". This copies appropriate default files (arcconfig, gitignore, gitattributes, etc) for a project directory. This command can also be run using the arc-init script.
• log: Displays git log nicely.
• patch-clean: Cleans up arcpatch branches.
• set-exe: Use with filename. Sets it to be executable and updates the git index..
• status: When run in your workspace directory (i.e., the dir where you keep your repositories, will iterate through all available git repos and inform which repositories have modified or untracked files. This command can also be run using the arc-status script.

Linters

This project installs a number of important linters, used by arcanist. These linters can also be used in a standalone manner.

Checkstyle can be used as a command line tool to check that your Java code conforms with a given Java style. Elhub's default checkstyle config is also installed. The script /usr/local/bin/checkstyle automatically uses our default config.

See the checkstyle documentation for more detailed information.

Detekt can be used as a command line tool to check that your Kotlin code conforms with a given code style. Elhub's default kotlin config is also installed. The script in /usr/local/bin/detekt automatically uses our default config.

See the detekt documentation for more detailed information.

It also install yamllint and ansible-lint.

Git Utility Scripts

The project installs a number of git utility scripts on the dev box.

git-clone-all is a script that can be used to clone all development repositories from our git servers.

git-mirror is a simple script for mirroring repositories using git clone --mirror.

git-status-all carries out a git status on all the repositories in a directory.

Docker

To execute the subcommands in docker in WSL, you need to start the service docker which will run the Docker daemon:

sudo service docker start

then you will not get this error message when executing the subcommands in docker:

Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?

There is no need for Docker Desktop or anything similar installed.

If you are getting the error above after starting the docker-service, execute

sudo service docker status

to see if it is running.

If not, it may not start due to a change to iptables in Ubuntu 22.04 LTS that sets it to iptables-nft by default which does not work in WSL2. To fix that, either execute:

sudo update-alternatives --set iptables /usr/sbin/iptables-legacy

or do:

1. Execute this command:

sudo update-alternatives --config iptables

2. Type number "1" and press Enter to select "iptables-legacy".

After iptables has been set to iptables-legacy, then execute again

sudo service docker start

to see if it starts now.

Testing

The project runs basic sanity tests automatically (the validate role) after installation.

With Docker

docker build .

Contributing

Contributing, issues and feature requests are welcome. See the Contributing file.

Owners

This project is developed by Elhub. For the specific development group responsible for this code, see the Codeowners file.

License

This project is MIT licensed.