From 0342fde58e5d3d4ad1e163b9ee238f716307c413 Mon Sep 17 00:00:00 2001 From: Marin Dzhigarov Date: Fri, 7 Nov 2025 10:09:46 +0200 Subject: [PATCH 1/2] Document no_compression flag for release and package archives This adds documentation for the new no_compression feature that allows controlling compression for both individual package archives and the outer release archive. Changes: - Added Release Compression Configuration section to release-blobstore.md documenting the no_compression flag in final.yml - Updated packages.md to document no_compression in package spec files - Updated create-release.md example to include no_compression flag The documentation includes: - Version requirements (BOSH Director 282.1.3+ and stemcell versions) - Default behavior (compression enabled if not specified) - Note about bosh export-release limitation - Examples for both final.yml and package spec files --- content/create-release.md | 4 ++++ content/packages.md | 11 +++++++++++ content/release-blobstore.md | 29 +++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+) diff --git a/content/create-release.md b/content/create-release.md index 6fadbced7..5de0e51c3 100644 --- a/content/create-release.md +++ b/content/create-release.md @@ -665,8 +665,12 @@ blobstore: provider: local options: blobstore_path: /tmp/ardo-blobs +no_compression: false ``` +!!! note "Compression Configuration" + The `no_compression` flag (optional) controls whether the outer release tarball is compressed. When set to `true`, compression is disabled. Defaults to `false` (compression enabled) if not specified. See [Release Compression Configuration](release-blobstore.md#no-compression) for more details. + Example `private.yml`: ```yaml diff --git a/content/packages.md b/content/packages.md index 9f455bc1c..e5826233f 100644 --- a/content/packages.md +++ b/content/packages.md @@ -21,6 +21,13 @@ sections when you run the `bosh generate-package PACKAGE_NAME` command: * `dependencies`: **(Optional)** Defines a list of other packages that this package depends on. * `files`: Defines a list of files that this package contains. You can define this list explicitly or through pattern-matching. * `excluded_files`: **(Optional)** Defines a list of files to be excluded from the package. You can define this list explicitly or through pattern-matching. + * `no_compression`: **(Optional)** Defines whether compression is disabled for the individual package tarball. Defaults to `false` (compression enabled) if not specified. + +!!! note "Version Requirements" + The `no_compression` flag requires BOSH Director version `282.1.3` or newer and the following stemcell versions: + - Ubuntu Noble (24.04): vXXX or newer + - Ubuntu Jammy (22.04): vXXX or newer + - Ubuntu Bionic (18.04): vXXX or newer To edit a package spec file: @@ -58,8 +65,12 @@ files: excluded_files: - ruby_1.9.3/security/secrets.yml + +no_compression: true ``` +When `no_compression` is set to `true`, the individual package tarball will not be compressed. By default, if `no_compression` is not specified or set to `false`, packages are compressed. + ## Create a Packaging Script {: #create-a-packaging-script } diff --git a/content/release-blobstore.md b/content/release-blobstore.md index 88c87f3e9..80ffd2ab3 100644 --- a/content/release-blobstore.md +++ b/content/release-blobstore.md @@ -108,6 +108,35 @@ blobstore: ``` --- +## Release Compression Configuration {: #no-compression } + +!!! note "Version Requirements" + The `no_compression` flag requires BOSH Director version `282.1.3` or newer and the following stemcell versions: + - Ubuntu Noble (24.04): vXXX or newer + - Ubuntu Jammy (22.04): vXXX or newer + - Ubuntu Bionic (18.04): vXXX or newer + +You can control whether the outer release tarball is compressed by setting the `no_compression` flag in `config/final.yml`. + +**config/final.yml** + +```yaml +--- +name: my-release +blobstore: + provider: s3 + options: + bucket_name: +no_compression: true +``` + +* **no_compression** [Boolean, optional]: When set to `true`, disables compression for the outer release tarball. Defaults to `false` (compression enabled) if not specified. + +!!! note + The `bosh export-release` command does not currently respect the `no_compression` flag due to technical limitations. When using `bosh export-release`, the outer tarball will always be compressed regardless of the `no_compression` setting in `final.yml`. + +--- + ## Migrating blobs {: #migration } CLI does not currently provide a builtin way to migrate blobs to a different blobstore. Suggested way to migrate blobs is to use third party tool like `s3cmd` to list and copy all blobs from current blobstore to another. Once copying of all blobs is complete, update `config` directory to with new blobstore location. From f9904a156d2185eb705c7e9b254f38d8876f11ff Mon Sep 17 00:00:00 2001 From: Marin Dzhigarov Date: Wed, 3 Dec 2025 09:56:06 +0200 Subject: [PATCH 2/2] Fixates the stemcell versions --- content/packages.md | 5 ++--- content/release-blobstore.md | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/content/packages.md b/content/packages.md index e5826233f..7aa90b2e1 100644 --- a/content/packages.md +++ b/content/packages.md @@ -25,9 +25,8 @@ sections when you run the `bosh generate-package PACKAGE_NAME` command: !!! note "Version Requirements" The `no_compression` flag requires BOSH Director version `282.1.3` or newer and the following stemcell versions: - - Ubuntu Noble (24.04): vXXX or newer - - Ubuntu Jammy (22.04): vXXX or newer - - Ubuntu Bionic (18.04): vXXX or newer + - Ubuntu Noble (24.04): v1.165 or newer + - Ubuntu Jammy (22.04): v1.990 or newer To edit a package spec file: diff --git a/content/release-blobstore.md b/content/release-blobstore.md index 80ffd2ab3..612ad84cd 100644 --- a/content/release-blobstore.md +++ b/content/release-blobstore.md @@ -112,9 +112,8 @@ blobstore: !!! note "Version Requirements" The `no_compression` flag requires BOSH Director version `282.1.3` or newer and the following stemcell versions: - - Ubuntu Noble (24.04): vXXX or newer - - Ubuntu Jammy (22.04): vXXX or newer - - Ubuntu Bionic (18.04): vXXX or newer + - Ubuntu Noble (24.04): v1.165 or newer + - Ubuntu Jammy (22.04): v1.990 or newer You can control whether the outer release tarball is compressed by setting the `no_compression` flag in `config/final.yml`.