This repository has been archived by the owner on Feb 12, 2021. It is now read-only.
os: add user-docs on how to use custom torcx remotes and images #1261
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
lucab
force-pushed
the
ups/torcx-using-custom-remotes
branch
from
b7b661f
to
1c6fce4
Compare
This adds a walk-through and CLC snippets on how to configure custom remotes and use addons from there.
lucab
force-pushed
the
ups/torcx-using-custom-remotes
branch
from
1c6fce4
to
67850ac
Compare
ajeddeloh
approved these changes
Dec 13, 2018
|
|
||
| If it is not possible to provision any of the configured addons for the upcoming OS, the update will not applied and the process will be re-tried later. | ||
|
|
||
| This can happen if an addon is not anymore present on a remote, if the image matching the new OS version is not yet available, or in case of any other error when fetching from a remote. |
There was a problem hiding this comment.
addon is not present anymore on a remote
arithx
reviewed
Dec 13, 2018
|
|
||
| ## Remotes Overview | ||
|
|
||
| A Torcx [remote][torcx-remotes-design] is a collection of addon images for torcx, served from a remote source, which can be fetched by a node for use by [torcx-generator][torcx-overview]. |
There was a problem hiding this comment.
Might make sense to add a the in fetched by a node for us by _the_ [torcx generator]
| ## Remotes Overview | ||
|
|
||
| A Torcx [remote][torcx-remotes-design] is a collection of addon images for torcx, served from a remote source, which can be fetched by a node for use by [torcx-generator][torcx-overview]. | ||
| Images for configured addons can be retrieved automatically on first-boot provisioning (i.e. in initramfs) and when preparing for new OS updates (i.e. before marking a node as "reboot needed"). |
There was a problem hiding this comment.
Can new remotes be added outside of first-boot/updates? If not then the can be in configured addons can be should probably be replaced with are
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This adds a walk-through and CLC snippets on how to configure custom
remotes and use addons from there.