You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage/github-organisation-management.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,8 @@ It is expected that all `plans` and `applies` are carried out within GitHub Acti
12
12
13
13
Access to Terraform Cloud is limited due to team size restrictions if you need access to Terraform Cloud and don't have access already then feel free to request access in the appropriate Slack channel.
14
14
15
+
GitHub authentication is handled using a GitHub app.
16
+
15
17
## Making Changes
16
18
17
19
In this section we shall look at how you may modify the Terraform configuration to suit your needs and requirements.
@@ -181,3 +183,11 @@ Run the script to rename the repository. Note that this will directly update the
181
183
```
182
184
183
185
Create a PR for the changes.
186
+
187
+
## StackHPC Release Train TF bot
188
+
189
+
GitHub authentication is handled using the [StackHPC Release Train TF bot App](https://github.com/organizations/stackhpc/settings/apps/stackhpc-release-train-tf-bot).
190
+
This app has a private key that is registered as a [GitHub secret](secrets.md).
191
+
The app is [installed](https://github.com/organizations/stackhpc/settings/installations/27194723) on the `stackhpc` organisation, with access to all repositories.
192
+
It has only the necessary permissions, but these are rather broad.
193
+
GitHub apps are documented [here](https://docs.github.com/en/apps/overview).
Various [GitHub Actions secrets](https://github.com/stackhpc/stackhpc-release-train/settings/secrets/actions) are used within StackHPC Release Train for integrating with external services.
4
+
All secrets are scoped to the StackHPC Release Train repository unless stated otherwise.
|`GALAXY_API_KEY`| Ansible Galaxy API token | stackhpc-ci GitHub user | Organisation secret used for importing Ansible content into Ansible Galaxy. |
10
+
|`repository_configuration_token`| GitHub PAT token | stackhpc-ci GitHub user | Used in [source code CI](source-code-ci.md) to create GitHub pull requests. |
11
+
|||| Used in [GitHub organisation management](github-organisation-management.md) to add comments to PRs. |
12
+
|`SLACK_WEBHOOK_URL`| Slack webhook URL | Infra team leads | Used to send Slack notifications on GitHub Actions workflow failures. |
13
+
|`TF_API_TOKEN`| Terraform Cloud API token | Jack | Used in GitHub organisation management to authenticate with Terraform cloud. |
14
+
|`TF_VAR_GITHUB_APP_PEM_FILE`| GitHub app PEM file | GitHub org admins | Used in GitHub organisation management to authorise Terraform to manage GitHub repositories. |
0 commit comments