Required packages

MacOS: Please start with MacOS required packages.

The machine provisioner requires some basic packages. If your using ubuntu >= 20.04, you can follow along with the "Usage" section. On other operating system, i.e. MacOS, please satisfy the following requirements manually:

• python >= 3.10
• pip >= 20.3
• pip3 >= 20.3
• git
• vim

Important The command python3 needs to point to the python-executable for Python >= 3.10, python might not work.

Usage

Preparations

sudo apt update
sudo apt install -y software-properties-common git vim
cd ~

Installation

Clone repo

git clone https://github.com/modell-aachen/modac-dev-machine-setup.git
cd modac-dev-machine-setup

Install provisioner and devbox packages

./devbox/provision

Configure 1Password

As preparation you need to

• log into 1Password app
• integrate with 1Password cli. Follow the instructions here: https://developer.1password.com/docs/cli/get-started/#step-2-turn-on-the-1password-desktop-app-integration

After following the instructions you should be able to run

op vault list

and see a list of your vaults.

1. check successfull authentication against github.com

   ssh -T [email protected]

Add Harbor secrets to 1Password

1. in 1Password: New Item
2. Add Login
3. Change Login title to Harbor
4. set username to your modac email address
5. set password (https://harbor.modac.cloud -> Login -> user profile [top right corner] -> User Profile -> CLI secret)

Provision dev machine

source $HOME/.bashrc
machine provision

After that open up a new terminal to have an updated PATH with all the tools available.

Updates

Update your $(devbox global path)/devbox.json:

machine edit-config

Apply updates:

machine provision

FAQ

I want to use a different 'REPOS_DIRECTORY' than '$HOME/qwiki-repos'

Add an ENV variable to "$(devbox global path)/devbox.json:

machine edit-config

• add "REPOS_DIRECTORY": "$HOME/path" to the env object

Problem lösen "GitHub Error Message - Permission denied (publickey)"

Source: https://stackoverflow.com/questions/12940626/github-error-message-permission-denied-publickey Solution: Write that before starting the script

ssh-agent -s
ssh-add ~/.ssh/id_rsa

Docker setup fails

The docker task requires a system restart. If any succeeding docker-related tasks fail (kubectl, calico, etc.) try restarting the system and the provisioning process (machine provision).

Calico: ImageInspectError

The calico task can fail because of an incompatibility issue:

Workaround:

apt-cache policy docker-ce | grep 24.0.7

Use the printed version (e.g. 5:24.0.7-1ubuntu.22.04jammy) to ...

sudo apt install docker-ce=*VERSION*