This chart bootstraps installation of Lighthouse.
- Add jenkins-x helm charts repo
helm repo add jenkins-x https://jenkins-x-charts.github.io/repo
helm repo update- Install (or upgrade)
# This will install Lighthouse in the lighthouse namespace (with a my-lighthouse release name)
# Helm v2
helm upgrade --install my-lighthouse --namespace lighthouse jenkins-x/lighthouse
# Helm v3
helm upgrade --install my-lighthouse --namespace lighthouse jenkins-x/lighthouseLook below for the list of all available options and their corresponding description.
To uninstall the chart, simply delete the release.
# This will uninstall Lighthouse in the lighthouse namespace (assuming a my-lighthouse release name)
# Helm v2
helm delete --purge my-lighthouse
# Helm v3
helm uninstall my-lighthouse --namespace lighthouse| Key | Type | Description | Default |
|---|---|---|---|
cluster.crds.create |
bool | Create custom resource definitions | true |
configMaps.config |
string | Raw config.yaml content |
nil |
configMaps.configUpdater |
object | Settings used to configure the config-updater plugin |
{"orgAndRepo":"","path":""} |
configMaps.create |
bool | Enables creation of config.yaml and plugins.yaml config maps |
false |
configMaps.plugins |
string | Raw plugins.yaml content |
nil |
engines.jenkins |
bool | Enables the Jenkins engine | false |
engines.jx |
bool | Enables the jx engine | true |
engines.tekton |
bool | Enables the tekton engine | false |
env |
object | Environment variables | {"JX_DEFAULT_IMAGE":""} |
externalPlugins[0].name |
string | "cd-indicators" |
|
externalPlugins[0].requiredResources[0].kind |
string | "Service" |
|
externalPlugins[0].requiredResources[0].name |
string | "cd-indicators" |
|
externalPlugins[0].requiredResources[0].namespace |
string | "jx" |
|
externalPlugins[1].name |
string | "lighthouse-webui-plugin" |
|
externalPlugins[1].requiredResources[0].kind |
string | "Service" |
|
externalPlugins[1].requiredResources[0].name |
string | "lighthouse-webui-plugin" |
|
externalPlugins[1].requiredResources[0].namespace |
string | "jx" |
|
foghorn.affinity |
object | Affinity rules applied to the foghorn pods | {} |
foghorn.image.pullPolicy |
string | Template for computing the foghorn controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
foghorn.image.repository |
string | Template for computing the foghorn controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-foghorn" |
foghorn.image.tag |
string | Template for computing the foghorn controller docker image tag | "{{ .Values.image.tag }}" |
foghorn.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
foghorn.nodeSelector |
object | Node selector applied to the foghorn pods | {} |
foghorn.replicaCount |
int | Number of replicas | 1 |
foghorn.resources.limits |
object | Resource limits applied to the foghorn pods | {"cpu":"100m","memory":"256Mi"} |
foghorn.resources.requests |
object | Resource requests applied to the foghorn pods | {"cpu":"80m","memory":"128Mi"} |
foghorn.terminationGracePeriodSeconds |
int | Termination grace period for foghorn pods | 180 |
foghorn.tolerations |
list | Tolerations applied to the foghorn pods | [] |
gcJobs.backoffLimit |
int | Set the backoff limit for failed cronJobs | 6 |
gcJobs.concurrencyPolicy |
string | Drives the job's concurrency policy | "Forbid" |
gcJobs.failedJobsHistoryLimit |
int | Drives the failed jobs history limit | 1 |
gcJobs.image.pullPolicy |
string | Template for computing the gc job docker image pull policy | "{{ .Values.image.pullPolicy }}" |
gcJobs.image.repository |
string | Template for computing the gc job docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-gc-jobs" |
gcJobs.image.tag |
string | Template for computing the gc job docker image tag | "{{ .Values.image.tag }}" |
gcJobs.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
gcJobs.maxAge |
string | Max age from which LighthouseJobs will be deleted |
"168h" |
gcJobs.schedule |
string | Cron expression to periodically delete LighthouseJobs |
"0/30 * * * *" |
gcJobs.successfulJobsHistoryLimit |
int | Drives the successful jobs history limit | 3 |
git.kind |
string | Git SCM provider (github, gitlab, stash) |
"github" |
git.server |
string | Git server URL | "" |
githubApp.enabled |
bool | Enables GitHub app authentication | false |
githubApp.username |
string | GitHub app user name | "jenkins-x[bot]" |
hmacSecretName |
string | Existing hmac secret to use for webhooks | "" |
hmacToken |
string | Secret used for webhooks | "" |
hmacTokenEnabled |
bool | Enables the use of a hmac token. This should always be enabled if possible - though some git providers don't support it such as bitbucket cloud | true |
image.parentRepository |
string | Docker registry to pull images from | "ghcr.io/jenkins-x" |
image.pullPolicy |
string | Image pull policy | "IfNotPresent" |
image.tag |
string | Docker images tag the following tag is latest on the main branch, it's a specific version on a git tag | "latest" |
jenkinscontroller.affinity |
object | Affinity rules applied to the tekton controller pods | {} |
jenkinscontroller.image.pullPolicy |
string | Template for computing the tekton controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
jenkinscontroller.image.repository |
string | Template for computing the Jenkins controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-jenkins-controller" |
jenkinscontroller.image.tag |
string | Template for computing the tekton controller docker image tag | "{{ .Values.image.tag }}" |
jenkinscontroller.jenkinsToken |
string | The token for authenticating the Jenkins user | nil |
jenkinscontroller.jenkinsURL |
string | The URL of the Jenkins instance | nil |
jenkinscontroller.jenkinsUser |
string | The username for the Jenkins user | nil |
jenkinscontroller.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
jenkinscontroller.nodeSelector |
object | Node selector applied to the tekton controller pods | {} |
jenkinscontroller.podAnnotations |
object | Annotations applied to the tekton controller pods | {} |
jenkinscontroller.resources.limits |
object | Resource limits applied to the tekton controller pods | {"cpu":"100m","memory":"256Mi"} |
jenkinscontroller.resources.requests |
object | Resource requests applied to the tekton controller pods | {"cpu":"80m","memory":"128Mi"} |
jenkinscontroller.service |
object | Service settings for the tekton controller | {"annotations":{}} |
jenkinscontroller.terminationGracePeriodSeconds |
int | Termination grace period for tekton controller pods | 180 |
jenkinscontroller.tolerations |
list | Tolerations applied to the tekton controller pods | [] |
keeper.affinity |
object | Affinity rules applied to the keeper pods | {} |
keeper.datadog.enabled |
string | Enables datadog | "true" |
keeper.env |
object | Lets you define keeper specific environment variables | {} |
keeper.image.pullPolicy |
string | Template for computing the keeper controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
keeper.image.repository |
string | Template for computing the keeper controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-keeper" |
keeper.image.tag |
string | Template for computing the keeper controller docker image tag | "{{ .Values.image.tag }}" |
keeper.livenessProbe |
object | Liveness probe configuration | {"initialDelaySeconds":120,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
keeper.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
keeper.nodeSelector |
object | Node selector applied to the keeper pods | {} |
keeper.podAnnotations |
object | Annotations applied to the keeper pods | {} |
keeper.probe |
object | Liveness and readiness probes settings | {"path":"/"} |
keeper.readinessProbe |
object | Readiness probe configuration | {"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
keeper.replicaCount |
int | Number of replicas | 1 |
keeper.resources.limits |
object | Resource limits applied to the keeper pods | {"cpu":"400m","memory":"512Mi"} |
keeper.resources.requests |
object | Resource requests applied to the keeper pods | {"cpu":"100m","memory":"128Mi"} |
keeper.service |
object | Service settings for the keeper controller | {"externalPort":80,"internalPort":8888,"type":"ClusterIP"} |
keeper.statusContextLabel |
string | Label used to report status to git provider | "Lighthouse Merge Status" |
keeper.terminationGracePeriodSeconds |
int | Termination grace period for keeper pods | 30 |
keeper.tolerations |
list | Tolerations applied to the keeper pods | [] |
lighthouseJobNamespace |
string | Namespace where LighthouseJobs and Pods are created |
Deployment namespace |
logFormat |
string | Log format either json or stackdriver | "json" |
logService |
string | The name of the service registered with logging | "" |
logStackSkip |
string | Comma separated stack frames to skip from the log | "" |
oauthSecretName |
string | Existing Git token secret | "" |
oauthToken |
string | Git token (used when GitHub app authentication is not enabled) | "" |
poller.affinity |
object | Affinity rules applied to the poller pods | {} |
poller.contextMatchPattern |
string | Regex pattern to use to match commit status context | "" |
poller.datadog.enabled |
string | Enables datadog | "true" |
poller.enabled |
bool | Whether to enable or disable the poller component | false |
poller.env |
object | Lets you define poller specific environment variables | {"POLL_HOOK_ENDPOINT":"http://hook/hook/poll","POLL_PERIOD":"20s"} |
poller.image.pullPolicy |
string | Template for computing the poller controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
poller.image.repository |
string | Template for computing the poller controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-poller" |
poller.image.tag |
string | Template for computing the poller controller docker image tag | "{{ .Values.image.tag }}" |
poller.internalPort |
int | 8888 |
|
poller.livenessProbe |
object | Liveness probe configuration | {"initialDelaySeconds":120,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
poller.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
poller.nodeSelector |
object | Node selector applied to the poller pods | {} |
poller.podAnnotations |
object | Annotations applied to the poller pods | {} |
poller.probe |
object | Liveness and readiness probes settings | {"path":"/"} |
poller.readinessProbe |
object | Readiness probe configuration | {"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
poller.replicaCount |
int | Number of replicas | 1 |
poller.requireReleaseSuccess |
bool | Keep polling releases until the most recent commit status is successful | false |
poller.resources.limits |
object | Resource limits applied to the poller pods | {"cpu":"400m","memory":"512Mi"} |
poller.resources.requests |
object | Resource requests applied to the poller pods | {"cpu":"100m","memory":"128Mi"} |
poller.terminationGracePeriodSeconds |
int | Termination grace period for poller pods | 30 |
poller.tolerations |
list | Tolerations applied to the poller pods | [] |
scope |
string | set scope to either cluster or namespace for permissions |
cluster |
tektoncontroller.affinity |
object | Affinity rules applied to the tekton controller pods | {} |
tektoncontroller.dashboardTemplate |
string | Go template expression for URLs in the dashboard if not using Tekton dashboard | "" |
tektoncontroller.dashboardURL |
string | the dashboard URL (e.g. Tekton dashboard) | "" |
tektoncontroller.image.pullPolicy |
string | Template for computing the tekton controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
tektoncontroller.image.repository |
string | Template for computing the tekton controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-tekton-controller" |
tektoncontroller.image.tag |
string | Template for computing the tekton controller docker image tag | "{{ .Values.image.tag }}" |
tektoncontroller.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
tektoncontroller.nodeSelector |
object | Node selector applied to the tekton controller pods | {} |
tektoncontroller.podAnnotations |
object | Annotations applied to the tekton controller pods | {} |
tektoncontroller.replicaCount |
int | Number of replicas | 1 |
tektoncontroller.resources.limits |
object | Resource limits applied to the tekton controller pods | {"cpu":"100m","memory":"256Mi"} |
tektoncontroller.resources.requests |
object | Resource requests applied to the tekton controller pods | {"cpu":"80m","memory":"128Mi"} |
tektoncontroller.service |
object | Service settings for the tekton controller | {"annotations":{}} |
tektoncontroller.terminationGracePeriodSeconds |
int | Termination grace period for tekton controller pods | 180 |
tektoncontroller.tolerations |
list | Tolerations applied to the tekton controller pods | [] |
user |
string | Git user name (used when GitHub app authentication is not enabled) | "" |
webhooks.affinity |
object | Affinity rules applied to the webhooks pods | {} |
webhooks.customDeploymentTriggerCommand |
string | deployments can configure the ability to allow custom lighthouse triggers using their own unique chat prefix, for example extending the default /test trigger prefix let them specify customDeploymentTriggerPrefix: foo which means they can also use their own custom trigger /foo mycoolthing |
"" |
webhooks.image.pullPolicy |
string | Template for computing the webhooks controller docker image pull policy | "{{ .Values.image.pullPolicy }}" |
webhooks.image.repository |
string | Template for computing the webhooks controller docker image repository | "{{ .Values.image.parentRepository }}/lighthouse-webhooks" |
webhooks.image.tag |
string | Template for computing the webhooks controller docker image tag | "{{ .Values.image.tag }}" |
webhooks.ingress.annotations |
object | Webhooks ingress annotations | {} |
webhooks.ingress.enabled |
bool | Enable webhooks ingress | false |
webhooks.ingress.hosts |
list | Webhooks ingress host names | [] |
webhooks.ingress.ingressClassName |
string | Webhooks ingress ingressClassName | nil |
webhooks.labels |
object | allow optional labels to be added to the webhook deployment | {} |
webhooks.livenessProbe |
object | Liveness probe configuration | {"initialDelaySeconds":60,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
webhooks.logLevel |
string | The logging level: trace, debug, info, warn, panic, fatal | "info" |
webhooks.nodeSelector |
object | Node selector applied to the webhooks pods | {} |
webhooks.podAnnotations |
object | Annotations applied to the webhooks pods | {} |
webhooks.podLabels |
object | {} |
|
webhooks.probe |
object | Liveness and readiness probes settings | {"path":"/"} |
webhooks.readinessProbe |
object | Readiness probe configuration | {"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1} |
webhooks.replicaCount |
int | Number of replicas | 1 |
webhooks.resources.limits |
object | Resource limits applied to the webhooks pods | {"cpu":"100m","memory":"512Mi"} |
webhooks.resources.requests |
object | Resource requests applied to the webhooks pods | {"cpu":"80m","memory":"128Mi"} |
webhooks.service |
object | Service settings for the webhooks controller | {"annotations":{},"externalPort":80,"internalPort":8080,"type":"ClusterIP"} |
webhooks.serviceName |
string | Allows overriding the service name, this is here for compatibility reasons, regular users should clear this out | "hook" |
webhooks.terminationGracePeriodSeconds |
int | Termination grace period for webhooks pods | 180 |
webhooks.tolerations |
list | Tolerations applied to the webhooks pods | [] |
You can look directly at the values.yaml file to look at the options and their default values.