Web Analytics

setup-distributed-nix-builds

⭐ 1 stars Hindi by Misaka13514

🌐 भाषा

❄️ वितरित निक्स बिल्ड्स सेटअप करें

एक GitHub Action जो कि एक अल्पकालिक, क्रॉस-प्लेटफार्म वितरित निक्स बिल्ड क्लस्टर को तुरंत स्थापित करता है, जिसमें स्टैंडर्ड GitHub होस्टेड रनर्स को Tailscale के माध्यम से सुरक्षित रूप से जोड़ा जाता है।

यह एक्शन आपको द्वितीयक GitHub रनर्स (जिन्हें बिल्डर्स कहा जाता है) की एक मैट्रिक्स को तुरंत शुरू करने और उन्हें एक प्राथमिक रनर (जिसे कोऑर्डिनेटर कहा जाता है) से Tailscale SSH के ज़रिए सहजता से जोड़ने की अनुमति देता है। कोऑर्डिनेटर स्वतः निक्स को इन नोड्स को रिमोट बिल्डर्स के रूप में उपयोग करने के लिए कॉन्फ़िगर करता है, जिससे बिना बाहरी इन्फ्रास्ट्रक्चर प्रबंधन के अधिकतम समवर्ती बिल्ड प्रदर्शन मिलता है! यह मल्टी-आर्किटेक्चर पैकेज बिल्ड करने या कई x86 रनर्स पर भारी NixOS सिस्टम क्लोज़र को क्षैतिज रूप से स्केल करने के लिए आदर्श है।

विशेषताएँ

यह कैसे काम करता है

वर्कफ़्लो रनर्स को दो भूमिकाओं में विभाजित करता है: builder और 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

आवश्यकताएँ

इस क्रिया का उपयोग करने से पहले, आपको रनर्स के लिए सुरक्षित रूप से संचार करने हेतु एक Tailscale नेटवर्क कॉन्फ़िगर करना होगा।

सुनिश्चित करें कि आपके Tailscale में टैग समूह बनाए गए हैं और ACLs कोऑर्डिनेटर को Tailscale SSH के माध्यम से बिल्डर्स में निर्बाध रूप से SSH करने की अनुमति देते हैं। निम्नलिखित को अपने Tailscale Access Controls में जोड़ें:

आवश्यक Tailscale ACL कॉन्फ़िगरेशन देखने के लिए क्लिक करें

{
  "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 Admin पैनल में auth_keys लिखने के लिए स्कोप और nix-ci-builder nix-ci-coordinator टैग्स के साथ एक OAuth क्लाइंट सीक्रेट जेनरेट करें। इस सीक्रेट को अपनी GitHub Repository Secrets में TS_OAUTH_SECRET के रूप में जोड़ें।

इनपुट

| इनपुट | विवरण | आवश्यक | डिफ़ॉल्ट | | -------------------- | ---------------------------------------------------------------------------------------------- | -------- | ------------ | | tailscale_authkey | Tailscale OAuth क्लाइंट सीक्रेट या Auth Key. | हाँ | लागू नहीं | | tailscale_hostname | Tailscale के साथ रजिस्टर करने के लिए होस्टनेम. | हाँ | लागू नहीं | | tailscale_tags | Tailscale पर विज्ञापित करने के लिए टैग्स (जैसे tag:nix-ci-builder). | हाँ | लागू नहीं | | role | वर्तमान जॉब की भूमिका: "builder" या "coordinator". | हाँ | "builder" | | builders | प्रतीक्षा करने के लिए पूर्ण बिल्डर होस्टनेम्स की स्पेस सेपरेटेड लिस्ट। (_अगर रोल coordinator है तो आवश्यक_) | नहीं | "" | | builder_timeout | अधिकतम समय (सेकंड में) जिसे बिल्डर को स्वयं-टर्मिनेट करने से पहले प्रतीक्षा करनी चाहिए। | नहीं | "300" | | extra_nix_config | /etc/nix/nix.conf में जोड़ने के लिए अतिरिक्त Nix कॉन्फ़िगरेशन। | नहीं | "" |

उपयोग

पूर्ण वितरित बिल्ड उदाहरण

नीचे एक संपूर्ण वर्कफ़्लो (nix-build.yml) है जो डायनामिक रूप से कई रनर आर्किटेक्चर्स (Ubuntu x86, Ubuntu ARM, macOS x86, macOS Apple Silicon) को स्पिन करता है, उन्हें जोड़ता है और एक वितरित Nix बिल्ड चलाता है।

यदि आप एक भारी NixOS कॉन्फ़िगरेशन बना रहे हैं और बस इसे क्षैतिज स्केलिंग का उपयोग करके तेज़ करना चाहते हैं, तो आप BUILDER_COUNTS को बदल सकते हैं ताकि कई समान x86 रनर स्पॉन हो सकें। उदाहरण के लिए: BUILDER_COUNTS: '{"ubuntu-24.04": 4}' यह आपको तुरंत 16 CPU कोर (4 रनर × 4 कोर) के साथ एक बिल्ड फार्म देगा, ताकि डेरिवेशन समानांतर में प्रोसेस किए जा सकें।

चूंकि GitHub Hosted Runners अस्थायी होते हैं, वर्कफ़्लो समाप्त होने पर Nix स्टोर में सभी बिल्ड आर्टीफैक्ट्स खो जाएंगे। भविष्य के CI रन या अपनी स्थानीय मशीनों पर अपने वितरित बिल्ड्स का लाभ उठाने के लिए, परिणामों को किसी बाइनरी कैश जैसे Cachix या Attic में पुश करना अत्यधिक अनुशंसित है।

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

लाइसेंस

यह परियोजना MIT लाइसेंस के तहत लाइसेंस प्राप्त है।

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

Original README: View on GitHub

Translated by OpenAiTx | Last updated: 2026-03-27