Document managedosimage lifecycle #440
Merged
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
✅ Deploy Preview for elemental-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
fgiudici
approved these changes
Nov 26, 2024
docs/managedosimage-reference.md
Outdated
| @@ -12,6 +12,8 @@ import ClusterTarget from "!!raw-loader!@site/examples/upgrade/upgrade-cluster-t | |||
| # ManagedOSImage reference | |||
|
|
|||
| The ManagedOSImage resource is responsible of defining an OS image or image version that needs to be applied to each node in a set of targeted Clusters. | |||
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |||
There was a problem hiding this comment.
nit: the "following upgrade" at first read was not crystal clear to me... what about changing to something like "new upgrade" or "a brand new upgrade workflow" ?
Suggested change
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a new upgrade. |
| @@ -12,6 +12,8 @@ import ClusterTarget from "!!raw-loader!@site/examples/upgrade/upgrade-cluster-t | |||
| # ManagedOSImage reference | |||
|
|
|||
| The ManagedOSImage resource is responsible of defining an OS image or image version that needs to be applied to each node in a set of targeted Clusters. | |||
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |||
There was a problem hiding this comment.
Suggested change
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a new upgrade. |
| For example if the to-be-upgraded image is not found on the registry or otherwise broken, the upgrade job running on the downstream clusters will not succeed. | ||
|
|
||
| When this is the case, the nodes running the failing upgrade job will stay cordoned. | ||
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. |
There was a problem hiding this comment.
typo (missing 'n').
Suggested change
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. | |
| You can update the ManagedOSImage with a functioning reference image, or alternatively delete it to stop any further upgrade attempt. |
| @@ -12,6 +12,8 @@ import ClusterTarget from "!!raw-loader!@site/examples/upgrade/upgrade-cluster-t | |||
| # ManagedOSImage reference | |||
|
|
|||
| The ManagedOSImage resource is responsible of defining an OS image or image version that needs to be applied to each node in a set of targeted Clusters. | |||
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |||
There was a problem hiding this comment.
Suggested change
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a new upgrade. |
| For example if the to-be-upgraded image is not found on the registry or otherwise broken, the upgrade job running on the downstream clusters will not succeed. | ||
|
|
||
| When this is the case, the nodes running the failing upgrade job will stay cordoned. | ||
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. |
There was a problem hiding this comment.
Suggested change
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. | |
| You can update the ManagedOSImage with a functioning reference image, or alternatively delete it to stop any further upgrade attempt. |
| For example if the to-be-upgraded image is not found on the registry or otherwise broken, the upgrade job running on the downstream clusters will not succeed. | ||
|
|
||
| When this is the case, the nodes running the failing upgrade job will stay cordoned. | ||
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. |
There was a problem hiding this comment.
Suggested change
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. | |
| You can update the ManagedOSImage with a functioning reference image, or alternatively delete it to stop any further upgrade attempt. |
| @@ -12,6 +12,8 @@ import ClusterTarget from "!!raw-loader!@site/examples/upgrade/upgrade-cluster-t | |||
| # ManagedOSImage reference | |||
|
|
|||
| The ManagedOSImage resource is responsible of defining an OS image or image version that needs to be applied to each node in a set of targeted Clusters. | |||
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |||
There was a problem hiding this comment.
Suggested change
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a new upgrade. |
| For example if the to-be-upgraded image is not found on the registry or otherwise broken, the upgrade job running on the downstream clusters will not succeed. | ||
|
|
||
| When this is the case, the nodes running the failing upgrade job will stay cordoned. | ||
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. |
There was a problem hiding this comment.
Suggested change
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. | |
| You can update the ManagedOSImage with a functioning reference image, or alternatively delete it to stop any further upgrade attempt. |
| @@ -12,6 +12,8 @@ import ClusterTarget from "!!raw-loader!@site/examples/upgrade/upgrade-cluster-t | |||
| # ManagedOSImage reference | |||
|
|
|||
| The ManagedOSImage resource is responsible of defining an OS image or image version that needs to be applied to each node in a set of targeted Clusters. | |||
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |||
There was a problem hiding this comment.
Suggested change
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a following upgrade. | |
| Once created, the ManagedOSImage resource can be updated with a new `osImage` or `managedOSVersionName` to trigger a new upgrade. |
| For example if the to-be-upgraded image is not found on the registry or otherwise broken, the upgrade job running on the downstream clusters will not succeed. | ||
|
|
||
| When this is the case, the nodes running the failing upgrade job will stay cordoned. | ||
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. |
There was a problem hiding this comment.
Suggested change
| You can update the ManagedOSImage with a functioing image reference, or alternatively delete it to stop any further upgrade attempt. | |
| You can update the ManagedOSImage with a functioning reference image, or alternatively delete it to stop any further upgrade attempt. |
Signed-off-by: Andrea Mazzotti <[email protected]>
Signed-off-by: Andrea Mazzotti <[email protected]>
Signed-off-by: Andrea Mazzotti <[email protected]>
anmazzotti
force-pushed
the
document_managedosimage_lifecycle
branch
from
043f084 to
f322065
Compare
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.
Closes #436