/ttf-devops-2018

Primary LanguageShellGNU General Public License v3.0GPL-3.0

Tech Talent Factory - DevOps Class 2020

This is the "archetype repository" for the students of Tech Talent Factory - DevOps Class 2020.

Into this repository will be saved the exercises done by the students during the class. The final assessment partially depends by the content and the usage of this repository.

Usage

Students will have to fork this repository on our GitHub account, insert their data into the STUDENTS.md file and finally make a pull request of the updated STUDENTS.md file.

After that, the students will use this repository, their own fork, as a single repository for all their exercises. The teacher considers the students repository as the only source of truth, therefore no other file, exercise or implementation will be taken into consideration for the final assessment.

Getting Started

  • fork on GitHub
  • clone the forked repository
  • fill the STUDENTS.md file with their data
  • commit the STUDENTS.md file
  • push the STUDENTS.md file on remote repository
  • make a new pull request to the "base repository"
  • start working and enjoy

vs-code plugins

List of usefull plugins:

  • Git History
  • GitLens — Git supercharged
  • gitignore
  • Docker
  • Bash IDE (optional)
  • Open in GitHub, Bitbucket, Gitlab, VisualStudio.com ! (optional)
  • Vagrant (optional)

Configure Docker plugin

Follow this step to configure the Docker plugin:

  • open the vs-code settings Ctrl + ,
  • use the left navigation menu to open Extensions -> Docker
  • search the field Docker: Host
  • fill the Docker: Host field with the following value tcp://192.168.50.95:2375

Working Agreements

  • libertà di lavorare da soli o in coppia (preferibilmente in coppia)
  • le coppie sono durature e invariabili nel tempo
  • la branch master contiene solo codice funzionante
  • ogni esercizio deve essere in una cartella separata
  • la branch master può contenere il "work in progress"
  • commit piccoli che permettano di ricostruire la storia
  • uso libero delle branch per il "work in progress"
  • messaggi di commit concisi, chiari ed esatti

Put it before them briefly so they will read it, clearly so they will appreciate it, picturesquely so they will remember it and, above all, accurately so they will be guided by its light. Joseph Pulitzer

Esercizi e Valutazione

Nella directory esercizi sono presenti i file necessari allo svolgimento degli stessi e per la precisione:

  • README.md file contenente il testo dell'esercizio
  • acceptance_test.sh file contenente i test di accettazione
  • eventuali altri file utili all'esercizio specifico

I criteri di valutazione tengono conto del:

  • contenuto della branch master
    • correttezza dello svolgimento dell'esercizio, cioè i test di accettazione dovrebber essere "verdi"
    • qualità del codice scritto e.g. rispetto delle buone pratiche e leggibilità
  • l'uso delle branch e dei commit
    • commit piccoli che permettano di ricostruire la storia
    • messaggi di commit concisi, chiari ed esatti

Vagrant

HashiCorp Vagrant provides the same, easy workflow regardless of your role as a developer, operator, or designer. It leverages a declarative configuration file which describes all your software requirements, packages, operating system configuration, users, and more.

More info at this link.

Vagrant - Overview

In the vagrant folder there is a file called Vagrantfile. Inside, the configuration of the virtual machine (VM) that can be used to perform the exercises is described. In addition, there is a bash file called provisioner.sh that is automatically executed during the creation of the VM and which has the purpose of installing the necessary software packages and making some configurations inside the newly created VM.

⚠️ WARNING: please change the values of user.name and user.email in provisioner.sh file and un-comment that lines!!!

Vagrant - Use Docker from outside

È possibile connettersi "remotamente" al servizio Docker presente all'interno della VM avviata con Vagrant. Per sfruttare questa possibilità è necessario istruire Docker per connettersi al server remoto in uno dei seguenti modi:

  • configurare la variabile d'ambiente DOCKER_HOST con il valore tcp://192.168.50.95:2375
  • eseguire ogni comando docker con l'opzione -H tcp://192.168.50.95:2375

Vagrant - Usage

To use vagrant you need to open a terminal in the vagrant folder and type one of the commands below, the one that's right fo you :-)

Name Vagrant Command Description
Up vagrant up starts and provisions the vagrant environment
Provision vagrant provision provisions the vagrant machine
Halt vagrant halt stops the vagrant machine
Destroy vagrant destroy stops and deletes all traces of the vagrant machine
Status vagrant status outputs status of the vagrant machine
Connect vagrant ssh connects to machine via SSH

Vagrant - Example of usage

In this example I show the commands to start and connect to the VM using Vagrant. Once connected to the VM you are in a fully functional, albeit minimal, GNU/Linux distribution. At the end of the work, remember to logout from the VM and turn it off.

Start VM and connect to it:

# you are on your pc
gianni@nolok ~/workspace/projects/ttf $ cd vagrant
gianni@nolok ~/workspace/projects/ttf/vagrant $ vagrant up
gianni@nolok ~/workspace/projects/ttf/vagrant $ vagrant ssh
# now you are connected to the VM and the next commands will be execute inside VM
alpine38:~$

At the end, you need to logout and shutdown the VM:

# remenber to logout from the VM
alpine38:~$ logout
# you are back on your pc
gianni@nolok ~/workspace/projects/ttf/vagrant $ vagrant halt

License

This project is licensed under the GPL-v3 License - see the LICENSE.md file for details