diff --git a/README.md b/README.md index 8616d5c67a0dabb1c95b1cc5446b73590f374e63..96552378dfba0711c11f2f98465bcf191b34f478 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,17 @@ In addition to CI/CD features and shared runners (see the [Prerequisites section](https://gitlab.inria.fr/gitlabci_gallery#prerequisites)), this project needs: +- Infrastructure to be activated: + - On the left sidebar in the Gitlab interface, go to **Settings** → **General**. + - Expand **Visibility, project features, permissions**. + - Turn on **Infrastructure**. + - Select Save changes. + > **Notes:** + > 1. Infrastructure as Code is described in the + > [Gitlab documentation](https://docs.gitlab.com/ee/user/infrastructure/index.html#infrastructure-as-code) + > 2. To view infrastructure status, on the left sidebar in the Gitlab + > interface, go to **Operate** → **Terraform states**. + - A dedicated project on [ci.inria.fr](https://ci.inria.fr): see the [tutorial](https://ci.inria.fr/doc/page/web_portal_tutorial/) @@ -61,7 +72,7 @@ this project needs: > to create its own virtual machines, unless if there are naming > conflicts. Therefore, you don't need to start from an empty > project. - > 2. [gitlabcigallery-opentofu](https://ci.inria.fr/project/gitlabcigallery-opentofu) + > 2. [gitlabcigallery-opentofu](https://ci.inria.fr/project/gitlabcigallery-opentofu/show) > was created for this tutorial. - A dedicated user on [ci.inria.fr](https://ci.inria.fr), @@ -151,11 +162,11 @@ this project needs: we can run locally `git update-index --assume-unchanged backend.tf` after having removed `backend.tf` for `git` to ignore this change. -- The pipeline defined in `.gitlab-ci.yml` contains a non-blocking step `fmt` +- The pipeline defined in `.gitlab-ci.yml` contains a step `format and validate` to check that `*.tf` files are formatted accordingly to the OpenTofu guidelines. - Automatic reformatting can be performed locally with the command - `tofu fmt`. + Automatic reformatting and `*.tf` files validation can be performed locally + respectively with the commands `tofu fmt` and `tofu init; tofu validate`. The file [`.pre-commit-config.yaml`](.pre-commit-config.yaml) defines a pre-commit hook to validate configuration files and perform automatic reformatting before each commit: you may enable it by @@ -331,7 +342,7 @@ resource "cloudstack_instance" "windows" { connection to work. - `gitlab-runner` service is not started on boot by default in the - template: we start the service explicitely before registering the runner. + template: we start the service explicitly before registering the runner. ### Mac OS X 15 virtual machine @@ -399,7 +410,7 @@ The cloud-init configuration file [`cloud-init.yaml.tftpl`](cloud-init.yaml.tftpl) sets up the following: - the user `ci` can execute `sudo` without password, so that the destroy provisioner be able to unregister the runners; -- the SSH public key is registed as authorized key for `ci`, +- the SSH public key is registered as authorized key for `ci`, - by default, password authentication is disabled for `ci` (you may add `lock_passwd: false` to enable it again, [documentation](https://cloudinit.readthedocs.io/en/latest/reference/modules.html#users-and-groups));