steffen/cryodev
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

remove all deploy-rs references from docs and config

Browse source 
- Update README, AGENTS.md, docs/index.md, docs/deployment/cd.md,
  docs/services/forgejo.md: replace deploy-rs with Comin everywhere
- Fix repo URL references (cryodev-server -> cryodev)
- Fix forgejo admin create command to use shell alias
- Rewrite cd.md for Comin-only deployment
This commit is contained in:
steffen 2026-03-14 14:52:30 +01:00
parent a4dfbdcd52
commit 4e36cca637
5 changed files with 49 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

11
AGENTS.md
View file

@ -27,7 +27,7 @@ nix build .#nixosConfigurations.cryodev-pi.config.system.build.sdImage
# Format code (required before committing) # Format code (required before committing)
nix fmt nix fmt
# Run all checks (lint, formatting, deploy-rs validation) # Run all checks (lint, formatting)
nix flake check nix flake check
# Quick evaluation test (faster than full build) # Quick evaluation test (faster than full build)
@ -46,14 +46,17 @@ nix develop
# Deploy all hosts via deploy app (uses deploy.json) # Deploy all hosts via deploy app (uses deploy.json)
nix run .#deploy nix run .#deploy
# Deploy to cryodev-main via deploy-rs # Deploy a specific host
nix run github:serokell/deploy-rs -- .#cryodev-main nix run .#deploy -- -n cryodev-main
# Manual deployment via SSH # Manual deployment via SSH
NIX_SSHOPTS="-p 2299" nixos-rebuild switch --flake .#<hostname> \ NIX_SSHOPTS="-p 2299" nixos-rebuild switch --flake .#<hostname> \
--target-host <user>@<ip> --sudo --ask-sudo-password --target-host <user>@<ip> --sudo --ask-sudo-password
``` ```
> **Note:** Both hosts use Comin for automatic pull-based deployment.
> Manual deployment is only needed for the initial setup or emergencies.
### Apps ### Apps
```bash ```bash
@ -200,7 +203,7 @@ services.nginx.enable = lib.mkDefault true;
| Host | Strategy | Trigger | | Host | Strategy | Trigger |
|------|----------|---------| |------|----------|---------|
| `cryodev-main` | Push via deploy-rs | Forgejo Actions on push to main | | `cryodev-main` | Pull via Comin | Automatic polling |
| `cryodev-pi` | Pull via Comin | Automatic polling | | `cryodev-pi` | Pull via Comin | Automatic polling |
| SD Images | Built in CI | Push to main (for Pi hosts) | | SD Images | Built in CI | Push to main (for Pi hosts) |

8
README.md
View file

@ -6,8 +6,8 @@ Declarative NixOS infrastructure for the **cryodev** environment, managed with N
```bash ```bash
# Clone repository # Clone repository
git clone https://git.cryodev.xyz/steffen/cryodev-server.git git clone https://git.cryodev.xyz/steffen/cryodev.git
cd cryodev-server cd cryodev
# Check configuration # Check configuration
nix flake check nix flake check
@ -20,7 +20,7 @@ nix build .#nixosConfigurations.cryodev-main.config.system.build.toplevel
| Host | Architecture | Deployment | Description | | Host | Architecture | Deployment | Description |
|------|--------------|------------|-------------| |------|--------------|------------|-------------|
| `cryodev-main` | x86_64 | Push (deploy-rs) | Main server | | `cryodev-main` | x86_64 | Pull (Comin) | Main server |
| `cryodev-pi` | aarch64 | Pull (Comin) | Raspberry Pi client | | `cryodev-pi` | aarch64 | Pull (Comin) | Raspberry Pi client |
## Services ## Services
@ -37,7 +37,7 @@ nix build .#nixosConfigurations.cryodev-main.config.system.build.toplevel
SD card images for Raspberry Pi clients are **built automatically** on every push to `main`. SD card images for Raspberry Pi clients are **built automatically** on every push to `main`.
Download from: [Releases](https://git.cryodev.xyz/steffen/cryodev-server/releases) Download from: [Releases](https://git.cryodev.xyz/steffen/cryodev/releases)
```bash ```bash
# Flash to SD card # Flash to SD card

130
docs/deployment/cd.md
View file

@ -1,121 +1,38 @@
# Continuous Deployment # Continuous Deployment
The cryodev infrastructure uses two deployment strategies optimized for different host types. All hosts use **Comin** (pull-based) for automatic deployment.
## Overview ## Overview
| Host | Strategy | Tool | Trigger | | Host | Strategy | Tool | Trigger |
|------|----------|------|---------| |------|----------|------|---------|
| `cryodev-main` | Push-based | deploy-rs | Git push via Forgejo Actions | | `cryodev-main` | Pull-based | Comin | Automatic polling |
| `cryodev-pi` | Pull-based | Comin | Periodic polling | | `cryodev-pi` | Pull-based | Comin | Automatic polling |
## Push-based Deployment (cryodev-main) ## How It Works
### How It Works
1. Developer pushes to `main` branch 1. Developer pushes to `main` branch
2. Forgejo Actions workflow triggers 2. CI (Forgejo Actions) runs flake-check and builds all hosts
3. `deploy-rs` connects via SSH and deploys 3. Comin on each host periodically polls the Git repository
4. On changes, Comin builds and activates the new configuration
### Setup ## Configuration
#### 1. Generate Deploy Key
```bash
ssh-keygen -t ed25519 -f deploy_key -C "forgejo-actions"
```
#### 2. Add Public Key to Server
On `cryodev-main`:
```bash
echo "PUBLIC_KEY_CONTENT" >> /root/.ssh/authorized_keys
```
#### 3. Add Private Key to Forgejo
1. Go to Repository Settings > Secrets
2. Add secret named `DEPLOY_SSH_KEY`
3. Paste the private key content
#### 4. Workflow Configuration
`.forgejo/workflows/deploy.yaml`:
```yaml
name: Deploy
on:
push:
branches: [main]
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: cachix/install-nix-action@v24
- run: nix flake check
deploy:
needs: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: cachix/install-nix-action@v24
- name: Setup SSH
env:
SSH_PRIVATE_KEY: ${{ secrets.DEPLOY_SSH_KEY }}
run: |
mkdir -p ~/.ssh
echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_ed25519
chmod 600 ~/.ssh/id_ed25519
ssh-keyscan cryodev-main >> ~/.ssh/known_hosts
- name: Deploy
run: nix run github:serokell/deploy-rs -- .#cryodev-main
```
### Rollback
deploy-rs automatically rolls back if the new configuration fails health checks.
Manual rollback:
```bash
# List generations
sudo nix-env -p /nix/var/nix/profiles/system --list-generations
# Rollback to previous
sudo nixos-rebuild switch --rollback
```
## Pull-based Deployment (cryodev-pi)
### How It Works
1. Comin periodically polls the Git repository
2. On changes, it builds and activates the new configuration
3. Works through NAT without incoming connections
### Configuration
```nix ```nix
# hosts/cryodev-pi/services/comin.nix # hosts/<hostname>/services/comin.nix
{ {
services.comin = { services.comin = {
enable = true; enable = true;
remotes = [{ remotes = [{
name = "origin"; name = "origin";
url = "https://git.cryodev.xyz/steffen/cryodev-server.git"; url = "https://git.cryodev.xyz/steffen/cryodev.git";
branches.main.name = "main"; branches.main.name = "main";
}]; }];
}; };
} }
``` ```
### Monitoring ## Monitoring
Check Comin status: Check Comin status:
@ -130,7 +47,7 @@ Force immediate update:
sudo systemctl restart comin sudo systemctl restart comin
``` ```
### Troubleshooting ## Troubleshooting
If Comin fails to build: If Comin fails to build:
@ -140,23 +57,30 @@ sudo journalctl -u comin --since "1 hour ago"
# Manual build test # Manual build test
cd /var/lib/comin/repo cd /var/lib/comin/repo
nix build .#nixosConfigurations.cryodev-pi.config.system.build.toplevel nix build .#nixosConfigurations.<hostname>.config.system.build.toplevel
```
## Rollback
```bash
# List generations
sudo nix-env -p /nix/var/nix/profiles/system --list-generations
# Rollback to previous
sudo nixos-rebuild switch --rollback
``` ```
## Manual Deployment ## Manual Deployment
For hosts not using automated deployment: For initial setup or emergencies:
```bash ```bash
# Build locally # Using the deploy app
nix build .#nixosConfigurations.<hostname>.config.system.build.toplevel nix run .#deploy -- -n <hostname>
# Deploy with nixos-rebuild # Or manually with nixos-rebuild
NIX_SSHOPTS="-p 2299" nixos-rebuild switch --flake .#<hostname> \ NIX_SSHOPTS="-p 2299" nixos-rebuild switch --flake .#<hostname> \
--target-host <user>@<hostname> --sudo --ask-sudo-password --target-host <user>@<hostname> --sudo --ask-sudo-password
# Or using deploy-rs
nix run github:serokell/deploy-rs -- .#<hostname>
``` ```
## Testing Changes ## Testing Changes

4
docs/index.md
View file

@ -90,5 +90,5 @@ Für Raspberry Pi: [SD-Image Referenz](getting-started/sd-image.md)
| Host | Strategie | Tool | Beschreibung | | Host | Strategie | Tool | Beschreibung |
|------|-----------|------|--------------| |------|-----------|------|--------------|
| `cryodev-main` | Push-basiert | deploy-rs via Forgejo Actions | Sofortige Updates bei Push | | `cryodev-main` | Pull-basiert | Comin | Pollt Repository auf Aenderungen |
| `cryodev-pi` | Pull-basiert | Comin | Pollt Repository auf Änderungen | | `cryodev-pi` | Pull-basiert | Comin | Pollt Repository auf Aenderungen |

39
docs/services/forgejo.md
View file

@ -75,44 +75,23 @@ forgejo-runner:
## CI/CD Workflows ## CI/CD Workflows
### deploy-rs Workflow CI runs on every push to `main` via Forgejo Actions:
`.forgejo/workflows/deploy.yaml`: 1. **flake-check** -- validates the flake
2. **build-hosts** -- builds all host configurations
```yaml Deployment is handled by **Comin** (pull-based), not by CI.
name: Deploy See [CD documentation](../deployment/cd.md) for details.
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Nix
uses: cachix/install-nix-action@v24
- name: Deploy
env:
SSH_PRIVATE_KEY: ${{ secrets.DEPLOY_SSH_KEY }}
run: |
mkdir -p ~/.ssh
echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_ed25519
chmod 600 ~/.ssh/id_ed25519
nix run .#deploy
```
## Administration ## Administration
### Create Admin User ### Create Admin User
```bash ```bash
sudo -u forgejo forgejo admin user create \ forgejo admin user create \
--username admin \ --username <benutzername> \
--password changeme \ --email <email>@<domain> \
--email admin@cryodev.xyz \ --password <passwort> \
--admin --admin
``` ```