Skip to content

jingweiz2017/sap-btp-operator

BranchesTags

Repository files navigation

Coverage Status Build Status License Go Report Card REUSE status

SAP Business Technology Platform (SAP BTP) Service Operator for Kubernetes

With the SAP BTP service operator, you can consume SAP BTP services from your Kubernetes cluster using Kubernetes-native tools. SAP BTP service operator allows you to provision and manage service instances and service bindings of SAP BTP services so that your Kubernetes-native applications can access and use needed services from the cluster. The SAP BTP service operator is based on the Kubernetes Operator pattern.

Table of Contents

Architecture

SAP BTP service operator communicates with Service Manager that uses the Open service broker API to communicate with service brokers, acting as an intermediary for the Kubernetes API Server to negotiate the initial provisioning and retrieve the credentials necessary for the application to use a managed service.

It is implemented using a CRDs-based architecture.

img

Prerequisites

Back to top

Setup

  1. Install cert-manager

    • for releases v0.1.18 or higher use cert manager v1.6.0 or higher
    • for releases v0.1.17 or lower use cert manager lower then v1.6.0

  2. Obtain the access credentials for the SAP BTP service operator:

    a. Using the SAP BTP cockpit or CLI, create an instance of the SAP Service Manager service (technical name: service-manager) with the plan: service-operator-access

    Note

    If you can't see the needed plan, you need to entitle your subaccount to use SAP Service Manager service.

    For more information about how to entitle a service to a subaccount, see:


    For more information about creating service instances, see:

    b. Create a binding to the created service instance.

    For more information about creating service bindings, see:

    c. Retrieve the generated access credentials from the created binding:

    The example of the default binding object used if no credentials type is specified:

     {
     "clientid": "xxxxxxx",
     "clientsecret": "xxxxxxx",
     "url": "https://mysubaccount.authentication.eu10.hana.ondemand.com",
     "xsappname": "b15166|service-manager!b1234",
     "sm_url": "https://service-manager.cfapps.eu10.hana.ondemand.com"
 }

    The example of the binding object with the specified X.509 credentials type:

    {
     "clientid": "xxxxxxx",
     "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----..-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----\n",
     "key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----\n",
     "certurl": "https://mysubaccount.authentication.cert.eu10.hana.ondemand.com",
     "xsappname": "b15166|service-manager!b1234",
     "sm_url": "https://service-manager.cfapps.eu10.hana.ondemand.com"
 }

  3. Add SAP BTP service operator chart repository

     helm repo add sap-btp-operator https://sap.github.io/sap-btp-service-operator

  4. Deploy the the SAP BTP service operator in the cluster using the obtained access credentials:

    Note:
    If you are deploying the SAP BTP service operator in the registered cluster based on the Service Catalog (svcat) and Service Manager agent so that you can migrate svcat-based content to service operator-based content, add --set cluster.id=<clusterID> to your deployment script.
    For more information, see the step 2 of the Setup section of Migration to SAP BTP service operator.

    The example of the deployment that uses the default access credentials type:

    helm upgrade --install <release-name> sap-btp-operator/sap-btp-operator \
    --create-namespace \
    --namespace=sap-btp-operator \
    --set manager.secret.clientid=<clientid> \
    --set manager.secret.clientsecret=<clientsecret> \
    --set manager.secret.sm_url=<sm_url> \
    --set manager.secret.tokenurl=<url>

    The example of the deployment that uses the X.509 access credentials type:

    helm upgrade --install <release-name> sap-btp-operator/sap-btp-operator \
    --create-namespace \
    --namespace=sap-btp-operator \
    --set manager.secret.clientid=<clientid> \
    --set manager.secret.tls.crt="$(cat /path/to/cert)" \
    --set manager.secret.tls.key="$(cat /path/to/key)" \
    --set manager.secret.sm_url=<sm_url> \
    --set manager.secret.tokenurl=<certurl>

Note:
In order to rotate the credentials between the BTP service operator and Service Manager, you have to create a new binding for the service-operator-access service instance, and then to execute the setup script again, with the new set of credentials. Afterwards you can delete the old binding.

Back to top.

Versions

Review the supported Kubernetes API versions for the following SAP BTP Service Operator versions.

Operator version Kubernetes API version
v0.2 or later v1
v0.1 v1alpha1

Using the SAP BTP Service Operator

Step 1: Create a service instance

  1. To create an instance of a service offered by SAP BTP, first create a ServiceInstance custom-resource file:
    apiVersion: services.cloud.sap.com/v1
    kind: ServiceInstance
    metadata:
        name: my-service-instance
    spec:
        serviceOfferingName: sample-service
        servicePlanName: sample-plan
        externalName: my-service-btp-name
        parameters:
          key1: val1
          key2: val2

  • <offering> - The name of the SAP BTP service that you want to create. To learn more about viewing and managing the available services for your subaccount in the SAP BTP cockpit, see Service Marketplace.

    Tip: Use the Environment filter to get all offerings that are relevant for Kubernetes.

  • <plan> - The plan of the selected service offering that you want to create.

  1. Apply the custom-resource file in your cluster to create the instance.

    kubectl apply -f path/to/my-service-instance.yaml

  2. Check that the status of the service in your cluster is Created.

    kubectl get serviceinstances
NAME                  OFFERING          PLAN        STATUS    AGE
my-service-instance   <offering>        <plan>      Created   44s

Back to top

Step 2: Create a Service Binding

  1. To get access credentials to your service instance and make it available in the cluster so that your applications can use it, create a ServiceBinding custom resource, and set the serviceInstanceName field to the name of the ServiceInstance resource you created.

    The credentials are stored in a secret created in your cluster.

apiVersion: services.cloud.sap.com/v1
kind: ServiceBinding
metadata:
  name: my-binding
spec:
  serviceInstanceName: my-service-instance
  externalName: my-binding-external
  secretName: my-secret
  parameters:
    key1: val1
    key2: val2

  1. Apply the custom resource file in your cluster to create the binding.

    kubectl apply -f path/to/my-binding.yaml

  2. Check that your binding status is Created.

    kubectl get servicebindings
NAME         INSTANCE              STATUS    AGE
my-binding   my-service-instance   Created   16s

  3. Check that a secret with the same name as the name of your binding is created. The secret contains the service credentials that apps in your cluster can use to access the service.

    kubectl get secrets
NAME         TYPE     DATA   AGE
my-binding   Opaque   5      32s

    See Using Secrets to learn about different options on how to use the credentials from your application running in the Kubernetes cluster,

Back to top

Reference Documentation

Service Instance

Spec

Parameter Type Description
serviceOfferingName* string The name of the SAP BTP service offering.
servicePlanName* string The plan to use for the service instance.
servicePlanID string The plan ID in case service offering and plan name are ambiguous.
externalName string The name for the service instance in SAP BTP, defaults to the instance metadata.name if not specified.
parameters []object Some services support the provisioning of additional configuration parameters during the instance creation.
For the list of supported parameters, check the documentation of the particular service offering.
parametersFrom []object List of sources to populate parameters.
customTags []string List of custom tags describing the ServiceInstance, will be copied to ServiceBinding secret in the key called tags.
userInfo object Contains information about the user that last modified this service instance.
shared *bool The shared state. Possible values: true, false, or nil (value was not specified, counts as "false").

Status

Parameter Type Description
instanceID string The service instance ID in SAP Service Manager service.
operationURL string The URL of the current operation performed on the service instance.
operationType string The type of the current operation. Possible values are CREATE, UPDATE, or DELETE.
conditions []condition An array of conditions describing the status of the service instance.
The possible condition types are:
- Ready: set to true if the instance is ready and usable
- Failed: set to true when an operation on the service instance fails.
In the case of failure, the details about the error are available in the condition message.
- Succeeded: set to true when an operation on the service instance succeeded. In case of false operation considered as in progress unless Failed condition exists.
- Shared: set to true when sharing of the service instance succeeded. set to false when unsharing of the service instance succeeded or when service instance is not shared.
tags []string Tags describing the ServiceInstance as provided in service catalog, will be copied to ServiceBinding secret in the key called tags.

Anotations

Parameter Type Description
services.cloud.sap.com/preventDeletion map[string] string You can prevent deletion of any service instance by adding the following annotation: services.cloud.sap.com/preventDeletion : "true". To enable back the deletion of the instance, either remove the annotation or set it to false.

Service Binding

Spec

Parameter Type Description
serviceInstanceName* string The Kubernetes name of the service instance to bind, should be in the namespace of the binding.
externalName string The name for the service binding in SAP BTP, defaults to the binding metadata.name if not specified.
secretName string The name of the secret where the credentials are stored, defaults to the binding metadata.name if not specified.
secretKey string The secret key is a part of the Secret object, which stores service binding data (credentials) received from the broker. When the secret key is used, all the credentials are stored under a single key. This makes it a convenient way to store credentials data in one file when using volumeMounts. Example
secretRootKey string The root key is a part of the Secret object, which stores service binding data (credentials) received from the broker, as well as additional service instance information. When the root key is used, all data is stored under a single key. This makes it a convenient way to store data in one file when using volumeMounts. Example
parameters []object Some services support the provisioning of additional configuration parameters during the bind request.
For the list of supported parameters, check the documentation of the particular service offering.
parametersFrom []object List of sources to populate parameters.
secretTemplate string A Go template that generates a custom Kubernetes v1/Secret based on the data of the service binding returned by Service Manager. The generated secret is used instead of the default secret. This is useful if the consumer of service binding data expects them in a specific format.
Also see Creating Custom Secrets from Templates below.
userInfo object Contains information about the user that last modified this service binding.
credentialsRotationPolicy object Holds automatic credentials rotation configuration.
credentialsRotationPolicy.enabled boolean Indicates whether automatic credentials rotation are enabled.
credentialsRotationPolicy.rotationFrequency duration Specifies the frequency at which the binding rotation is performed.
credentialsRotationPolicy.rotatedBindingTTL duration Specifies the time period for which to keep the rotated binding.

Status

Parameter Type Description
instanceID string The ID of the bound instance in the SAP Service Manager service.
bindingID string The service binding ID in SAP Service Manager service.
operationURL string The URL of the current operation performed on the service binding.
operationType string The type of the current operation. Possible values are CREATE, UPDATE, or DELETE.
conditions []condition An array of conditions describing the status of the service instance.
The possible conditions types are:
- Ready: set to true if the binding is ready and usable
- Failed: set to true when an operation on the service binding fails.
In the case of failure, the details about the error are available in the condition message.
- Succeeded: set to true when an operation on the service binding succeeded. In case of false operation considered as in progress unless Failed condition exists.
lastCredentialsRotationTime time Indicates the last time the binding secret was rotated.

Back to top

Passing Parameters

To set input parameters, you may use the parameters and parametersFrom fields in the spec field of the ServiceInstance or ServiceBinding resource:

  • parameters : can be used to specify a set of properties to be sent to the broker. The data specified will be passed "as-is" to the broker without any modifications - aside from converting it to JSON for transmission to the broker in the case of the spec field being specified as YAML. Any valid YAML or JSON constructs are supported. Only one parameters field may be specified per spec.
  • parametersFrom : can be used to specify which secret, and key in that secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker. The parametersFrom field is a list which supports multiple sources referenced per spec.

You may use either, or both, of these fields as needed.

If multiple sources in parameters and parametersFrom blocks are specified, the final payload is a result of merging all of them at the top level. If there are any duplicate properties defined at the top level, the specification is considered to be invalid, the further processing of the ServiceInstance/ServiceBinding resource stops and its status is marked with error condition.

The format of the spec in YAML

spec:
  ...
  parameters:
    name: value
  parametersFrom:
    - secretKeyRef:
        name: my-secret
        key: secret-parameter

The format of the spec in JSON

"spec": {
  "parameters": {
    "name": "value"
  },
  "parametersFrom": {
    "secretKeyRef": {
      "name": "my-secret",
      "key": "secret-parameter"
    }
  }
}

The secret with the secret-parameter- named key:

apiVersion: v1
kind: Secret
metadata:
  name: my-secret
type: Opaque
stringData:
  secret-parameter:
    '{
      "password": "letmein"
    }'

The final JSON payload to send to the broker:

{
  "name": "value",
  "password": "letmein"
}

You can list multiple parameters in the secret. To do so, separate "key": "value" pairs with commas as in this example:

secret-parameter:
  '{
    "password": "letmein",
    "key2": "value2",
    "key3": "value3"
  }'

Back to top.

Creating Custom Secrets from Templates

The Kubernetes secrets created by SAP BTP Service Operator for service bindings have a fixed content structure. This structure might not be suitable for any application.

To provide service binding data in arbitrarily structured Kubernetes secrets, a Go template can be specified in field spec.secretTemplate of a ServiceBinding object.

Once SAP BTP Service Operator has received a service binding from Service Manager, it executes the template with the data of the service binding to generate a Kubernetes v1/Secret object.

The template can use the following data:

Reference Description
.smBindingCredentials The binding credentials object returned by Service Manager. The content depends on the service.
.serviceInstanceInfos An object with data about the corresponding service instance (see below)
.serviceInstanceInfos.instance_name The service instance name.
.serviceInstanceInfos.instance_guid The service instance UID.
.serviceInstanceInfos.plan The service plan name.
.serviceInstanceInfos.label The service offering name.
.serviceInstanceInfos.type The service offering name.
.serviceInstanceInfos.tag The combination of tags under ServiceInstance.Spec.CustomTags and ServiceInstance.Status.Tags in JSON format.

Sprig template functions are also available, except of the following:

  • bcrypt
  • buildCustomCert
  • decryptAES
  • derivePassword
  • encryptAES
  • env
  • expandenv
  • genCA
  • genCAWithKey
  • genPrivateKey
  • genSelfSignedCert
  • genSelfSignedCertWithKey
  • genSignedCert
  • genSignedCertWithKey
  • getHostByName
  • htpasswd
  • osBase
  • osClean
  • osDir
  • osExt
  • osIsAbs
  • randBytes

Example

apiVersion: services.cloud.sap.com/v1
kind: ServiceBinding
...
spec:
  ...
  secretName: myapp-foo-access
  secretTemplate: |-
    apiVersion: v1
    kind: Secret
    metadata:
      labels:
        app: my-app
    stringData:
      FOO_USERNAME: {{ .smBindingCredentials.username | squote }}
      FOO_PASSWORD: {{ .smBindingCredentials.password | squote }}

.smBindingCredentials may look like this:

{
  "username": "foo-user1",
  "password": "topsecret"
}

The secret generated by the template and completed by SAP BTP Service Operator looks like this:

apiVersion: v1
kind: Secret
metadata:
  name: myapp-foo-access
  labels:
    app: my-app
  ...
stringData:
  USERNAME: 'foo-user1'
  PASSWORD: 'topsecret'

Limitations

Metadata Section

Secret manifests generated by templates must not contain any metadata fields except:

  • labels
  • annotations

If any other metadata field is found, an error occurs and the secret is not stored in Kubernetes.

The name of a secret must be defined using field spec.secretName (see above).

Manifest Size

The size of a manifest generated from a secret template must not exceed 1 MiB. If this limit is exceeded, an error occurs and the secret is not stored in Kubernetes.

Managing Access

By default, the SAP BTP operator has cluster-wide permissions.
You can also limit them to one or more namespaces; for this, you need to set the following two helm parameters:

--set manager.allow_cluster_access=false
--set manager.allowed_namespaces={namespace1, namespace2..}

Note:
If allow_cluster_access is set to true, then allowed_namespaces parameter is ignored.

SAP BTP kubectl Plugin (Experimental)

The SAP BTP kubectl plugin extends kubectl with commands for getting the available services in your SAP BTP account by using the access credentials stored in the cluster.

Prerequisites

Limitations

  • The SAP BTP kubectl plugin is currently based on bash. If you're using Windows, you should utilize the SAP BTP plugin commands from a linux shell (e.g. Cygwin).

Installation

  • Download https://github.com/SAP/sap-btp-service-operator/releases/download/<release>/kubectl-sapbtp
  • Move the executable file to any location in your PATH

The list of available releases: sapbtp-operator releases

Usage

kubectl sapbtp marketplace -n <namespace>
kubectl sapbtp plans -n <namespace>
kubectl sapbtp services -n <namespace>

Use the namespace parameter to specify the location of the secret containing the SAP BTP access credentials. Usually it is the namespace in which you installed the operator. If not specified, the default namespace is used.

Back to top.

Credentials Rotation

To enable automatic credentials rotation, you need to set the following parameters of the credentialsRotationPolicy field in the spec field of the ServiceBinding resource:

  • enabled - Whether the credentials rotation option is enabled. Default value is false.
  • rotationFrequency - Indicates the frequency at which the credentials rotation is performed.
  • rotatedBindingTTL - Indicates for how long to keep the rotated ServiceBinding.

Valid time units for rotationFrequency and rotatedBindingTTL are: "ns", "us" or ("µs"), "ms", "s", "m", "h".

status.lastCredentialsRotationTime indicates the last time the ServiceBinding secret was rotated.
Please note that credentialsRotationPolicy evaluated and executed during control loop which runs on every update or during full reconciliation process.

During the transition period, there are two (or more) ServiceBinding: the original and the rotated one (holds the services.cloud.sap.com/stale label), which is deleted once the rotatedBindingTTL duration elapses.

You can also choose the services.cloud.sap.com/forceRotate annotation (value doesn't matter), upon which immediate credentials rotation is performed. Note that the prerequisite for the force action is that credentials rotation enabled field is set to true.).

Note:
It isn't possible to enable automatic credentials rotation to an already-rotated ServiceBinding (with the services.cloud.sap.com/stale label).

Back to top

Multitenancy

You can configure the SAP BTP service operator to work with more than one subaccount in the same Kubernetes cluster. This means that different namespaces can be connected to different subaccounts. The association between a namespace and a subaccount is based on a different set of credentials configured for different namespaces.

To connect the namespace to a subaccount, you first have to obtain the access credentials for the SAP BTP service operator and then maintain them in a secret that is specific for that namespace.

There are two options to maintain namespace-specific credentials, and they differ between default and TLS-based access credentials types:

Default Access Credentials

  • Define a secret named sap-btp-service-operator in the namespace. ServiceInstance and ServiceBinding that are applied in the namespace will belong to the subaccount from which the credentials were issued.
  • Define different secrets for different namespaces in a centrally managed namespace, following the secret naming convention: <namespace>-sap-btp-service-operator.

Namespace Secret Structure

apiVersion: v1
kind: Secret
metadata:
  name: sap-btp-service-operator
  namespace: <namespace>
type: Opaque
data:
  clientid: "<clientid>"
  clientsecret: "<clientsecret>"
  sm_url: "<sm_url>"
  tokenurl: "<auth_url>"
  tokenurlsuffix: "/oauth/token"

TLS-Based Access Credentials

  • Define a secret pair named sap-btp-service-operator and sap-btp-service-operator-tls in the namespace. ServiceInstance and ServiceBinding that are applied in the namespace will belong to the subaccount from which the credentials were issued.
  • Define different secrets for different namespaces in a centrally managed namespace, following the secret naming convention: <namespace>-sap-btp-service-operator and <namespace>-sap-btp-service-operator-tls. For more information, see tls secret.

Namespace Secrets Structure

apiVersion: v1
kind: Secret
metadata:
  name: sap-btp-service-operator
  namespace: <namespace>
type: Opaque
data:
  clientid: "<clientid>"
  sm_url: "<sm_url>"
  tokenurl: "<auth_url>"
  tokenurlsuffix: "/oauth/token"
apiVersion: v1
kind: Secret
metadata:
  name: sap-btp-service-operator-tls
  namespace: <namespace>
type: kubernetes.io/tls
data:
  tls.crt: <crt> #base64 encoded
  tls.key: <key> #base64 encoded

Notes:

  • If none of the those mentioned above options are set, sap-btp-service-operator secret of a release namespace is used.
    See step 4 of the Setup section.

Back to top

Troubleshooting and Support

Cannot Create a Service Binding for Service Instance in Delete Failed State

The deletion of my service instance failed. To fix the failure, I have to create a service binding, but I can't do this because the instance is in the Delete Failed state.

Solution

To overcome this issue, use the force_k8s_binding query param when you create a service binding and set it to true (force_k8s_binding=true). You can do & this either with the Service Manager Control CLI (smctl) bind command or 'Create a Service Binding' Service Manager API.

smctl Example

smctl bind INSTANCE_NAME BINDING_NAME --param force_k8s_binding=true

Once you've finished working on the service instance, delete it by running the following command: 
smctl unbind INSTANCE_NAME BINDING_NAME --param force_k8s_binding=true

Note: force_k8s_binding is supported only for the Kubernetes instances that are in Delete Failed state.

You're welcome to raise issues related to feature requests, bugs, or give us general feedback on this project's GitHub Issues page. The SAP BTP service operator project maintainers will respond to the best of their abilities.

Back to top

Formats of Secret Objects

Key- Value Pairs (Default)

The binding object includes credentials returned from the broker and service instance info presented as key-value pairs.

#Credentials
uri: https://my-service.authentication.eu10.hana.ondemand.com
username: admin
password: ********

#Service instance info
instance_guid: <instance_guid> // The service instance ID
instance_name: my-service-btp-name // Taken from the service instance external_name field if set. Otherwise from metadata.name
plan: sample-plan // The service plan name
type: sample-service  // The service offering name

Credentials as JSON Object

To show credentials returned from the broker as a JSON object, use the 'secretKey' attribute in the service binding spec.

The value of 'secretKey' is the name of the key that stores the credentials in JSON format.

#Credentials
your-secretKey-value:
{
  uri: https://my-service.authentication.eu10.hana.ondemand.com
  username: admin
  password: ********
}

#Service Instance info
instance_guid: <instance_guid> // The service instance ID
instance_name: my-service-btp-name // Taken from the service instance external_name field if set. Otherwise from metadata.name
plan: sample-plan // The service plan name
type: sample-service // The service offering name

Credentials and Service Info as One JSON Object

To show both credentials returned from the broker and service instance info as a JSON object, use the 'secretRootKey' attribute in the service binding spec.

The value of 'secretRootKey' is the name of the key that stores both credentials and serivce instance info in JSON format.

your-secretRootKey-value:
{
    #Credentials
    uri: https://my-service.authentication.eu10.hana.ondemand.com
    username: admin
    password: ********

    #Service Instance info
    instance_guid: <instance_guid> // The service instance id
    instance_name: my-service-btp-name // Taken from the service instance external_name field if set. Otherwise from metadata.name
    plan: sample-plan // The service plan name
    type: sample-service // The service offering name
}

Back to top

Uninstalling the Operator

Before you uninstall the operator, we recommend you manually delete all associated service instances and bindings. This way, you'll ensure all data stored with service instances and bindings are properly taken care of. Instances and bindings that were not manually deleted will be automatically deleted once you start the uninstallation process.

To uninstall the operator, run the following command: helm uninstall <release name> -n <name space>

Example:

helm uninstall sap-btp-operator -n sap-btp-operator

Responses

  • release <release name> uninstalled - The operator has been successfully uninstalled

  • Timed out waiting for condition

    • What happened?

      The deletion of instances and bindings takes more than 5 minutes, this happens when there is a large number of instances and bindings.

    • What to do:

      Wait for the job to finish and re-trigger the uninstall process. To check the job status, run kubectl get jobs --namespace=<name space> or log on to the cluster and check the job log. Note that you may have to repeat this step several times untill the un-install process has been successfully completed.

  • job failed: BackoffLimitExceeded

    • What happened?

      One of the service instances or bindings could not be deleted.

    • What to do:

      First find the service instance or binding in question and fix it, then re-trigger the uninstalation.

      To find it, log on to the cluster and check the pre-delete job, or check the logs by running the following two commands:

      • kubectl get pods --all-namespaces| grep pre-delete - which gives you the list of all namespaces and jobs
      • kubectl logs <job_name> --namespace=<name_space_name> - where you specify the desired job and namespace

      Note that the pre-delete job is only visible for approximately one minute after the job execution is completed.   If you don't have an access to the pre-delete job, use kubectl to view details about the failed resource and check its status by running:

      • kubectl describe <resource_type> <resource_name>

      Check for resources with the deletion timestamp to determine if it tried to be deleted.

Contributions

We currently do not accept community contributions.

License

This project is licensed under Apache 2.0 unless noted otherwise in the license file.

Back to top

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages