Skip to content

Commit bff7a37

Browse files
committed
edit envbuilder docs
1 parent 0b4ac18 commit bff7a37

File tree

2 files changed

+16
-88
lines changed

2 files changed

+16
-88
lines changed

docs/admin/templates/managing-templates/devcontainers/devcontainer-security-caching.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Dev container security and caching
1+
# Envbuilder Dev Container Security and Caching
22

3-
Ensure Envbuilder can only pull pre-approved images and artifacts by configuring
4-
it with your existing HTTP proxies, firewalls, and artifact managers.
3+
Envbuilder can pull only pre-approved images and artifacts when you configure it with your enterprise proxies,
4+
firewalls, and artifact managers.
55

6-
## Configure registry authentication
6+
## Configure Registry Authentication
77

88
You may need to authenticate to your container registry, such as Artifactory, or
99
Git provider such as GitLab, to use Envbuilder. See the
1010
[Envbuilder documentation](https://github.com/coder/envbuilder/blob/main/docs/container-registry-auth.md)
1111
for more information.
1212

13-
## Layer and image caching
13+
## Layer and Image Caching
1414

1515
To improve build times, dev containers can be cached. There are two main forms
1616
of caching:
@@ -60,7 +60,7 @@ If you are building your own Dev container template, you can consult the
6060
You may also wish to consult a
6161
[documented example usage of the `envbuilder_cached_image` resource](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf).
6262

63-
## Next steps
63+
## Next Steps
6464

6565
- [Dev container releases and known issues](./devcontainer-releases-known-issues.md)
6666
- [Dotfiles](../../../../user-guides/workspace-dotfiles.md)
Lines changed: 10 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Dev containers
1+
# Envbuilder Dev Containers
22

33
A Development Container is an
44
[open-source specification](https://containers.dev/implementors/spec/) for
@@ -14,91 +14,18 @@ pre-approved by platform teams in registries like
1414
workflows, reduces the need for tickets and approvals, and promotes greater
1515
independence for developers.
1616

17-
## Prerequisites
18-
19-
An administrator should construct or choose a base image and create a template
20-
that includes a `devcontainer_builder` image before a developer team configures
21-
dev containers.
22-
23-
## Benefits of devcontainers
24-
25-
There are several benefits to adding a dev container-compatible template to
26-
Coder:
27-
28-
- Reliability through standardization
29-
- Scalability for growing teams
30-
- Improved security
31-
- Performance efficiency
32-
- Cost Optimization
33-
34-
### Reliability through standardization
35-
36-
Use dev containers to empower development teams to personalize their own
37-
environments while maintaining consistency and security through an approved and
38-
hardened base image.
39-
40-
Standardized environments ensure uniform behavior across machines and team
41-
members, eliminating "it works on my machine" issues and creating a stable
42-
foundation for development and testing. Containerized setups reduce dependency
43-
conflicts and misconfigurations, enhancing build stability.
44-
45-
### Scalability for growing teams
46-
47-
Dev containers allow organizations to handle multiple projects and teams
48-
efficiently.
49-
50-
You can leverage platforms like Kubernetes to allocate resources on demand,
51-
optimizing costs and ensuring fair distribution of quotas. Developer teams can
52-
use efficient custom images and independently configure the contents of their
53-
version-controlled dev containers.
17+
Envbuilder is a legacy implementation of dev containers.
5418

55-
This approach allows organizations to scale seamlessly, reducing the maintenance
56-
burden on the administrators that support diverse projects while allowing
57-
development teams to maintain their own images and onboard new users quickly.
19+
For the Docker-based Dev Containers integration, follow the [Configure a template for dev containers](../../extending-templates/devcontainers.md) documentation instead.
5820

59-
### Improved security
60-
61-
Since Coder and Envbuilder run on your own infrastructure, you can use firewalls
62-
and cluster-level policies to ensure Envbuilder only downloads packages from
63-
your secure registry powered by JFrog Artifactory or Sonatype Nexus.
64-
Additionally, Envbuilder can be configured to push the full image back to your
65-
registry for additional security scanning.
66-
67-
This means that Coder admins can require hardened base images and packages,
68-
while still allowing developer self-service.
69-
70-
Envbuilder runs inside a small container image but does not require a Docker
71-
daemon in order to build a dev container. This is useful in environments where
72-
you may not have access to a Docker socket for security reasons, but still need
73-
to work with a container.
74-
75-
### Performance efficiency
76-
77-
Create a unique image for each project to reduce the dependency size of any
78-
given project.
79-
80-
Envbuilder has various caching modes to ensure workspaces start as fast as
81-
possible, such as layer caching and even full image caching and fetching via the
82-
[Envbuilder Terraform provider](https://registry.terraform.io/providers/coder/envbuilder/latest/docs).
83-
84-
### Cost optimization
85-
86-
By creating unique images per-project, you remove unnecessary dependencies and
87-
reduce the workspace size and resource consumption of any given project. Full
88-
image caching ensures optimal start and stop times.
89-
90-
## When to use a dev container
21+
## Prerequisites
9122

92-
Dev containers are a good fit for developer teams who are familiar with Docker
93-
and are already using containerized development environments. If you have a
94-
large number of projects with different toolchains, dependencies, or that depend
95-
on a particular Linux distribution, dev containers make it easier to quickly
96-
switch between projects.
23+
An administrator should construct or choose a base image and create a template
24+
that includes an Envbuilder container image `coder/envbuilder` before a developer team configures dev containers.
9725

98-
They may also be a great fit for more restricted environments where you may not
99-
have access to a Docker daemon since it doesn't need one to work.
26+
Compare the differences between [Envbuilder and the Dev Containers integration](../../extending-templates/dev-containers-envbuilder.md).
10027

101-
## Devcontainer Features
28+
## Dev Container Features
10229

10330
[Dev container Features](https://containers.dev/implementors/features/) allow
10431
owners of a project to specify self-contained units of code and runtime
@@ -119,4 +46,5 @@ of the Coder control plane and even run within a CI/CD pipeline.
11946

12047
## Next steps
12148

122-
- [Add a dev container template](./add-devcontainer.md)
49+
- [Add an Envbuilder dev container template](./add-devcontainer.md)
50+
- [Choose an approach to Dev Containers](../../extending-templates/dev-containers-envbuilder.md)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy