Dipartimento Trasformazione Digitale / DevOps toolkit

The repository contains a set of tools used by DevOps to interact with the Cloud infrastructure.

These tools do not require any pre-installed software on your machine, but Docker.

You can pull the container and run commands inside it, or execute commands directly from your computer, sourcing first the azure-profile.sh script. Each command will bring up the "DevOps toolkit container" and execute the command inside it.

TL;DR

Execute commands from your machine (recommended)

# Strongly suggested to put the following command in your ~/.bash_profile or ~/.bashrc
source azure-profile.sh [PATH_TO_YOUR DPT_BOGUS]

# Note: PATH_TO_YOUR DPT_BOGUS is the path to your local password-manager repository, called dpt-bogus. You can clone the repository and see instructions [here](https://github.com/teamdigitale/dpt-bogus). If PATH_TO_YOUR DPT_BOGUS is not set, it will default to ~/dpt-bogus

# Done! Execute the commands you need
# { az | pass | terraform | terragrunt | kubectl | helm | aks-config-download }

OR bring the container environment up manually with docker-compose and execute commands inside the container

DPT_BOGUS_PATH=YOUR_PATH_TO_YOUR_LOCAL_DPT_BOGUS_REPO docker-compose up -d
docker exec -it devops_tools /bin/bash

# Note: if DPT_BOGUS_PATH is not set it defaults to ~/dpt-bogus

# Exit and stop the container
exit
docker-compose down

Requirements

• Docker

What commands/tools are supported

• az (latest image available)

• pass 1.7.3

• terraform 0.11.14

• terragrunt 0.18.2

• kubectl 1.18.0

• helm 3.3.0-rc.1

Volumes

Different volumes are mounted in the container. You can see the full list in the docker-compose.yml file, in the volumes section.

kubectl cp

kubectl cp allows users to upload and download files from remote containers. Unless the local path where you copy files from/to corresponds to one of the volumes mounted in your container, files will only persist inside of it, so you won't be able to see them on the host machine. For this reason, you should always use the local /devops folder while using kubectl cp. This will transfer files from/to the folder on the host machine where you've launched docker-compose or the command from.

kubectl port-forward

You may need to use the command kubectl port-forward. In order to do so from your host machine, remember to add the parameter --address 0.0.0.0 to your command.

This is an example of a connection from your host to a Prometheus installation:

kubectl -n monitoring port-forward --address 0.0.0.0 prometheus-prometheus-prometheus-oper-prometheus-0 9090

Note: to make this possible, both the azure-profile.sh and the docker-compose.yml files expose some ports that are usually needed to connect to known admin services (Prometheus, Kibana, Grafana). If you need to use different ports, you'll need to add them to these files, before running the commands.

aks-config-download.sh

Often, you're required to download the AKS config for one of the Team's clusters. It may be a simple but convoluted operation. The aks-config-download.sh tool simplifies the procedure:

aks-config-download {dpt-services | devita}

Want the container only?

docker pull teamdigitale/devops-tools:latest

Auto-completions

Auto-completions for each tool are included inside the container (meaning it will work if you run commands from it). If you want auto-completion while invoking commands on your host machine you should look at scripts available online for your platform.