Installing, uninstalling, and upgrading the toolkit
====================================================

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

- A deployment of Domino 4.x or newer. 
- This version of the toolkit does not run on Domino 3.x or older.
- Administrative access to the Kubernetes cluster that hosts Domino.
- The Kubernetes control plane must be working so that the toolkit can contact the Kubernetes API server.
- A bastion host, laptop, or other host running a Unix-like OS with `kubectl` access that has network connectivity to the target Kubernetes cluster.
- The latest Admin Toolkit CLI script, called `toolkit.sh`, which you can download to your bastion host or laptop using this command:

.. code-block:: bash

   curl -sSLO https://toolkit.re.domino.tech/toolkit.sh && chmod a+x ./toolkit.sh

* Some features of the toolkit, such as automatic upgrading or automatic uploading of scan reports, require an internet connection from the Kubernetes cluster.

Install the toolkit
--------------------

.. code-block:: bash

   ./toolkit.sh install

If there is a legacy version of the toolkit installed and running on the cluster, you will first have to remove the old version using;

.. code-block:: bash

   ./toolkit.sh uninstall

The install command also accepts the `--no-ingress` option that installs the toolkit with the `/toolkit` ingress route disabled. When installed with this option, it is not possible to use the web UI and only the CLI can be used to operate the toolkit.

NOTE: If your deployment is air-gapped and doesn't have access to either `quay.io` or `mirrors.domino.tech` then you must push the toolkit's Docker image to your internal registry and then use the `--image` option for the install command to point to your internal registry:

- On a machine with access to both the internal registry and quay.io/mirrors.domino.tech, run

.. code-block:: bash

   ./toolkit.sh push internal-registry-host/domino-admin-toolkit

- From your bastion host, run:

.. code-block:: bash

   ./toolkit.sh install --image internal-registry-host/domino-admin-toolkit


Uninstall the toolkit
----------------------

.. code-block:: bash

   ./toolkit.sh uninstall


This completely removes all Kubernetes resources associated with the toolkit. Any reports still on the toolkit's pod storage are deleted.


Upgrade the toolkit
--------------------

The toolkit can be updated independently of the Domino version deployed.
Domino regularly publishes new versions of the toolkit Docker image with new and updated checks.

In the toolkit UI, click *Toolkit Upgrade Check* to check for a new toolkit Docker image and deploy it.
You can also force an immediate check for a new version by stopping and re-starting the toolkit like this:

.. code-block:: bash

   ./toolkit.sh stop && ./toolkit.sh start


NOTE: In an air-gapped deployment you must use the `./toolkit.sh push` command to manually push the latest version of toolkit's Docker image to your internal registry in order to enable the upgrade feature.