commissaire
commissaire copied to clipboard
[docs/question] Where is commissaire going with distribution and should the documentation include 'enterprisey' installation instructions
Docs
The documentation is missing a clear How to install and deploy section. The closest thing to that I can find right now is in DEVEL.rst. Which is not technically part of the documentation. It's a file in the project github repo that's linked from the documentation. The DEVEL.rst file (rightly so) does not give clear instructions on how to run commissaire as a managed system service (ex, supervisord
/systemd
).
Distribution (packages/pip)
The DEVEL docs reference installing via local/remote pip
installs. That's not something I can feel good about doing in a cluster of hosts running business workloads. Ideally this product would be available through OS recommended package install programs (dnf
, yum
, atomic
).
Where's the project going in that direction? Are there plans to get all commissaire components fully installable via Fedora/RHEL Channels/EPEL/AtomicWhatever?
In fedora 25 repos I see there are commissaire
and commissaire-client
packages with version fields indicating the 0.0.1
release. The git tags say that 0.0.1rc3
was committed on Tue Apr 19 12:05:40 2016 -0400
, and since then the CHANGELOG.md
file says there has been a new v0.0.3
release made.
The commissaire
package includes a unitfile, ./commissaire-0.0.1-2.fc25.noarch/usr/lib/systemd/system/commissaire.service
and the commisaire
command. Where are the other commands and services? In the commissaire-service
repo I can find several unit files
./commissaire-service/conf/systemd/commissaire-investigator.service
./commissaire-service/conf/systemd/commissaire-storage.service
./commissaire-service/conf/systemd/commissaire-clusterexec.service
./commissaire-service/conf/systemd/commissaire-watcher.service
./commissaire-service/conf/systemd/commissaire-containermgr.service
./commissaire-http/conf/systemd/commissaire-server.service
I can see vague references to the systemd services in the Vagrantfile
. But again, even this is only referenced in a development context.
Docs: enterprisey installation instructions
In the form of a user story
As a system operator I want a set of instructions/tutorial/installation scripts for deploying commissaire
on my infrastructure so that I can run components as proper managed system services rather than as
backgrounded tasks the way described in the current [development documentation].
In my mind, Acceptance Criteria on that story would include
- Verify that the http://commissaire.readthedocs.io documentation includes a top-level section "Installing"
- Verify that instructions are provided for running the product as a managed system service (ex: via included
supervisord
process scripts,systemd
unit files, etc) - Verify that package instructions are clear - See the notes above about the old package versions and that they don't install all of the systemd files.
- Verify the DEVEL file is properly included as part of the readthedocs.io documentation
Additional Info
Some of this I think requires separate tasks. For example: updating packages in repositories. You can't document that a user should just dnf install commissaire
if you know the version is out of date and the documentation no longer reflects the reality of that package.