Tools 🔧

A comprehensive collection of utility tools, scripts, and templates for modern development workflows. This repository provides reusable components for DevOps, CI/CD, containerization, and development automation.

Copilot

Available instructions

• Consolidated Instructions - All technologies in one file
• JavaScript/TypeScript - Scoped to JS/TS files
• Go - Scoped to Go files
• Kubernetes/Helm - Scoped to K8s YAML files
• GitHub Actions - Scoped to workflow files
• Docker - Scoped to Dockerfiles
• Bash/Shell - Scoped to shell scripts
• General Development - Universal practices

Usage

This collection follows GitHub's official Copilot instructions format with two approaches:

Option 1: Single File (Recommended for most projects)

curl -fsSL "https://raw.githubusercontent.com/this-is-tobi/tools/main/copilot/copilot-instructions.md" \
  -o ".github/copilot-instructions.md"

Option 2: Scoped Instructions (For complex multi-technology projects)

# Create instructions directory
mkdir -p .github/instructions

# Copy specific technology instructions
TECHNOLOGY="javascript"  # or "go", "docker", "kubernetes", etc.
curl -fsSL "https://raw.githubusercontent.com/this-is-tobi/tools/main/copilot/instructions/$TECHNOLOGY.instructions.md" \
  -o ".github/instructions/$TECHNOLOGY.instructions.md"

Features

• GitHub Official Format: Uses .github/copilot-instructions.md and .github/instructions/*.instructions.md
• Scoped Instructions: Technology-specific instructions with applyTo frontmatter
• File Targeting: Instructions only apply to relevant file types
• Modular Design: Mix and match technologies as needed
• VS Code Compatible: Full support for advanced scoped instructions

DevOps

This section contains templates and configurations for modern DevOps practices, focusing on Kubernetes orchestration and CI/CD automation.

ArgoCD App Previews

Templates to configure preview environments with ArgoCD by using the Pull Request Generator. The Pull Request generator uses the API of an SCMaaS provider (GitHub, GitLab, Gitea, Bitbucket, ...) to automatically discover open pull requests within a repository, this fits well with the style of building a test environment when you create a pull request.

• github-appset.yaml

For further information, see ArgoCD documentation.

Github Self-Hosted Runners

Templates to deploy Github Actions Runners across a Kubernetes cluster.

Using legacy install:

1. Install actions-runner-controller helm chart.

   # Get chart informations
   
   helm show chart actions-runner-controller --repo https://actions-runner-controller.github.io/actions-runner-controller
   helm show values actions-runner-controller --repo https://actions-runner-controller.github.io/actions-runner-controller

2. Deploy the runner-deployment.yaml.

Using github install:

1. Install actions-runner-controller helm chart.

   # Get chart informations
   
   helm show chart oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set-controller
   helm show values oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set-controller

For further information, see :

• Legacy ARC documentation.
• Github ARC documentation.

Docker

This section provides a collection of pre-built Docker images and templates designed for various development and operational tasks.

Utils Images

Image	Description	Dockerfiles
ghcr.io/this-is-tobi/tools/act-runner	act runner image for local CI tests (ubuntu based).	Dockerfile
ghcr.io/this-is-tobi/tools/debug	debug image with all convenients tools (debian based).	Dockerfile
ghcr.io/this-is-tobi/tools/dev	development image with all convenients tools (debian based).	Dockerfile
ghcr.io/this-is-tobi/tools/gh-runner	github self hosted runner with common packages (ubuntu based).	Dockerfile
ghcr.io/this-is-tobi/tools/gh-runner-gpu	github self hosted runner with common packages and GPU binaries (ubuntu based).	Dockerfile
ghcr.io/this-is-tobi/tools/homelab-utils	helper image used for homelab configuration (alpine based).	Dockerfile
ghcr.io/this-is-tobi/tools/mc	ligthweight image with tools for s3 manipulations (alpine based).	Dockerfile
ghcr.io/this-is-tobi/tools/pg-backup	helper image to backup postgresql to s3 (postgres based).	Dockerfile
ghcr.io/this-is-tobi/tools/s3-backup	helper image to backup s3 bucket to another s3 bucket (debian based).	Dockerfile
ghcr.io/this-is-tobi/tools/vault-backup	helper image to backup vault raft cluster to s3 bucket (vault based).	Dockerfile

Versions correlation table:

Name	Image version	Base image
act-runner	2.0.3	docker.io/ubuntu:24.04
debug	2.1.1	docker.io/debian:12
dev	2.0.3	docker.io/debian:12
gh-runner	1.4.1	ghcr.io/actions/actions-runner:2.328.0
gh-runner-gpu	1.2.1	ghcr.io/actions/actions-runner:2.328.0
homelab-utils	0.0.1	ghcr.io/actions/alpine:3.22.1
mc	1.1.2	docker.io/alpine:3.22.1
pg-backup	3.5.0	docker.io/postgres:17.6
pg-backup	2.5.0	docker.io/postgres:16.10
pg-backup	1.9.0	docker.io/postgres:15.14
s3-backup	1.2.0	docker.io/debian:12
vault-backup	1.6.2	docker.io/hashicorp/vault:1.20.2

TIP

The backup images are supplied with a sample kubernetes cronjob in their respective folders.

Template Images

Pre-configured Docker image templates that can be customized for specific use cases.

Name	Description
nginx	bitnami/nignx rootless conf with variables substitution.

Git Hooks

This section provides a collection of Git hooks to enforce code quality, commit conventions, and security practices in your repositories.

Hooks List

Name	Type	Description	Config
conventional-commit	commit-msg	pure bash check for conventional commit pattern in git commit messages.	-
eslint-lint	pre-commit	lint js, ts and many more files using eslint.	eslint.config.js
helm-lint	pre-commit	lint helm charts using chart-testing.	chart-testing.yaml
signed-commit	pre-push	pure bash check if commits are signed.	-
yaml-lint	pre-commit	lint yaml using yamllint.	yamllint.yaml

Quick Setup

Run the following command to download the hook from the GitHub repository and install it in your current repository:

# Define the target hook, file and the URL to download from
# Replace '<git_hook>' by the name of the hook you want to copy (eg. 'conventional-commit')
HOOK_NAME="<git_hook>"
TARGET_FILE=".git/hooks/$HOOK_NAME"
URL="https://raw.githubusercontent.com/this-is-tobi/tools/main/git-hooks/$HOOK_NAME"

# Check if the target file exists
if [ -f "$TARGET_FILE" ]; then
  # File exists, download the content and remove the shebang from the first line
  curl -fsSL "$URL" | sed '1 s/^#!.*//' >> "$TARGET_FILE"
else
  # File does not exist, create the file with the downloaded content
  curl -fsSL "$URL" -o "$TARGET_FILE"
fi

# Ensure the file is executable
chmod +x "$TARGET_FILE"

Scripts

A collection of utility scripts for common development and operations tasks, organized by technology and purpose.

Node.js Utilities

Name	Description
crypto.mjs	set of crypto functions.

Shell Scripts

Bash/shell scripts for automation, backup operations, and system administration tasks.

Name	Description
backup-kube-pg.sh	backup / restore postgres database from / to a kubernetes pod.
backup-kube-vault.sh	backup / restore vault raft cluster from / to a kubernetes pod.
clone-subdir.sh	clone a subdirectory from a git repository.
compose-to-matrix.sh	parse docker-compose file to create github matrix.
copy-env-examples.sh	copy all git project env*-examples files to env files.
delete-ghcr-image.sh	delete image and subsequent manifests from ghcr.
eol-infos.sh	get package end of life infos.
export-argocd-resources.sh	export ready-to-apply argocd resources.
export-kube-resources.sh	export ready-to-apply kubernetes resources.
helm-template.sh	generate helm template.
init-env-files.sh	init '.env' and '.yaml' example files by copying them without '-example'.
keycloak-add-clients.sh	add keycloak clients for a given keycloak realm.
keycloak-add-users.sh	add keycloak users for a given keycloak realm.
keycloak-get-token.sh	display keycloak token for the given infos.
keycloak-list-users.sh	list keycloak users for a given keycloak realm.
keycloak-required-tac.sh	add terms and conditions required action to all realm users.
manage-etc-hosts.sh	add or update host ip adress in /etc/hosts.
purge-ghcr-tags.sh	purge ghcr tags older than a given date.
trivy-report.sh	parse trivy json reports to create a markdown summary.
update-zsh-completions.sh	update zsh-completions sources.

TIP

Using a script directly from a curl command :

curl -s https://raw.githubusercontent.com/this-is-tobi/tools/main/shell/<script_name> | bash -s -- -h

Development Tools

Local development environment tools and wrappers for testing and development workflows.

Name	Description
act	local github action act wrapper.
kind	local kubernetes kind wrapper.

Sources

Take a look at the project sources.