From d873188119cf05409674b98da23450647e9b0fd8 Mon Sep 17 00:00:00 2001 From: jacobwgillespie <130874+jacobwgillespie@users.noreply.github.com> Date: Thu, 19 Dec 2024 14:26:05 +0000 Subject: [PATCH] Update docs content from https://github.com/depot/app --- content/cache/authentication.mdx | 10 ++-- content/cache/{ => reference}/bazel.mdx | 0 content/cache/{ => reference}/gradle.mdx | 0 content/cache/{ => reference}/pants.mdx | 0 content/cache/{ => reference}/sccache.mdx | 0 content/cache/{ => reference}/turbo.mdx | 0 content/cli/reference.mdx | 2 +- .../how-to-guides}/arm-containers.mdx | 18 +++---- .../how-to-guides}/continuous-integration.mdx | 20 ++++---- .../how-to-guides}/devcontainers.mdx | 0 .../how-to-guides}/docker-build.mdx | 2 +- .../how-to-guides}/docker-compose.mdx | 2 +- .../how-to-guides}/ephemeral-registry.mdx | 0 .../how-to-guides}/local-development.mdx | 2 +- .../how-to-guides/optimal-dockerfiles.mdx | 14 ++++++ .../node-pnpm-dockerfile.mdx | 0 .../optimal-dockerfiles}/node.mdx | 2 +- .../python-poetry-dockerfile.mdx | 0 .../python-uv-dockerfile.mdx | 0 .../optimal-dockerfiles}/python.mdx | 4 +- .../optimal-dockerfiles}/rust-dockerfile.mdx | 0 .../how-to-guides}/private-registries.mdx | 0 content/container-builds/overview.mdx | 50 +++++++++---------- content/container-builds/quickstart.mdx | 18 +++---- .../reference/api-authentication.mdx} | 0 .../reference/api-overview.mdx} | 2 +- .../reference}/aws-codebuild.mdx | 0 .../reference}/bitbucket-pipelines.mdx | 0 .../reference}/buildkite.mdx | 0 .../reference}/circleci.mdx | 0 .../reference}/fly.mdx | 0 .../reference}/github-actions.mdx | 0 .../reference}/gitlab-ci.mdx | 0 .../reference}/google-cloud-build.mdx | 0 .../reference}/jenkins.mdx | 0 .../reference}/travis-ci.mdx | 0 .../troubleshooting.mdx | 0 content/overview/faq.mdx | 8 +-- content/overview/index.mdx | 2 +- content/overview/languages.mdx | 14 ------ 40 files changed, 85 insertions(+), 85 deletions(-) rename content/cache/{ => reference}/bazel.mdx (100%) rename content/cache/{ => reference}/gradle.mdx (100%) rename content/cache/{ => reference}/pants.mdx (100%) rename content/cache/{ => reference}/sccache.mdx (100%) rename content/cache/{ => reference}/turbo.mdx (100%) rename content/{guides => container-builds/how-to-guides}/arm-containers.mdx (76%) rename content/{guides => container-builds/how-to-guides}/continuous-integration.mdx (58%) rename content/{guides => container-builds/how-to-guides}/devcontainers.mdx (100%) rename content/{guides => container-builds/how-to-guides}/docker-build.mdx (96%) rename content/{guides => container-builds/how-to-guides}/docker-compose.mdx (97%) rename content/{guides => container-builds/how-to-guides}/ephemeral-registry.mdx (100%) rename content/{guides => container-builds/how-to-guides}/local-development.mdx (97%) create mode 100644 content/container-builds/how-to-guides/optimal-dockerfiles.mdx rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/node-pnpm-dockerfile.mdx (100%) rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/node.mdx (79%) rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/python-poetry-dockerfile.mdx (100%) rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/python-uv-dockerfile.mdx (100%) rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/python.mdx (66%) rename content/{languages => container-builds/how-to-guides/optimal-dockerfiles}/rust-dockerfile.mdx (100%) rename content/{guides => container-builds/how-to-guides}/private-registries.mdx (100%) rename content/{api/authentication.mdx => container-builds/reference/api-authentication.mdx} (100%) rename content/{api/overview.mdx => container-builds/reference/api-overview.mdx} (99%) rename content/{integrations => container-builds/reference}/aws-codebuild.mdx (100%) rename content/{integrations => container-builds/reference}/bitbucket-pipelines.mdx (100%) rename content/{integrations => container-builds/reference}/buildkite.mdx (100%) rename content/{integrations => container-builds/reference}/circleci.mdx (100%) rename content/{integrations => container-builds/reference}/fly.mdx (100%) rename content/{integrations => container-builds/reference}/github-actions.mdx (100%) rename content/{integrations => container-builds/reference}/gitlab-ci.mdx (100%) rename content/{integrations => container-builds/reference}/google-cloud-build.mdx (100%) rename content/{integrations => container-builds/reference}/jenkins.mdx (100%) rename content/{integrations => container-builds/reference}/travis-ci.mdx (100%) rename content/{guides => container-builds}/troubleshooting.mdx (100%) delete mode 100644 content/overview/languages.mdx diff --git a/content/cache/authentication.mdx b/content/cache/authentication.mdx index f070e68..b596738 100644 --- a/content/cache/authentication.mdx +++ b/content/cache/authentication.mdx @@ -18,8 +18,8 @@ Depot Cache supports authenticating with user tokens and organization tokens. Ad For specific details on how to configure your build tools to authenticate with Depot Cache, refer to the following guides: -- [Bazel](/docs/cache/bazel) -- [Gradle](/docs/cache/gradle) -- [Pants](/docs/cache/pants) -- [sccache](/docs/cache/sccache) -- [Turborepo](/docs/cache/turbo) +- [Bazel](/docs/cache/reference/bazel) +- [Gradle](/docs/cache/reference/gradle) +- [Pants](/docs/cache/reference/pants) +- [sccache](/docs/cache/reference/sccache) +- [Turborepo](/docs/cache/reference/turbo) diff --git a/content/cache/bazel.mdx b/content/cache/reference/bazel.mdx similarity index 100% rename from content/cache/bazel.mdx rename to content/cache/reference/bazel.mdx diff --git a/content/cache/gradle.mdx b/content/cache/reference/gradle.mdx similarity index 100% rename from content/cache/gradle.mdx rename to content/cache/reference/gradle.mdx diff --git a/content/cache/pants.mdx b/content/cache/reference/pants.mdx similarity index 100% rename from content/cache/pants.mdx rename to content/cache/reference/pants.mdx diff --git a/content/cache/sccache.mdx b/content/cache/reference/sccache.mdx similarity index 100% rename from content/cache/sccache.mdx rename to content/cache/reference/sccache.mdx diff --git a/content/cache/turbo.mdx b/content/cache/reference/turbo.mdx similarity index 100% rename from content/cache/turbo.mdx rename to content/cache/reference/turbo.mdx diff --git a/content/cli/reference.mdx b/content/cli/reference.mdx index d953af8..30d22d5 100644 --- a/content/cli/reference.mdx +++ b/content/cli/reference.mdx @@ -101,7 +101,7 @@ If you want to build a specific target in the bake file, you can specify it in t depot bake -f docker-bake.hcl original ``` -You can also save all of the targets built in a bake or compose file to the [ephemeral registry](/docs/guides/ephemeral-registry) for later use with the `--save` flag: +You can also save all of the targets built in a bake or compose file to the [ephemeral registry](/docs/container-builds/how-to-guides/ephemeral-registry) for later use with the `--save` flag: ```shell depot bake -f docker-bake.hcl --save diff --git a/content/guides/arm-containers.mdx b/content/container-builds/how-to-guides/arm-containers.mdx similarity index 76% rename from content/guides/arm-containers.mdx rename to content/container-builds/how-to-guides/arm-containers.mdx index 2d0bda3..e1301ad 100644 --- a/content/guides/arm-containers.mdx +++ b/content/container-builds/how-to-guides/arm-containers.mdx @@ -12,7 +12,7 @@ Depot removes emulation altogether. Depot is a remote Docker container build service that orchestrates optimized BuildKit builders on native CPUs for Intel (x86) and Arm (arm64). -When a Docker image build is routed to Depot either via [`depot build`](/docs/cli/reference#depot-build) or [`docker build`](/docs/guides/docker-build#how-to-use-depot-with-docker), we launch optimized builders for each architecture requested with a persistent layer cache attached to them. Each builder has 16 CPUs, 32GB of memory, and at least 50GB of fast NVMe cache SSDs. +When a Docker image build is routed to Depot either via [`depot build`](/docs/cli/reference#depot-build) or [`docker build`](/docs/container-builds/how-to-guides/docker-build#how-to-use-depot-with-docker), we launch optimized builders for each architecture requested with a persistent layer cache attached to them. Each builder has 16 CPUs, 32GB of memory, and at least 50GB of fast NVMe cache SSDs. ## How to build Docker images for Arm CPUs like M1/M2 MacBooks or AWS Graviton @@ -32,14 +32,14 @@ docker build --platform linux/arm64 . We have integration guides for most of the CI providers: -- [Bitbucket Pipelines](../integrations/bitbucket-pipelines) -- [Buildkite](../integrations/buildkite) -- [CircleCI](../integrations/circleci) -- [GitHub Actions](../integrations/github-actions) -- [GitLab CI](../integrations/gitlab-ci) -- [Google Cloud Build](../integrations/google-cloud-build) -- [Jenkins](../integrations/jenkins) -- [Travis CI](../integrations/travis-ci) +- [Bitbucket Pipelines](/docs/container-builds/reference/bitbucket-pipelines) +- [Buildkite](/docs/container-builds/reference/buildkite) +- [CircleCI](/docs/container-builds/reference/circleci) +- [GitHub Actions](/docs/container-builds/reference/github-actions) +- [GitLab CI](/docs/container-builds/reference/gitlab-ci) +- [Google Cloud Build](/docs/container-builds/reference/google-cloud-build) +- [Jenkins](/docs/container-builds/reference/jenkins) +- [Travis CI](/docs/container-builds/reference/travis-ci) ## How to build multi-platform Docker images diff --git a/content/guides/continuous-integration.mdx b/content/container-builds/how-to-guides/continuous-integration.mdx similarity index 58% rename from content/guides/continuous-integration.mdx rename to content/container-builds/how-to-guides/continuous-integration.mdx index d71313d..b29ee13 100644 --- a/content/guides/continuous-integration.mdx +++ b/content/container-builds/how-to-guides/continuous-integration.mdx @@ -10,18 +10,18 @@ Depot provides a remote Docker build service that makes the image build process By routing the image build step of your CI to Depot, you can complete the image build up to 40x faster than you could in your generic CI provider. Saving you build minutes in your existing CI provider and, more importantly, saving you developer time waiting for the build to finish. -The `depot build` command is a drop-in replacement for `docker build` and `docker buildx build`. Alternatively, you can [configure your local Docker CLI to use Depot as the default builder](/docs/guides/docker-build). Depot launches remote builders for both native Intel & Arm CPUs with 16 CPUs, 32 GB of memory, and a 50 GB persistent NVMe cache SSD. +The `depot build` command is a drop-in replacement for `docker build` and `docker buildx build`. Alternatively, you can [configure your local Docker CLI to use Depot as the default builder](/docs/container-builds/how-to-guides/docker-build). Depot launches remote builders for both native Intel & Arm CPUs with 16 CPUs, 32 GB of memory, and a 50 GB persistent NVMe cache SSD. Running `depot` in a continuous integration environment is a great way to get fast and consistent builds with any CI provider. See below for documentation on integrating Depot with your CI provider. ## Providers -- [AWS CodeBuild](../integrations/aws-codebuild) -- [Bitbucket Pipelines](../integrations/bitbucket-pipelines) -- [Buildkite](../integrations/buildkite) -- [CircleCI](../integrations/circleci) -- [GitHub Actions](../integrations/github-actions) -- [GitLab CI](../integrations/gitlab-ci) -- [Google Cloud Build](../integrations/google-cloud-build) -- [Jenkins](../integrations/jenkins) -- [Travis CI](../integrations/travis-ci) +- [AWS CodeBuild](/docs/container-builds/reference/aws-codebuild) +- [Bitbucket Pipelines](/docs/container-builds/reference/bitbucket-pipelines) +- [Buildkite](/docs/container-builds/reference/buildkite) +- [CircleCI](/docs/container-builds/reference/circleci) +- [GitHub Actions](/docs/container-builds/reference/github-actions) +- [GitLab CI](/docs/container-builds/reference/gitlab-ci) +- [Google Cloud Build](/docs/container-builds/reference/google-cloud-build) +- [Jenkins](/docs/container-builds/reference/jenkins) +- [Travis CI](/docs/container-builds/reference/travis-ci) diff --git a/content/guides/devcontainers.mdx b/content/container-builds/how-to-guides/devcontainers.mdx similarity index 100% rename from content/guides/devcontainers.mdx rename to content/container-builds/how-to-guides/devcontainers.mdx diff --git a/content/guides/docker-build.mdx b/content/container-builds/how-to-guides/docker-build.mdx similarity index 96% rename from content/guides/docker-build.mdx rename to content/container-builds/how-to-guides/docker-build.mdx index 6a24537..caa86bb 100644 --- a/content/guides/docker-build.mdx +++ b/content/container-builds/how-to-guides/docker-build.mdx @@ -42,4 +42,4 @@ Again, you can confirm that builds are going to your Depot project by looking fo ## Using Depot with Docker Compose -You can efficiently build Compose service images in parallel with Depot, with either `depot bake --load -f ./docker-compose.yml` or `docker compose build`. See [the Docker Compose integration guide](/docs/guides/docker-compose) for more information. +You can efficiently build Compose service images in parallel with Depot, with either `depot bake --load -f ./docker-compose.yml` or `docker compose build`. See [the Docker Compose integration guide](/docs/container-builds/how-to-guides/docker-compose) for more information. diff --git a/content/guides/docker-compose.mdx b/content/container-builds/how-to-guides/docker-compose.mdx similarity index 97% rename from content/guides/docker-compose.mdx rename to content/container-builds/how-to-guides/docker-compose.mdx index 8fd2341..440ac06 100644 --- a/content/guides/docker-compose.mdx +++ b/content/container-builds/how-to-guides/docker-compose.mdx @@ -82,7 +82,7 @@ Once configured, you can use `docker compose build` as usual. The `build` comman $ docker compose build ``` -See the [Docker integration guide](/docs/guides/docker-build) for more information about `depot configure-docker`. +See the [Docker integration guide](/docs/container-builds/how-to-guides/docker-build) for more information about `depot configure-docker`. ### Caveats diff --git a/content/guides/ephemeral-registry.mdx b/content/container-builds/how-to-guides/ephemeral-registry.mdx similarity index 100% rename from content/guides/ephemeral-registry.mdx rename to content/container-builds/how-to-guides/ephemeral-registry.mdx diff --git a/content/guides/local-development.mdx b/content/container-builds/how-to-guides/local-development.mdx similarity index 97% rename from content/guides/local-development.mdx rename to content/container-builds/how-to-guides/local-development.mdx index bde0884..61dcefc 100644 --- a/content/guides/local-development.mdx +++ b/content/container-builds/how-to-guides/local-development.mdx @@ -51,4 +51,4 @@ depot configure-docker docker build -t my-image:latest . ``` -For a full guide on using Depot via your existing `docker build` of `docker compose` commands, see our [Docker integration guide](/docs/guides/docker-build#docker-compose-build). +For a full guide on using Depot via your existing `docker build` of `docker compose` commands, see our [Docker integration guide](/docs/container-builds/how-to-guides/docker-build#docker-compose-build). diff --git a/content/container-builds/how-to-guides/optimal-dockerfiles.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles.mdx new file mode 100644 index 0000000..6170968 --- /dev/null +++ b/content/container-builds/how-to-guides/optimal-dockerfiles.mdx @@ -0,0 +1,14 @@ +--- +title: Best practice Dockerfiles +ogTitle: Best practice Dockerfiles +description: A set of best practice Dockerfiles for building Docker images +--- + +We've assembled some best practice Dockerfiles for building Docker images for several different languages: + +## Guides + +- [Dockerfile for Node.js using `pnpm`](/docs/container-builds/how-to-guides/optimal-dockerfiles/node-pnpm-dockerfile) +- [Dockerfile for Python using `uv`](/docs/container-builds/how-to-guides/optimal-dockerfiles/python-uv-dockerfile) +- [Dockerfile for Python using `poetry`](/docs/container-builds/how-to-guides/optimal-dockerfiles/python-poetry-dockerfile) +- [Dockerfile for Rust](/docs/container-builds/how-to-guides/optimal-dockerfiles/rust-dockerfile) diff --git a/content/languages/node-pnpm-dockerfile.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/node-pnpm-dockerfile.mdx similarity index 100% rename from content/languages/node-pnpm-dockerfile.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/node-pnpm-dockerfile.mdx diff --git a/content/languages/node.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/node.mdx similarity index 79% rename from content/languages/node.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/node.mdx index db581d0..9458b40 100644 --- a/content/languages/node.mdx +++ b/content/container-builds/how-to-guides/optimal-dockerfiles/node.mdx @@ -8,4 +8,4 @@ We've assembled some best practice Dockerfiles for building Docker images for No ## Guides -- [Dockerfile for Node.js using `pnpm`](/docs/languages/node-pnpm-dockerfile) +- [Dockerfile for Node.js using `pnpm`](/docs/container-builds/how-to-guides/optimal-dockerfiles/node-pnpm-dockerfile) diff --git a/content/languages/python-poetry-dockerfile.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/python-poetry-dockerfile.mdx similarity index 100% rename from content/languages/python-poetry-dockerfile.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/python-poetry-dockerfile.mdx diff --git a/content/languages/python-uv-dockerfile.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/python-uv-dockerfile.mdx similarity index 100% rename from content/languages/python-uv-dockerfile.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/python-uv-dockerfile.mdx diff --git a/content/languages/python.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/python.mdx similarity index 66% rename from content/languages/python.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/python.mdx index 94ec253..19da957 100644 --- a/content/languages/python.mdx +++ b/content/container-builds/how-to-guides/optimal-dockerfiles/python.mdx @@ -8,5 +8,5 @@ We've assembled some best practice Dockerfiles for building Docker images for Py ## Guides -- [Dockerfile for Python using `uv`](/docs/languages/python-uv-dockerfile) -- [Dockerfile for Python using `poetry`](/docs/languages/python-poetry-dockerfile) +- [Dockerfile for Python using `uv`](/docs/container-builds/how-to-guides/optimal-dockerfiles/python-uv-dockerfile) +- [Dockerfile for Python using `poetry`](/docs/container-builds/how-to-guides/optimal-dockerfiles/python-poetry-dockerfile) diff --git a/content/languages/rust-dockerfile.mdx b/content/container-builds/how-to-guides/optimal-dockerfiles/rust-dockerfile.mdx similarity index 100% rename from content/languages/rust-dockerfile.mdx rename to content/container-builds/how-to-guides/optimal-dockerfiles/rust-dockerfile.mdx diff --git a/content/guides/private-registries.mdx b/content/container-builds/how-to-guides/private-registries.mdx similarity index 100% rename from content/guides/private-registries.mdx rename to content/container-builds/how-to-guides/private-registries.mdx diff --git a/content/container-builds/overview.mdx b/content/container-builds/overview.mdx index 3373531..f1cdb76 100644 --- a/content/container-builds/overview.mdx +++ b/content/container-builds/overview.mdx @@ -42,15 +42,15 @@ Using Depot for your Docker image builds is as straightforward as replacing your We have extensive integrations with most major CI providers and developer tools to make it easy to use Depot remote container builds in your existing workflows. You can read more about how to leverage our remote container build service in your existing CI provider: -- [AWS CodeBuild](../integrations/aws-codebuild) -- [Bitbucket Pipelines](../integrations/bitbucket-pipelines) -- [Buildkite](../integrations/buildkite) -- [CircleCI](../integrations/circleci) -- [GitHub Actions](../integrations/github-actions) -- [GitLab CI](../integrations/gitlab-ci) -- [Google Cloud Build](../integrations/google-cloud-build) -- [Jenkins](../integrations/jenkins) -- [Travis CI](../integrations/travis-ci) +- [AWS CodeBuild](/docs/container-builds/reference/aws-codebuild) +- [Bitbucket Pipelines](/docs/container-builds/reference/bitbucket-pipelines) +- [Buildkite](/docs/container-builds/reference/buildkite) +- [CircleCI](/docs/container-builds/reference/circleci) +- [GitHub Actions](/docs/container-builds/reference/github-actions) +- [GitLab CI](/docs/container-builds/reference/gitlab-ci) +- [Google Cloud Build](/docs/container-builds/reference/google-cloud-build) +- [Jenkins](/docs/container-builds/reference/jenkins) +- [Travis CI](/docs/container-builds/reference/travis-ci) #### OIDC support @@ -60,9 +60,9 @@ We support OIDC trust relationships with GitHub, CircleCI, Buildkite, and Mint s We can accelerate your image builds for other developer tools like Dev Containers & Docker Compose. You can either use our drop-in replacements for `docker build` and `docker bake`, or configure Docker to use Depot as the remote builder. -- [How to use Depot in local development](/docs/guides/local-development) -- [How to use Depot with Docker & Docker Compose](/docs/guides/docker-build) -- [How to use Depot with Dev Containers](/docs/guides/devcontainers) +- [How to use Depot in local development](/docs/container-builds/how-to-guides/local-development) +- [How to use Depot with Docker & Docker Compose](/docs/container-builds/how-to-guides/docker-build) +- [How to use Depot with Dev Containers](/docs/container-builds/how-to-guides/devcontainers) ### Build autoscaling @@ -72,7 +72,7 @@ We offer autoscaling for our remote container builds. By default, all builds for We offer a built-in ephemeral registry that you can use to save the images from your `depot build` and `depot bake` commands to a temporary registry. You can then pull those images back down or push them to your final registry as you see fit. -[Learn more about the ephemeral registry](/docs/guides/ephemeral-registry) +[Learn more about the ephemeral registry](/docs/container-builds/how-to-guides/ephemeral-registry) ## How does it work? @@ -82,7 +82,7 @@ Builder instances come with 16 CPUs, 32GB of memory, and an SSD disk for layer c We offer native Intel and Arm builder instances for all projects. Hence, both architectures build with zero emulation, and you don't have to run your own build runners to get native multi-platform images. -Once built, the image can be left in the build cache (the default) or downloaded to the local Docker daemon with `--load` or pushed to a registry with `--push`. If `--push` is specified, the image is pushed to the registry directly from the remote builder via high-speed network links and does not use your local network connection. See our [private registry guide](/docs/guides/private-registries) for more details on pushing to private Docker registries like Amazon ECR or Docker Hub. +Once built, the image can be left in the build cache (the default) or downloaded to the local Docker daemon with `--load` or pushed to a registry with `--push`. If `--push` is specified, the image is pushed to the registry directly from the remote builder via high-speed network links and does not use your local network connection. See our [private registry guide](/docs/container-builds/how-to-guides/private-registries) for more details on pushing to private Docker registries like Amazon ECR or Docker Hub. You can generally plug Depot into your existing Docker image build workflows with minimal changes, whether you're building locally or in CI. @@ -126,15 +126,15 @@ We have built several integrations to make it easy to plug Depot into your exist You can read more about how to leverage our remote container build service in your existing CI provider of choice: -- [AWS CodeBuild](../integrations/aws-codebuild) -- [Bitbucket Pipelines](../integrations/bitbucket-pipelines) -- [Buildkite](../integrations/buildkite) -- [CircleCI](../integrations/circleci) -- [GitHub Actions](../integrations/github-actions) -- [GitLab CI](../integrations/gitlab-ci) -- [Google Cloud Build](../integrations/google-cloud-build) -- [Jenkins](../integrations/jenkins) -- [Travis CI](../integrations/travis-ci) +- [AWS CodeBuild](/docs/container-builds/reference/aws-codebuild) +- [Bitbucket Pipelines](/docs/container-builds/reference/bitbucket-pipelines) +- [Buildkite](/docs/container-builds/reference/buildkite) +- [CircleCI](/docs/container-builds/reference/circleci) +- [GitHub Actions](/docs/container-builds/reference/github-actions) +- [GitLab CI](/docs/container-builds/reference/gitlab-ci) +- [Google Cloud Build](/docs/container-builds/reference/google-cloud-build) +- [Jenkins](/docs/container-builds/reference/jenkins) +- [Travis CI](/docs/container-builds/reference/travis-ci) ## Common opportunities to use Depot remote container builds @@ -144,11 +144,11 @@ Depot works best in the following scenarios: 1. **Building the Docker image is slow in CI** — common CI providers often do not have native support for the Docker build cache. Instead, they require layer cache to be saved to and loaded from tarballs over slow networks. Often, CI providers offer limited resources as well, causing overall build time to be long. - Depot works within your existing CI workflow by swapping out the call to `docker build` with `depot build`. Or by configuring `docker` in your environment to leverage Depot. See [our continuous integration guides](/docs/guides/continuous-integration) for more information. + Depot works within your existing CI workflow by swapping out the call to `docker build` with `depot build`. Or by configuring `docker` in your environment to leverage Depot. See [our continuous integration guides](/docs/container-builds/how-to-guides/continuous-integration) for more information. 2. **You need to build images for multiple platforms/multiple architectures (Intel and Arm)** — today, you're often stuck with managing your own build runner or relying on slow emulation in order to build multi-platform images. For example, CI providers usually run their workflows on Intel machines. So, to create a Docker image for Arm, you either have to launch your own BuildKit builder for Arm and connect to it from your CI provider. Or build your Arm image with slow QEMU emulation. - Depot can [build multi-platform and Arm images](/docs/guides/arm-containers) natively with zero-emulation and without running additional infrastructure. + Depot can [build multi-platform and Arm images](/docs/container-builds/how-to-guides/arm-containers) natively with zero-emulation and without running additional infrastructure. 3. **Building the Docker image on your local machine is slow or expensive** — Docker can hog resources on developer machines, taking up valuable network, CPU, and memory resources. Depot executes builds on remote compute infrastructure; it offloads the CPU, memory, disk, and network resources required to that remote builder. If builds on your local machine are slow due to constrained compute, disk, or network, `depot build` eliminates the need to rely on your local environment. diff --git a/content/container-builds/quickstart.mdx b/content/container-builds/quickstart.mdx index 84dc8c3..8106496 100644 --- a/content/container-builds/quickstart.mdx +++ b/content/container-builds/quickstart.mdx @@ -66,15 +66,15 @@ There is the option to configure your existing `docker build` commmands to lever Integrating Depot into your CI workflow is a very similar process. Depot works with any CI provider. You can find guides for our most popular providers: -- [AWS CodeBuild](../integrations/aws-codebuild) -- [Bitbucket Pipelines](../integrations/bitbucket-pipelines) -- [Buildkite](../integrations/buildkite) -- [CircleCI](../integrations/circleci) -- [GitHub Actions](../integrations/github-actions) -- [GitLab CI](../integrations/gitlab-ci) -- [Google Cloud Build](../integrations/google-cloud-build) -- [Jenkins](../integrations/jenkins) -- [Travis CI](../integrations/travis-ci) +- [AWS CodeBuild](/docs/container-builds/reference/aws-codebuild) +- [Bitbucket Pipelines](/docs/container-builds/reference/bitbucket-pipelines) +- [Buildkite](/docs/container-builds/reference/buildkite) +- [CircleCI](/docs/container-builds/reference/circleci) +- [GitHub Actions](/docs/container-builds/reference/github-actions) +- [GitLab CI](/docs/container-builds/reference/gitlab-ci) +- [Google Cloud Build](/docs/container-builds/reference/google-cloud-build) +- [Jenkins](/docs/container-builds/reference/jenkins) +- [Travis CI](/docs/container-builds/reference/travis-ci) ## Adding a build minute usage cap diff --git a/content/api/authentication.mdx b/content/container-builds/reference/api-authentication.mdx similarity index 100% rename from content/api/authentication.mdx rename to content/container-builds/reference/api-authentication.mdx diff --git a/content/api/overview.mdx b/content/container-builds/reference/api-overview.mdx similarity index 99% rename from content/api/overview.mdx rename to content/container-builds/reference/api-overview.mdx index 2ce6241..432219f 100644 --- a/content/api/overview.mdx +++ b/content/container-builds/reference/api-overview.mdx @@ -12,7 +12,7 @@ We currently support the following SDKs for interacting with Depot: ## Authentication -Authentication to the API is handled via an `Authorization` header with the value being an Organization Token that you generate inside of your Organization Settings. See the [Authentication docs](/docs/api/authentication) for more details. +Authentication to the API is handled via an `Authorization` header with the value being an Organization Token that you generate inside of your Organization Settings. See the [Authentication docs](/docs/container-builds/reference/api-authentication) for more details. ## Security diff --git a/content/integrations/aws-codebuild.mdx b/content/container-builds/reference/aws-codebuild.mdx similarity index 100% rename from content/integrations/aws-codebuild.mdx rename to content/container-builds/reference/aws-codebuild.mdx diff --git a/content/integrations/bitbucket-pipelines.mdx b/content/container-builds/reference/bitbucket-pipelines.mdx similarity index 100% rename from content/integrations/bitbucket-pipelines.mdx rename to content/container-builds/reference/bitbucket-pipelines.mdx diff --git a/content/integrations/buildkite.mdx b/content/container-builds/reference/buildkite.mdx similarity index 100% rename from content/integrations/buildkite.mdx rename to content/container-builds/reference/buildkite.mdx diff --git a/content/integrations/circleci.mdx b/content/container-builds/reference/circleci.mdx similarity index 100% rename from content/integrations/circleci.mdx rename to content/container-builds/reference/circleci.mdx diff --git a/content/integrations/fly.mdx b/content/container-builds/reference/fly.mdx similarity index 100% rename from content/integrations/fly.mdx rename to content/container-builds/reference/fly.mdx diff --git a/content/integrations/github-actions.mdx b/content/container-builds/reference/github-actions.mdx similarity index 100% rename from content/integrations/github-actions.mdx rename to content/container-builds/reference/github-actions.mdx diff --git a/content/integrations/gitlab-ci.mdx b/content/container-builds/reference/gitlab-ci.mdx similarity index 100% rename from content/integrations/gitlab-ci.mdx rename to content/container-builds/reference/gitlab-ci.mdx diff --git a/content/integrations/google-cloud-build.mdx b/content/container-builds/reference/google-cloud-build.mdx similarity index 100% rename from content/integrations/google-cloud-build.mdx rename to content/container-builds/reference/google-cloud-build.mdx diff --git a/content/integrations/jenkins.mdx b/content/container-builds/reference/jenkins.mdx similarity index 100% rename from content/integrations/jenkins.mdx rename to content/container-builds/reference/jenkins.mdx diff --git a/content/integrations/travis-ci.mdx b/content/container-builds/reference/travis-ci.mdx similarity index 100% rename from content/integrations/travis-ci.mdx rename to content/container-builds/reference/travis-ci.mdx diff --git a/content/guides/troubleshooting.mdx b/content/container-builds/troubleshooting.mdx similarity index 100% rename from content/guides/troubleshooting.mdx rename to content/container-builds/troubleshooting.mdx diff --git a/content/overview/faq.mdx b/content/overview/faq.mdx index da168ea..fc8d8c0 100644 --- a/content/overview/faq.mdx +++ b/content/overview/faq.mdx @@ -18,15 +18,15 @@ We have all our authentication options documented for `depot` in our [CLI authen ## How do I push my images to a private registry? -You can use the `--push` flag to push your images to a private registry. Our `depot` CLI uses your local Docker credentials provider. So, any registry you've logged into with `docker login` or similar will be available when running a Depot build. See our guide on [private registries](/docs/guides/private-registries) for more details. +You can use the `--push` flag to push your images to a private registry. Our `depot` CLI uses your local Docker credentials provider. So, any registry you've logged into with `docker login` or similar will be available when running a Depot build. See our guide on [private registries](/docs/container-builds/how-to-guides/private-registries) for more details. ## Can I build Docker images for M1/M2 Macs? -Yes! Depot supports native Arm container builds out of the box. We detect the architecture of the machine requesting a build via `depot build`. If that architecture is Arm, we route the build to a builder running Arm natively. You can build Docker images for M1/M2 Macs and run the resulting image immediately, as it is made specifically for your architecture. See our documentation on [Arm containers](/docs/guides/arm-containers) for more details. +Yes! Depot supports native Arm container builds out of the box. We detect the architecture of the machine requesting a build via `depot build`. If that architecture is Arm, we route the build to a builder running Arm natively. You can build Docker images for M1/M2 Macs and run the resulting image immediately, as it is made specifically for your architecture. See our documentation on [Arm containers](/docs/container-builds/how-to-guides/arm-containers) for more details. ## Can I build multi-platform Docker images? -Yes! Check out our [integration guide](/docs/guides/arm-containers#what-about-multi-architecture-containers) on how we do it. +Yes! Check out our [integration guide](/docs/container-builds/how-to-guides/arm-containers#what-about-multi-architecture-containers) on how we do it. ## How should I use Depot with a monorepo setup? @@ -34,7 +34,7 @@ If you're building multiple images from a single monorepo, and the builds are li ## Can I use Depot with my existing `docker build` or `docker buildx build` commands? -Yes! We have a [`depot configure-docker`](/docs/cli/reference#depot-configure-docker) command that configures Depot as a plugin for the Docker CLI and sets Depot as the default builder for both `docker build` and `docker buildx build`. See our [`docker build` guide](/docs/guides/docker-build) for more details. +Yes! We have a [`depot configure-docker`](/docs/cli/reference#depot-configure-docker) command that configures Depot as a plugin for the Docker CLI and sets Depot as the default builder for both `docker build` and `docker buildx build`. See our [`docker build` guide](/docs/container-builds/how-to-guides/docker-build) for more details. ## What are these extra files in my registry? diff --git a/content/overview/index.mdx b/content/overview/index.mdx index c6076a4..59d8c96 100644 --- a/content/overview/index.mdx +++ b/content/overview/index.mdx @@ -38,4 +38,4 @@ We offer Depot-managed GitHub Actions Runners that bring the power of Depot to t If you need to build container images from untrusted sources or simply want to be able to call an API to build an image, we offer our remote container build infrastructure behind an API. You can use our build API to build container images from your own code on behalf of your own users using our `depot` CLI or with `buildx` as a library. -[Learn more about the Build API.](/docs/api/overview) +[Learn more about the Build API](/docs/container-builds/reference/api-overview) diff --git a/content/overview/languages.mdx b/content/overview/languages.mdx deleted file mode 100644 index 60ae1ea..0000000 --- a/content/overview/languages.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Best practice Dockerfiles -ogTitle: Best practice Dockerfiles -description: A set of best practice Dockerfiles for building Docker images ---- - -We've assembled some best practice Dockerfiles for building Docker images for several different languages: - -## Guides - -- [Dockerfile for Node.js using `pnpm`](/docs/languages/node-pnpm-dockerfile) -- [Dockerfile for Python using `uv`](/docs/languages/python-uv-dockerfile) -- [Dockerfile for Python using `poetry`](/docs/languages/python-poetry-dockerfile) -- [Dockerfile for Rust](/docs/languages/rust-dockerfile)