On Mon, Sep 23, 2019 at 11:16:04AM -0400, Randy Barlow wrote:
Hey Kevin and Petr (and anyone else on the list who is interested),
I've been talking with Ben Cotton about moving the elections
application into Communishift[0]. We had a few back and forth e-mails,
and it became clear that it would be helpful if we had quality
documentation describing how community members can use Communishift.
+10
I think there may need to be a balance between documenting how to
use
OpenShift, and linking to already existing resources regarding the use
of OpenShift. Perhaps some simple hello world type examples would be
good to document, but it would probably be best to link to official
OpenShift documentation for details on how to use OpenShift.
Yeah, there's tons of docs out there about using openshift and how to
get started, etc. We shouldn't document any of that, but pointing to
some good ones sounds like a great idea.
On the other hand, there are likely to be some particularities with
how
we have deployed/configured Communishift that should be documented.
Since we are hoping to hand off several infrastructure applications to
the community, there may be some common patterns among those apps that
would be good to document as well.
Yep.
It would also be good to document best practices suggestions for
some
common problems our users will need to solve:
* How can they use persistent storage?
Just make a pvc (persistent volume claim) and it will get filled.
We use NFS, but I'm not sure they need to know that.
One thing we still need to sort out though is that we currently have a
bunch of nfs volumes defined for pv's, but to be safe we have set them
to 'reclaim', which means when someone uses one, then stops using it,
the volume needs to be wiped and re-added. This means that we run out of
pv's after a while as they are used. We either need to automate
something reclaiming them or some other solution so we don't have to
manually clean them up. (sorry for the side note)
* How can they use a database?
They need to make a db pod and use a persistent volume.
We could make this easier perhaps by installing some database operators.
* How can they back up the applications, persistent storage, and
database?
oc get --export all -o json
for the storage, perhaps rsync or tar with oc rsh
ditto the database.
We do have a wiki page[1] for Communishift already that we can use as a
starting point, but we probably want to move it to our documentation
project as we extend it.
Sure. I just put it there because it was easy.
Let me know if you are interested in participating in this project.
Happy to help out.
kevin
--
[0] Communishift is an OpenShift instance hosted by Fedora
Infrastructure for the community to use to host applications for
Fedora. Fedora Infrastructure does not maintain or administrate any
applications in Communishift, but rather administers the OpenShift
deployment itself.
[1]
https://fedoraproject.org/wiki/Infrastructure/Communishift