Added specifications for refactoring tendrl code #7
Conversation
This specification details the refactoring across the tendrl modules to move major common code to common module. Signed-off-by: Shubhendu <shtripat@redhat.com>
|
@nthomas-redhat @r0h4n @brainfunked @anmolbabu @nnDarshan @GowthamShanmugam please review. |
|
@r0h4n I was of a thought that each module specific code changes would be created as individual github issues and this spec PR would be linked to all of them. So effectively this spec PR ends up into multiple github issues and multiple re-factoring code change PRs as a result. @nthomas-redhat @brainfunked comments?? ^^ If everybody strongly feels, its required, I can create multiple ones (its just a copy paste of same content mostly ;)) |
| @@ -0,0 +1,206 @@ | |||
| = Refactor modules like tendrl-gluster-integartion, tendrl-node-agent etc and | |||
There was a problem hiding this comment.
Line breaks do not work in titles, if I'm not mistaken. Shorten the main title. Add a subtitle if you wish to convey additional context.
There was a problem hiding this comment.
Ok. Will shorten the heading..
|
|
||
| == Use Cases | ||
|
|
||
| None |
There was a problem hiding this comment.
The most important use case is that this enables commons to function as a library and the code becomes completely reusable by any component.
There was a problem hiding this comment.
Done. Would add the use case details.
|
The following issues need to be incorporated in this specification: |
|
@shtripat Specs needs to be per component and github issues should be against that component, It is difficult to track one spec spanning multiple components. Also that way component owners can review those specs without needing much insight on other components apart from making sure the impact on other components is documented |
|
@r0h4n Specifications are tendrl-global. They can affect multiple components. The specification should explicitly point out the affected components and the changes required across them. Issues from the specification can be created across multiple components. The issues detail out the exact implementation changes required in each of the components. Basically, specifications are our tendrl project design. Issues are per component implementation details. |
|
@brainfunked Agree. Even I feel this specification could be single and we can add all the required details here and then link the github issues to this from different modules of tendrl. |
Signed-off-by: Shubhendu <shtripat@redhat.com>
shtripat
force-pushed
the
common-refactor
branch
from
4e7d99b
to
b2ce6e2
Compare
|
@shtripat Can you please mention about moving the general purpose utilities like command executor, package installer, service manager etc to common in this spec. |
|
@nnDarshan regarding your comment, I think enough details are available under "Proposed changes" and "Work Items". These section talk about manager, persister changes etc in detail. Anything specific you need? |
|
@shtripat Can you please mention about general purpose utilities like command executor, package installer, service manager. |
|
|
||
| * https://github.com/Tendrl/common/issues/60 | ||
|
|
||
| * https://github.com/Tendrl/common/issues/62 |
There was a problem hiding this comment.
Have a mention about issue 60 as well in the document. That means common module specific logging and configuirations will be removed. This has a documentaion impact as well
Also you need to create individual issues per component(changes occuring) and link it here
There was a problem hiding this comment.
@shtripat can you please include: Tendrl/commons#80. Sorry for informing you late.
Created individual issues for different modules and referred into specification. Signed-off-by: Shubhendu <shtripat@redhat.com>
This specification details the refactoring across the tendrl
modules to move major common code to common module.
Signed-off-by: Shubhendu shtripat@redhat.com