From 3dfb6fbae9f157c9626858cb8d97a459df8627b1 Mon Sep 17 00:00:00 2001
From: "marcoemi.poleggi" <marco-emilio.poleggi@hesge.ch>
Date: Tue, 6 Dec 2022 11:10:44 +0100
Subject: [PATCH] Update README.md
---
SwitchEngines/README.md | 27 ++++++++++++++++++++++-----
1 file changed, 22 insertions(+), 5 deletions(-)
diff --git a/SwitchEngines/README.md b/SwitchEngines/README.md
index 477eadf..7d66f3a 100644
--- a/SwitchEngines/README.md
+++ b/SwitchEngines/README.md
@@ -3,6 +3,11 @@
Lab template for a Cloud provisioning/orchestration exercise with Terraform
(TF) and SwitchEngines (OpenStack).
+:bulb: OpenStack is an open-source Cloud management platform. Although we use here
+the SwitchEngines provider, the instructions should be valid for any other Cloud
+provider that employs OpenStack.
+
+
## Tasks ##
**N.B.** Some tasks require interacting with your local machine's OS: any
@@ -25,7 +30,7 @@ special marks to explain what is (or would be) going on:
### Task #1: install Terraform CLI and OpenStack CLI ###
**Goal:** install the Terraform CLI and OpenStack CLI on your local machine.
-Please, refer to your OS documentation for the proper way to do so
+Please, refer to your OS documentation for the proper way to do so.
1. [Terraform
CLI](https://learn.hashicorp.com/tutorials/terraform/install-cli)
@@ -35,9 +40,9 @@ Please, refer to your OS documentation for the proper way to do so
version >= 6.0.0. It is recommended to install your original distribution
package named like `python-openstackclient`.
1. :bulb: **Skip this step if you already have a project assigned in SwitchEngines.**
- On the OpenStack dashboard, create a new project. The placeholder used in
- this exercise is `<your-project-name>` with value `Cloud-MA-IaC`.
- 1. :bulb: **Skip this step if you already have configured your SwitchEngines access credentials.**
+ On the OpenStack "Horizon" dashboard, create a new project. The placeholder used in
+ this exercise is `<your-project-name>`.
+ 1. :bulb: **Skip this step if you already have your project's application credentials.**
Go to your project page, then create new [Application
Credentials](https://engines.switch.ch/horizon/identity/application_credentials/)
and save it as `~/.config/openstack/clouds.yaml`. With SwitchEngines,
@@ -58,13 +63,25 @@ Please, refer to your OS documentation for the proper way to do so
If you have just one cloud configured, you can drop the switch
`--os-cloud=engines`, else adapt accordingly):
``` shell
- lcl$ openstack --os-cloud=engines [application] credential list
+ lcl$ openstack --os-cloud=engines credential list
+ lcl$ openstack --os-cloud=engines application credential list
```
### Task #2: configure TF for OpenStack ###
**Goal:** instruct TF to handle a single OpenStack instance.
+:bulb: Mind that the SwitchEngines' default _zone_ is "ZH", as it is shown in the top bar of the Horizon dashboard.
+Make sure that the same zone is configured in your `clouds.yaml`:
+
+```yaml
+clouds:
+ engines:
+ ...
+ region_name: "ZH"
+ ...
+```
+
Find out the smallest image to use for a Debian server:
``` shell
--
GitLab