Support Dev Containers / Github Codespaces

.devcontainer/devcontainer.json

@@ -0,0 +1,41 @@
+// For format details, see https:https://containers.dev/implementors/spec/. For config options, see the README at:
+// https://github.com/devcontainers/images/tree/main/src/base-debian
+{
+    "name": "Kubernetes with e2e testing image build and push",
+    "image": "mcr.microsoft.com/devcontainers/base:bullseye",
+    // Setup the go environment and mount into the dev container at the expected location
+    "hostRequirements": {
+        "cpus": 4
+    },
+    // Copy over welcome message and install pyyaml
+    "onCreateCommand": "bash .devcontainer/setup.sh",
+    // for Kubernetes testing, suppress extraneous forwarding messages
+    "otherPortsAttributes": {
+        "onAutoForward": "silent"
+    },
+    "remoteUser": "root",
+    // Install utils, go, docker-in-docker, and other tools
+    // For more info about dev container Features see https://containers.dev/features
+    "features": {
+        "ghcr.io/devcontainers/features/go:1": {
+            "version": "1.21.1",
+            "username": "root"
+        },
+        // Install kubectl, but skip minikube and helm
+        "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {
+            "version": "latest",
+            "helm": "none",
+            "minikube": "none"
+        },
+        // Enable running docker in docker
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+        "ghcr.io/devcontainers/features/sshd:1": {},
+        "ghcr.io/devcontainers/features/github-cli:1": {},
+        // Python required for some hack tools
+        "ghcr.io/devcontainers/features/python:1": {},
+        // TO DO - move these features from local to their projects, and publish them
+        "./local-features/kubectl-kind": {},
+        "./local-features/etcd": {},
+        "./local-features/kubetest2": {}
+    }
+}

.devcontainer/local-features/etcd/devcontainer-feature.json

@@ -0,0 +1,21 @@
+{
+    "id": "etcd",
+    "name": "ETCD",
+    "descrption": "Operating etcd clusters for Kubernetes",
+    "options": {
+        "version": {
+            "type": "string",
+            "proposals": [
+                "latest"
+            ],
+            "default": "latest",
+            "description": "Select or enter a version."
+        }
+    },
+    "containerEnv": {
+        "PATH": "/usr/local/etcd:${PATH}"
+    },
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/common-utils"
+    ]
+}

.devcontainer/local-features/etcd/install.sh

@@ -0,0 +1,92 @@
+#!/usr/bin/env bash
+# Copyright 2022 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Only supports Linux
+
+set -eux
+
+ETCD_VERSION="${VERSION:-"latest"}"
+
+# Figure out correct version of a three part version number is not passed
+find_version_from_git_tags() {
+    local variable_name=$1
+    local requested_version=${!variable_name}
+    if [ "${requested_version}" = "none" ]; then return; fi
+    local repository=$2
+    local prefix=${3:-"tags/v"}
+    local separator=${4:-"."}
+    local last_part_optional=${5:-"false"}
+    if [ "$(echo "${requested_version}" | grep -o "." | wc -l)" != "2" ]; then
+        local escaped_separator=${separator//./\\.}
+        local last_part
+        if [ "${last_part_optional}" = "true" ]; then
+            last_part="(${escaped_separator}[0-9]+)?"
+        else
+            last_part="${escaped_separator}[0-9]+"
+        fi
+        local regex="${prefix}\\K[0-9]+${escaped_separator}[0-9]+${last_part}$"
+        # shellcheck disable=SC2155
+        local version_list="$(git ls-remote --tags "${repository}" | grep -oP "${regex}" | tr -d ' ' | tr "${separator}" "." | sort -rV)"
+        if [ "${requested_version}" = "latest" ] || [ "${requested_version}" = "current" ] || [ "${requested_version}" = "lts" ]; then
+            # shellcheck disable=SC2086
+            declare -g ${variable_name}="$(echo "${version_list}" | head -n 1)"
+        else
+            set +e
+                # shellcheck disable=SC2086
+                declare -g ${variable_name}="$(echo "${version_list}" | grep -E -m 1 "^${requested_version//./\\.}([\\.\\s]|$)")"
+            set -e
+        fi
+    fi
+    if [ -z "${!variable_name}" ] || ! echo "${version_list}" | grep "^${!variable_name//./\\.}$" > /dev/null 2>&1; then
+        echo -e "Invalid ${variable_name} value: ${requested_version}\nValid values:\n${version_list}" >&2
+        exit 1
+    fi
+    # shellcheck disable=SC1079
+    echo "${variable_name}=${!variable_name}"
+}
+
+apt-get update
+apt-get -y install --no-install-recommends curl tar
+
+# Get closest match for version number specified
+find_version_from_git_tags ETCD_VERSION "https://github.com/etcd-io/etcd"
+
+# Installs etcd in ./third_party/etcd
+echo "Installing etcd ${ETCD_VERSION}..."
+
+architecture="$(uname -m)"
+case "${architecture}" in
+    "x86_64") architecture="amd64"
+    ;;
+    "aarch64" | "armv8*") architecture="arm64"
+    ;;
+    *) echo "(!) Architecture ${architecture} unsupported";
+    exit 1
+    ;;
+esac
+
+# shellcheck disable=SC1079
+FILE_NAME="etcd-v${ETCD_VERSION}-linux-${architecture}.tar.gz"
+curl -sSL -o "${FILE_NAME}" "https://github.com/coreos/etcd/releases/download/v${ETCD_VERSION}/${FILE_NAME}"
+tar xzf "${FILE_NAME}"
+
+# shellcheck disable=SC1073
+mv "etcd-v${ETCD_VERSION}-linux-amd64" /usr/local/etcd
+rm -rf "${FILE_NAME}"
+
+# Installs etcd in /usr/bin so we don't have to futz with the path.
+install -m755 /usr/local/etcd/etcd /usr/local/bin/etcd
+install -m755 /usr/local/etcd/etcdctl /usr/local/bin/etcdctl
+install -m755 /usr/local/etcd/etcdutl /usr/local/bin/etcdutl

.devcontainer/local-features/kubectl-kind/devcontainer-feature.json

@@ -0,0 +1,18 @@
+{
+    "id": "kubectl-kind",
+    "name": "Kubectl kind",
+    "description": "Installs kind - a tool for running local Kubernetes clusters using Docker container 'nodes'",
+    "options": {
+        "version": {
+            "type": "string",
+            "proposals": [
+                "latest"
+            ],
+            "default": "latest",
+            "description": "Select or enter a version."
+        }
+    },
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/go"
+    ]
+}

.devcontainer/local-features/kubectl-kind/install.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+# Copyright 2015 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# only supports Linux
+
+set -eux
+
+KIND_VERSION="${VERSION:-"latest"}"
+
+# Figure out correct version of a three part version number is not passed
+find_version_from_git_tags() {
+    local variable_name=$1
+    local requested_version=${!variable_name}
+    if [ "${requested_version}" = "none" ]; then return; fi
+    local repository=$2
+    local prefix=${3:-"tags/v"}
+    local separator=${4:-"."}
+    local last_part_optional=${5:-"false"}
+    if [ "$(echo "${requested_version}" | grep -o "." | wc -l)" != "2" ]; then
+        local escaped_separator=${separator//./\\.}
+        local last_part
+        if [ "${last_part_optional}" = "true" ]; then
+            last_part="(${escaped_separator}[0-9]+)?"
+        else
+            last_part="${escaped_separator}[0-9]+"
+        fi
+        local regex="${prefix}\\K[0-9]+${escaped_separator}[0-9]+${last_part}$"
+        # shellcheck disable=SC2155
+        local version_list="$(git ls-remote --tags "${repository}" | grep -oP "${regex}" | tr -d ' ' | tr "${separator}" "." | sort -rV)"
+        if [ "${requested_version}" = "latest" ] || [ "${requested_version}" = "current" ] || [ "${requested_version}" = "lts" ]; then
+            # shellcheck disable=SC2086
+            declare -g ${variable_name}="$(echo "${version_list}" | head -n 1)"
+        else
+            set +e
+                # shellcheck disable=SC2086
+                declare -g ${variable_name}="$(echo "${version_list}" | grep -E -m 1 "^${requested_version//./\\.}([\\.\\s]|$)")"
+            set -e
+        fi
+    fi
+    if [ -z "${!variable_name}" ] || ! echo "${version_list}" | grep "^${!variable_name//./\\.}$" > /dev/null 2>&1; then
+        echo -e "Invalid ${variable_name} value: ${requested_version}\nValid values:\n${version_list}" >&2
+        exit 1
+    fi
+    echo "${variable_name}=${!variable_name}"
+}
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+# Get closest match for version number specified
+find_version_from_git_tags KIND_VERSION "https://github.com/kubernetes-sigs/kind"
+
+echo "Installing kind ${KIND_VERSION}..."
+
+# Install kind
+go install sigs.k8s.io/kind@v"${KIND_VERSION}"
+
+chown -R "${_REMOTE_USER}:golang" "${GOPATH}"
+chmod -R g+r+w "${GOPATH}"
+find "${GOPATH}" -type d -print0 | xargs -n 1 -0 chmod g+s

.devcontainer/local-features/kubetest2/devcontainer-feature.json

@@ -0,0 +1,8 @@
+{
+    "id": "kubetest2",
+    "name": "Kubetest2",
+    "description": "Kubetest2 a framework for deploying Kubernetes clusters and running end to end tests",
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/go"
+    ]
+}

.devcontainer/local-features/kubetest2/install.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+# Copyright 2015 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# only supports Linux
+
+set -eux
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+echo "Installing kubetest2..."
+go install sigs.k8s.io/kubetest2/...@latest
+
+apt-get update
+apt-get -y install --no-install-recommends curl apt-transport-https ca-certificates gnupg
+echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
+
+curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo tee /usr/share/keyrings/cloud.google.gpg
+apt-get update && apt-get install google-cloud-cli
+
+chown -R "${_REMOTE_USER}:golang" "${GOPATH}"
+chmod -R g+r+w "${GOPATH}"
+find "${GOPATH}" -type d -print0 | xargs -n 1 -0 chmod g+s

.devcontainer/setup.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -eux
+
+cd "$(dirname "$0")"
+cd ../
+
+# Install pyyaml as required by verify.publishing-bot
+python3 -m pip install --user --upgrade --no-cache-dir pyyaml
+
+# Copies over welcome message
+cp .devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt
+
+git remote add upstream https://github.com/kubernetes/kubernetes.git || true
+# Never push to upstream master
+git remote set-url --push upstream no_push

.devcontainer/welcome-message.txt

@@ -0,0 +1,20 @@
+👋 Welcome to Kubernetes contribution in a dev container!
+     Works in GitHub Codespaces, VS Code, or in docker using the devcontainer cli
+
+See https://www.kubernetes.dev/docs/onboarding/ for guidance on contributing to Kuberentes
+
+This debian dev container image satisfies https://github.com/kubernetes/community/blob/master/contributors/devel/development.md and includes:
+ - kubernetes/kubernetes repository
+ - Docker
+ - go
+ - kubectl, etcd, kubetest2, and kind
+For details about dev containers and the debian dev container base image see https://containers.dev and https://github.com/devcontainers/images/tree/main/src/base-debian.
+The configuration for the dev container is in the .github/.devcontainer folder. (will be moved to prow)
+🎵 By default in Codespaces this environment uses a 4-core machine. Some tests may require a larger machine. In Codespaces you can change the machine type.
+   See https://docs.github.com/en/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace
+
+⚙️ If you are working in Codespaces on your own fork, this environment is automatically configured to support the GitHub
+   workflow https://www.kubernetes.dev/docs/guide/github-workflow/ (omit the clone step)
+↪️ Otherwise Codespaces will automatically fork the repository for you when you make your first push
+
+🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).