.. index:: Installation

.. _installation:

Installation
===========================

After setting up your config file :ref:`my-values.yaml <my-values.yaml>`, run

.. code:: sh

   helm install cocalc ~/path/to/cocalc-onprem-helm/cocalc --timeout 20m -f my-values.yaml

in your own directory. What's happening is a `standard Helm installation <https://helm.sh/docs/helm/helm_install/>`_.
This means the HELM chart and sub-charts in the ``/cocalc`` directory is rendered and populated with all configuration parameters – your ``my-values.yaml`` parameters are merged into the default parameters.
The resulting Kubernetes YAML config files are installed under the
HELM deployment name ``cocalc`` in the current namespace.

Since pulling the images and running some setup jobs could take a while,
the :ref:`timeout is increased <troubleshoot-upgrade-timeout>`.

If you want to check the status on HELM's side, you can run::

    helm status cocalc

.. note::

    If something goes horribly wrong, you can always `uninstall the deployment <https://helm.sh/docs/helm/helm_uninstall/>`_ via ``helm uninstall cocalc``.
    Only caveat, if PV/PVCs have been created, they might not be deleted automatically.