From 05188cc390a1dda0a62c35a6ee5b17dd360f6552 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joachim=20Schl=C3=B6ffel?= Date: Tue, 9 Jun 2026 11:04:52 +0200 Subject: [PATCH] Add SeaweedFS package README links --- README.md | 145 ++------------------- packaging/alpine/local/seaweedfs/README.md | 133 +++++++++++++++++++ 2 files changed, 143 insertions(+), 135 deletions(-) create mode 100644 packaging/alpine/local/seaweedfs/README.md diff --git a/README.md b/README.md index b06620b..651b3f9 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ https://code.factoring.digital/api/packages/public/alpine/v3.23/alpine-packages https://code.factoring.digital/api/packages/public/alpine/edge/alpine-packages ``` +## Available Packages + +- [SeaweedFS](packaging/alpine/local/seaweedfs/README.md): `seaweedfs` plus OpenRC role, docs, and completion subpackages. +- [GreptimeDB](packaging/alpine/local/greptimedb/README.md): `greptimedb` plus OpenRC service subpackages and default configs. + ## Use In Production ### Add The Package Repository @@ -48,133 +53,12 @@ repository URL: https://:@code.factoring.digital/api/packages/public/alpine/v3.23/alpine-packages ``` -### Install SeaweedFS Node Roles +### Install Packages -Install the base package plus only the OpenRC role packages needed on that node. +Package-specific install and service guidance lives next to each `APKBUILD`: -For a single-node test or a compact small deployment: - -```sh -apk add seaweedfs \ - seaweedfs-master-openrc \ - seaweedfs-volume-openrc \ - seaweedfs-filer-openrc -``` - -For separated production nodes, install only the role running there: - -```sh -apk add seaweedfs seaweedfs-master-openrc -apk add seaweedfs seaweedfs-volume-openrc -apk add seaweedfs seaweedfs-filer-openrc -``` - -Available OpenRC role packages: - -```text -seaweedfs-master-openrc -> /etc/init.d/seaweedfs.master -seaweedfs-volume-openrc -> /etc/init.d/seaweedfs.volume -seaweedfs-filer-openrc -> /etc/init.d/seaweedfs.filer -seaweedfs-s3-openrc -> /etc/init.d/seaweedfs.s3 -seaweedfs-webdav-openrc -> /etc/init.d/seaweedfs.webdav -seaweedfs-sftp-openrc -> /etc/init.d/seaweedfs.sftp -seaweedfs-admin-openrc -> /etc/init.d/seaweedfs.admin -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: - -```sh -apk del seaweedfs-openrc -apk add seaweedfs seaweedfs-master-openrc -``` - -### Configure Services - -Runtime files are installed in the usual Alpine locations: - -```text -/usr/bin/weed -/etc/seaweedfs/*.toml -/etc/conf.d/seaweedfs.* -/etc/init.d/seaweedfs.* -``` - -Edit `/etc/conf.d/seaweedfs.` 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: - -```text -/usr/share/doc/seaweedfs/examples/ -``` - -Enable and start only the services needed on the node: - -```sh -rc-update add seaweedfs.master default -rc-service seaweedfs.master start - -rc-update add seaweedfs.volume default -rc-service seaweedfs.volume start - -rc-update add seaweedfs.filer default -rc-service seaweedfs.filer start -``` - -Check the installed binary and service state: - -```sh -weed version -rc-service seaweedfs.master status -``` - -### Optional Packages - -Install docs and generated examples: - -```sh -apk add seaweedfs-doc -``` - -Install bash completion: - -```sh -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 - -Use normal Alpine package operations: - -```sh -apk upgrade seaweedfs -rc-service seaweedfs.master restart -``` - -Pin a specific package build when needed: - -```sh -apk add seaweedfs=4.31-r3 -``` - -### Install GreptimeDB - -Install GreptimeDB: - -```sh -apk add greptimedb -``` - -Check the installed binary: - -```sh -greptime --version -``` +- [SeaweedFS](packaging/alpine/local/seaweedfs/README.md) +- [GreptimeDB](packaging/alpine/local/greptimedb/README.md) ## Background And Contribution @@ -193,16 +77,7 @@ seaweedfs SeaweedFS 4.31 release binary and OpenRC role splits greptimedb GreptimeDB 1.0.2 built from source for x86_64 ``` -### SeaweedFS Package - -The APKBUILD repackages the official SeaweedFS Linux release tarballs. It does -not build SeaweedFS from source. The package installs: - -- `weed` as `/usr/bin/weed` -- minimal active config under `/etc/seaweedfs/` -- role-specific OpenRC subpackages -- upstream example configs under `/usr/share/doc/seaweedfs/examples/` -- generated bash completion as a separate subpackage +Package-specific details are in the linked package READMEs above. Local build output is written under: diff --git a/packaging/alpine/local/seaweedfs/README.md b/packaging/alpine/local/seaweedfs/README.md new file mode 100644 index 0000000..0a766ba --- /dev/null +++ b/packaging/alpine/local/seaweedfs/README.md @@ -0,0 +1,133 @@ +# 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. + +## Package Commands + +Refresh generated config examples and bash completion after changing the SeaweedFS version or generated source flow: + +```sh +ALPINE_PACKAGE=seaweedfs mise run apk:update-generated +ALPINE_PACKAGE=seaweedfs mise run apk:checksum +``` + +Build only this package: + +```sh +ALPINE_PACKAGE=seaweedfs mise run apk:build +``` + +Install-test an existing local build without rebuilding: + +```sh +ALPINE_PACKAGE=seaweedfs SKIP_BUILD=1 mise run apk:test-install +``` + +## Install Node Roles + +Install the base package plus only the OpenRC role packages needed on that node. + +For a single-node test or a compact small deployment: + +```sh +apk add seaweedfs \ + seaweedfs-master-openrc \ + seaweedfs-volume-openrc \ + seaweedfs-filer-openrc +``` + +For separated production nodes, install only the role running there: + +```sh +apk add seaweedfs seaweedfs-master-openrc +apk add seaweedfs seaweedfs-volume-openrc +apk add seaweedfs seaweedfs-filer-openrc +``` + +Available OpenRC role packages: + +```text +seaweedfs-master-openrc -> /etc/init.d/seaweedfs.master +seaweedfs-volume-openrc -> /etc/init.d/seaweedfs.volume +seaweedfs-filer-openrc -> /etc/init.d/seaweedfs.filer +seaweedfs-s3-openrc -> /etc/init.d/seaweedfs.s3 +seaweedfs-webdav-openrc -> /etc/init.d/seaweedfs.webdav +seaweedfs-sftp-openrc -> /etc/init.d/seaweedfs.sftp +seaweedfs-admin-openrc -> /etc/init.d/seaweedfs.admin +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: + +```sh +apk del seaweedfs-openrc +apk add seaweedfs seaweedfs-master-openrc +``` + +## Configure Services + +Runtime files are installed in the usual Alpine locations: + +```text +/usr/bin/weed +/etc/seaweedfs/*.toml +/etc/conf.d/seaweedfs.* +/etc/init.d/seaweedfs.* +``` + +Edit `/etc/conf.d/seaweedfs.` 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: + +```text +/usr/share/doc/seaweedfs/examples/ +``` + +Enable and start only the services needed on the node: + +```sh +rc-update add seaweedfs.master default +rc-service seaweedfs.master start + +rc-update add seaweedfs.volume default +rc-service seaweedfs.volume start + +rc-update add seaweedfs.filer default +rc-service seaweedfs.filer start +``` + +Check the installed binary and service state: + +```sh +weed version +rc-service seaweedfs.master status +``` + +## Optional Packages + +Install docs and generated examples: + +```sh +apk add seaweedfs-doc +``` + +Install bash completion: + +```sh +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 + +Use normal Alpine package operations: + +```sh +apk upgrade seaweedfs +rc-service seaweedfs.master restart +``` + +Pin a specific package build when needed: + +```sh +apk add seaweedfs=4.31-r3 +```