Heketi on OpenShift

[gaurav-nelson]

For https://bugzilla.redhat.com/show_bug.cgi?id=1436101

[wkshi]

Didn't see /usr/share/heketi/toplogy-sample.json, may because I just have heketi-client RPM package installed. Should hint customer here.

[gaurav-nelson]

Thanks @wkshi I have updated the docs to include more details around this one by adding following note:

Depending upon your method of installation this file may not exist. If its missing, manually create the *_toplogy-sample.json_* file, as shown in the following example.

[wkshi]

Looks good to me~

[wkshi]

# heketi-cli topology load --json=topology.json
Error: Unable to open config file

The topology.json does existing, may some steps missing.

[wkshi]

There is a extra "," here. Remove it then "heketi-cli topology load --json=toplogy-sample.json" could works.

[gaurav-nelson]

I removed the extra "," from line 179, in the latest commit and also fixed it in the gluster dynamic example.

[wkshi]

Looks good to me~

[gaurav-nelson]

@openshift/team-documentation PTAL

[mburke5678]

Assumes you have familiarity ??

[gaurav-nelson]

[rev_history]
|xref:../install_config/storage_examples/containerized_heketi_with_dedicated_gluster.adoc#install-config-storage-examples-containerized-heketi-dedicated-gluster[Containerized Heketi for managing dedicated GlusterFS storage]
|Added an example with instructions to install Heketi on OpenShift and use to manage external GlusterFS storage
%

[gaurav-nelson]

Thanks @mburke5678 I have added rev history as well. Are you done with peer review?

[mburke5678]

Does EmptyDir need mark up? i looked quickly at the docs and there doesn't seem to be consistent usage. Some EmptyDir, some EmptyDir and some with no mark up.

[gaurav-nelson]

Kubernetes uses emptyDir maybe we should use the same markup. I'll check this in our docs and submit a new PR with the changes.

[gaurav-nelson]

Thanks @mburke5678 addressed this in #6084

[mburke5678]

s/its/ it is

[mburke5678]

Run the heketi-cli command to load the topology of your environment (??)

[gaurav-nelson]

I think I will just go with Run the following command to load the topology of your environment:

[mburke5678]

Where the last storageclass is talking about a storage class object, should this be two words?
Or, "...skip the following storage class creation steps..."
Or StorageClass like in the "Dynamic Provisioning and Creating Storage Classes" chapter?
There does not seem to be a consistent way that we are using this term.

[gaurav-nelson]

I think we should use StorageClass when we talk about specific object and use storage class in general.

[mburke5678]

@gaurav-nelson A few more nits and an open question on how we present the term storage class. LGTM