Skip to content

Commit

Permalink
improved install.sh script
Browse files Browse the repository at this point in the history
  • Loading branch information
@gianlucascopelliti
gianlucascopelliti committed Sep 27, 2023
1 parent aa522e1 commit ee776d7
Show file tree
Hide file tree
Showing 4 changed files with 217 additions and 36 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/artifacts.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:

jobs:
proofs:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
-
uses: actions/checkout@master
Expand Down Expand Up @@ -34,7 +34,7 @@ jobs:
name: proofs
path: proofs/out
simulation:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
-
uses: actions/checkout@master
Expand Down Expand Up @@ -67,7 +67,7 @@ jobs:
name: simulation
path: simulation/simulations
prl:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
-
uses: actions/checkout@master
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@ on:

jobs:
tests:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
-
uses: actions/checkout@master
-
name: Install dependencies
run: |
echo "" | ./install.sh -f
echo "" | ./install.sh
timeout-minutes: 5
-
name: Tamarin
run: |
Expand Down
36 changes: 19 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,34 +72,36 @@ artifacts generated as output.
### Getting started

Our artifacts can be run on a commodity desktop machine with a x86-64 CPU an a
recent Linux operating system installed (preferably one between Ubuntu 20.04,
Ubuntu 22.04 and Debian 12). A machine with at least 8 cores and 16 GB of RAM is
recent Linux operating system installed (preferably one between Ubuntu >= 20.04
and Debian >= 10). A machine with at least 8 cores and 16 GB of RAM is
_recommended_ to ensure that all the artifacts run correctly.

We require the following software components installed and configured on
the machine:
- `git`, `make`, `screen` installed via apt: `sudo apt install -y git make screen`
- [Docker](https://docs.docker.com/engine/install/)
- The `Docker Compose` plugin is also needed but should be installed
automatically
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
- [Minikube](https://minikube.sigs.k8s.io/docs/start/)

Below, we provide instructions to set up all dependencies on a fresh VM (we
tested on Ubuntu 20.04 and 22.04).
For Ubuntu and Debian users, we provide a script `install.sh` to install all
dependencies automatically:

```bash
# Install dependencies
# Install all dependencies.
# Note: the script will skip installation of any dependencies that you have already installed
# if you want install up-to-date packages, pass the flag "-f" to the script
./install.sh

# enable docker group in the current shell
# NOTE: to make it permanent, you should logout and login again
newgrp docker
# Note: if this is the first installation of Docker, logout from the current shell
# and login again to enable the "docker" group in the current user
```

If you opt for a manual installation, make sure the following software
components are installed and configured on the machine:
- `git`, `make`, `screen` installed via apt: `sudo apt install -y git make screen`
- [Docker](https://docs.docker.com/engine/install/)
- The [Docker Compose](https://docs.docker.com/compose/install/) plugin is also needed but should be installed
automatically with recent Docker versions
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
- [Minikube](https://minikube.sigs.k8s.io/docs/start/)

In the end, make sure of the following:
1. Docker is installed correctly: the `docker run --rm hello-world` command
succeeds
- If you get a permission error, make sure [your user is in the "docker" group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
2. Docker Compose is installed: `docker compose version` succeeds
3. Kubectl is installed: `kubectl version` succeeds
4. Minikube is installed: `minikube version` succeeds
Expand Down
203 changes: 188 additions & 15 deletions install.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,196 @@

set -e

echo "Installing dependencies via apt.."
Color_Off='\033[0m' # Text Reset
BBlack='\033[1;30m' # Black
BRed='\033[1;31m' # Red
BGreen='\033[1;32m' # Green
BYellow='\033[1;33m' # Yellow
BBlue='\033[1;34m' # Blue
BWhite='\033[1;37m' # White

wait_for_enter() {
while [ true ]
do
read -s -n 1 key
case $key in
"")
break
;;
*)
;;
esac
done
}

check_root() {
if [ "$EUID" -eq 0 ]
then
warn "Please do not run this script as root"
exit 1
fi
}

check_sudo() {
if ! command -v sudo &> /dev/null
then
warn "'sudo' is not installed on the machine. Please log in as 'root' and run 'apt-get update && apt-get install sudo'"
exit 1
fi

if ! sudo -v > /dev/null
then
warn "It seems like you don't have root privileges. Please make sure you are added to the 'sudo' group."
exit 1
fi
}

check_distro() {
os=`cat /etc/os-release 2> /dev/null || echo ""`
if echo $os | grep 'NAME="Ubuntu"' > /dev/null || echo $os | grep 'NAME="Debian GNU/Linux"' > /dev/null
then :
else
echo -e -n "${BYellow}"
echo "It seems like you are running a different OS than Ubuntu or Debian, which this script does not support."
echo "If you think this is an error or if you want to continue anyway, press ENTER, otherwise exit with CTRL-C"
echo -e -n "${Color_Off}"
wait_for_enter
fi
}

start() {
echo -e -n "${BWhite}"
echo "Welcome! This script will install all the required dependencies to run our artifacts."
if [ $FORCE -eq 0 ]
then
echo "By default, this script will *not* attempt to install components that are already installed."
echo "This means that if you have outdated versions installed, you *might* encounter problems when running the artifacts."
echo "If you want to install up-to-date packages, run this script with '-f' instead."
else
echo "You are running the script in *force* mode: I will replace any existing dependencies with the latest versions."
echo "If you do *not* want to overwrite the current versions, run this script without '-f' instead."
fi
echo -e -n "${BGreen}"
echo "Press ENTER to continue, or CTRL-C to exit"
echo -e -n "${Color_Off}"
wait_for_enter
}

err_report() {
echo -e -n "${BRed}"
echo "Could not install all dependencies correctly due to an error on line $1"
echo "Running the artifacts with the current setup might cause errors."
echo "We recommend fixing the error and then running this script again to complete the installation."
echo -e -n "${Color_Off}"
}

print_section() {
echo
echo -e -n "${BYellow}"
echo "### Installing $1 ###"
echo -e -n "${Color_Off}"
}

success() {
echo
echo -e -n "${BGreen}"
echo "Success! Your machine is now set up correctly for running the artifacts."
echo -e -n "${Color_Off}"
}

info() {
echo -e -n "${BBlue}"
echo $1
echo -e -n "${Color_Off}"
}

warn() {
echo -e -n "${BYellow}"
echo $1
echo -e -n "${Color_Off}"
}

note() {
echo -e -n "${BWhite}"
echo "$1"
echo -e -n "${Color_Off}"
}

trap 'err_report $LINENO' ERR

if [ "$1" = "-f" ]; then
FORCE=1
else
FORCE=0
fi

check_distro
check_root
check_sudo
start

cd /tmp

print_section "apt dependencies"
sudo apt update && sudo apt install -y git make screen curl

echo "Getting Docker.."
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh ./get-docker.sh
rm get-docker.sh
print_section "Docker"
if ! command -v docker &> /dev/null || [ $FORCE -eq 1 ]
then
info "Uninstalling old versions (if present).."
for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt-get remove $pkg || true; done
info "Getting docker. Note: you may see a warning from the docker script, you can safely ignore it"
sleep 5
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh ./get-docker.sh
rm get-docker.sh
sudo usermod -aG docker $USER
else
echo "Seems like Docker is already installed, skipping."
fi

if docker compose version &> /dev/null
then
echo "Docker Compose is correctly installed"
else
print_section "Docker Compose"
DOCKER_CONFIG=${DOCKER_CONFIG:-/usr/local/lib/docker}
sudo mkdir -p $DOCKER_CONFIG/cli-plugins
sudo curl -SL https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
fi

echo "Adding user to docker group.."
sudo usermod -aG docker $USER
print_section "kubectl"
if ! command -v kubectl &> /dev/null || [ $FORCE -eq 1 ]
then
info "Uninstalling old versions (if present).."
sudo rm -rf `which kubectl` > /dev/null 2>&1
sudo apt-get remove kubectl > /dev/null 2>&1 || true
brew uninstall kubectl > /dev/null 2>&1 || true
sudo snap remove kubectl > /dev/null 2>&1 || true
info "Getting kubectl"
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
rm kubectl
else
echo "Seems like kubectl is already installed, skipping."
fi

echo "Getting kubectl.."
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
rm kubectl
print_section "Minikube"
if ! command -v minikube &> /dev/null || [ $FORCE -eq 1 ]
then
info "Uninstalling old versions (if present).."
sudo rm -rf `which minikube`
info "Getting minikube"
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
sudo install minikube-linux-amd64 /usr/local/bin/minikube
rm minikube-linux-amd64
else
echo "Seems like minikube is already installed, skipping."
fi

echo "Getting minikube.."
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
sudo install minikube-linux-amd64 /usr/local/bin/minikube
rm minikube-linux-amd64
success
if ! groups | grep "docker" > /dev/null
then
warn "Note: to login to the 'docker' group, please logout and login again"
fi

0 comments on commit ee776d7

Please sign in to comment.