Web Analytics

setup-distributed-nix-builds

⭐ 1 stars Turkish by Misaka13514

🌐 Dil

❄️ Dağıtık Nix Derlemelerini Kurma

Ephemeral, platformlar arası Dağıtık Nix Derlemesi kümesini standart GitHub Hosted Runnerlar üzerinden Tailscale ile güvenli şekilde anında sağlamak için bir GitHub Action’ı.

Bu action, birincil runner’a ( Koordinatör ) sorunsuz şekilde bağlanan ikincil GitHub runner’larından ( Derleyiciler ) oluşan bir matris oluşturmanıza ve Tailscale SSH üzerinden bağlantı sağlamanıza olanak tanır. Koordinatör, Nix’i bu düğümleri uzak derleyiciler olarak kullanacak şekilde otomatik olarak yapılandırır; harici altyapı yönetmeden eşzamanlı derleme performansını en üst düzeye çıkarır! Çok mimarili paketler derlemek veya x86 runner filosu üzerinde ağır NixOS sistem kapamalarını yatay olarak ölçeklendirmek için mükemmeldir.

Özellikler

Nasıl Çalışır

İş akışı, çalışanları iki role ayırır: builder ve coordinator.

sequenceDiagram
  participant GH as GitHub Actions
  participant Coord as Coordinator (Ubuntu)
  participant B1 as Builder 1 (Ubuntu ARM)
  participant B2 as Builder 2 (macOS)
  participant TS as Tailscale Network

GH->>B1: Spawn Builder Node GH->>B2: Spawn Builder Node GH->>Coord: Spawn Coordinator Node

B1->>TS: Auth & Idle Wait B2->>TS: Auth & Idle Wait Coord->>TS: Auth & Wait for Builders

TS-->>Coord: Builders Online!

Note over Coord: Tests Nix connection &
Updates /etc/nix/machines

Coord->>B1: Send aarch64-linux build tasks via SSH Coord->>B2: Send aarch64-darwin build tasks via SSH

B1-->>Coord: Return Build Artifacts B2-->>Coord: Return Build Artifacts

Note over Coord: Build Completes Coord->>B1: Send Teardown Signal Coord->>B2: Send Teardown Signal

Önkoşullar

Bu işlemi kullanmadan önce, koşucuların güvenli bir şekilde iletişim kurabilmesi için bir Tailscale ağı yapılandırmanız gerekir.

Tailscale'inizde etiket gruplarının oluşturulduğundan ve ACL'lerin koordinatörün Tailscale SSH kullanarak yapılandırıcılara sorunsuz bir şekilde SSH yapmasına izin verdiğinden emin olun. Aşağıdakileri Tailscale Erişim Kontrolleri bölümüne ekleyin:

Gerekli Tailscale ACL yapılandırmasını görüntülemek için tıklayın

{
  "grants": [
    {
      "src": ["tag:nix-ci-builder", "tag:nix-ci-coordinator"],
      "dst": ["tag:nix-ci-builder", "tag:nix-ci-coordinator"],
      "ip": ["*"]
    }
  ],
  "ssh": [
    {
      "src": ["tag:nix-ci-coordinator"],
      "dst": ["tag:nix-ci-builder"],
      "users": ["autogroup:nonroot", "root"],
      "action": "accept"
    }
  ],
  "tagOwners": {
    "tag:nix-ci-coordinator": ["autogroup:admin", "tag:nix-ci-coordinator"],
    "tag:nix-ci-builder": ["autogroup:admin", "tag:nix-ci-builder"]
  }
}

Tailscale Yönetim panelinizde auth_keys yazma kapsamı ve nix-ci-builder ile nix-ci-coordinator etiketleriyle bir OAuth İstemci Sırrı oluşturun. Bu sırrı GitHub Depo Sırlarınızda TS_OAUTH_SECRET olarak ekleyin.

Girdiler

| Girdi | Açıklama | Gerekli | Varsayılan | | -------------------- | ---------------------------------------------------------------------------------------------- | -------- | ----------- | | tailscale_authkey | Tailscale OAuth istemci sırrı veya Kimlik Anahtarı. | Evet | N/A | | tailscale_hostname | Tailscale ile kaydedilecek ana bilgisayar adı. | Evet | N/A | | tailscale_tags | Tailscale'a bildirilecek etiketler (örn. tag:nix-ci-builder). | Evet | N/A | | role | Mevcut işin rolü: "builder" veya "coordinator". | Evet | "builder" | | builders | Beklenecek tam builder ana bilgisayar adlarının boşlukla ayrılmış listesi. (_Rol coordinator ise gereklidir_) | Hayır | "" | | builder_timeout | Builder'ın kendi kendini sonlandırmadan önce bekleyeceği maksimum süre (saniye cinsinden). | Hayır | "300" | | extra_nix_config | /etc/nix/nix.conf dosyasına eklenecek ekstra Nix yapılandırması. | Hayır | "" |

Kullanım

Tam Dağıtık Derleme Örneği

Aşağıda, birden fazla runner mimarisini (Ubuntu x86, Ubuntu ARM, macOS x86, macOS Apple Silicon) dinamik olarak başlatan, bunları birbirine bağlayan ve dağıtık bir Nix derlemesi çalıştıran eksiksiz bir iş akışı (nix-build.yml) bulunmaktadır.

Ağır bir NixOS yapılandırması oluşturuyorsanız ve sadece yatay ölçeklendirme ile hızlandırmak istiyorsanız, BUILDER_COUNTS değerini değiştirerek birden fazla aynı x86 runner başlatabilirsiniz. Örneğin: BUILDER_COUNTS: '{"ubuntu-24.04": 4}' Bu, size anında 16 CPU çekirdeği (4 runner × 4 çekirdek) ile paralel olarak türevleri işleyebilecek bir derleme çiftliği sağlar.

GitHub Hosted Runner'lar geçici olduğundan, iş akışı tamamlandığında Nix deposundaki tüm derleme çıktıları kaybolacaktır. Dağıtık derlemelerinizin avantajlarından gelecekteki CI çalıştırmalarında veya yerel makinelerinizde faydalanmak için, sonuçları Cachix veya Attic gibi bir binary cache'e göndermeniz şiddetle tavsiye edilir.

name: Distributed Nix Build

on: workflow_dispatch:

env: # Define exactly how many runners of each OS type you want BUILDER_COUNTS: '{"ubuntu-24.04": 1, "ubuntu-24.04-arm": 1, "macos-26-intel": 1, "macos-26": 1}'

jobs: config: runs-on: ubuntu-slim outputs: builder_matrix: ${{ steps.set.outputs.builder_matrix }} builders_list: ${{ steps.set.outputs.builders_list }} run_suffix: ${{ steps.set.outputs.run_suffix }} steps:

  • id: set
run: | SUFFIX=$(openssl rand -hex 3) echo "run_suffix=$SUFFIX" >> "$GITHUB_OUTPUT"

# Dynamically generate the Matrix JSON based on BUILDER_COUNTS MATRIX_JSON=$(echo '${{ env.BUILDER_COUNTS }}' | jq -c '[ to_entries[] | .key as $os | .value as $count | range(1; $count + 1) | { os: $os, id: "\($os)-\(.)" } ] ') echo "builder_matrix=$MATRIX_JSON" >> "$GITHUB_OUTPUT"

# Create a space-separated list of hostnames for the coordinator BUILDERS_LIST=$(echo "$MATRIX_JSON" | jq -r --arg suffix "$SUFFIX" 'map("nix-builder-\($suffix)-\(.id)") | join(" ")') echo "builders_list=$BUILDERS_LIST" >> "$GITHUB_OUTPUT"

builder: needs: config name: Builder ${{ matrix.builder.id }} (${{ needs.config.outputs.run_suffix }}) runs-on: ${{ matrix.builder.os }} strategy: fail-fast: false matrix: builder: ${{ fromJSON(needs.config.outputs.builder_matrix) }} steps:

  • name: Setup Distributed Nix Builder
uses: Misaka13514/setup-distributed-nix-builds@main with: tailscale_authkey: ${{ secrets.TS_OAUTH_SECRET }} tailscale_hostname: nix-builder-${{ needs.config.outputs.run_suffix }}-${{ matrix.builder.id }} tailscale_tags: tag:nix-ci-builder role: builder

# Optionally configure your Cachix/Attic or other caching here # - uses: cachix/cachix-action@v17

coordinator: needs: config name: Coordinator (${{ needs.config.outputs.run_suffix }}) runs-on: ubuntu-24.04 steps:

  • name: Setup Coordinator & Connect Builders
uses: Misaka13514/setup-distributed-nix-builds@main with: tailscale_authkey: ${{ secrets.TS_OAUTH_SECRET }} tailscale_hostname: nix-coordinator-${{ needs.config.outputs.run_suffix }} tailscale_tags: tag:nix-ci-coordinator role: coordinator builders: ${{ needs.config.outputs.builders_list }}

# Optionally configure your Cachix/Attic or other caching here # - uses: cachix/cachix-action@v17

  • name: Execute Distributed Build
run: | # Your build command here. Because builders are registered in /etc/nix/machines, # Nix will automatically offload tasks to the correct architecture node. nix build -L --max-jobs 0 .#my-package

# Signal builders to terminate if they are not needed anymore

  • name: Teardown Builders
run: stop-nix-builders

# Push build results to Cachix/Attic or other cache here if desired # - name: Push to Cachix # run: cachix push mycache --all

Lisans

Bu proje MIT Lisansı kapsamında lisanslanmıştır.

--- Tranlated By Open Ai Tx | Last indexed: 2026-03-27 ---