Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release bundle docs under Deploy/Release Strategy. #3072

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/navigation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Learn
[/learn/deploy/release-strategy/release-policy]
[/learn/deploy/release-strategy/update-locking]
[/learn/deploy/release-strategy/update-strategies]
[/learn/deploy/release-strategy/identical-releases-across-fleets]
[/learn/deploy/delta]
[/learn/deploy/offline-updates]
[/learn/deploy/build-optimization]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Identical releases across multiple fleets
excerpt: Use the same release across multiple fleets using release bundles
---

# Identical releases across multiple fleets
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To bring it as more of an action word, how about we do the title as

Share releases with multiple fleets


It is common to use multiple fleets on {{$names.company.lower}} to organize application development and fleet operations. Some users dedicate fleets to development and testing, pushing only tested code to production fleets. Others may use a "canary" fleet with a subset of production devices for additional testing before full deployment.

Testing can take time, and building a release from the same source may produce a different image than before due to updated external dependencies or mutable Dockerfile base images (e.g., latest). Consequently, a release built later might behave differently.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
Testing can take time, and building a release from the same source may produce a different image than before due to updated external dependencies or mutable Dockerfile base images (e.g., latest). Consequently, a release built later might behave differently.
Testing can take time, and building a release from the same source may produce a different image than before due to updated external dependencies or mutable Dockerfile base images (e.g. latest). Consequently, a release built later might behave differently.


To ensure the exact version of a tested release is deployed across fleets, you can export a release bundle file from an app, block, or fleet. This bundle allows you to import an identical copy of the release into another fleet. Unlike [{{$names.company.lower}} deploy][balena-deploy], which pushes images built locally, importing a release doesn't require a Docker engine on your machine.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To ensure the exact version of a tested release is deployed across fleets, you can export a release bundle file from an app, block, or fleet. This bundle allows you to import an identical copy of the release into another fleet. Unlike [{{$names.company.lower}} deploy][balena-deploy], which pushes images built locally, importing a release doesn't require a Docker engine on your machine.
To ensure the exact version of a tested release is deployed across fleets, you can export a release bundle file from an app, block, or fleet. This bundle allows you to import an identical copy of the release into another app, block, or fleet. Unlike [{{$names.company.lower}} deploy][balena-deploy], which pushes images built locally, importing a release doesn't require a Docker engine on your machine.


__Note:__ Only successfully built releases can be exported.

## Release Bundles

Release bundles are files that contain all components of an application release, including release metadata and the images of services that make up the release. They can be stored offline and deployed to fleets, even in different {{$names.company.lower}} accounts.

## Exporting a Release

You can export a release to a release bundle using the {{$names.company.lower}} CLI.

To export a release, you have two options:

1. Specify the commit of the release to be exported:

```shell
$ {{$names.company.lower}} release export c4f3b4b3 -o /path/to/release.tar
```
__Note:__ If more than one successful release with the same commit exists in multiple fleets, this option will not work due to ambiguity. The next option should be used instead.

2. Specify the application, block, or fleet in conjunction with the semantic version (semver) of the release.

```shell
$ {{$names.company.lower}} release export myOrg/myFleet --version 1.2.3 -o /path/to/release.tar
```

## Importing a Release

You can import a release from a release bundle into a {{$names.company.lower}} app, block, or fleet. This creates the release in the specified fleet with the version defined in the release manifest within the release bundle. Additionally, the images for the release are uploaded to the registry during the import process.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can import a release from a release bundle into a {{$names.company.lower}} app, block, or fleet. This creates the release in the specified fleet with the version defined in the release manifest within the release bundle. Additionally, the images for the release are uploaded to the registry during the import process.
You can import a release from a release bundle into a {{$names.company.lower}} app, block, or fleet. This creates the release in the specified app, block, or fleet with the version defined in the release manifest within the release bundle. Additionally, the images for the release are uploaded to the registry during the import process.


__Note:__ The revision number of the release's semantic version (semver) will not be set on the imported release. This number is automatically iterate by the {{$names.company.lower}} API when a release with the same semantic version already exists in the app, block, or fleet.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
__Note:__ The revision number of the release's semantic version (semver) will not be set on the imported release. This number is automatically iterate by the {{$names.company.lower}} API when a release with the same semantic version already exists in the app, block, or fleet.
__Note:__ The revision number of the release's semantic version (semver) will not be set on the imported release. This number is automatically iterated by the {{$names.company.lower}} API when a release with the same semantic version already exists in the app, block, or fleet.


Releases can be imported to multiple fleets. A new fleet can be created, and a release from an older fleet can be imported into it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A new fleet can be created, and a release from an older fleet can be imported into it.

Not sure what the purpose of this sentence is 🤔 Seems obvious to me but idk


```shell
$ {{$names.company.lower}} release import /path/to/release.tar myOrg/myFleet
```

You can also override the version of the release using the `--override-version` option.

```shell
$ {{$names.company.lower}} release import /path/to/release.tar myOrg/myFleet --override-version 1.2.3
```


[balena-deploy]:/learn/deploy/deployment/#balena-build--deploy
Loading