Merge remote-tracking branch 'old_origin/20-merge-karmacomputingserver-bootstrap-into-public-karmacomput' into 27-recieve-merge-of-karmacomputingserver-bootstrap-ncl

Author: chrisjsimpson

.github/workflows/git-auto-issue-branch-creation.yml

@@ -6,6 +6,10 @@ on:
 jobs:
   create-issue-branch:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+      issues: write
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -22,7 +26,7 @@ jobs:
           # Given an issue title: "Fix the 2'nd bug in UI where there's a # in the form"
           # Becomes:
           #
-                                                             # Note there is a space here, to keep both '-' and spaces ' '
+          # Note there is a space here, to keep both '-' and spaces ' '
           echo ISSUE_BRANCH_NAME=`echo "${{ github.event.issue.title }}" | \
           # Remove non alpha/numeric chars
           tr -cd '[:alnum:]- ' | \
@@ -41,3 +45,12 @@ jobs:
           git checkout -b "${{ steps.issue.outputs.number }}-${{ env.ISSUE_BRANCH_NAME }}"
           git push -u origin HEAD
 
+      - name: Creating PR based on branch name ${{ github.ref_name }}
+        run: |
+          curl -L \
+          -X POST \
+          -H "Accept: application/vnd.github+json" \
+          -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+          -H "X-GitHub-Api-Version: 2022-11-28" \
+          https://api.github.com/repos/Subscribie/subscribie/pulls \
+          -d '{"title": "#${{ steps.issue.outputs.number }} ${{ env.ISSUE_BRANCH_NAME }}","body":"Pull request related issue: #${{ steps.issue.outputs.number }}. Please pull these awesome changes in!","head":"${{ steps.issue.outputs.number }}-${{ env.ISSUE_BRANCH_NAME }}","base":"master"}'

.gitignore

@@ -7,3 +7,6 @@ node_modules
 test-results/
 playwright-report/
 playwright/.cache/
+key*
+deploy/serve/www/*
+!deploy/serve/www/bootfile

repo-server-bootstrap-ncl-issue-20/README.md

@@ -0,0 +1,50 @@
+# Overview
+
+> [!NOTE]
+> This repo & docs is very much in flux.
+> For project purpose see [Server Bootstrap Project Concise project summary & deliverables](https://docs.google.com/document/d/15YR0hAkHfq8g_2rFzpKjpKf1mytyygREyR7a1ZWfzhE/edit?usp=sharing)
+> For background reading also see [https://github.com/KarmaComputing/server-bootstrap](https://github.com/KarmaComputing/server-bootstrap)
+
+![diagram](docs/diagram.drawio.png)
+
+
+## Table of contents
+
+- [Alpine Mirroring](./deploy/alpine-mirror/README.md)
+
+
+
+## Run for debugging
+
+- In `internal/runner`
+
+    ```sh
+    URL=https://192.168.0.230 USERNAME=Administrator PASSWORD=A0F7HKUU VALIDCERT=false WIPEINTERVAL=300 go run .
+    ```
+
+## Full deploy
+
+1. Build
+  - Building ipxe.iso image
+    - Use new/existing iPXE config file in `deploy/build/ipxe/scripts`
+    - Input its name as FILE variable in `deploy/scripts/build-ipxe-iso.sh`
+    - Run `deploy/scripts/build-ipxe-iso.sh`
+    - `ipxe.iso` is placed in `deploy/serve/www`
+  - Building alpine-netboot image
+    - Run `deploy/scripts/build-alpine.sh`
+    - Files are placed in `deploy/serve/www/iso`
+  - SSH keys
+    - An SSH keypair is automatically generated upon building an `ipxe.iso` image with the above command
+      - The **private** key is placed at `deploy/ssh/key`
+      - The **public** key is placed at `deploy/serve/www/ssh/key.pub`
+    - Up **re**building the `ipxe.iso`, the script will prompt to replace these keys or not
+
+2. Run stack
+  - Ensure the files are correctly placed from step 1
+  - `podman compose up -d` in repository root
+
+3. !! VM FOR TESTING !!
+  - Ensure `qemu` is installed and runnable
+  - Ensure web server is accessible at whatever address is defined in the iPXE boot script
+  - `qemu-system-x86_64 -cdrom <ipxe.iso> -net nic -net user,hostfwd=tcp::2223-:22 -m 3072 -smp $(nproc)`
+  - VM can be accessed over SSH at `localhost:2223`

repo-server-bootstrap-ncl-issue-20/compose.yaml

@@ -0,0 +1,21 @@
+services:
+  controller:
+    build: ./internal/runner
+    # ports:
+    # - 8081:8080
+    volumes:
+      - ./deploy/ssh/key:/app/key:z
+      - ./deploy/ansible:/app/ansible:z
+    environment:
+      - LC_ALL=en_US.UTF-8
+      - USERNAME=Administrator
+      - PASSWORD=A0F7HKUU
+      - URL=https://192.168.0.230
+      - VALIDCERT=false
+      - WIPEINTERVAL=300
+  apache:
+    build: ./deploy/serve
+    volumes:
+      - ./deploy/serve/www:/usr/local/apache2/htdocs:z
+    ports:
+      - 8080:80

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/Containerfile

@@ -0,0 +1,10 @@
+FROM docker.io/library/alpine:3.20
+
+RUN apk add rsync
+
+COPY ./synchroniser /app
+RUN cat /app/crontab >> /etc/crontabs/root
+
+RUN chmod +x /app/mirror.sh
+
+CMD ["crond", "-f"]

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/README.md

@@ -0,0 +1,23 @@
+# How to Use
+
+- Adjust `synchroniser/crontab` for desired schedule of synchronising
+- Adjust `synchroniser/mirror.sh` for which repos to exclude, etc.
+- The container image must be re-built when `crontab` or `mirror.sh` are changed
+- Run by `<podman|docker> compose up`
+
+# Notes
+
+- [Alpine Wiki - How to setup a Mirror](https://wiki.alpinelinux.org/wiki/How_to_setup_a_Alpine_Linux_mirror)
+- You can trigger the syncs manually via
+  - `<podman|docker> exec -it alpine-mirror-sync /app/mirror.sh`
+
+# How I've Tested It
+
+1. `git clone git@github.com:KarmaComputing/server-bootstrap-ncl.git`
+2. `cd server-bootstrap-ncl/deploy/alpine-mirror`
+3. `sudo docker compose up`
+4. `sudo docker run --rm -it --network host alpine:3.21 sh`
+  - `echo -e "http://localhost/v3.21/main\nhttp://localhost/v3.21/community" > /etc/apk/repositories`
+  - `apk update`
+  - Feel free to install anything to test, with `apk add`
+    - e.g. `apk add fastfetch` and `fastfetch`

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/compose.yaml

@@ -0,0 +1,13 @@
+services:
+  sync:
+    container_name: alpine-mirror-sync
+    build: .
+    volumes:
+      - ./repo:/site:z
+  server:
+    container_name: alpine-mirror-server
+    image: docker.io/library/httpd:alpine
+    volumes:
+      - ./repo:/usr/local/apache2/htdocs:z
+    ports:
+      - 8080:80

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/repo/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/synchroniser/crontab

@@ -0,0 +1,2 @@
+# every 5 days
+* * */5 * * sh /app/mirror.sh

repo-server-bootstrap-ncl-issue-20/deploy/alpine-mirror/synchroniser/mirror.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+# make sure we never run 2 rsync at the same time
+lockfile="/tmp/alpine-mirror.lock"
+if [ -z "$flock" ] ; then
+  exec env flock=1 flock -n $lockfile "$0" "$@"
+fi
+
+src=rsync://rsync.alpinelinux.org/alpine/ 
+dest=/site
+
+exclude="--exclude v2.* --exclude v3.0 --exclude v3.1 --exclude v3.2 --exclude v3.3 --exclude v3.4 --exclude v3.5 --exclude v3.6 --exclude v3.7 --exclude v3.8 --exclude v3.9 --exclude v3.10 --exclude v3.11 --exclude v3.12 --exclude v3.13 --exclude v3.14 --exclude v3.15 --exclude v3.16 --exclude v3.17"
+
+echo "--- Starting Sync ---"
+
+mkdir -p "$dest"
+/usr/bin/rsync \
+        --archive \
+        --update \
+        --hard-links \
+        --delete \
+        --delete-after \
+        --delay-updates \
+        --timeout=600 \
+        $exclude \
+        "$src" "$dest"
+        
+echo "--- Finished Sync ---"