Skip to content

Commit 6e121ec

Browse files
andie787github-actions[bot]
authored andcommitted
Update docs content from https://github.com/depot/app
1 parent 2dfe9b0 commit 6e121ec

File tree

8 files changed

+339
-292
lines changed

8 files changed

+339
-292
lines changed

content/cache/integrations/sccache.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,18 @@ DEPOT_TOKEN=your_token depot bake
9090

9191
[Depot GitHub Actions runners](/docs/github-actions/overview) are pre-configured to use Depot Cache with sccache. Each runner launches with a `SCCACHE_WEBDAV_ENDPOINT` environment variable pre-configured with the connection details for Depot Cache.
9292

93-
You don't need additional configuration. Run your sccache builds as normal:
93+
Tell Rust to compile via sccache, and run your sccache builds as normal:
9494

9595
```yaml
9696
jobs:
9797
build:
9898
runs-on: depot-ubuntu-24.04
9999
steps:
100100
- uses: actions/checkout@v4
101-
- run: sccache --start-server && cargo build --release
101+
- uses: mozilla-actions/[email protected]
102+
- run: cargo build --release
103+
env:
104+
RUSTC_WRAPPER: 'sccache'
102105
```
103106
104107
To disable automatic configuration, turn off **Allow Actions jobs to automatically connect to Depot Cache** in your organization settings page. You can then manually configure sccache as described in the Local workstation section.

content/cache/overview.mdx

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ Supported build tools can be configured to use Depot Cache, so that they store a
2727

2828
This speeds up your builds and tests by orders of magnitude, especially for large codebases, as those builds and tests become incremental. Instead of always having to rebuild from scratch, only the parts of your codebase that have changed are rebuilt, and only affected tests are re-run.
2929

30+
### Cache retention policy
31+
32+
The default cache retention policy is to store the cache entries for 14 days with no limit on total cache size.
33+
34+
Configure the cache retention policy on your organization's [settings page](/orgs/_/settings) to control time based retention and cache size limits.
35+
36+
- Available values for time based retention: 7 days, 14 days (default), 30 days
37+
- Available values for size based retention: 25 GB, 50 GB, 100 GB, 150 GB, 250 GB, 500 GB, No limit (default)
38+
39+
**Note:** Retention policy settings don't apply to Docker layer cache entries (shown as type `docker` in the [Cache Explorer](/orgs/_/cache)). To manage Docker cache retention, set cache policy per [project](/orgs/_/projects) in project Settings.
40+
3041
## Where can I use Depot Cache?
3142

3243
Depot Cache is accessible anywhere you run your builds, in local development or from any CI/CD system. Additionally, all supported tools are pre-configured to use Depot Cache when using [Depot GitHub Actions Runners](/docs/github-actions/overview).
@@ -35,8 +46,4 @@ This means that build artifacts are shared between different members of your tea
3546

3647
## Pricing
3748

38-
Depot Cache is available on all of our pricing plans. Each plan includes a block of cache storage. Each additional GB over the included amount is billed at **$0.20/GB/month**. See our [pricing page](/pricing) for more details.
39-
40-
## Cache Retention
41-
42-
Depot Cache retains build artifacts for a configurable amount of time. By default, artifacts are retained for 14 days. You can configure this retention period in the Depot Cache settings.
49+
Depot Cache is available on all of our pricing plans. Each plan includes a block of cache storage. Each additional GB over the included amount is billed at $0.20 per GB of usage. We calculate usage by taking a snapshot every hour and then averaging out those snapshots over the month. For more information about plans and included usage, see the [pricing page](/pricing).

content/cli/reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Below is a reference to the `depot` CLI, including all config, commands, flags,
88

99
## Specifying a Depot project
1010

11-
Some commands need to know which [project](/docs/core-concepts#projects) to route the build to.
11+
Some commands need to know which [project](/docs/container-builds/overview#projects) to route the build to.
1212

1313
For interactive terminals calling [`build`](#depot-build) or [`bake`](#depot-bake), if you don't specify a project, you will be prompted to choose a project when using an interactive prompt and given the option to save that project for future use in a `depot.json` file.
1414

content/container-builds/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {CheckCircleIcon} from '~/components/icons'
88
import {DocsCTA} from '~/components/blog/CTA'
99
import {FAQSection, FAQItem} from '~/components/blog/FAQ'
1010

11-
Building a Docker image using Depot is up to [40x faster](https://depot.dev/benchmark/posthog) than on your local machine or CI provider. See a live benchmark.
11+
Building a Docker image using Depot is up to 40x faster than on your local machine or CI provider. See a live [benchmark](https://depot.dev/benchmark/posthog).
1212

1313
At a high level, here's what happens when you run `depot build`:
1414

content/core-concepts.mdx

Lines changed: 0 additions & 45 deletions
This file was deleted.

content/faq.mdx

Lines changed: 0 additions & 148 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Use egress filters for GitHub Actions runners
3+
ogTitle: How to configure egress filtering for your Depot GitHub Actions runners
4+
description: Learn how to configure egress filtering rules to control which external services your GitHub Actions runners can connect to.
5+
---
6+
7+
Configure egress filtering to control which external services your GitHub Actions runners can connect to by blocking or allowing connections at the network level. Egress filtering helps prevent data exfiltration and reduces the attack surface of your CI infrastructure.
8+
9+
### Configuration
10+
11+
Configure egress rules on your organization's [settings page](/orgs/_/settings), in the **GitHub Actions Runners** section under **Egress Rules**.
12+
13+
By default, Depot runners allow outbound connections to any external service. You can set the default rule (target `*`) to either `Deny` or `Allow`. You can add more rules to allow or deny connections to specific IPs, CIDRs, or hostnames.
14+
15+
The following example shows a set of rules to get a Docker build with Golang working:
16+
17+
[![A screenshot of the egress filter rules settings in use](/images/egress-filter-rules.webp)](/images/egress-filter-rules.webp)
18+
19+
This example first applies a blanket deny rule, which blocks all outbound connections by default. Then, it allows connections to the following:
20+
21+
- `auth.docker.io` and `docker.io` for Docker Hub authentication and registry access
22+
- `sum.golang.org` and `proxy.golang.org` for Go modules and proxy access
23+
- `storage.googleapis.com` for Google Cloud Storage access
24+
25+
### How the runner applies the rules
26+
27+
The runner applies the filtering rules in the following order:
28+
29+
1. Allow all loopback traffic (127.0.0.1, ::1) to prevent breaking localhost services.
30+
2. Apply Deny rules: denied IPs and CIDR blocks take precedence.
31+
3. Apply Allow rules: explicitly permitted IP addresses and CIDR blocks.
32+
4. Apply the default policy (ALLOW or DENY) to all other traffic.
33+
34+
When you specify a hostname in your rules, it's resolved to IP addresses and pinned in `/etc/hosts` to ensure consistent filtering.
35+
36+
### Pre-configured rules
37+
38+
To ensure that runners can still connect to necessary services, we automatically add certain IPs and hosts to the allowlist:
39+
40+
- depot.dev domains
41+
- GitHub Actions service IPs
42+
- AWS service IPs
43+
44+
Container builds with `depot build` also work with egress filtering enabled. Depot dynamically adds BuildKit machine IPs to the allowlist as they're allocated.
45+
46+
### Limitations
47+
48+
Keep the following limitations in mind when you use egress filtering:
49+
50+
- You can't use Tailscale with egress filters because each modifies the network config in incompatible ways.
51+
- Any process with root access can modify the egress filter rules. Ensure that untrusted processes don't run with higher privileges than necessary.
52+
- The egress filter is currently supported only on Linux runners.

0 commit comments

Comments
 (0)