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

chore: add git mirror copy #2964

Merged
merged 10 commits into from
Sep 15, 2024
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions pages/pipelines/hosted_agents/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ steps:
```
{: codeblock-file="pipeline.yml"}

Required attributes:
#### Required attributes

<table data-attributes data-attributes-required>
<tr>
Expand All @@ -86,7 +86,7 @@ Required attributes:
</tr>
</table>

Optional attributes:
#### Optional attributes

<table data-attributes data-attributes-required>
<tr>
Expand All @@ -100,7 +100,7 @@ Optional attributes:
<tr>
<td><code>size</code></td>
<td>
The size of the cache volume. The default size is 20 gigabytes. Units are in gigabytes, specified as <code>Ng</code>, where <code>N</code> is the size in gigabytes, and <code>g</code> indicates gigabytes.<br>
The size of the cache volume. The default size is 20 gigabytes, which is also the minimum cache size that can be requested.<br/>Units are in gigabytes, specified as <code>Ng</code>, where <code>N</code> is the size in gigabytes, and <code>g</code> indicates gigabytes.<br>
<em>Example:</em> <code>"20g"</code><br>
</td>
</tr>
Expand Down Expand Up @@ -128,7 +128,7 @@ An additional (smaller) charge is made per gigabyte of _active cache_, where act

### Git mirror cache

The Git mirror cache is a special type of cache volume that is used to speed up Git operations by caching the Git repository between builds. This is useful for large repositories that are slow to clone.
The Git mirror cache is a specialized type of cache volume designed to accelerate Git operations by caching the Git repository between builds. This is useful for large repositories that are slow to clone.

Git mirror caching can be enabled on the cluster's cache volumes settings page. Once enabled, the Git mirror cache will be used for all hosted jobs in that cluster. A separate cache volume will be created for each repository.

Expand Down
44 changes: 39 additions & 5 deletions pages/pipelines/hosted_agents/mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ Updated Xcode versions will be available one week after Apple offers them for do

### Xcode

- Xcode 16.1-Beta
- Xcode 16.0-Beta6
- Xcode 16.0-Beta5
- Xcode 16.0-Beta4
- Xcode 16.0-Beta3
- Xcode 16.0-Beta2
Expand All @@ -55,22 +58,21 @@ Updated Xcode versions will be available one week after Apple offers them for do
- iOS 17.5-beta2
- iOS 17.5
- iOS 18.0-beta4
- iOS 18.1-beta
- watchOS 9.4
- watchOS 10.2
- watchOS 10.4
- watchOS 10.5-beta2
- watchOS 10.5
- watchOS 11.0
- watchOS 11.0-beta7
- tvOS 16.4
- tvOS 17.2
- tvOS 17.4
- tvOS 17.5-beta2
- tvOS 17.5
- tvOS 18.0
- tvOS 18.0-beta7
- visionOS 1.0
- visionOS 1.1
- visionOS 1.2
- visionOS 2.0
- visionOS 2.0-beta7

### Other languages and compilers

Expand All @@ -95,6 +97,7 @@ Updated Xcode versions will be available one week after Apple offers them for do
- CocoaPods
- Ant
- Maven
- Mint
- Gradle
- Carthage
- CMake
Expand Down Expand Up @@ -149,3 +152,34 @@ Updated Xcode versions will be available one week after Apple offers them for do

- libpq
- GMP

## Git mirror cache

The Git mirror cache is a specialized type of cache volume designed to accelerate Git operations by caching the Git repository between builds. This is useful for large repositories that are slow to clone.

These volumes are attached on a best-effort basis depending on their locality, expiration and current usage, and therefore, should not be relied upon as durable data storage. By default, a Git mirror cache is created for each repository.

### Enabling Git mirror cache

To enable Git mirror cache for your hosted agents:

1. Select **Agents** in the global navigation to access the **Clusters** page.
1. Select the cluster in which to enable the Git mirror cache feature.
1. Select **Cache Storage**, then select the **Settings** tab.
1. Select **Enable Git mirror**, then select **Save cache settings** to enable Git mirrors for the selected hosted cluster.

Once enabled, the Git mirror cache will be used for all hosted jobs using Git repositories in that cluster. A separate cache volume will be created for each repository.

<%= image "hosted-agents-git-mirror.png", width: 1760, height: 436, alt: "Hosted agents git mirror setting displayed in the Buildkite UI" %>

### Deleting Git mirror cache

Deleting a cache volume may affect the build time for the associated pipelines until the new cache is established.

To delete a git mirror cache:

1. Select **Agents** in the global navigation to access the **Clusters** page.
1. Select the cluster whose Git mirror cache is to be deleted.
1. Select **Cache Storage**, then select the **Volumes** tab to view a list of all exiting cache volumes.
1. Select **Delete** for the Git mirror cache volume you wish to remove.
1. Confirm the deletion by selecting **Delete Cache Volume**.
Loading