Documentation and project description #6
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
nelsonkopliku
approved these changes
Jan 14, 2025
There was a problem hiding this comment.
Thanks for this.
I could not but notice a parallelism between this
The minimum required version is 3.1.0. If saptune is not installed or the version does not meet the minimum requirement
and what we might already be happening in checks.
Is it correct to assume that very likely every operator would check something like that in the plan phase?
|
The plan phase is supposed to check for prerequisites so yes, in this case
the prerequisite is saptune anche the correct version
We will see much more complex approaches in the next operators when we deal
for examples with files
Il giorno mar 14 gen 2025 alle 14:25 Nelson Kopliku <
***@***.***> ha scritto:
… ***@***.**** approved this pull request.
Thanks for this.
I could not but notice a parallelism between this
The minimum required version is 3.1.0. If saptune is not installed or the
version does not meet the minimum requirement
and what we might already be happening in checks.
Is it correct to assume that very likely every operator would *check*
something like that in the plan phase?
—
Reply to this email directly, view it on GitHub
<#6 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ACHZHXSV3FYXBKIY5MYQX6L2KUF4NAVCNFSM6AAAAABVE2ULRSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKNBZGY4TAOBUGM>
.
You are receiving this because you were assigned.Message ID:
***@***.***>
|
arbulu89
approved these changes
Jan 14, 2025
README.md
Outdated
|  | ||
|
|
||
| An operator is a unit of code that can perform write operations on target machines. | ||
| A write operation can either fail or succeed. If it succeeds, the operation will display a diff highlighting the changes before and after the commit phase. |
There was a problem hiding this comment.
I'm always in favor of using present term:
the operation displays a diff..
README.md
Outdated
| #### COMMIT | ||
|
|
||
| The COMMIT phase executes the actual write operations on the system, utilizing the information collected during the PLAN phase. | ||
| If an error occurs during this phase, a rollback will be triggered. |
README.md
Outdated
| If an error occurs during this phase, a rollback will be triggered. | ||
|
|
||
| The COMMIT phase should be idempotent. If a requested change has already been applied, the commit operation is simply skipped without returning an error. | ||
| Maintaining idempotency should be implemented appropriately based on the type of operations to be performed. |
There was a problem hiding this comment.
I think the Maintaining word is not needed here. Simply Idempotency should be...
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.
Description
This PR aims to provide a basic documentation on how the operator works and the documentation for saptuneapplysolution operator.