Commit 1c8acd78 authored by Brian Hackworth's avatar Brian Hackworth
Browse files

Use command-line overrides for helm; add use case diagram

parent b46610f5
......@@ -3,3 +3,54 @@ Kubesafe Concepts
This documents talks about Kubesafe concepts: what the software does
and how to accomplish key use cases.
Use Cases
-----------
.. image:: _static/use-cases.png
:alt: Kubesafe use cases
Terminology
------------
Recovery Point
A point in time copy of a namespace or application, including its data
and configuration. A recovery point may be local (visible on the same
cluster where the aplication is running) or remote (visible on a cluster
or object store other than the one where the cluster is running).
Back up
(verb) Create a new recovery point.
Backup
(nound) A recovery point.
Snapshot
(noun) A recovery point.
Restore
Replace the contents of a namespace or application with the data and
configuration from a recovery point. Because restores are done in
place, this action is possible only when the recovery point exists
on the cluster where the application is running.
Restore Latest
Restore from the most recent recovery point for a namespace or application.
Clone
Create a new running copy of a namespace or aplication using the
data and configuration from a recovery point.
Clone Latest
Clone from the most recent recovery point for a namespace or application.
Protectable
Describes a namespace or application running on the current cluster.
Protected
Describes a namespace or application with at least one recovery point.
Recoverable
Describes a namespace or application having one or more recovery points
on the current cluster.
......@@ -83,63 +83,36 @@ After extracting the downloaded tar file, change into the `helm` directory::
This directory contains the Kubesafe helm chart.
Customizing the deployment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Customizing the deployment (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You might need to customize the `kubesafe/values.yaml` for your installation:
1. If you have your own Amazon Cognito authentication service,
specify the configuration details for your identity provider.
2. Set the `openshift.enable: "true"` flag:
.. code-block::
openshift:
enable: "true"
3. Set the `onprem.enabled: true` flag:
.. code-block::
onprem:
enabled: "true"
4. Specify that the Kubesafe UI use `NodePort` as its service type:
.. code-block::
ui:
service:
url: kubesafe-ui.kubesafe.svc.cluster.local
type: NodePort
5. Search for `gp2` and replace that string with `glusterfs-storage`, the
storage class name you have defined for Gluster.
6. Change the `apiserver.image.tag` to `ocs3`:
.. code-block::
apiserver:
...
image:
repository: quay.io/kubesafe.io/api
pullPolicy: IfNotPresent
tag: ocs3
7. Kubesafe services normally create their own self-signed SSL certificates for HTTPS.
2. Kubesafe services normally create their own self-signed SSL certificates for HTTPS.
If you have your own SSL certificates, specify the `keyFile`, `certFile`, `caCert`, `pemFile`.
Installing Kubesafe services
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For OpenShift Container Platform 3.x, enter::
oc new-project kubesafe
helm template <release-name> kubesafe > rendered.yaml
helm template <release-name> kubesafe > rendered.yaml \
--set openshift.enable=true \
--set onprem.enabled=true \
--set ui.service.type=NodePort \
--set db.pvc.storageClass=glusterfs-storage \
--set apiserver.pvc.storageClass=glusterfs-storage \
--set apiserver.image.tag=ocs3
oc create -f rendered.yaml
The `glusterfs-storage` value is the name of the storage class you have
defined for Gluster.
Note that the Kubesafe software must be deployed in the `kubesafe` namespace.
The output shows something like this:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment