Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Latest commit

 

History

History
170 lines (127 loc) · 8.62 KB

INSTALL.md

File metadata and controls

170 lines (127 loc) · 8.62 KB
Raw

Installation

The job-executor-service can be installed as a part of Keptn's uniform using helm. It is recommended to install the job-executor-service on the remote execution-plane, which can be on the same cluster, or on a completely separate Kubernetes environment (see Keptn docs: Multi-cluster setup for details).

During the installation process various parameters of the job-executor-service can be customized, for a complete list of these helm values have a look at the documentation. In order to install the job-executor-service on the remote execution plane, some values of the helm chart need to be configured:

  • remoteControlPlane.topicSubscription - list of Keptn CloudEvent types that this instance should listen to, e.g., sh.keptn.event.remote-task.triggered
  • remoteControlPlane.api.protocol - protocol (http or https) used to connect to the remote control plane (default: http - this has changed with the 0.2.0 release)
  • remoteControlPlane.api.hostname - Keptn API Hostname (e.g., 1.2.3.4.nip.io). If Keptn is installed on the same cluster the API is usually reachable under api-gateway-nginx.keptn.
  • remoteControlPlane.api.token - Keptn API Token (can be obtained from Bridge)
  • remoteControlPlane.api.authMode - Authentication mode which should be used when communicating with Keptn. Must be either token or oauth. Defaults to token if omitted

Example installation with token:

JES_VERSION=<VERSION> # e.g. 0.2.3

KEPTN_API_PROTOCOL=http # or https
KEPTN_API_HOST=<INSERT-YOUR-HOSTNAME-HERE> # e.g., 1.2.3.4.nip.io
 KEPTN_API_TOKEN=<INSERT-YOUR-KEPTN-API-TOKEN-HERE>

TASK_SUBSCRIPTION=sh.keptn.event.remote-task.triggered

helm upgrade --install --create-namespace -n <NAMESPACE> job-executor-service \
    https://github.com/keptn-contrib/job-executor-service/releases/download/${JES_VERSION}/job-executor-service-${JES_VERSION}.tgz \
    --set remoteControlPlane.topicSubscription=${TASK_SUBSCRIPTION} \
    --set remoteControlPlane.api.protocol=${KEPTN_API_PROTOCOL} \
    --set remoteControlPlane.api.hostname=${KEPTN_API_HOST} \
    --set remoteControlPlane.api.token=${KEPTN_API_TOKEN}

Please replace <VERSION> with the actual version you want to install from the compatibility matrix above or the GitHub releases page.

To verify that everything works you can visit Bridge, select a project, go to Uniform, and verify that job-executor-service is registered as "remote execution plane" with the correct version and event type.

Example installation with auto-detection:

For easier installation of the job-executor-service a Keptn installation on the same kubernetes cluster can be discovered automatically. This only works if no remoteControlPlane.api.token, remoteControlPlane.api.protocol or remoteControlPlane.api.hostname is provided and remoteControlPlane.api.authMode is set to token. If multiple Keptn installations are present, the remoteControlPlane.autoDetect.namespace must be set to the desired Keptn instance. The auto-detection feature can be enabled by setting remoteControlPlane.autoDetect.enabled to true.

JES_VERSION=<VERSION> # e.g. 0.2.3
TASK_SUBSCRIPTION=sh.keptn.event.remote-task.triggered

helm upgrade --install --create-namespace -n <NAMESPACE> \
  job-executor-service https://github.com/keptn-contrib/job-executor-service/releases/download/${JES_VERSION}/job-executor-service-${JES_VERSION}.tgz \
  --set remoteControlPlane.autoDetect.enabled=true \
  --set remoteControlPlane.topicSubscription=${TASK_SUBSCRIPTION} \
  --set remoteControlPlane.api.token="" \
  --set remoteControlPlane.api.hostname="" \
  --set remoteControlPlane.api.protocol=""

Example installation with OAuth:

If the oauth authentication mode should be used instead of the token, the following properties must be specified in addition to the setting remoteControlPlane.api.authMode to oauth:

  • remoteControlPlane.api.oauth.clientId - The OAuth client ID
  • remoteControlPlane.api.oauth.clientSecret - The OAuth client secret
  • remoteControlPlane.api.oauth.clientDiscovery - The well known discovery URL for the OAuth endpoint (e.g.: https://your.sso.domain/.well-known/openid-configuration)
  • remoteControlPlane.api.oauth.scopes - The scopes which should be requested by the job executor service
JES_VERSION=<VERSION> # e.g. 0.2.3

KEPTN_API_PROTOCOL=http # or https
KEPTN_API_HOST=<INSERT-YOUR-HOSTNAME-HERE> # e.g., 1.2.3.4.nip.io

KEPTN_OAUTH_CLIENT_ID=<INSERT-YOUR-CLIENT_ID>
 KEPTN_OAUTH_CLIENT_SECRET=<INSERT-YOUR-CLIENT_SECRET>
KEPTN_OAUTH_DISCOVERY=<INSERT-YOUR-DISCOVERY_URL>
KEPTN_OAUTH_SCOPES=<INSERT-YOUR-OAUTH-SCOPES>

TASK_SUBSCRIPTION=sh.keptn.event.remote-task.triggered

helm upgrade --install --create-namespace -n <NAMESPACE> job-executor-service \
    https://github.com/keptn-contrib/job-executor-service/releases/download/${JES_VERSION}/job-executor-service-${JES_VERSION}.tgz \
    --set remoteControlPlane.autoDetect.enabled="false" \
    --set remoteControlPlane.topicSubscription="${TASK_SUBSCRIPTION}" \
    --set remoteControlPlane.api.protocol=${KEPTN_API_PROTOCOL} \
    --set remoteControlPlane.api.hostname=${KEPTN_API_HOST} \
    --set remoteControlPlane.api.authMode="oauth" \
    --set remoteControlPlane.api.oauth.clientId=${KEPTN_OAUTH_CLIENT_ID} \
    --set remoteControlPlane.api.oauth.clientSecret=${KEPTN_OAUTH_CLIENT_SECRET} \
    --set remoteControlPlane.api.oauth.clientDiscovery=${KEPTN_OAUTH_DISCOVERY} \
    --set remoteControlPlane.api.oauth.scopes=${KEPTN_OAUTH_SCOPES}

Update API Token on Remote Execution-Plane

To update your KEPTN_API_TOKEN on an existing installation, please execute the following command (make sure to use the same <VERSION> is currently installed):

 KEPTN_API_TOKEN=<INSERT-YOUR-NEW-KEPTN-API-TOKEN-HERE>

helm upgrade -n <NAMESPACE> \
  job-executor-service https://github.com/keptn-contrib/job-executor-service/releases/download/<VERSION>/job-executor-service-<VERSION>.tgz \
  --reuse-values \
  --set remoteControlPlane.api.token=${KEPTN_API_TOKEN}

Update Topic Subscriptions

To update your TASK_SUBSCRIPTION (as in the Cloud Event types that job-executor-service is listening to), please execute the following command (make sure to use the same <VERSION> is currently installed):

TASK_SUBSCRIPTION=sh.keptn.event.remote-task.triggered,sh.keptn.event.some-other-task.triggered

helm upgrade -n <NAMESPACE> \
  job-executor-service https://github.com/keptn-contrib/job-executor-service/releases/download/<VERSION>/job-executor-service-<VERSION>.tgz \
  --reuse-values \
  --set remoteControlPlane.topicSubscription=${TASK_SUBSCRIPTION}

Upgrade

Preparation

To upgrade to a newer version of job-executor-service, first figure out what version you are currently on:

helm -n <NAMESPACE> list job-executor-service

or via looking at your Keptn Bridge Integration page.

Then figure out which version you want to upgrade to, e.g., from the GitHub Releases Page.

Note: Please get informed about breaking changes via the release notes provided for each release or via looking at our Changelog.

Perform the upgrade

First save the existing installation values to a helm override file:

helm -n <NAMESPACE> get values job-executor-service > values.yaml

Perform any changes on values.yaml, especially with breaking changes in mind. Please avoid using helm upgrade ... --reuse-values as there are some limitations, especially regarding default values.

Then upgrade using the previous installation value file as an override

helm upgrade -n <NAMESPACE> \
  job-executor-service https://github.com/keptn-contrib/job-executor-service/releases/download/<VERSION>/job-executor-service-<VERSION>.tgz \
  -f values.yaml

In order to upgrade to a newer version of job-executor-service and automatically use the auto-detection to configure the Keptn API token, the helm upgrade command should be:

helm upgrade -n <NAMESPACE> \
  job-executor-service https://github.com/keptn-contrib/job-executor-service/releases/download/<VERSION>/job-executor-service-<VERSION>.tgz \
  -f values.yaml \
  --set remoteControlPlane.api.token="",remoteControlPlane.api.hostname="",remoteControlPlane.api.protocol=""

Uninstall

To uninstall job-executor-service, run

helm uninstall -n <NAMESPACE> job-executor-service