This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installation

Overview on available installation methods

cf-service-operator relies on four custom resource types, the according definitions can be found here. These definitions must be deployed before the operator can be started, otherwise it will fail. The core of the cf-service-operator installation is the executable built from this repository (Docker image ghcr.io/sap/cf-service-operator). It implements both the controller logic and validating/mutating webhooks for the above custom resource types.

A valid deployment consists of:

  • the custom resource definitions
  • the controller deployment
  • rbac objects for the controller (service account, (cluster) roles, according (cluster) role bindings)
  • a service for the webhooks
  • webhook configurations.

Note that it is highly recommended to always activate the webhooks, as they are not only validating, but also adding default values to our custom resource objects. Running without this mutating functionality might lead to unexpected behavior.

The following deployment methods are available (recommended is Helm).

1 - Helm

Installation by Helm

Helm deployment

The recommended way to deploy cf-service-operator is to use the Helm chart, also available in packaged form:

The chart does not require any mandatory parameters, so deploying cf-service-operator is as easy as

helm repo add cf-service-operator https://sap.github.io/cf-service-operator-helm
helm -n cf-service-operator upgrade -i cf-service-operator cf-service-operator/cf-service-operator