feat: Add devcontainer to simplify configuration

Author: Alan Christie

.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+FROM mcr.microsoft.com/devcontainers/python:1-3.13-bullseye
+
+# The platform (CPU architecture)
+# if not provided by a build-arg we take a default (ARM)
+ARG PLATFORM=amd64
+ENV PLATFORM=$PLATFORM
+
+# Install our main Python requirements
+# and kubectl
+ARG KUBECTL_VERSION=1.32.8
+COPY requirements.txt /tmp
+RUN pip install -r /tmp/requirements.txt \
+    && rm /tmp/requirements.txt \
+    && curl -LO "https://dl.k8s.io/release/v${KUBECTL_VERSION}/bin/linux/${PLATFORM}/kubectl" \
+    && install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

.devcontainer/devcontainer.json

@@ -0,0 +1,61 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Ansible Infrastructure Python 3.13",
+	"build": {
+    "dockerfile": "Dockerfile",
+    // Args is one of arm64 or amd64
+    "args": {
+      "PLATFORM": "${localEnv:PLATFORM:arm64}"
+    }
+  },
+	"features": {
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {
+			"moby": true,
+			"azureDnsAutoDetection": true,
+			"installDockerBuildx": true,
+			"installDockerComposeSwitch": true,
+			"version": "latest",
+			"dockerDashComposeVersion": "v2"
+		},
+		"ghcr.io/devcontainers/features/git:1": {
+			"ppa": true,
+			"version": "os-provided"
+		}
+	},
+  // We mount bash history in an attempt to preserver history
+  // between container restarts
+  // (see https://code.visualstudio.com/remote/advancedcontainers/persist-bash-history)
+  //
+  // The user will also need a ~/k8s-config directory (kubernetes config files)
+  // as well as a ~/.kube directory
+  "mounts": [
+      "source=${localEnv:HOME}/.gitconfig,target=/home/vscode/.gitconfig,type=bind,consistency=cached",
+      "source=${localEnv:HOME}/k8s-config,target=/k8s-config,type=bind,consistency=cached",
+      "source=${localEnv:HOME}/.kube,target=/home/vscode/.kube,type=bind,consistency=cached",
+      "source=projectname-bashhistory,target=/commandhistory,type=volume"
+  ],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "codezombiech.gitignore",
+        "donjayamanne.githistory",
+        "donjayamanne.git-extension-pack",
+        "eamodio.gitlens",
+        "github.vscode-github-actions",
+        "ms-kubernetes-tools.vscode-kubernetes-tools",
+        "ms-python.vscode-pylance",
+        "sourcery.sourcery",
+        "streetsidesoftware.code-spell-checker",
+        "trond-snekvik.simple-rst",
+        "vivaxy.vscode-conventional-commits",
+        "yzhang.markdown-all-in-one"
+      ]
+    }
+  },
+  "postCreateCommand": {
+		"Install Pre-Commit": "pre-commit install -t commit-msg -t pre-commit",
+    "Fix Volume Permissions": "sudo chown -R $(whoami): /commandhistory"
+	},
+  "forwardPorts": []
+}

.devcontainer/requirements.txt

@@ -0,0 +1,5 @@
+# Requirements file for the dev-container
+ansible == 12.0.0
+kubernetes == 31.0.0
+poetry == 2.2.1
+pre-commit == 4.3.0

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
 
 # Conventional Commit message checker (commitizen)
 - repo: https://github.com/commitizen-tools/commitizen
-  rev: v3.12.0
+  rev: v4.9.1
   hooks:
   - id: commitizen
     stages:
@@ -19,7 +19,7 @@ repos:
 
 # Standard pre-commit rules
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v6.0.0
   hooks:
   - id: check-case-conflict
   - id: check-docstring-first
@@ -36,7 +36,7 @@ repos:
     - --markdown-linebreak-ext=md
 
 - repo: https://github.com/adrienverge/yamllint
-  rev: v1.33.0
+  rev: v1.37.1
   hooks:
   - id: yamllint
 
@@ -51,6 +51,6 @@ repos:
 #    - ansible-core>=2.16.0
 
 - repo: https://github.com/IamTheFij/ansible-pre-commit
-  rev: v1.0.0
+  rev: v1.0.1
   hooks:
   - id: encryption-check

doc/getting-started.rst

@@ -4,7 +4,6 @@ Getting Started
 
 Prerequisites
 =============
-
 Before starting a basic understanding or experience with the following will
 be beneficial: -
 
@@ -13,8 +12,23 @@ be beneficial: -
 *   `Ansible Galaxy`_
 *   `Ansible Vault`_
 
-Working environment
-===================
+Working environment (VSCode)
+============================
+If you are familiar with VisualStudio Code the easiest way to get started is to use
+our built-in **development container**. It provides you with a pre-configured set of
+tools, including ``kubectl`` and ``pre-commit`` pre-configured.
+
+You will need to have two directories in your HOME directory: ``.kube`` (the default
+location for kubeconfig files) and ``k8-config``, our own directory where we tend to
+store all our installation config files, each in a separate kubeconfig file.
+
+..  warning::
+    Make sure you have these directories before you start your devcontainer,
+    otherwise the container build will fail.
+
+Working environment (DIY)
+=========================
+If you do not use VisualStudio the following instuctions should help you get started.
 
 Ideally you'll start from a Poetry environment::
 
@@ -35,7 +49,6 @@ And can then check the current diction fo the repository with::
 
 Cluster (Kubernetes) pre-requisites
 ===================================
-
 Your Kubernetes cluster will need: -
 
 1.  A **StorageClass** for the infrastructure database (postgres).
@@ -62,17 +75,16 @@ Your Kubernetes cluster will need: -
 
 Cluster credentials
 ===================
-
 You will also need a copy of your **kubeconfig** file and will need to set the
 ``KUBECONFIG`` environment variable to point to your copy. You can safely place
 the config in the root of a clone of this repository as the file
 ``kubeconfig`` as this is part of the project ignore set::
 
-    $ export KUBECONFIG=./kubeconfig
+    $ export KUBECONFIG=~/k8s-config/my-config
 
 Plays run from within AWX benefit from the automatic injection of Kubernetes
 variables. Once installed our AWX will inject the following environment
-cat variables: -
+variables: -
 
 -   ``K8S_AUTH_HOST``
 -   ``K8S_AUTH_API_KEY``
@@ -100,7 +112,6 @@ configuring via the environment for some of the Roles to properly function::
     export AWS_ACCESS_KEY_ID=xxxxxxxxxxxx
     export AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxx
 
-
 The permissions of the AWS user will depend on what you intend to deploy.
 Typically these will be something like: -
 

host_vars/localhost.yaml

@@ -1,6 +1,7 @@
 ---
 
 ansible_connection: local
+ansible_python_interpreter: python
 
 # Install core?
 core_state: present