Remove releaseId and imageId from container names #2136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pipex
force-pushed
the
remove-releaseId-imageId
branch
4 times, most recently
from
e285017 to
ea5fb85
Compare
pipex
commented
Mar 8, 2023
pipex
commented
Mar 8, 2023
pipex
force-pushed
the
remove-releaseId-imageId
branch
3 times, most recently
from
91949cf to
bcc2617
Compare
pipex
commented
Apr 27, 2023
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Apr 27, 2023
On local push, the CLI uses `localrelease` as the `commit` property for the development application. This is not a valid uuid and will not be read properly by the supervisor, as seen in https://github.com/balena-os/balena-supervisor/blob/master/src/compose/service.ts#L652 While this is not a problem right now, the commit is becoming the main way to identify a service release (replacing `releaseId` and `imageId`), and the invalid release uuid could cause update issues when pushing a local release on when using some API endpoints. Change-type: patch Relates-to: balena-os/balena-supervisor#2136
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
May 2, 2023
On local push, the CLI uses `localrelease` as the `commit` property for the development application. This is not a valid uuid and will not be read properly by the supervisor, as seen in https://github.com/balena-os/balena-supervisor/blob/master/src/compose/service.ts#L652 While this is not a problem right now, the commit is becoming the main way to identify a service release (replacing `releaseId` and `imageId`), and the invalid release uuid could cause update issues when pushing a local release on when using some API endpoints. Change-type: patch Relates-to: balena-os/balena-supervisor#2136
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
May 3, 2023
On local push, the CLI uses `localrelease` as the `commit` property for the development application. This is not a valid uuid and will not be read properly by the supervisor, as seen in https://github.com/balena-os/balena-supervisor/blob/master/src/compose/service.ts#L652 While this is not a problem right now, the commit is becoming the main way to identify a service release (replacing `releaseId` and `imageId`), and the invalid release uuid could cause update issues when pushing a local release on when using some API endpoints. Change-type: patch Relates-to: balena-os/balena-supervisor#2136
pipex
force-pushed
the
remove-releaseId-imageId
branch
2 times, most recently
from
a915937 to
74aa838
Compare
pipex
force-pushed
the
remove-releaseId-imageId
branch
from
74aa838 to
8a47e0f
Compare
pipex
force-pushed
the
remove-releaseId-imageId
branch
from
8a47e0f to
4b772c4
Compare
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Jul 14, 2023
The supervisor is changing the container name format from `<serviceName>_<imageId>_<releaseId>_<commit>` to `<serviceName>_<commit>`. This updates the SSH command to work with both formats. Change-type: minor Depends-on: balena-os/balena-supervisor#2136
pipex
force-pushed
the
remove-releaseId-imageId
branch
3 times, most recently
from
fd6c890 to
6171d96
Compare
The release id is not really necessary for reporting the current state since v3 (it has been replaced by `releaseUuid`) and is only kept for backwards compatibility for some supervisor API endpoints. Until now, the `releaseId` was part o the container name, leading to longer names than desired. This change removes the value from the container name and modifies queries to look for the value in the image database. Change-type: minor Relates-to: #2077
pipex
force-pushed
the
remove-releaseId-imageId
branch
from
6171d96 to
fbdb2ca
Compare
|
@cywang117 remember to take a look at this when you get a chance |
cywang117
reviewed
Nov 29, 2023
src/device-api/v2.ts
Outdated
Comment on lines
443
to
447
| // QUESTION: what to do if we cannot find the image? | ||
| // if the image database got deleted | ||
| s.imageId = allImages.find( | ||
| (img) => img.commit === svc.commit && img.serviceName === s.serviceName, | ||
| )?.imageId; | ||
|
|
||
| return s; |
There was a problem hiding this comment.
I don't think we need to worry about this, if the image table got deleted unexpectedly, then the action would have thrown a lot earlier during images.getState
There was a problem hiding this comment.
I don't think images.getState would throw, but we recreate the image database when initializing application manager so if the data from getState should be correct, so you are right the comment is unnecessary
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Dec 1, 2023
The supervisor is changing the container name format from `<serviceName>_<imageId>_<releaseId>_<commit>` to `<serviceName>_<commit>`. This updates the SSH command to work with both formats. Change-type: minor Depends-on: balena-os/balena-supervisor#2136
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Dec 6, 2023
The supervisor is changing the container name format from `<serviceName>_<imageId>_<releaseId>_<commit>` to `<serviceName>_<commit>`. This updates the SSH command to work with both formats. Change-type: minor Depends-on: balena-os/balena-supervisor#2136
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Dec 11, 2023
The supervisor is changing the container name format from `<serviceName>_<imageId>_<releaseId>_<commit>` to `<serviceName>_<commit>`. This updates the SSH command to work with both formats. Change-type: minor Depends-on: balena-os/balena-supervisor#2136
The image id is no longer necessary to report the current state since moving to v3 of the state endpoint and it is only kept for backwards compatibility for some supervisor API endpoings. Until now, `imageId` was part of the container name leading to longer names than desired. This change removes the value from the container name an modifies queries to look for the value in the image database. This also removes the imageId from the log stream which should result in reduced bandwidth usage. Change-type: minor
This allows to compare the current and target container names and trigger an `updateMetadata` step if they are different. This allows us to normalize the container name format with a new supervisor update. Change-type: minor
pipex
force-pushed
the
remove-releaseId-imageId
branch
from
fbdb2ca to
f7ed27f
Compare
pipex
added a commit
to balena-io/balena-cli
that referenced
this pull request
Dec 12, 2023
The supervisor is changing the container name format from `<serviceName>_<imageId>_<releaseId>_<commit>` to `<serviceName>_<commit>`. This updates the SSH command to work with both formats. Change-type: minor Depends-on: balena-os/balena-supervisor#2136
|
Will need to refactor this, I had not considered that, because of the git workflow, in a multi-app world you could have two apps pointing to the same release commit. Will probably need to keep the releaseId |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The release id and image id are not really necessary for reporting the current state since v3 (it has been replaced by
releaseUuid+imageName) and is only kept for backwards compatibility for some supervisor API endpoints.Until now, both the
releaseIdandimageIdwere part of the container name, leading to longer names than desired. This change removes those values from the container name and modifies queries to look for the value in the image database.This also removes
imageIdfrom the log stream, which was no longer used by the backend and should result in some bandwidth usage improvementsChange-type: minor
Relates-to: #2077