diff --git a/README.md b/README.md index e3f7f00e0c920da877046640d7ccddc20e1919ce..15ac06500d1fae23b3edd8021f7a3568e36ce8c2 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,10 @@ # How does it work ? -The template will provision several resources (including your instances) to the Scaleway cloud provider using Terraform and Gitlab CI. -After provisioning, configuration of the instances and deployment of the services (Atrium and TTYD) will be done using Cloud-init and bash scripts. +The template will provision resources to the Scaleway cloud provider using Terraform and Gitlab CI. +After provisioning, the configuration of the instances and the service deployment (Atrium and TTYD) will be done using Cloud-init and bash scripts. -> All your information must be stored in Gitlab and passed as variable to Terraform. - -## How the deployment is managed ? - -The whole project is managed by Gitlab using the Gitlab CI. -Launching the pipeline will start the deployment of your infrastructure in 3 steps. - -**Plan :** -Terraform will perform a "fake deployment" and initialize everything he needs before deploying. -After performing, you will be able to see the plan of the future creation/modification/destruction in the log of the pipeline. -If the modification could lead to break changes and errors, you must not launch the next step of the pipeline. -**Creation :** -Terraform will be applying the exact changes you reviewed in the Plan step. -**Destruction :** -Terraform will destroy the resources he managed to create (or manually imported one). +> **Be carefull** : All your information must be stored in Gitlab and passed as variable to Terraform. # How can I use it ? @@ -27,10 +13,10 @@ Terraform will destroy the resources he managed to create (or manually imported **On The Forge (Gitlab)**, you must have or ask for the right to fork the repository. -**Scaleway** needs you to have credentials to use their services. You must go to [Scaleway API key page](https://console.scaleway.com/iam/api-keys) -and create one for your project. Please make sure to add a description starting with `Terraform - <your description>`. +**Scaleway** needs credentials to use their services. Create some for your project at [Scaleway API key page](https://console.scaleway.com/iam/api-keys) +Please make sure to add a description matching with `Terraform - <your description>`. -**The Certificate Authority (CA)** Let's Encrypt needs an email. He will use it to send a notification before the certificate expires to proceed with +**The Certificate Authority (CA)** Let's Encrypt needs an email to send a notification before the certificate expires and proceed to the the renewal. ## Step 1 : Getting your own repository @@ -65,7 +51,7 @@ button` to destroy the infrastructure when you don't need it anymore. ## Step 4 : Accessing your services -After deployment, each resource can be accessed though HTTPS, URL depends on the variable you defined before : +After deployment, each resource can be accessed through HTTPS, URL depends on the variables you defined before : - **TTYD :** `https://terminal-<INSTANCE_COUNT>.<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN>.com/` - **Atrium :** `https://<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN>.com/`