Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] [question] reference to tendrl-ceph-integration and tendrl-gluster-integration in installation instructions #98

Closed
mbukatov opened this issue Dec 12, 2016 · 3 comments

Comments

@mbukatov
Copy link
Contributor

I noticed that both tendrl-ceph-integration and tendrl-gluster-integration are referenced in README file of node agent, without further explanation what to do with these components (besides default configuration).

Based on the already reported issues related to this:

I would assume that content of the README file belongs to installation.rst file (as suggested in #89) and that documentation for overall high level installation of Tendrl belongs to Tendrl/documentation repo (as suggested in Tendrl/specifications#25). Another evidence suggesting that this is the case is the fact that no interesting details or further reasoning about integration of node-agent and ceph/gluster-integration components are given (right now, it's just clone a repo and copy default config file).

That said, I may be wrong and there may be some reason to reference other components in installation.rst file. If this is the case, this issue is tracking the work on documenting the reasoning of this better, otherwise we could just drop the references to tendrl-ceph-integration and tendrl-gluster-integration from installation.rst file during work on the issues I referenced above and this issue can be closed.

@TimothyAsirJeyasing
Copy link
Contributor

TimothyAsirJeyasing commented Dec 14, 2016

Yes you are right!, Node agent is not depends on gluster-integration or ceph-integration. So all the references and configuration related to any of those packages should be removed from node-agent installation or readme files.

Only node-agent is required for gluster-integration or ceph-integration packages.
The configuration required for gluster-integration or ceph-integration should be moved to related documents in either gluster or ceph integration packages.

@r0h4n
Copy link
Contributor

r0h4n commented Dec 15, 2016

Can we close this?

@mbukatov
Copy link
Contributor Author

Can we close this?

The proposed changes hasn't reached current master (commit 39d2dfe), so I would let it open until that happens. I still see references in the README file:

$ find . -name '*.rst' | xargs egrep '(ceph|gluster)[_-]integration'
./README.rst:       $ git clone https://github.com/Tendrl/ceph_integration.git
./README.rst:       $ git clone https://github.com/Tendrl/gluster_integration.git
./README.rst:       $ cp ceph_integration/etc/logging.yaml.timedrotation.sample \
./README.rst:         /etc/tendrl/ceph_integration_logging.yaml
./README.rst:       $ cp gluster_integration/etc/logging.yaml.timedrotation.sample \
./README.rst:         /etc/tendrl/gluster_integration_logging.yaml

But it seems that it's being addressed in #107

$ git checkout fix-89 
Branch fix-89 set up to track remote branch fix-89 from TimothyAsirJeyasing.
Switched to a new branch 'fix-89'
$ find . -name '*.rst' | xargs egrep '(ceph|gluster)[_-]integration'
$

@r0h4n r0h4n closed this as completed Mar 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants