Aklite v95 changes #802
Merged
Aklite v95 changes #802
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
After the introduction of `check` command in aktualizr-lite command line interface, the list command no longer updates the TUF metadata. So, the check command should be used when verifying in the device that a new target was added to the factory. Signed-off-by: Andre Detsch <[email protected]>
Signed-off-by: Andre Detsch <[email protected]>
Signed-off-by: Andre Detsch <[email protected]>
|
@mike-sul to avoid delaying the required changes, I've not added a change on how we document the CLI exit codes yet, as I'm not very satisfied with the current solutions I have. |
mike-sul
approved these changes
Feb 19, 2025
vanmaegima
approved these changes
Feb 19, 2025
There was a problem hiding this comment.
lgtm, let's also add an entry to this page: https://docs.foundries.io/latest/reference-manual/ota/update-rollback.html#update-rollback
kprosise
approved these changes
Feb 19, 2025
| @@ -211,22 +221,32 @@ It yields an error if the specified Target has not been pulled before, and also | |||
| It is necessary to verify the return codes for each command to guarantee the correct update process flow, | |||
| as detailed in the next section. | |||
|
|
|||
| Rollback to previous working version | |||
There was a problem hiding this comment.
Suggested change
| Rollback to previous working version | |
| Rollback to Previous Working Version |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| .. warning:: The rollback command is in beta stage, | ||
| and is subject to change over the following releases. |
There was a problem hiding this comment.
Suggested change
| and is subject to change over the following releases. | |
| and is subject to change. |
Optional suggestion.
| .. warning:: The rollback command is in beta stage, | ||
| and is subject to change over the following releases. | ||
|
|
||
| The ``rollback`` command can be used to abort the current installation and revert the system to the previous successfully installed target. |
There was a problem hiding this comment.
Suggested change
| The ``rollback`` command can be used to abort the current installation and revert the system to the previous successfully installed target. | |
| The ``rollback`` command can be used to abort the current installation and revert the system to the previous successfully installed Target. |
There was a problem hiding this comment.
I've also changed abort to cancel
| The ``rollback`` command can be used to abort the current installation and revert the system to the previous successfully installed target. | ||
| No download operation is done in that case. | ||
|
|
||
| If there is no installation being done, the current running target is marked as failing, |
There was a problem hiding this comment.
Suggested change
| If there is no installation being done, the current running target is marked as failing, | |
| If there is no installation being done, the current running Target is marked as failing. |
| No download operation is done in that case. | ||
|
|
||
| If there is no installation being done, the current running target is marked as failing, | ||
| to avoid having it automatically installed again, |
There was a problem hiding this comment.
Suggested change
| to avoid having it automatically installed again, | |
| This avoids having it automatically installed again, |
|
|
||
| If there is no installation being done, the current running target is marked as failing, | ||
| to avoid having it automatically installed again, | ||
| and an installation of the previous successful target is performed. |
There was a problem hiding this comment.
Suggested change
| and an installation of the previous successful target is performed. | |
| and an installation of the previous successful Target is performed. |
| and an installation of the previous successful target is performed. | ||
| In that situation, the installation is preceded by a download (pull) operation. | ||
|
|
||
| Like in a regular installation, the exit code can be used to identify if a reboot is required in order to finalize the rollback. |
There was a problem hiding this comment.
Suggested change
| Like in a regular installation, the exit code can be used to identify if a reboot is required in order to finalize the rollback. | |
| Like in a regular installation, the exit code can be used to identify if a reboot is required in to finalize the rollback. |
Signed-off-by: Andre Detsch <[email protected]>
detsch
force-pushed
the
detsch-aklite-v95-changes
branch
2 times, most recently
from
44424d4 to
1c741ea
Compare
|
@kprosise I've accepted your suggestions, thanks. I thought about adding another commit to the current PR, adding an additional section, but I may leave it for another PR. |
|
@detsch shall I go ahead and merge? |
@kprosise yes, please. I'll deal with @vanmaegima's suggestion in another PR
|
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.
PR Template and Checklist
Please complete as much as possible to speed up the reviewing process.
Readiness and adding reviewers as appropriate is required.
All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.
Readiness
Overview
Update aktualizr-lite CLI information considering improvements made for v95
Checklist
make linkcheck.-s, --signoff).-S, --gpg-sign).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.