linkerd2/.devcontainer
Oliver Gould f33bb7beed
Add a devcontainer configuration (#7583)
VS Code [devcontainers][dc] provide a way to define a reproducible,
customizable developer environment. This should lower the barrier to
entry for contributors and reduce the maintenance burden for existing
developers, as a docker daemon is now basically all that's needed to get
up and running.

This change adds a devcontainer for the Linkerd2 project. Its container
starts in the host's network so that it can easily access k3d clusters
running on the host's docker daemon.

[dc]: https://code.visualstudio.com/docs/remote/containers

Signed-off-by: Oliver Gould <ver@buoyant.io>
2022-01-11 14:38:18 -08:00
..
Dockerfile Add a devcontainer configuration (#7583) 2022-01-11 14:38:18 -08:00
README.md Add a devcontainer configuration (#7583) 2022-01-11 14:38:18 -08:00
devcontainer.json Add a devcontainer configuration (#7583) 2022-01-11 14:38:18 -08:00

README.md

devcontainer

This directory provides a devcontainer configuration that configures a reproducible development environment for this project.

Docker

This configuration currently uses the parent host's Docker daemon (rather than running a separate docker daemon within in the container). It creates devcontainers on the host network so it's easy to use k3d clusters hosted in the parent host's docker daemon.

Customizing

This configuration is supposed to provide a minimal setup without catering to any one developer's personal tastes. Devcontainers can be extended with per-user configuration.

To add your own extensions to the devcontainer, configure default extensions in your VS Code settings:

    "remote.containers.defaultExtensions": [
        "eamodio.gitlens",
        "GitHub.copilot",
        "GitHub.vscode-pull-request-github",
        "mutantdino.resourcemonitor",
        "stateful.edge"
    ],

Furthermore, you can configure a dotfiles repository to perform customizations with a configuration like:

    "dotfiles.repository": "https://github.com/olix0r/dotfiles.git",