Choose your installation method
Before installing the application, you'll have to choose between three installation types:
- Embedded Cluster,
- Existing Cluster using Kots,
- Existing Cluster using Helm.
This guide will explain the differences between these methods and help you decide which is the best for your needs.
What is an embedded cluster installation#
The Embedded Installation is an "all in one" installation, where the Kubernetes cluster is created on your machine and all components needed for the application are installed.
You can find more details about Embedded Cluster Installation in the Replicated documentation.
What is an existing cluster installation#
You can install the application on an existing Kubernetes cluster that already
contains nodes.
You have to check that this cluster meets the
system and
network requirements.
You can find more details about Existing Cluster Installation in the Replicated documentation
On existing clusters, you can choose between two installation methods:
Existing Cluster Installation using KOTS#
With this installation method, you'll use the Web KOTS Admin Portal provided
by Replicated. This interface will allow you to configure, deploy, backup and
troubleshoot your application without writing code.
Existing cluster Installation using Helm#
Helm is a package management tool for Kubernetes clusters. It allows fine-tuning the configuration through a YAML file that can be versioned in a Git Repository. It also integrates well with CD tools like Argo CD.
How to choose between these options#
Before installing the application, you'll have to reply to some considerations:
- do you have the resources and knowledge to manage your Kubernetes cluster?
- do you have security policies concerning applications deployed by Kube?
- do you prefer web UI or configuration with code?
- will you need fine-tuning of the application?
If you already have a Kubernetes cluster, that is running different applications, with precise management and security policies and a dedicated maintainer in your teams, you should use the existing cluster installation using Kots or the existing cluster installation using Helm.
While KOTS Admin Portal is well suited for small and medium installations where
you won't need to fine-tune the application, Helm installation will offer more
configuration options and will be more easily integrated into automation
pipelines.
Choosing between these 2 installation methods also depends on your processes and
resources. Web UI doesn't require specific knowledge as Helm does.
If you don't have resources dedicated to the maintenance of a Kubernetes cluster, prefer the embedded installation.
Using external databases#
For both solutions, you can use databases external from your Kubernetes cluster. The database preparation section will help you correctly configure them for your environment.
caution
If you are using external databases, remind to open ports between the GitGuardian application cluster and your databases.
For an embedded cluster#
For an existing cluster#
