Variables
Variables in TIAB are defined in \vars directory.
vars/runner_var.yml
These are the variables used for runners.
| Name | Required | Default Value | Description |
|---|---|---|---|
| domain | Yes | "tiab" | The domain to access the GitLab/OpenQA server. |
| gitlab_port | Yes | "444" | The port to access the GitLab instance. |
| gitlab_runner_coordinator_url | Yes | "https://{{ domain }}:{{ gitlab_port }}" | The full URL to register the GitLab against. |
| gitlab_runner_use_ssl | Yes | yes | If the GitLab instance uses a self signed SSL certificate. The runner will have to fetch it and verify it when registering against it. |
| gitlab_registration_key | Yes | None | The registration key to register the runner to the GitLab instance. This will need to be retrieved from GitLab and set yourself |
| openqa_server | Yes | "https://{{ domain }}:443" | The full URL of the OpenQA instance for the worker to use. |
| ser2net_devices | Yes | A list of devices for ser2net to use. Please have a look at documentation here for how to define a device |
gitlab_runners
This describes all the GitLab runners properties
| Name | Required | Default Value | Description |
|---|---|---|---|
| name | Yes | "GitLabRunner" | This is the name of the GitLab runner |
| executor | Yes | "docker" | The type of executor the runner will be. Please refer to the documentation on docs.gitlab.com for more information. |
| docker_image | Yes | "apline:latest" | The docker image the runner will use. |
| tags | Yes | "" | The tags for the GitLab runner to be registered against. |
vars/server_var.yml
These are the variables used for the server.
| Name | Required | Default Value | Description |
|---|---|---|---|
| gitlab_https_external_port | Yes | 444 | The port used to access the GitLab instance. |
| gitlab_domain | Yes | "tiab" | The domain used to access the GitLab instance. |
| gitlab_version | Yes | "15.11.9-ce.0" | The version of GitLab to be installed. |
| gitlab_external_url | Yes | "https://{{ gitlab_domain }}:{{ gitlab_https_external_port }}" | The full URL to be used to access the GitLab instance. By default this variable containers gitlab_domain and gitlab_https_external_port. |
| gitlab_self_signed_cert_subj | Yes | "/C=GB/ST=Greater Manchester /L=Manchester /O=IT/CN={{ gitlab_domain }}" | The subject the self-signed SSL certificate to be generated for the GitLab instance. |
| gitlab_ssl_certificate | Yes | "/etc/gitlab/ssl/{{ gitlab_domain }}.crt" | The path where the self-signed SSL certificate file is created for the GitLab |
| instance to use. | |||
| gitlab_ssl_certificate_key | Yes | "/etc/gitlab/ssl/{{gitlab_domain }}.key" | The path where the self-signed SSL certificate key file is created for the GitLab instance to use. |
| gitlab_username | Yes | "tiab" | A username that can be used to log-in to the GitLab instance. |
| gitlab_password | Yes | "t3st1ng1n4B0x" | The password used to access the generated user. |
| gitlab_root_access_token | Yes | "access_root_token_string" | The root gitlab access token generated to enable OAuth in OpenQA |
| gitlab_email | Yes | "testing.in.a.box@example.com" | The email registered to the GitLab user that has been generated. |
| openqa_url | Yes | "https://{{gitlab_domain}}:443" | The URL that can be used to access OpenQA. |
| gitlab_users_access_token | Yes | The users gitlab access token generated | |
| gitlab_external_url_api | http://server/api/v4/projects | The GitLab eternal url endpoint |
vars/tiab_vars.yml
| Name | Required | Default Value | Description |
|---|---|---|---|
| docker_registry | Yes | "registry.gitlab.com" | This is the url of the Docker container registry will use to fetch containers for TIAB. All the Docker Containers are stored in GitLab. There is no need to change this variable. |
| docker_username | Yes | The account username of the Docker container registry for logging in. No default value is set and needs to be specified. | |
| docker_password | Yes | The account password for the Docker container registry for logging in. No default value is set and needs to be specified. For GitLab, a Personal Access Token (PAC) with read_registry permissions will need to be generated in place of the accounts password. For more information on PAC you can find it here. |
|
| gitlab_root_password | Yes | The initial password for the GitLab root (admin) user | |
| gitlab_root_pubkey | Yes | SSH public key for the GitLab root (admin) user | |
| retrieve_credentials | yes | yes | Retrieve GitLab credentials and OpenQA secrets to be used for runners. |