Skip to content
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.

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

Update docker-build.mdx #16

Merged
merged 2 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions content/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,6 @@ Configure Docker to use Depot's remote builder infrastructure. This command inst
depot configure-docker
```

To configure `docker buildx build` to use the Depot plugin, you can specify the `--shim-buildx` flag.

```shell
depot configure-docker --shim-buildx
```

If you want to uninstall the plugin, you can specify the `--uninstall` flag.

```shell
Expand Down
2 changes: 1 addition & 1 deletion content/guides/devcontainers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Once the CLI is installed, you can configure your environment:
Dev Containers uses the `docker buildx build` command internally to build the container image. You can configure Depot as a plugin for the Docker CLI and Buildx with the following command:

```bash
depot configure-docker --shim-buildx
depot configure-docker
```

The `configure-docker` command is a one-time operation that routes any `docker build` or `docker buildx build` commands to Depot builders.
Expand Down
18 changes: 5 additions & 13 deletions content/guides/docker-build.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Docker build and buildx build
ogTitle: How to use Depot with your existing Docker build and buildx build commands
description: Use Depot with your existing docker build and docker buildx build commands with our depot configure-docker command.
title: Docker build
ogTitle: How to use Depot with your existing Docker build command
description: Use Depot with your existing docker build command with our depot configure-docker command.
---

# Docker build and buildx build
# Docker build

## How to use Depot with `docker build` and `docker buildx build`
## How to use Depot with `docker build`

Depot can directly integrate with your existing `docker build` workflows via a one-time configuration command from our `depot` CLI. See [our instructions for installing our CLI](/docs/cli/installation) if you still need to do so.

Expand All @@ -16,14 +16,6 @@ With the CLI installed, you can run `configure-docker` to configure your Docker
depot configure-docker
```

For using Depot for your `docker buildx build` commands, you can use the `--shim-buildx` flag:

```bash
depot configure-docker --shim-buildx
```

This command installs Depot as a plugin to the Docker CLI and sets Depot as the default builder for `docker build` and `docker buildx build` commands.

## Running builds with Depot

To run builds with Depot via `docker`, you still need to connect the build to an active Depot project either via the `depot init` and `depot.json` file or via the `DEPOT_PROJECT_ID` environment variable.
Expand Down
2 changes: 1 addition & 1 deletion content/guides/local-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ depot build -t my-image:latest --load .
You can also run a build with Depot locally via the `docker build` or `docker buildx build` commands. To do so, you'll need to run `depot configure-docker` to configure your Docker CLI to use Depot as the default builder:

```bash
depot configure-docker --shim-buildx
depot configure-docker
docker build -t my-image:latest .
```

Expand Down
2 changes: 1 addition & 1 deletion content/overview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Take a look at the [quickstart](/docs/quickstart) to get started.
First, you will create a **project** underneath an organization. Projects usually represent a single application, repository, or Dockerfile. Once you've made your project, you can leverage Depot builders from your local machine or an existing CI workflow in two ways:

1. Use the `depot build` command from your local machine or an existing CI workflow to execute the container build
2. Run `depot configure-docker --shim-buildx` one time and then use `docker build` or `docker buildx build` as normal
2. Run `depot configure-docker` one time and then use `docker build` or `docker buildx build` as normal

Builder instances come with 16 CPUs, 32GB of memory, and an SSD disk for layer caching (the default size is 50GB). In addition, they run the latest version of [BuildKit](https://github.com/moby/buildkit), the advanced build engine that backs Docker.

Expand Down
2 changes: 1 addition & 1 deletion content/overview/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ depot build -t repo/image:tag .
Once you've initialized your projects and installed the `depot` CLI, you can run a one time configuration command to configure Depot as a plugin for the Docker CLI and for `buildx`.

```shell
depot configure-docker --shim-buildx
depot configure-docker
```

This command installs `depot` as a plugin for the Docker CLI and makes Depot the default builder for `docker build` and `docker buildx build`.
Expand Down