Support Dev Containers / Github Codespaces #124584

bells17 · 2024-04-27T20:14:26Z

Based on:

https://kubernetes.slack.com/archives/C1TU9EB9S/p1714223550391479?thread_ts=1713701062.612009&cid=C1TU9EB9S

What type of PR is this?

/kind feature
/sig architecture
/sig contributor-experience

What this PR does / why we need it:

This PR adds configuration files for running dev containers.

Currently, I am developing on Mac OS X, but sometimes I encounter errors like the one mentioned below:
#124156

By enabling the use of dev containers in the k/k repository, I can reduce the discrepancies in the development environment caused by differences in operating systems, and decrease the occurrence of errors like the one mentioned above.

Which issue(s) this PR fixes:

Fixes #113019

Special notes for your reviewer:

To ensure that all tools mentioned in the Development Guide are installed, I use the dev container feature and setup.sh to install any tools that are not already included in the kube-cross Dockerfile.

The following commands have been confirmed to work successfully in VSCode Dev Containers / Github Codespaces:

make
make verify
make update
make test
make test-integration

Running e2e tests with kubetest2:

KUBETEST2_RUN_DIR=$(pwd)/_output/local/go/bin/ kubetest2 kind -v 2 \
    --build \
    --up \
    --down \
    --test=ginkgo \
    -- \
    --parallel 4 \
    --focus-regex='TTLAfterFinished'

Does this PR introduce a user-facing change?

Added support for using a [devcontainer](https://containers.dev/) when developing Kubernetes.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

- [Usage]: https://github.com/features/codespaces
- [More Info]: https://containers.dev/

cc @craiglpeters

k8s-ci-robot · 2024-04-27T20:14:28Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

k8s-ci-robot · 2024-04-27T20:14:34Z

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

bells17 · 2024-04-27T20:15:07Z

.devcontainer/devcontainer.json

+
+    // Add etcd path to PATH
+    "remoteEnv": {
+        "PATH": "${containerEnv:PATH}:${containerEnv:GOPATH}/src/k8s.io/kubernetes/third_party/etcd"


https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#etcd

bells17 · 2024-04-27T20:15:18Z

.devcontainer/setup.sh

+rm -f /etc/apt/sources.list.d/google-cloud-sdk.list
+
+# Install PyYAML
+pip3 install pyyaml


https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#pyyaml

k8s-ci-robot · 2024-04-27T20:15:22Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bells17
Once this PR has been reviewed and has the lgtm label, please assign dims for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

bells17 · 2024-04-27T20:15:36Z

.devcontainer/setup.sh

+# Never push to upstream master
+git remote set-url --push upstream no_push
+
+# Install gcloud command


https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#gcloud

bells17 · 2024-04-27T20:19:12Z

.devcontainer/setup.sh

+mkdir -p /usr/local/etc/vscode-dev-containers
+cp .devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt
+
+# Ensure that the upstream remote is set, and configure it if it's not


https://www.kubernetes.dev/docs/guide/github-workflow/#2-clone-fork-to-local-storage

bells17 · 2024-04-27T20:21:26Z

.devcontainer/setup.sh

+
+# Install kind & kubetest2 for e2e testing
+go install sigs.k8s.io/kind@latest
+go install sigs.k8s.io/kubetest2/...@latest


https://github.com/kubernetes-sigs/kubetest2#installation

bells17 · 2024-04-27T20:27:18Z

.devcontainer/devcontainer.json

+
+    // Features to add to the dev container. More info: https://containers.dev/features
+    "features": {
+        // The first-run-notice.txt is displayed by a script within


https://github.com/devcontainers/features/blob/main/src/common-utils/scripts/rc_snippet.sh

bells17 · 2024-04-27T20:31:52Z

.devcontainer/welcome-message.txt

+
+🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).
+
+🤖 Run e2e test command example:


I’m not familiar with the best command to easily run e2e tests in a local environment, so I would appreciate any guidance.
(I believe it is preferable to use a deployer like kind that allows anyone to easily run it locally.)

https://kubernetes.slack.com/archives/C09QZ4DQB/p1714322316537309?thread_ts=1714273693.871849&cid=C09QZ4DQB

bells17 · 2024-04-28T05:18:21Z

/retest

bells17 · 2024-04-28T06:21:11Z

I'll add individuals who appear to be related to the original PR as reviewers:
#121561

/cc @craiglpeters @mrbobbytables @cblecker @sftim

Copy from kubernetes#121561

c9f4f0d

k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Apr 27, 2024

bells17 commented Apr 27, 2024

View reviewed changes

k8s-ci-robot requested review from johnbelamaric and logicalhan April 27, 2024 20:15

bells17 commented Apr 27, 2024

View reviewed changes

bells17 force-pushed the devcontainer branch 2 times, most recently from 364df68 to 905bc10 Compare April 27, 2024 20:26

bells17 commented Apr 27, 2024

View reviewed changes

bells17 marked this pull request as ready for review April 27, 2024 20:48

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 27, 2024

k8s-ci-robot requested a review from dims April 27, 2024 20:48

bells17 force-pushed the devcontainer branch from 905bc10 to bea012d Compare April 28, 2024 04:03

bells17 force-pushed the devcontainer branch from bea012d to 479b790 Compare April 28, 2024 06:04

k8s-ci-robot requested review from cblecker and craiglpeters April 28, 2024 06:21

k8s-ci-robot requested review from mrbobbytables and sftim April 28, 2024 06:21

bells17 force-pushed the devcontainer branch 2 times, most recently from 68f0c9a to 2fda795 Compare April 28, 2024 12:28

Update devcontainer config

dadcabd

bells17 force-pushed the devcontainer branch from 2fda795 to dadcabd Compare April 28, 2024 12:45

bells17 mentioned this pull request Apr 28, 2024

Support Dev Containers / Github Codespaces #121561

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Dev Containers / Github Codespaces #124584

Support Dev Containers / Github Codespaces #124584

bells17 commented Apr 27, 2024 •

edited

k8s-ci-robot commented Apr 27, 2024

k8s-ci-robot commented Apr 27, 2024

bells17 Apr 27, 2024

bells17 Apr 27, 2024

k8s-ci-robot commented Apr 27, 2024

bells17 Apr 27, 2024

bells17 Apr 27, 2024

bells17 Apr 27, 2024 •

edited

bells17 Apr 27, 2024

bells17 Apr 27, 2024 •

edited

bells17 Apr 28, 2024

bells17 commented Apr 28, 2024

bells17 commented Apr 28, 2024


		🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).

		🤖 Run e2e test command example:

Support Dev Containers / Github Codespaces #124584

Are you sure you want to change the base?

Support Dev Containers / Github Codespaces #124584

Conversation

bells17 commented Apr 27, 2024 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

k8s-ci-robot commented Apr 27, 2024

k8s-ci-robot commented Apr 27, 2024

bells17 Apr 27, 2024

Choose a reason for hiding this comment

bells17 Apr 27, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 27, 2024

bells17 Apr 27, 2024

Choose a reason for hiding this comment

bells17 Apr 27, 2024

Choose a reason for hiding this comment

bells17 Apr 27, 2024 • edited

Choose a reason for hiding this comment

bells17 Apr 27, 2024

Choose a reason for hiding this comment

bells17 Apr 27, 2024 • edited

Choose a reason for hiding this comment

bells17 Apr 28, 2024

Choose a reason for hiding this comment

bells17 commented Apr 28, 2024

bells17 commented Apr 28, 2024

bells17 commented Apr 27, 2024 •

edited

bells17 Apr 27, 2024 •

edited

bells17 Apr 27, 2024 •

edited