diff --git a/README.md b/README.md index 8144a4223ec84e4c15eb2346bc1c72ce29890289..2c68c2b2956a9af40a251c20bac31c2307dcc670 100644 --- a/README.md +++ b/README.md @@ -301,11 +301,11 @@ back-end. The whole software stack, apart from the KinD package, shall be deployed via **Ansible**. Of course, instead of the dummy `http-echo` app, two different -Docker images shall be used -- :construction: see the [project's Docker file -boilerplate](provide-link-please): one for the front-end, the other for the -back-end, both hosted in the [Docker Hub registry](https://hub.docker.com/) -- -you shall create a personal public repository. **We trust you, please, do not -cheat!** +Docker images shall be used: one for the front-end, the other for the +back-end, both to be hosted in the [Docker Hub +registry](https://hub.docker.com/) -- you shall create a personal public +repository. **We trust you, please, do not cheat!** Front-end and back-end +have their own Dockerfile. The front-end image does not need to be rebuilt, unless you want to implement some client-side (HTML/JS) bonuses. @@ -318,9 +318,7 @@ The whole stack shall be redeployed whenever any of its images are updated. ## Tasks -:construction: **To be finalized** - -:bulb: Please, respect the file layout provided by this repository. Here is +:bulb: Please, respect the file layout provided by this repository. Here is a map: ``` @@ -332,7 +330,6 @@ map: │ ├── backend <= main.tf to be extended │ └── frontend │ └── views -├── Docker └── Terraform <= recipes to be extended └── conf <= Cloud-init files ``` @@ -341,10 +338,12 @@ map: 1. Fork this repository. 2. Complete the Python back-end file `Application/backend/main.py`. See the - section [Development](#development) below. -3. Rebuild the application back-end Docker image, and push it to your public - Docker Hub repository -- **(:question: TO-DO - We should provide - instructions)**. This task shall be automated via Ansible -- see below. + section [Development](#development) below. Test locally the application as + explained in section [Local installation](#local-installation). +3. Rebuild the application's Docker images, then: + - test [locally the deployment](#local-docker-deployment), then + - push the images to your public Docker Hub repository. This task shall + be automated via Ansible -- see below. 4. Complete your Terraform files from the version you developed in [Lab-Terraform](https://gitedu.hesge.ch/lsds/teaching/bachelor/cloud-and-deployment/lab-terraform/-/blob/main/SwitchEngines/README.md) up to Task #8. Your recipe shall handle only the provisioning of the VM @@ -368,7 +367,7 @@ map: ### Bonuses -You will get bonus for any of the following improvements. +You will get bonus points for any of the following improvements. * Ask for the password when removing an account (unenroll) -- extra safety. +0.2 points. @@ -429,7 +428,7 @@ $ make trun ``` -#### Managing the containerized application with Docker +#### Local Docker deployment :hammer_and_wrench: **Install the following Docker packages on your workstation according to your distribution's instructions: docker(.io), docker-cli,