diff --git a/README.md b/README.md index 1bab58348c6480ee2f74493e815caee725fec064..e3f7f00e0c920da877046640d7ccddc20e1919ce 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ Fork the project from [this repository](https://forge.grandlyon.com/systemes-din Go to the `Settings` menu, `CI/CD` and look for the `Variables` submenu. Once it's done, you will need to create the variable bellow : -- **ENVIRONMENT** : Environment of the deployment, contained in domains, subdomains and resources name convention. +- **ENVIRONMENT** : Environment of the deployment, contained in domains, subdomains and resources name convention, should match the project name. - **TF_VAR_INSTANCES_COUNT** : Number of instances to create. - **TF_VAR_LETSENCRYPT_EMAIL** : Lets encrypt mail for renewal. -- **TF_VAR_PROJECT_DOMAIN** : External domain from Scaleway. (Example : <xxx>.alpha.grandlyon.com) +- **TF_VAR_PROJECT_DOMAIN** : External domain from Scaleway. Example : `<PROJECT_DOMAIN>.alpha.grandlyon.com` - **TF_VAR_SCW_ACCESS_KEY** : Scaleway Access Key. - **TF_VAR_SCW_PROJECT_ID** : Project ID from your Scaleway project. - **TF_VAR_SCW_SECRET_KEY** : Scaleway Secret Key. @@ -65,9 +65,9 @@ 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 of the variable you defined before : -- **TTYD :** https://terminal-<INSTANCE_COUNT>.<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN/ -- **Atrium :** https://<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN>/ +After deployment, each resource can be accessed though HTTPS, URL depends on the variable you defined before : +- **TTYD :** `https://terminal-<INSTANCE_COUNT>.<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN>.com/` +- **Atrium :** `https://<ENVIRONMENT>-<INSTANCE_COUNT>.<PROJECT_DOMAIN>.com/` **Example :** - https://terminal-1.rust-1.daag.alpha.grandlyon.com/