Skip to content

Add documentation for creating and managing Docker containers #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add documentation for creating and managing Docker containers #518

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e95714
Add documentation for creating and managing Docker containers
Punkin-Anarcrassy Nov 26, 2024
5d2c902
Add a new section on creating and managing Docker containers
Punkin-Anarcrassy Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/specs/devcontainer-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,3 +550,35 @@ There are several things to keep in mind for an application that implements Feat
- Parameters like `capAdd`, `securityOp` are concatenated.
- `containerEnv` is added before the Feature is executed as `ENV` commands in the Dockerfile.
- Each Feature script executes as its own layer to aid in caching and rebuilding.

## Creating and Managing Docker Containers

Docker containers are lightweight, portable, and consistent environments that encapsulate applications and their dependencies. They are essential in development environments as they provide a reproducible and isolated environment for building, testing, and deploying applications.

### Dockerfile

A Dockerfile is a text document that contains all the commands to assemble an image. You can find examples and references in the repository, such as the `Dockerfile` in the `src` directory of various features.

### Docker Compose

Docker Compose is a tool for defining and running multi-container Docker applications. You can find examples of Docker Compose files in the repository, such as `docker-compose.yml` in the `src` directory of various templates.

### Dev Container Features

Dev Container Features are self-contained, shareable units of installation code and development container configuration. You can learn more about them in the [Dev Container Features](#dev-container-features-reference) section.

### Dev Container Templates

Dev Container Templates are source files packaged together that encode configuration for a complete development environment. You can learn more about them in the [Dev Container Templates](./devcontainer-templates.md) section.

### Lifecycle Scripts

Lifecycle scripts are commands that run at different points in the container's lifecycle. You can learn more about them in the [Lifecycle Scripts](./devcontainer-reference.md#lifecycle-scripts) section.

### Secrets

Secrets are variables that hold sensitive values and need to be handled securely. You can learn more about them in the [Secrets](./declarative-secrets.md) section.

### Image Metadata

Image metadata allows you to store dev container configuration and feature metadata in prebuilt images. You can learn more about it in the [Image Metadata](./image-metadata.md) section.