sap-btp-service-operator

README

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.

Note

This feature is still under development, review, and testing.

Table of content

• Prerequisites
• Setup Operator
• SAP BTP kubectl extension
• Using the SAP BTP Service Operator
  • Creating a service instance
  • Binding the service instance
• Reference documentation
  • Service instance properties
  • Binding properties

Prerequisites

• SAP BTP Global Account and Subaccount
• Service Management Control (SMCTL) Command Line Interface. See Using the SMCTL.
• Kubernetes cluster running version 1.17 or higher
• kubectl v1.17 or higher
• helm v3.0 or higher

Back to top

Setup

1. Install cert-manager

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:

   • Configure Entitlements and Quotas for Subaccounts

   
   For more information about creating service instances, see:

   • Creating Service Instances Using the SAP BTP Cockpit

   • Creating Service Instances using SMCTL

   b. Create a binding to the created service instance.

   For more information about creating service bindings, see:

   • Creating Service Bindings Using the SAP BTP Cockpit

   • Creating Service Bindings Using SMCTL.

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

   The example of the credentials in the binding object

    {
        "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"
    }
   

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

   helm upgrade --install sap-btp-operator https://github.com/SAP/sap-btp-service-operator/releases/download/<release>/sap-btp-operator-<release>.tgz \
       --create-namespace \
       --namespace=sap-btp-operator \
       --set manager.secret.clientid=<clientid> \
       --set manager.secret.clientsecret=<clientsecret> \
       --set manager.secret.url=<sm_url> \
       --set manager.secret.tokenurl=<url>
   

   The list of available releases: sapbtp-operator releases

Back to top.

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/v1alpha1
    kind: ServiceInstance
    metadata:
        name: my-service-instance
    spec:
        serviceOfferingName: sample-service
        servicePlanName: sample-plan
        externalName: my-service-instance-external
        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/v1alpha1
  kind: ServiceBinding
  metadata:
      name: my-binding
  spec:
      serviceInstanceName: my-service-instance
      externalName: my-binding-external
      secretName: mySecret
      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.
userInfo	object	Contains information about the user that last modified this service instance.

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.

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.
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.
userInfo	object	Contains information about the user that last modified this service 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.

Back to top

Support

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.

Contributions

We currently do not accept community contributions.

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

• jq

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/v0.1.6/kubectl-sapbtp
• Move the executable file to any location in your PATH

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

Licence

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