diff --git a/content/create-release.md b/content/create-release.md index 6fadbced..5de0e51c 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 9f455bc1..7aa90b2e 100644 --- a/content/packages.md +++ b/content/packages.md @@ -21,6 +21,12 @@ 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): v1.165 or newer + - Ubuntu Jammy (22.04): v1.990 or newer To edit a package spec file: @@ -58,8 +64,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 88c87f3e..612ad84c 100644 --- a/content/release-blobstore.md +++ b/content/release-blobstore.md @@ -108,6 +108,34 @@ 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): 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`. + +**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.