External Dependencies
To deploy instances of GitGuardian on-premises, some external software components and network accesses are required.
#
KOTS / ReplicatedReplicated (https://www.replicated.com/) is a third-party service that provides a management tool for our on-premise installations. During the installation, the KOTS (https://kots.io/) add-on is configured to manage the GitGuardian application. KOTS is open-source, Apache 2 licensed software developed by Replicated.
An overview of Replicated's security posture can be found at: https://www.replicated.com/resources/files/Replicated-Security-Whitepaper.pdf
#
InstallationFor an existing cluster, Kots can be installed as a plugin for kubectl with this command:
curl https://kots.io/install | bash
Then, you can run the install command for GitGuardian shown here.
#
UpgradesTo check Kots plugin version, run the following command:
kubectl kots version
If there is an update available, follow the instructions and run this command:
curl https://kots.io/install | bash
Then, you will need to upgrade the kots application running in the cluster:
kubectl kots admin-console upgrade -n <namespace>
#
External accessThe following domains can be needed:
get.replicated.com
api.replicated.com
registry.replicated.com
proxy.replicated.com
A list of IP addresses for this is maintained by Replicated: https://github.com/replicatedhq/ips/blob/master/ip_addresses.json
#
kURLIf you use an embedded Kubernetes cluster, you will use kURL (https://kurl.sh). kURL is a Kubernetes installer that installs Kubernetes and some other Kubernetes components. kURL is an open-source, Apache 2 licensed software developed by Replicated.
#
UsageTo install a cluster and its components with kURL, use the command shown here.
To upgrade kubernetes and its components, you just need to run the same command.