-
Notifications
You must be signed in to change notification settings - Fork 3
πΎ Installation v0.2.0
This installation page explains the configuration of each way of the syngit installation. It is based on the 0.2.0 version. This is not the latest version. The latest version can be found here.
- Access to a Kubernetes v1.11.3+ cluster.
- kubectl version v1.11.3+.
- helm version v3.0.0+.
The configuration values can be found in the values.yaml file. The following array explains in details the role of each entry of the values file.
This section is aimed to configure the resource catcher webhook. The entries are prefixed by webhook:
Entry | Default value | Role |
---|---|---|
certmanager.enable | true |
Use certmanager to create self-signed CA and inject it in the webhook. false results with a webhook without any caBundle. If false , the caBundle must be manually specified in each webhook and in the CRD for the conversion webhook. |
certmanager.certificate.name | webhook-cert |
The name of the self-signed CA. |
certmanager.certificate.secret | webhook-server-cert |
The name of the secret where the CA is stored. |
This section is aimed to configure the controller. The entries are prefixed by controller:
Entry | Default value | Role |
---|---|---|
image.prefix | ghcr.io/syngit-org |
The repository where the image is stored. |
image.name | syngit |
The name of the image. |
image.tag | v0.2.0 |
The tag of the image. |
image.imagePullSecrets | {} | A list of secret reference |
securityContext | The recommended values provided by Kubernetes for a restricted cluster. | The security context. |
resources | Default Kubebuilder resources. | The requests and limits for CPU and memory. |
tolerations | [] |
The toleration of the pods of the controller. |
dynamicWebhookName | "remotesyncer.syngit.io" | The ValidatingWebhookConfiguration name that will be used to register the webhooks for all the RemoteSyncers |
Choose to install the CRDs with Helm of to manually add them. At the root of the yaml file.
Entry | Default value | Role |
---|---|---|
installCRD | true |
Install the CRDs. |
- Add this github repository to your helm repos.
helm repo add syngit https://syngit-org.github.io/syngit
helm repo update syngit
- Install the operator
You can customize the values before installing the Helm chart. The template can be found under
chart/x.x.x/values.yaml
and add the-f values.yaml
flag. TheSYNGIT_NAMESPACE
variable can be any namespace on the cluster.
helm install syngit syngit/syngit --version 0.2.0 -n <SYNGIT_NAMESPACE>
syngit is now installed on your cluster!
To upgrade syngit operator, execute the following command:
helm repo update syngit
helm upgrade -n <SYNGIT_NAMESPACE> syngit syngit/syngit
The upgrade is full automated. If there is a new apiVersion
of the CRDs, then the old objects will be converted to the new apiVersion
using conversion webhooks.