From 651fe617b5b5abd95a84e77833c96a89bcfa5112 Mon Sep 17 00:00:00 2001 From: Alexander von Gluck Date: Wed, 28 Aug 2024 08:52:10 -0500 Subject: [PATCH] buildmaster/backend: Document storage backend config file --- buildmaster/backend/README.md | 13 +++++++++---- storage-backend-sample.json | 8 -------- 2 files changed, 9 insertions(+), 12 deletions(-) delete mode 100644 storage-backend-sample.json diff --git a/buildmaster/backend/README.md b/buildmaster/backend/README.md index 12ad5fef..65e3b038 100644 --- a/buildmaster/backend/README.md +++ b/buildmaster/backend/README.md @@ -14,8 +14,15 @@ One buildmaster container per architecture * ```BUILD_TARGET_ARCH``` - Target architecture for buildmaster * ```SYSTEM_PACKAGE_BRANCH``` - The branch of the system packages * system-packages are expected at /var/buildmaster/system-packages/$SYSTEM_PACKAGE_BRANCH - * ```STORAGE_BACKEND_CONFIG``` - The path of an external storage backend config file (optional) - * This would normally be pointed at a secret + * ```STORAGE_BACKEND_CONFIG``` - The path of an external storage backend json config file (optional) + * example: ```{"backend_type": "s3", "endpoint_url": "", "access_key_id": "", "secret_access_key": "", "bucket_name": ""}``` + * Fields: + * backend_type - s3 for now (required) + * prefix - prefix path of repository (optional) + * endpoint_url - s3 endpoint url + * access_key_id - s3 access key id + * secret_access_key - s3 secret access key + * bucket_name - s3 bucket name * ```REPOSITORY_TRIGGER_URL``` - Target URL to hit when build complete (optional) * example: https://depot.haiku-os.org/__repository/haikuports/source/haikuports_x86_64/import @@ -42,8 +49,6 @@ One buildmaster container per architecture ## Repository generation -> aka our Rube Goldberg machine - * haikuporter buildmaster builds packages into /var/buildmaster/haikuports/packages which quietly goes to /var/packages/instances/master/(arch) via a symlink * This follows the basic haikuporter behaviour * haikuporter buildmaster then moves obsolete packages from /var/buildmaster/haikuports/packages /var/buildmaster/haikuports/packages/.obsolete/ (keeping in mind packages is a symlink) diff --git a/storage-backend-sample.json b/storage-backend-sample.json deleted file mode 100644 index ea5fbc0c..00000000 --- a/storage-backend-sample.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "backend_type": "s3", - "endpoint_url": "https://storage.example.org", - "access_key_id": "example_key", - "secret_access_key": "example_secret", - "bucket_name": "haikuports", - "prefix": "master/x86_64/current" -}