Github Configuration

The basic configuration for all (relevant) Github Repositories is done from a Github Actions workflow to ensure all repositories are set up in a similar way and to avoid manual steps as much as possible. Additionally the config is updated to the desired state regularly to avoid (invalid) updates (which mostly are done manually). Terraform is used to ensure this desired consistent state accross all repositories.

Prerequisites

  1. Create a Personal Access Token for your Github Account to use with Terraform. The minimum required scopes are repo and read:user

  2. Create Actions secrets for sebastian-sommerfeld-io/configs repo

    1. BW_CLIENT_ID: https://vault.bitwarden.com → Account Settings → Security → View API key

    2. BW_CLIENT_SECRET: https://vault.bitwarden.com → Account Settings → Security → View API key

    3. BW_MASTER_PASS: https://vault.bitwarden.com → Account Settings → Security → View API key

    4. TERRAFORM: The Github Personal Access Token github.com/settings/tokens → Settings Developer settings → Tokens (classic)

Building Blocks

The Github Actions workflow configures issue labels and secrets for a lot of Github repositories. It needs four Actions secrets configured (see Prerequisites) to access Bitwarden (BW_* → load other secrets) and to access Github repositories and projects (TERRAFORM).

puml-build-image

The Terraform state is stored in a separate private repository. The pipeline clones this repo, applies the Terraform config and pushes the updated Terraform state back to the repository.

Terraform Config

Available (Terraform) commands

The apply-config.sh script can handle these commands. Wile developing use run-local.sh on your localhost instead of direct calls to this script. run-local.sh provides a more conviniert way to trigger the terraform commands.

  • apply → Executes the actions proposed in a Terraform plan.

  • cleanup → Cleanup local filesystem.

  • docs → Generate Asciidoc for this Terraform configration and write into Antora partials directory.

  • fmt → Rewrite Terraform configuration files to a canonical format and style.

  • init → Initializes a working directory containing Terraform configuration files. This is the first command that should be run.

  • lint → Run TFLint in Docker container to check the Terraform config.

  • plan → Create an execution plan, which lets you preview the changes that Terraform plans to make.

  • validate → Validates configuration files in a directory, referring only to configuration and not accessing any remote services.

  • -version → Display Terraform version.

Requirements

Name Version

terraform

1.3.7

bitwarden

0.5.0

github

5.18.0

local

2.3.0

Providers

Name Version

bitwarden

0.5.0

github

5.18.0

Inputs

Name Description Type Default Required

bw_client_id

Bitwarden Client ID (Github Actions Secret) - Needed for Terraform Provider to read Data from Bitwarden

string

n/a

yes

bw_client_secret

Bitwarden Client Secret (Github Actions Secret) - Needed for Terraform Provider to read Data from Bitwarden

string

n/a

yes

bw_email

Bitwarden Email - Needed for Terraform Provider to read Data from Bitwarden

string

"sebastian@sommerfeld.io"

no

bw_password

Bitwarden Master Key (Github Actions Secret) - Needed for Terraform Provider to read Data from Bitwarden

string

n/a

yes

Modules

Name Source Version

configs-issues

configs-persistent-data-issues

docker-image-adoc-antora-docker-pipelines

docker-image-adoc-antora-issues

docker-image-folderslint-docker-pipelines

docker-image-folderslint-issues

docker-image-ftp-client-docker-pipelines

docker-image-ftp-client-issues

docker-image-git-docker-pipelines

docker-image-git-issues

docker-image-jq-docker-pipelines

docker-image-jq-issues

docker-image-terraform-docker-pipelines

docker-image-terraform-issues

dojo-issues

github-action-generate-docs-issues

github-action-generate-readme-issues

github-action-update-antora-yml-issues

jarvis-issues

jiracli-docker-pipelines

jiracli-issues

monitoring-issues

provinzial-issues

trashbox-issues

tron-docker-pipelines

tron-issues

website-masterblender-de-docker-pipelines

website-masterblender-de-issues

website-numero-uno-de-docker-pipelines

website-numero-uno-de-issues

website-sommerfeld-io-docker-pipelines

website-sommerfeld-io-issues

website-tafelboy-de-docker-pipelines

website-tafelboy-de-issues

Resources

Name Type

github_actions_secret.configs_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.configs_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-adoc-antora_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-adoc-antora_DOCKERHUB_USER

resource

github_actions_secret.docker-image-adoc-antora_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-adoc-antora_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-adoc-antora_SNYK_TOKEN

resource

github_actions_secret.docker-image-folderslint_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-folderslint_DOCKERHUB_USER

resource

github_actions_secret.docker-image-folderslint_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-folderslint_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-folderslint_SNYK_TOKEN

resource

github_actions_secret.docker-image-ftp-client_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-ftp-client_DOCKERHUB_USER

resource

github_actions_secret.docker-image-ftp-client_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-ftp-client_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-ftp-client_SNYK_TOKEN

resource

github_actions_secret.docker-image-git_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-git_DOCKERHUB_USER

resource

github_actions_secret.docker-image-git_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-git_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-git_SNYK_TOKEN

resource

github_actions_secret.docker-image-jq_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-jq_DOCKERHUB_USER

resource

github_actions_secret.docker-image-jq_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-jq_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-jq_SNYK_TOKEN

resource

github_actions_secret.docker-image-terraform_DOCKERHUB_TOKEN

resource

github_actions_secret.docker-image-terraform_DOCKERHUB_USER

resource

github_actions_secret.docker-image-terraform_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.docker-image-terraform_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.docker-image-terraform_SNYK_TOKEN

resource

github_actions_secret.dojo_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.dojo_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.dojo_SONARCLOUD_TOKEN

resource

github_actions_secret.github-action-generate-docs_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.github-action-generate-docs_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.github-action-generate-readme_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.github-action-generate-readme_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.github-action-update-antora-yml_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.github-action-update-antora-yml_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.jarvis_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.jarvis_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.jiracli_DOCKERHUB_TOKEN

resource

github_actions_secret.jiracli_DOCKERHUB_USER

resource

github_actions_secret.jiracli_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.jiracli_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.jiracli_SNYK_TOKEN

resource

github_actions_secret.jiracli_SONARCLOUD_TOKEN

resource

github_actions_secret.monitoring_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.monitoring_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.provinzial_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.provinzial_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.trashbox_EXAMPLE_FROM_TERRAFORM

resource

github_actions_secret.trashbox_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.trashbox_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.tron_DOCKERHUB_TOKEN

resource

github_actions_secret.tron_DOCKERHUB_USER

resource

github_actions_secret.tron_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.tron_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.tron_SNYK_TOKEN

resource

github_actions_secret.tron_SONARCLOUD_TOKEN

resource

github_actions_secret.website-masterblender-de_DOCKERHUB_TOKEN

resource

github_actions_secret.website-masterblender-de_DOCKERHUB_USER

resource

github_actions_secret.website-masterblender-de_FTP_PASS

resource

github_actions_secret.website-masterblender-de_FTP_USER

resource

github_actions_secret.website-masterblender-de_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.website-masterblender-de_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.website-masterblender-de_SNYK_TOKEN

resource

github_actions_secret.website-numero-uno-de_DOCKERHUB_TOKEN

resource

github_actions_secret.website-numero-uno-de_DOCKERHUB_USER

resource

github_actions_secret.website-numero-uno-de_FTP_PASS

resource

github_actions_secret.website-numero-uno-de_FTP_USER

resource

github_actions_secret.website-numero-uno-de_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.website-numero-uno-de_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.website-numero-uno-de_SNYK_TOKEN

resource

github_actions_secret.website-sommerfeld-io_DOCKERHUB_TOKEN

resource

github_actions_secret.website-sommerfeld-io_DOCKERHUB_USER

resource

github_actions_secret.website-sommerfeld-io_FTP_PASS

resource

github_actions_secret.website-sommerfeld-io_FTP_USER

resource

github_actions_secret.website-sommerfeld-io_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.website-sommerfeld-io_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.website-sommerfeld-io_SNYK_TOKEN

resource

github_actions_secret.website-tafelboy-de_DOCKERHUB_TOKEN

resource

github_actions_secret.website-tafelboy-de_DOCKERHUB_USER

resource

github_actions_secret.website-tafelboy-de_FTP_PASS

resource

github_actions_secret.website-tafelboy-de_FTP_USER

resource

github_actions_secret.website-tafelboy-de_GH_TOKEN_REPO_AND_PROJECT

resource

github_actions_secret.website-tafelboy-de_GOOGLE_CHAT_WEBHOOK

resource

github_actions_secret.website-tafelboy-de_SNYK_TOKEN

resource

github_issue_label.jiracli_19_1

resource

github_issue_label.provinzial_19_1

resource

github_issue_label.provinzial_organzation

resource

github_issue_label.provinzial_recurring

resource

github_issue_label.provinzial_training_certs

resource

github_issue_label.tron_19_1

resource

bitwarden_item_login.DOCKERHUB_USER

data source

bitwarden_item_login.GH_TOKEN_REPO_AND_PROJECT

data source

bitwarden_item_login.GOOGLE_CHAT_WEBHOOK

data source

bitwarden_item_login.SNYK_TOKEN

data source

bitwarden_item_login.docker-image-adoc-antora_DOCKERHUB_TOKEN

data source

bitwarden_item_login.docker-image-folderslint_DOCKERHUB_TOKEN

data source

bitwarden_item_login.docker-image-ftp-client_DOCKERHUB_TOKEN

data source

bitwarden_item_login.docker-image-git_DOCKERHUB_TOKEN

data source

bitwarden_item_login.docker-image-jq_DOCKERHUB_TOKEN

data source

bitwarden_item_login.docker-image-terraform_DOCKERHUB_TOKEN

data source

bitwarden_item_login.dojo_SONARCLOUD_TOKEN

data source

bitwarden_item_login.jiracli_DOCKERHUB_TOKEN

data source

bitwarden_item_login.jiracli_SONARCLOUD_TOKEN

data source

bitwarden_item_login.tron_DOCKERHUB_TOKEN

data source

bitwarden_item_login.tron_SONARCLOUD_TOKEN

data source

bitwarden_item_login.website-masterblender-de_DOCKERHUB_TOKEN

data source

bitwarden_item_login.website-masterblender-de_FTP_PASS

data source

bitwarden_item_login.website-masterblender-de_FTP_USER

data source

bitwarden_item_login.website-numero-uno-de_DOCKERHUB_TOKEN

data source

bitwarden_item_login.website-numero-uno-de_FTP_PASS

data source

bitwarden_item_login.website-numero-uno-de_FTP_USER

data source

bitwarden_item_login.website-sommerfeld-io_DOCKERHUB_TOKEN

data source

bitwarden_item_login.website-sommerfeld-io_FTP_PASS

data source

bitwarden_item_login.website-sommerfeld-io_FTP_USER

data source

bitwarden_item_login.website-tafelboy-de_DOCKERHUB_TOKEN

data source

bitwarden_item_login.website-tafelboy-de_FTP_PASS

data source

bitwarden_item_login.website-tafelboy-de_FTP_USER

data source

github_repository.configs

data source

github_repository.configs-persistent-data

data source

github_repository.docker-image-adoc-antora

data source

github_repository.docker-image-folderslint

data source

github_repository.docker-image-ftp-client

data source

github_repository.docker-image-git

data source

github_repository.docker-image-jq

data source

github_repository.docker-image-terraform

data source

github_repository.dojo

data source

github_repository.github-action-generate-docs

data source

github_repository.github-action-generate-readme

data source

github_repository.github-action-update-antora-yml

data source

github_repository.jarvis

data source

github_repository.jiracli

data source

github_repository.monitoring

data source

github_repository.provinzial

data source

github_repository.trashbox

data source

github_repository.tron

data source

github_repository.website-masterblender-de

data source

github_repository.website-numero-uno-de

data source

github_repository.website-sommerfeld-io

data source

github_repository.website-tafelboy-de

data source

Outputs

No outputs.