wip: docs: moar resolutions

See coop-cloud/organising#583

docs/abra/cheat-sheet.md

@@ -15,6 +15,8 @@ Definitely set up autocomplete or you'll be sad :sob: `abra` supports `bash`,
 
 ```
 $ abra autocomplete bash
+# Restart your terminal or load autocompletion in place
+$ source /etc/bash_completion.d/abra
 ```
 
 

docs/abra/hack.md

@@ -54,11 +54,44 @@ go test ./pkg/recipe -v -run TestGetVersionLabelLocalDoesNotUseTimeoutLabel
 
 ## Integration tests
 
-### Install dependencies
+### Running on the CI server
 
-We use [`bats`](https://bats-core.readthedocs.io/en/stable/), you can install
-the required dependencies with the following. You also need a working
-installation of Docker and Go (not covered in this section).
+Based on
+[R020](https://docs.coopcloud.tech/federation/resolutions/passed/020/), we have
+automated running the integration test suite. Here's the TLDR;
+
+* We have a donated CI server (tysm `@mirsal` 💝) standing at the ready,
+  `int.coopcloud.tech`.
+* We run the entire integration suite nightly via our Drone CI/CD configuration [here](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/.drone.yml) (see "`name: integration test`" stanza)
+* Here is the script that is run on the remote server: [`run-ci-int`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/tests/run-ci-int)
+
+What follows is a listing of how this was achieved so that we can collectivise
+the maintenance.
+
+On the server, we have:
+
+* Created an `abra` user with `docker` permissions
+* Ran `apt install bats bats-file bats-assert bats-support jq make git golang-1.21 wget bash`
+* Installed `bats-core` from source, following the instructions below
+* Docker was already installed on the machine, so nothing to do there
+* `docker login` with the `thecoopcloud` details so we don't get rate limited
+
+The drone configuration was wired up as follows:
+
+* Generated a SSH key and put the public key part in `~/.ssh/authorize_keys`
+* Added that public key part as a "deploy key" in the abra repo (so we can do `ssh://` git remote pulls)
+* Added the private key part as a Drone secret which is available in build so that the build can SSH over to the server to run commands. That was done like so: `drone secret add --repository coop-cloud/abra --name abra_int_private_key --data @id_ed25519`
+* In order to specify a cron timing, you need to create it with the Drone CLI: `drone cron add "coop-cloud/abra" "integration" @daily --branch main`
+
+Please ask `@decentral1se` or on the Matrix channels for SSH access to the machine.
+
+### Running them locally
+
+#### Install dependencies
+
+We use [`bats`](https://bats-core.readthedocs.io/en/stable/) to run the tests.
+You can install the required dependencies with the following. You also need a
+working installation of Docker and Go >= 1.16 (not covered in this section).
 
 ```
 apt install bats-file bats-assert bats-support jq make git
@@ -75,12 +108,14 @@ cd bats-core
 sudo ./install.sh /usr/local
 ```
 
-### Setup Test Server
+#### Setup Test Server
 
-For many tests an actual server is needed, where apps can be deployed. You can
-either use a local one or a remote test server.
+For some tests an actual server is needed, where apps can be deployed. You can
+either use a local one or a remote test server. There is also a way to run or
+skip tests that require a remote server. This is covered below in the
+[filtering tests](#filter-tests_1) section.
 
-#### With remote test server
+##### Remote swarm
 
 ```
 export ABRA_TEST_DOMAIN="test.example.com"
@@ -89,14 +124,9 @@ export ABRA_DIR="$HOME/.abra_test"
 
 `ABRA_TEST_DOMAIN` should also have a DNS A record for `*.test.example.com`
 which points to the same server so that the test suite can deploy apps freely.
-It's advised that you re-use the same server and therefore the same Traefik
-deployment for running your integration tests. The test suite does not deploy
-Traefik for you. Then you'll have more stable results.
+The test suite does not deploy Traefik for you.
 
-You probably don't want to run the entire test suite though, it takes a while.
-Try the following for starters.
-
-#### With local swarm
+##### Local swarm
 
 When running the test suite localy you need a running docker swarm setup:
 
@@ -128,10 +158,11 @@ bats -Tp tests/integration/autocomplete.bats
 
 ### Tagging tests
 
-When a test actually deploys something to a server, we tag it with the following:
+When a test actually deploys something, we tag it as "slow". When the test
+requires public DNS, we use "dns". There may be more tags we write more tests.
 
 ```
-# bats test_tags=slow
+# bats test_tags=slow,dns
 @test "..." {
   ...
 }
@@ -166,14 +197,17 @@ bats -Tp tests/integration --filter "validate app argument"
 You can filter on tags.
 
 ```
-bats -Tp tests/integration --filter-tags "\!slow" # only fast tests
-bats -Tp tests/integration --filter-tags "slow"   # only slow tests
+bats -Tp tests/integration --filter-tags \!slow      # only fast tests
+bats -Tp tests/integration --filter-tags slow        # only slow tests
+bats -Tp tests/integration --filter-tags slow,\!dns  # slow but no DNS tests
 ```
 
 You can also only run the previously failed tests.
 
 ```
-bats -TP tests/integration --filter-status failed
+mkdir -p tests/integration/.bats/run-logs
+bats -Tp tests/integration                        # run tests
+bats -Tp tests/integration --filter-status failed # re-run only failed
 ```
 
 ### Debug tests

docs/federation/minutes/2024-04-17.md

@@ -0,0 +1,73 @@
+---
+title: 2024-04-17
+---
+
+## Meta
+
+* Poll: https://poll.local-it.org/invite/Q828kjlYLNwW
+* Call: https://talk.local-it.org/rooms/nyy-z5y-yrh-sc2/join
+* Present: Local IT (moritz), EOTL (BaseBuilder, blu), BeWater(d1), Autonomic (Lai), Klasse & Methode (p4u1)
+
+## Agenda
+
+### First
+
+* Fixed monthly Federation meeting (3rd Mon, etc) `@basebuilder`
+* Project re-organisation (recipes, tools, fedi repos) `@d1`
+* Backup specification `@p4u1`
+
+### The Rest
+
+* Non-Federation tasks specific bounty / funding `@basebuilder`
+* Website and docs work to better showcase federation - `@kawaiipunk`
+    * https://git.coopcloud.tech/coop-cloud/organising/milestone/43
+* Recipe maintainence proposal - `@kawaiipunk`
+* "Hacking velocity = slow & money" (RE: recent fedi orga chat) `@d1`
+* Continuing budget 001 for meeting attendance, resolution 004 technically only covered 6 months to oct 2023 `@3wc` (but I won't be there)
+
+## Notes
+
+### Fixed monthly Federation meeting (3rd Mon, etc)
+
+Talked about it couple of times, back and forth.
+- People who want to do regular can do that
+- Other people can do polled meeting
+- Poll every month is time consuming
+- Timezones is an issue
+
+Poll options for meeting
+1. fix time/date every month
+1. fixed time/date with timezone wraparound (can be merged with 1. :)
+1. flexible every month (poll)
+1. fixed week with poll (day of week, crab.fit)
+
+> crab.fit - software with heatmap of availability
+
+### Project re-organisation (recipes, tools, fedi repos)
+
+Problem: All projects are under one organisation (coop-cloud). Abra has to do a lot of work to figure out what is a recipe repo and what not. This got fixed but made recipe generation really slow
+
+Proposal: 3 Organisations in gitea:
+- Recipes
+- Tools
+- Projects
+
+What to look out for:
+- Redirects (mainly for recipes)
+- SSH will break though -> could make a migration script for that?
+ 
+https://git.coopcloud.tech/coop-cloud/organising/milestone/45
+https://git.coopcloud.tech/coop-cloud/organising/issues/569
+
+Maybe "tools" / "projects" not needed, only "recipes" / "other".
+
+### Backup Specification
+
+Needing to write operators and matainers guide
+
+- [ ] should abra implement backup and restore or only provide an integration?
+- [ ] should we add a specification version?
+
+## Next Meeting
+
+* Who: ???

docs/federation/resolutions/drafts/020.md

@@ -0,0 +1,49 @@
+---
+title: "Resolution 020"
+---
+
+- Topic: Federation member responsibilities
+- Date: ...
+- Deadline: ...
+- Size: Large
+
+### Summary
+
+Motivated by the last Federation meeting: [minutes](https://docs.coopcloud.tech/federation/minutes/2024-29-03/).
+
+New members are joining the Federation, hurray! In the discussion about what it means to join, the question came up: what exactly are the responsibilities of the members? This was raised in [`#581`](https://git.coopcloud.tech/coop-cloud/organising/issues/581).
+
+Responsibilities were defined in the original [Federation Proposal](https://pad.autonomic.zone/s/MLafJE2jC#Responsibilities). We would like to document and extend those in this proposal.
+
+Furthermore, some existing members have not been participating, not paid dues/asked for waiver and some have even left the federation chat room. It would seem also time to define some "exit criteria" to keep a healthy balance.
+
+### Details
+
+#### Responsibilities
+
+**Already agreed upon**
+
+- Pay yearly dues or ask for waiver (if they can't afford it)
+- Actively participate in all large decisions
+- Agree to the [Code of Co-operation (CoC)](https://docs.coopcloud.tech/federation/code-of-coop/)
+
+**New**
+
+- Actively participate in monthly federation meetings. If they can't make it, updates will be sent by text.
+
+#### Exit criteria
+
+> The idea is not to eject people out the federation but to use these clear guidelines as a way to assess if participants should remain federation members. This applies to both sides as it is often unclear how to leave volunteer projects.
+
+**New**
+
+- Not paying dues / having an agreed waiver
+- Not actively participating in all large decisions
+- Not active in federation monthly meetings
+- Do not behave in accordance with the [CoC](https://docs.coopcloud.tech/federation/code-of-coop/)
+
+#### Implementation
+
+- These criteria + a link to the [Federation proposal](https://pad.autonomic.zone/s/MLafJE2jC) will be clearly linked on a new "Federation handbook" on docs.coopcloud.tech
+
+- An agenda point will be put on the next federation meeting to chase up dues/waiver agreements and to agree on a collective process for checking on participation of members.

docs/federation/resolutions/drafts/023.md

@@ -0,0 +1,48 @@
+---
+title: "Resolution 023"
+---
+
+- Topic: Budget XXX: Improved project organisation
+- Date: ...
+- Deadline: ...
+- Size: Large
+
+### Summary
+
+Motivated by the collective release planning: [`#583`](https://git.coopcloud.tech/coop-cloud/organising/issues/583) under "Improved Project Organisation".
+
+Several issues, both social & technical in nature are cominmg up based on our chocies for how to organise our project management in Co-op Cloud. This proposal will present the problems and proposals for solutions.
+
+### Details (Budget XXX)
+
+#### The problems
+
+1. Because recipes and "other" repositories are gathered under a single Gitea organisation, [co-op cloud](https://git.coopcloud.tech/coop-cloud), `abra` has to do some serious acrobatics to understand what is a recipe and what is not a recipe. More details in [`#377`](https://git.coopcloud.tech/coop-cloud/organising/issues/377). See also [`#569`](https://git.coopcloud.tech/coop-cloud/organising/issues/569).
+1. Several participants have complained that there is too much indirection & noise involved in having a single issue tracker, [organising](https://git.coopcloud.tech/coop-cloud/organising/issues). By noise, we mean that, e.g. there are several conventions (labels, writing "Abra: " / "Docs: ") in marking issues related to different repositories. By indirection, we mean that it is not always clear where the issue relates to.
+1. There is an old Federation related organisation and related repository, [Federation](https://git.coopcloud.tech/Federation) which has raised questions from new members. It is not used now but it is still there.
+
+#### The solutions
+
+For the recipes issue:
+
+1. Rename [co-op cloud](https://git.coopcloud.tech/coop-cloud) to "Co-op Cloud Configuration Commons (CCCC)".
+1. Create a new Gitea organisation called "Co-op Cloud Federation (CCF)".
+1. Migrate all "non recipe" repositories away from [co-op cloud](https://git.coopcloud.tech/coop-cloud) ("CCCC") and under the CCF organisation.
+
+This creates a clear separation between the configuration commons AKA "the recipes" and "other stuff". This means that `abra` logic can be greatly simplified and become performant once again. Furthermore, we don't break any URLs by keeping the recipes where they always were. The renaming aspect is purely cosmetic, the recipe organisation URL will remain "co-op cloud".
+
+Then, for the issue management issue:
+
+1. Re-open all repository issue trackers instead of pointing to [organising](https://git.coopcloud.tech/coop-cloud/organising/issues).
+1. Migrate all issues by hand from `organising` to their relevant issue trackers. E.g. all issues in organising with the `abra` label will go to the `abra` issue tracker.
+1. Create a new repository called "Co-op Cloud Federation Coordination" where we have an issue tracker for specific federation discussions (E.g. "tracking every member paying dues").
+1. Create a single Gitea Project under the CCF organisation called "Federation FTW".
+
+"Federation FTW" will be the project we collectively refer to in our federation meetings as the "main list of priorities". Issues from every part of the project can be referenced there in a single place. Discussions can happen decentrally in their own issue trackers. It is the central source of truth for our current priorities and a way to stay up to date with what we want to do in the short to medium term.
+
+#### Budget
+
+* 5 hrs for migrating labours of the issues to their related issue trackers.
+* Additional 3 hrs for unseen migration / busy work gotchas.
+* 4 hrs for `abra` changes to only parse the new recipes repository
+* Total: 12 hrs

docs/federation/resolutions/passed/020.md

@@ -1,5 +1,5 @@
 ---
-title: "Resolution 022"
+title: "Resolution 020"
 ---
 
 - Topic: Budget 10: Abra integration suite automation

docs/operators/handbook.md

@@ -480,3 +480,23 @@ abra app secret insert localhost ssl_cert v1 "$(cat localhost.crt)"
 abra app secret insert localhost ssl_key v1 "$(cat localhost.key)"
 ```
 4. Re-deploy `traefik` with `--force` and voila!
+
+## Remote recipes
+
+!!! warning "This is only available in the currently unreleased version of `abra`"
+
+    Please see [this issue](https://git.coopcloud.tech/coop-cloud/organising/issues/583) to track current progress towards a release. All feedback and testing are welcome on this new feature. The design is not finalised yet.
+
+It is possible to specify a remote recipe in your `.env` file:
+
+```
+RECIPE=mygit.org/myorg/cool-recipe.git:1.3.12
+```
+
+Where `1.3.12` is an optional pinned version. When `abra` runs a deployment, it
+will fetch the remote recipe and create a directory for it under `$ABRA_DIR`
+(typically `~/.abra`):
+
+```
+$ABRA_DIR/recipes/mygit_org_myorg_cool-recipe
+```

docs/operators/tutorial.md

@@ -13,13 +13,6 @@ In order to deploy an app you need two things:
 
 This tutorial tries to help you make choices about which server and which DNS setup you need to run a _Co-op Cloud_ deployment but it does not go into great depth about how to set up a new server.
 
-??? question "Can `abra` help automate this?"
-
-    Our `abra` tool can help bootstrap new servers & configure DNS records for
-    you. We'll skip that for now since we're just getting started. For more on
-    these topics after you finish the tutorial see the [operators
-    handbook](/operators/handbook).
-
 ### Server setup
 
 Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/intro/faq/#isnt-running-everything-in-containers-inefficient)).
@@ -39,15 +32,25 @@ You need to keep port `:80` and `:443` free on your server for web proxying to y
     Docker.
 
 ```
+# ssh into your server
+ssh <server-domain>
+
 # docker install convenience script
 wget -O- https://get.docker.com | bash
 
 # add user to docker group
 sudo usermod -aG docker $USER
 
-# setup swarm
+# exit and re-login to load the group
+exit
+ssh <server-domain>
+
+# back on the server, setup swarm
 docker swarm init
 docker network create -d overlay proxy
+
+# now you can exit and start using abra
+exit
 ```
 
 ??? question "Do you support multiple web proxies?"
@@ -89,7 +92,8 @@ abra -h
 ```
 
 You may need to add the `~/.local/bin/` directory to your `$PATH` variable, in
-order to run the executable.
+order to run the executable. Also, run this line into your terminal so
+you have immediate access to `abra` on the current terminal.
 
 ```bash
 export PATH=$PATH:$HOME/.local/bin
@@ -103,14 +107,38 @@ If you run into issues during installation, [please report a ticket](https://git
 
 ### Add your server
 
-Now you can connect `abra` with your server. You should have a working SSH configuration before you can do this (e.g. a matching `Host <server-domain>` entry in `~/.ssh/config` with the correct SSH connection details). That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:.
+Now you can connect `abra` with your server. You must have a working SSH configuration for your server before you can proceed. That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:. See the [`abra` SSH troubleshooting](/abra/trouble/#ssh-connection-issues) for a working SSH configuration example.
+
+??? warning "Beware of SSH dragons :dragon_face:"
+
+    Under the hood `abra` uses plain 'ol `ssh` and aims to make use of your
+    existing SSH configurations in `~/.ssh/config` and interfaces with your
+    running `ssh-agent` for password protected secret key files.
+
+    Running `server add` with `-d` or `--debug` should help you debug what is
+    going on under the hood. `ssh -v ...` should also help. If you're running
+    into SSH connection issues with `abra` take a moment to read [this
+    troubleshooting entry](/abra/trouble/#ssh-connection-issues).
 
 ```bash
 ssh <server-domain> # make sure it works
 abra server add <server-domain>
 ```
 
-It is important to note that `<domain>` here is a publicy accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.
+It is important to note that `<server-domain>` here is a publicy accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.
+
+??? warning "Can I use arbitrary server names?"
+
+    Yes, this is possible. You need to pass `-D` to `server add` and ensure
+    that your `Host ...` entry in your SSH configuration includes the name.
+    So, for example:
+
+      Host example.com example
+        ...
+
+    And then:
+
+      abra server add -D example
 
 You will now have a new `~/.abra/` folder on your local file system which stores all the configuration of your Co-op Cloud instance.
 
@@ -120,20 +148,10 @@ By now `abra` should have registered this server as managed. To confirm this run
 abra server ls
 ```
 
-??? warning "Beware of SSH dragons :dragon_face:"
-
-    Under the hood `abra` uses plain 'ol `ssh` and aims to make use of your
-    existing SSH configurations in `~/.ssh/config` and interfaces with your
-    running `ssh-agent` for password protected secret key files.
-
-    Running `server add` with `-d` or `--debug` should help you debug what is going
-    on under the hood. If you're running into SSH connection issues with `abra`
-    take a moment to read [this troubleshooting
-    entry](/abra/trouble/#ssh-connection-issues).
-
 ??? question "How do I share my configs in `~/.abra`?"
 
-    It's possible and quite easy, for more see [this handbook entry](/operators/handbook/#understanding-app-and-server-configuration).
+    It's possible and quite easy, for more see [this handbook
+    entry](/operators/handbook/#understanding-app-and-server-configuration).
 
 ### Web proxy setup
 

mkdocs.yml

@@ -127,15 +127,16 @@ nav:
           - federation/resolutions/passed/017.md
           - federation/resolutions/passed/018.md
           - federation/resolutions/passed/019.md
+          - federation/resolutions/passed/020.md
         - "In Progress":
           - federation/resolutions/in-progress/013.md
-          - federation/resolutions/in-progress/022.md
       - "Minutes":
         - federation/minutes/index.md
         - "Recently":
+          - federation/minutes/2024-04-17.md
           - federation/minutes/2024-03-29.md
-          - federation/minutes/2024-02-01.md
         - "Archive":
+          - federation/minutes/2024-02-01.md
           - federation/minutes/2022-03-03.md
           - federation/minutes/2023-05-03.md
       - "Digital Tools": federation/tools.md