Setup
=====

This page provides information to help you set up ghost for your Kubernetes
cluster on Greenhost VPSs. Currently this process requires manual activation.
Please contact Greenhost support to activate this feature.

Prerequisites
-------------

* a Kubernetes platform running on the Greenhost VPS platform, or on eclips.is;

* a functioning `Helm`_ install for that cluster.

Set permissions
---------------

The ghost storage provisioner will need to use Greenhost's API to create (and
delete) virtual disks, based on requests by the Kubernetes cluster. Because
this has obvious implications for security, and also incurs costs for the
virtual disks to the account owner, this needs special permissions to be set
for the machines that make up the cluster.

Please contact `our support team <Greenhost support_>`_ to request these
changes, including a list of VPSs that make up the cluster, and optionally a
label we use internally to identify the cluster for future reference.

Install ghost
-------------

1.  Clone the ghost repository to the machine that you run Helm from, typically
    your workstation or laptop:

    ::

        git clone https://code.greenhost.net/open/kubernetes-ghost.git
        cd kubernetes-ghost

2.  (optional) Review the ``values.yaml`` in the top-level directory, and change as you see fit. The defaults should give you a working setup.

3.  Install the ghost components to your cluster:

    ::

        helm install --name=my-personal-ghost .

Check installation
------------------

You can check that the provisioner and driver are running:

::

    kubectl get pod -n kube-system

Should list among other things a single ``greenhost-provisioner`` pod, and one
``ghost-driver`` pod on per worker node.

If you now create a Persistent Volume Claim, the provisioner should pick this up and create a corresponding Persistent Volume. You can also check that virtual disks appear in the `listing <Greenhost disk image listing_>`_.

.. _Helm: https://helm.sh
.. _Greenhost support: mailto:support@greenhost.net
.. _Greenhost disk image listing: https://service.greenhost.net/cloud/DiskImage