public/alpine-packages
5
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

tighten docs

Browse Source
This commit is contained in:
Joachim Schlöffel
2026-07-05 23:21:24 +02:00
parent 1c4b598b5c
commit e076b3249a
3 changed files with 50 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -43
View File
@@ -16,16 +16,14 @@ https://code.factoring.digital/api/packages/public/alpine/v3.24/alpine-packages
### Add The Package Repository ### Add The Package Repository
Install the registry signing key on each Alpine node: Install the registry key:
```sh ```sh
cd /etc/apk/keys cd /etc/apk/keys
curl -fsSLOJ https://code.factoring.digital/api/packages/public/alpine/key curl -fsSLOJ https://code.factoring.digital/api/packages/public/alpine/key
``` ```
Keep the filename returned by Gitea. Alpine matches repository signatures by key filename, otherwise `apk update` reports `UNTRUSTED signature`. Add the repository for the node's Alpine branch:
Add the stable package repository matching the Alpine branch on the node:
```sh ```sh
printf '%s\n' \ printf '%s\n' \
@@ -35,8 +33,7 @@ printf '%s\n' \
apk update apk update
``` ```
If a forked or future registry is private, include a Gitea user and package token in the Private registry URL format:
repository URL:
```text ```text
https://<user>:<token>@code.factoring.digital/api/packages/public/alpine/v3.24/alpine-packages https://<user>:<token>@code.factoring.digital/api/packages/public/alpine/v3.24/alpine-packages
@@ -59,8 +56,6 @@ seaweedfs SeaweedFS 4.31 release binary and OpenRC role splits
greptimedb GreptimeDB 1.0.2 built from source for x86_64 greptimedb GreptimeDB 1.0.2 built from source for x86_64
``` ```
Package-specific details are in the linked package READMEs above.
Local build output is written under: Local build output is written under:
```text ```text
@@ -100,17 +95,13 @@ gitea-workflow-build Run the Gitea build workflow locally through act as a pull
``` ```
`apk:build` targets `x86_64` by default. Multi-arch builds target `x86_64` and `apk:build` targets `x86_64` by default. Multi-arch builds target `x86_64` and
`aarch64`; override with `ALPINE_ARCHES` when needed: `aarch64`:
```sh ```sh
ALPINE_ARCHES="x86_64 aarch64" mise run apk:build-all ALPINE_ARCHES="x86_64 aarch64" mise run apk:build-all
``` ```
Unqualified build and install-test tasks discover all packages. GreptimeDB is a Limit package selection with `ALPINE_PACKAGE` or `ALPINE_PACKAGES`:
source build and can take close to an hour; it is limited to `x86_64` during
production evaluation. Target fast package work explicitly:
Build or test a subset of packages with `ALPINE_PACKAGE` or `ALPINE_PACKAGES`:
```sh ```sh
ALPINE_PACKAGE=seaweedfs mise run apk:build ALPINE_PACKAGE=seaweedfs mise run apk:build
@@ -121,29 +112,27 @@ ALPINE_PACKAGE=greptimedb mise run apk:build
ALPINE_PACKAGE=greptimedb SKIP_BUILD=1 mise run apk:test-install ALPINE_PACKAGE=greptimedb SKIP_BUILD=1 mise run apk:test-install
``` ```
Docker-backed build tasks keep Cargo registry, Rustup, and Cargo target caches in named Docker volumes. The default volume scope is derived from the Git remote owner/repository and is split by package and architecture. Override it when needed: Override Docker cache scope:
```sh ```sh
ALPINE_APK_CACHE_SCOPE=public-alpine-packages ALPINE_PACKAGE=greptimedb mise run apk:build ALPINE_APK_CACHE_SCOPE=public-alpine-packages ALPINE_PACKAGE=greptimedb mise run apk:build
ALPINE_APK_CACHE_PREFIX=alpine-apk-ci ALPINE_PACKAGE=greptimedb mise run apk:build ALPINE_APK_CACHE_PREFIX=alpine-apk-ci ALPINE_PACKAGE=greptimedb mise run apk:build
``` ```
Use the test shell to inspect the package in Alpine with the current build Open an Alpine test shell:
installed:
```sh ```sh
ALPINE_PACKAGE=seaweedfs mise run apk:shell ALPINE_PACKAGE=seaweedfs mise run apk:shell
mise run apk:test-shell mise run apk:test-shell
``` ```
Use the install test to validate the production instructions against the local Run the install test:
package repository in a fresh Alpine container:
```sh ```sh
mise run apk:test-install mise run apk:test-install
``` ```
Use `SKIP_BUILD=1` to reuse existing local packages: Reuse existing local packages:
```sh ```sh
SKIP_BUILD=1 mise run apk:test-install SKIP_BUILD=1 mise run apk:test-install
@@ -152,45 +141,35 @@ SKIP_BUILD=1 mise run apk:test-shell
### Adding Packages ### Adding Packages
Each package lives under: Package path:
```text ```text
packaging/alpine/local/<pkgname>/ packaging/alpine/local/<pkgname>/
``` ```
The only required file is `APKBUILD`. Package-specific helpers can be added as Optional package hooks:
hooks:
```text ```text
packaging/alpine/local/<pkgname>/scripts/test-install.sh packaging/alpine/local/<pkgname>/scripts/test-install.sh
packaging/alpine/local/<pkgname>/scripts/update-generated-sources.sh packaging/alpine/local/<pkgname>/scripts/update-generated-sources.sh
``` ```
Repo-level tasks discover all `packaging/alpine/local/*/APKBUILD` files. Hook Start from the blueprint:
tasks skip packages that do not provide the requested hook.
Start new packages from the blueprint:
```text ```text
packaging/alpine/blueprint/ packaging/alpine/blueprint/
``` ```
For compiled software, declare build tools in `makedepends` and use normal
Alpine `build()`, `check()`, and `package()` functions in the package's
`APKBUILD`.
### Generated Package Sources ### Generated Package Sources
Generated files should live next to the package's `APKBUILD` so Generated package sources live next to the package `APKBUILD`:
`abuild checksum` can track them as ordinary package sources. For SeaweedFS,
that includes:
```text ```text
packaging/alpine/local/seaweedfs/example-*.toml packaging/alpine/local/seaweedfs/example-*.toml
packaging/alpine/local/seaweedfs/weed.bash-completion packaging/alpine/local/seaweedfs/weed.bash-completion
``` ```
Refresh generated sources through package-local hooks: Refresh generated sources:
```sh ```sh
mise run apk:update-generated mise run apk:update-generated
@@ -198,14 +177,10 @@ ALPINE_PACKAGE=seaweedfs mise run apk:update-generated
mise run apk:checksum mise run apk:checksum
``` ```
Run `apk:checksum` after changing any file listed in `source=`.
### Gitea Workflow ### Gitea Workflow
The workflow at `.gitea/workflows/build.yml` builds against each stable Alpine `.gitea/workflows/build.yml` builds and publishes `v3.23` and `v3.24`.
target in its matrix and publishes to the matching registry branch, currently Pull requests build only.
`v3.23` and `v3.24`, on push or tag. It skips publishing for pull request
events.
Repository variables: Repository variables:
@@ -222,13 +197,13 @@ PACKAGE_USER=<gitea package publisher>
PACKAGE_TOKEN=<token with package write access> PACKAGE_TOKEN=<token with package write access>
``` ```
Pre-check the workflow locally with `act`: Check the workflow locally:
```sh ```sh
mise run gitea-workflow-build mise run gitea-workflow-build
``` ```
Publish already-built local packages manually: Publish local packages:
```sh ```sh
INSTANCE_URL=https://code.factoring.digital \ INSTANCE_URL=https://code.factoring.digital \
packaging/alpine/local/greptimedb/README.md
+15 -30
View File
@@ -1,8 +1,9 @@
# GreptimeDB Alpine Package # GreptimeDB Alpine Package
This package builds `greptime` from the upstream GreptimeDB source release and packages OpenRC service subpackages plus default `/etc/greptimedb` configuration. Builds `greptime` from the upstream source release and packages OpenRC service
subpackages plus `/etc/greptimedb` defaults.
The APKBUILD builds the release directly: Build command:
```sh ```sh
cargo build --profile nightly --locked --bin greptime --features servers/dashboard cargo build --profile nightly --locked --bin greptime --features servers/dashboard
@@ -10,9 +11,7 @@ cargo build --profile nightly --locked --bin greptime --features servers/dashboa
## Runtime Layout ## Runtime Layout
The package installs the upstream `greptime` binary as `/usr/bin/greptime`. Installs `/usr/bin/greptime` and component OpenRC packages:
OpenRC support is split into component subpackages that map to the documented
GreptimeDB commands:
- `greptimedb-docs`: upstream configuration examples and reference files from - `greptimedb-docs`: upstream configuration examples and reference files from
`config/` `config/`
@@ -22,23 +21,19 @@ GreptimeDB commands:
- `greptimedb-flownode-openrc`: `greptime flownode start` - `greptimedb-flownode-openrc`: `greptime flownode start`
- `greptimedb-frontend-openrc`: `greptime frontend start` - `greptimedb-frontend-openrc`: `greptime frontend start`
Default TOML files are installed in `/etc/greptimedb`. The standalone config Default TOML files are installed in `/etc/greptimedb`. Standalone ports:
listens on the documented local ports:
- `127.0.0.1:4000`: HTTP API and dashboard - `127.0.0.1:4000`: HTTP API and dashboard
- `127.0.0.1:4001`: gRPC - `127.0.0.1:4001`: gRPC
- `127.0.0.1:4002`: MySQL - `127.0.0.1:4002`: MySQL
- `127.0.0.1:4003`: PostgreSQL - `127.0.0.1:4003`: PostgreSQL
GreptimeDB binds to localhost by default. Edit the matching TOML file before Configs bind to localhost by default. Upstream config examples are in
exposing a service on another interface. `/usr/share/doc/greptimedb/config`.
Install `greptimedb-docs` for the full upstream configuration reference and
example files under `/usr/share/doc/greptimedb/config`.
## OpenRC Usage ## OpenRC Usage
Install and start the standalone service: Standalone:
```sh ```sh
apk add greptimedb greptimedb-docs greptimedb-standalone-openrc apk add greptimedb greptimedb-docs greptimedb-standalone-openrc
@@ -46,7 +41,7 @@ rc-update add greptimedb.standalone default
rc-service greptimedb.standalone start rc-service greptimedb.standalone start
``` ```
Install the distributed components when managing a small OpenRC deployment: Distributed components:
```sh ```sh
apk add \ apk add \
@@ -57,8 +52,7 @@ apk add \
greptimedb-frontend-openrc greptimedb-frontend-openrc
``` ```
The package starts each service with `-c /etc/greptimedb/<component>.toml`. Wrapper settings in `/etc/conf.d/greptimedb.<component>`:
Package wrapper settings live in `/etc/conf.d/greptimedb.<component>`:
- `GREPTIMEDB_CONFIG`: config file path passed with `-c` - `GREPTIMEDB_CONFIG`: config file path passed with `-c`
- `GREPTIMEDB_LOG_DIR`: component log directory passed with `--log-dir` - `GREPTIMEDB_LOG_DIR`: component log directory passed with `--log-dir`
@@ -68,35 +62,27 @@ Package wrapper settings live in `/etc/conf.d/greptimedb.<component>`:
- `GREPTIMEDB_OPTS`: extra component arguments appended after package defaults - `GREPTIMEDB_OPTS`: extra component arguments appended after package defaults
- `GREPTIMEDB_GLOBAL_OPTS`: arguments inserted before the component command - `GREPTIMEDB_GLOBAL_OPTS`: arguments inserted before the component command
GreptimeDB's own config environment variables are separate from these OpenRC
wrapper variables. The upstream docs use component prefixes such as
`GREPTIMEDB_STANDALONE`, `GREPTIMEDB_DATANODE`, `GREPTIMEDB_FRONTEND`, and
`GREPTIMEDB_METASRV` with double underscores for nested config keys.
For production clusters, follow the upstream deployment guidance. GreptimeDB
recommends Kubernetes and the GreptimeDB Operator for production self-hosting.
## Package Commands ## Package Commands
Refresh the source checksum after changing `pkgver`: Refresh checksums:
```sh ```sh
ALPINE_PACKAGE=greptimedb mise run apk:checksum ALPINE_PACKAGE=greptimedb mise run apk:checksum
``` ```
Build only this package: Build:
```sh ```sh
ALPINE_PACKAGE=greptimedb mise run apk:build ALPINE_PACKAGE=greptimedb mise run apk:build
``` ```
Install-test an existing local build without recompiling: Install-test local build:
```sh ```sh
ALPINE_PACKAGE=greptimedb SKIP_BUILD=1 mise run apk:test-install ALPINE_PACKAGE=greptimedb SKIP_BUILD=1 mise run apk:test-install
``` ```
Install-test from a published Gitea Alpine repository: Install-test published repository:
```sh ```sh
ALPINE_PACKAGE=greptimedb \ ALPINE_PACKAGE=greptimedb \
@@ -106,5 +92,4 @@ ALPINE_REPOSITORY_KEY_URL=https://code.factoring.digital/api/packages/public/alp
mise run apk:test-install mise run apk:test-install
``` ```
The full build can take close to an hour. Do not run it as part of lightweight Full builds take close to an hour.
metadata or script checks.
packaging/alpine/local/seaweedfs/README.md
+17 -19
View File
@@ -1,23 +1,24 @@
# SeaweedFS Alpine Package # SeaweedFS Alpine Package
This package repackages the official SeaweedFS 4.31 Linux release tarballs for `x86_64` and `aarch64`. It installs the `weed` binary, short active config defaults, generated examples, bash completion, and split OpenRC service packages. Repackages official SeaweedFS 4.31 Linux release tarballs for `x86_64` and
`aarch64`.
## Package Commands ## Package Commands
Refresh generated config examples and bash completion after changing the SeaweedFS version or generated source flow: Refresh generated sources:
```sh ```sh
ALPINE_PACKAGE=seaweedfs mise run apk:update-generated ALPINE_PACKAGE=seaweedfs mise run apk:update-generated
ALPINE_PACKAGE=seaweedfs mise run apk:checksum ALPINE_PACKAGE=seaweedfs mise run apk:checksum
``` ```
Build only this package: Build:
```sh ```sh
ALPINE_PACKAGE=seaweedfs mise run apk:build ALPINE_PACKAGE=seaweedfs mise run apk:build
``` ```
Install-test an existing local build without rebuilding: Install-test local build:
```sh ```sh
ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install
@@ -25,9 +26,7 @@ ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install
## Install Node Roles ## Install Node Roles
Install the base package plus only the OpenRC role packages needed on that node. Single-node install:
For a single-node test or a compact small deployment:
```sh ```sh
apk add seaweedfs \ apk add seaweedfs \
@@ -36,7 +35,7 @@ apk add seaweedfs \
seaweedfs-filer-openrc seaweedfs-filer-openrc
``` ```
For separated production nodes, install only the role running there: Role-specific installs:
```sh ```sh
apk add seaweedfs seaweedfs-master-openrc apk add seaweedfs seaweedfs-master-openrc
@@ -57,7 +56,7 @@ seaweedfs-admin-openrc -> /etc/init.d/seaweedfs.admin
seaweedfs-worker-openrc -> /etc/init.d/seaweedfs.worker seaweedfs-worker-openrc -> /etc/init.d/seaweedfs.worker
``` ```
The package name is `seaweedfs`, matching Alpine aports. If a node already has Alpine's old generic OpenRC package installed, remove it before installing a role-specific split: Replace Alpine's old generic OpenRC package before installing a role split:
```sh ```sh
apk del seaweedfs-openrc apk del seaweedfs-openrc
@@ -66,7 +65,7 @@ apk add seaweedfs seaweedfs-master-openrc
## Configure Services ## Configure Services
Runtime files are installed in the usual Alpine locations: Runtime paths:
```text ```text
/usr/bin/weed /usr/bin/weed
@@ -75,13 +74,14 @@ Runtime files are installed in the usual Alpine locations:
/etc/init.d/seaweedfs.* /etc/init.d/seaweedfs.*
``` ```
Edit `/etc/conf.d/seaweedfs.<role>` for command-line flags and `/etc/seaweedfs/*.toml` for SeaweedFS config. The packaged defaults are short and production-neutral; full upstream example configs are in: Edit `/etc/conf.d/seaweedfs.<role>` for flags and `/etc/seaweedfs/*.toml` for
SeaweedFS config. Upstream examples:
```text ```text
/usr/share/doc/seaweedfs/examples/ /usr/share/doc/seaweedfs/examples/
``` ```
Enable and start only the services needed on the node: Enable services:
```sh ```sh
rc-update add seaweedfs.master default rc-update add seaweedfs.master default
@@ -94,7 +94,7 @@ rc-update add seaweedfs.filer default
rc-service seaweedfs.filer start rc-service seaweedfs.filer start
``` ```
Check the installed binary and service state: Check status:
```sh ```sh
weed version weed version
@@ -103,30 +103,28 @@ rc-service seaweedfs.master status
## Optional Packages ## Optional Packages
Install docs and generated examples: Docs and examples:
```sh ```sh
apk add seaweedfs-doc apk add seaweedfs-doc
``` ```
Install bash completion: Bash completion:
```sh ```sh
apk add bash-completion seaweedfs-bash-completion apk add bash-completion seaweedfs-bash-completion
``` ```
`seaweedfs-bash-completion` is also selected automatically when `seaweedfs` and `bash-completion` are installed together.
## Upgrade Or Pin ## Upgrade Or Pin
Use normal Alpine package operations: Upgrade:
```sh ```sh
apk upgrade seaweedfs apk upgrade seaweedfs
rc-service seaweedfs.master restart rc-service seaweedfs.master restart
``` ```
Pin a specific package build when needed: Pin:
```sh ```sh
apk add seaweedfs=4.31-r3 apk add seaweedfs=4.31-r3