Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #88

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Update README.md #88

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9c15738
Update README.md
Jan 14, 2021
5c48801
Update README.md
Jan 14, 2021
9abe6ab
Merge branch 'master' into i522006-patch-1
pavelmaliy Jan 28, 2021
de45dfd
Update README.md
Jan 31, 2021
528c1df
Update README.md
Feb 8, 2021
1764759
Update README.md
Feb 15, 2021
0baa8e0
Update README.md
Feb 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 52 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,50 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/sm-operator/sapcp-operator/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/sm-operator/sapcp-operator)](https://goreportcard.com/report/github.com/sm-operator/sapcp-operator)

# SAP Cloud Platform Service Operator
# SAP Business Technology Platform (SAP BTP) Service Operator


With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP services to your Kubernetes cluster in a Kubernetes-native way. The SAP CP Service Operator is based on the [Kubernetes custom resource definition (CRD) API](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) so that your applications can create, update, and delete SAP CP services from within the cluster by calling Kubnernetes APIs.
With the SAP BTP Operator, you can manage SAP BTP services from your Kubernetes cluster in a Kubernetes-native way. The SAP BTP Service Operator is based on the [Kubernetes custom resource definition (CRD) API](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) so that your applications can use the CRUD operations in regards to SAP BTP services from within the cluster by calling the Kubernetes APIs.

## Table of content
## Table of Content
* [Prerequisites](#prerequisites)
* [Setup Operator](#setup)
* [Setting Up Operator](#setting-up-operator)
* [Local Setup](#local-setup)
* [SAP CP kubectl extension](#sapcp-kubectl-extension-experimental)
* [Using the SAP CP Service Operator](#using-the-sapcp-operator)
* [Creating a service instance](#step-1-creating-a-service-instance)
* [Binding the service instance](#step-2-binding-the-service-instance)
* [Reference documentation](#reference-documentation)
* [Service instance properties](#service-instance-properties)
* [Binding properties](#binding-properties)
* [SAP CP kubectl Extension](#sap-cp-kubectl-extension-experimental)
* [Using the SAP BTP Service Operator](#using-the-sap-btp-service-operator)
* [Creating a Service Instance](#step-1-creating-a-service-instance)
* [Binding a Service Instance](#step-2-binding-a-service-instance)
* [Reference Documentation](#reference-documentation)
* [Service Instance Properties](#service-instance-properties)
* [Service Binding Properties](#service-binding-properties)

## Prerequisites
- SAP Cloud Platform [Global Account](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/d61c2819034b48e68145c45c36acba6e.html) and [Subaccount](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/55d0b6d8b96846b8ae93b85194df0944.html)
- SAP BTP [Global Account](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/d61c2819034b48e68145c45c36acba6e.html) and [Subaccount](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/55d0b6d8b96846b8ae93b85194df0944.html)
- [Kubernetes cluster](https://kubernetes.io/) running version 1.17 or higher
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) v1.17 or higher
- [helm](https://helm.sh/) v3.0 or higher

[Back to top](#sapcp-operator)

## Setup
## Setting Up Operator
1. Install [cert-manager](https://cert-manager.io/docs/installation/kubernetes)

1. Obtain access credentials for the SAP CP Service Operator:
1. Using SAP CP Cockpit or CLI, create an instance of the Service Management (`service-manager`) service, plan `service-operator-access`
1. Obtain access credentials for the SAP BTP Service Operator:
1. Using SAP BTP Cockpit or CLI, create an instance of the SAP Cloud Service Management service (`service-manager`) service, with the plan `service-operator-access`.

More information about creating service instances is available here:
[Cockpit](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/bf71f6a7b7754dbd9dfc2569791ccc96.html),
[CLI](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/b327b66b711746b085ec5d2ea16e608e.html)
[CLI](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/b327b66b711746b085ec5d2ea16e608e.html).

1. Create a binding to the created service instance
1. Create a binding to the created service instance.

More information about creating service bindings is available here:
[Cockpit](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/bf71f6a7b7754dbd9dfc2569791ccc96.html),
[CLI](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/f53ff2634e0a46d6bfc72ec075418dcd.html)
[CLI](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/f53ff2634e0a46d6bfc72ec075418dcd.html).

1. Retrieve the generated access credentials from the created binding.

The generated access credentials will available in the created binding, for example:
Example:
```json
{
"clientid": "xxxxxxx",
Expand All @@ -57,7 +57,7 @@ With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP
}
```

1. Deploy the sapcp-service-operator in the cluster using the obtained access credentials:
1. Deploy the sapcp-service-operator in the Kubernetes cluster using the obtained access credentials:
```bash
helm upgrade --install sapcp-operator https://github.com/sm-operator/sapcp-operator/releases/download/<release>/sapcp-operator-<release>.tgz \
--create-namespace \
Expand All @@ -72,11 +72,11 @@ With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP

[Back to top](#sapcp-operator)

## Using the SAP CP Service Operator
## Using the SAP BTP Service Operator

#### Step 1: Create a service instance
#### Step 1: Creating a Service Instance

1. To create an instance of a SAP CP service, first create a `ServiceInstance` custom resource file:
1. To create an instance of an SAP BTP service, first create a `ServiceInstance` custom resource file:

```yaml
apiVersion: services.cloud.sap.com/v1alpha1
Expand All @@ -88,9 +88,9 @@ With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP
servicePlanName: <plan>
```

* `<offering>` is the name of the SAP CP service that you want to create.
You can find the list of available services in the SAP CP Cockpit, see [Service Marketplace](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/55b31ea23c474f6ba2f64ee4848ab1b3.html).
* `<plan>` is the plan of the selected service offering that you want to create.
* `<offering>` is the name of the SAP BTP service that you are creating.
You can find [the list of the available services](https://help.sap.com/viewer/09cc82baadc542a688176dce601398de/Cloud/en-US/55b31ea23c474f6ba2f64ee4848ab1b3.html) in the SAP CP Cockpit.
* `<plan>` is the plan of the selected service offering that you are creating.

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

Expand All @@ -109,7 +109,7 @@ With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP
```
[Back to top](#sapcp-operator)

#### Step 2: Create a Service Binding
#### Step 2: Binding a Service Instance

1. To get access credentials to your service instance and make them 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.

Expand Down Expand Up @@ -137,80 +137,80 @@ With the SAP Cloud Platform (SAP CP) Operator, you can provision and bind SAP CP

```

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

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

See [Using Secrets](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets) for the different options to use the credentials from your application running in the Kubernetes cluster,
See [Using Secrets](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets) for the different options to use the credentials for your application running in the Kubernetes cluster,

[Back to top](#sapcp-operator)

## Reference documentation
## Reference Documentation

### Service Instance
### Service Instance Properties
#### Spec
| Property | Type | Comments |
|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------|
| serviceOfferingName`*` | `string` | The SAP CP service offering name |
| serviceOfferingName`*` | `string` | The name of the SAP Business Technology Platform (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 CP, defaults to the binding `metadata.name` if not specified |
| servicePlanID | `string` | The plan ID in case service offering and plan names are ambiguous |
| externalName | `string` | The name of the service instance in SAP BTP, defaults to the binding `metadata.name` if not specified |
| parameters | `[]object` | Provisioning parameters for the instance, check the documentation of the specific service you are using for details |

#### Status
| Property | Type | Comments |
|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------|
| instanceID | `string` | The service instance ID in SAP CP Service Management |
| operationURL | `string` | URL of ongoing operation for the service instance |
| operationType | `string` | The operation type (CREATE/UPDATE/DELETE) for ongoing operation |
| conditions | `[]condition` | An array of conditions describing the status of the service instance. <br>The possible conditions types are:<br>- `Ready`: set to `true` if the instance is ready and usable<br>- `Failed`: set to `true` when an operation on the service instance fails, in this case the error details will be available in the condition message
| instanceID | `string` | The service instance ID in SAP Cloud Service Management service |
| operationURL | `string` | URL of the ongoing operation for the service instance |
| operationType | `string` | The operation type (CREATE/UPDATE/DELETE) of the ongoing operation |
| conditions | `[]condition` | An array of conditions describing the status of the service instance. <br>The possible conditions types are:<br>- `Ready`: set to `true` if the instance is ready and usable<br>- `Failed`: set to `true` when an operation on the service instance fails, in this case the error details are available in the condition message



### Service Binding
### Service Binding Properties
#### Spec
| Parameter | Type | Comments |
|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------|
| 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 CP Service Management, defaults to the binding `metadata.name` if not specified |
| secretName | `string` | The name of the secret where credentials will be stored, defaults to the binding `metadata.name` if not specified |
| externalName | `string` | The name of the service binding in SAP Cloud Service Management service, defaults to the binding `metadata.name` if not specified |
| secretName | `string` | The name of the secret where credentials are stored, defaults to the binding `metadata.name` if not specified |
| parameters | `[]object` | Parameters for the binding |

#### Status
| Property | Type | Comments |
|:-----------------|:---------|:-----------------------------------------------------------------------------------------------------------|
| instanceID | `string` | The ID of the bound instance in SAP CP Service Management |
| bindingID | `string` | The service binding ID in SAP CP Service Management |
| operationURL | `string` | URL of ongoing operation for the service binding |
| operationType | `string` | The operation type (CREATE/UPDATE/DELETE) for ongoing operation |
| instanceID | `string` | The ID of the bound instance in the SAP Cloud Service Management service |
| bindingID | `string` | The ID of the service binding in SAP Cloud Service Management service |
| operationURL | `string` | URL of the ongoing operation for the service binding |
| operationType | `string` | The operation type (CREATE/UPDATE/DELETE) of the ongoing operation |
| conditions | `[]condition` | An array of conditions describing the status of the service instance. <br>The possible conditions types are:<br>- `Ready`: set to `true` if the binding is ready and usable<br>- `Failed`: set to `true` when an operation on the service binding fails, in this case the error details will be available in the condition message

[Back to top](#sapcp-operator)

## Support
Feel free to open new issues for feature requests, bugs or general feedback on the GitHub issues page of this project.
The SAP CP Service Operator project maintainers will respond to the best of their abilities.
Feel free to open new issues for feature requests, bugs, or 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 CP kubectl Plugin (Experimental)
The SAP CP kubectl plugin extends kubectl with commands for getting the available services in your SAP CP account,
## SAP CP kubectl Extension (Experimental)
The SAP BTP kubectl plugin extends kubectl with commands for getting the available services in your SAP BTP account,
using the access credentials stored in the cluster.

### Prerequisites
- [jq](https://stedolan.github.io/jq/)

### Limitations
- The SAP CP kubectl plugin is currently based on `bash`. If using Windows, you should use the SAP CP plugin commands from a linux shell (e.g. [Cygwin](https://www.cygwin.com/)).
- The SAP BTP kubectl plugin is currently based on `bash`. If using Windows, you should use the SAP BTP plugin commands from a Linux shell (e.g. [Cygwin](https://www.cygwin.com/)).

### Installation
- Download https://github.com/sm-operator/sapcp-operator/releases/download/${release}/kubectl-sapcp
- Move the executable file to anywhere on your `PATH`
- Move the executable file to any location in your `PATH`

#### Usage
```
Expand All @@ -219,7 +219,7 @@ using the access credentials stored in the cluster.
kubectl sapcp services -n <namespace>
```

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


Expand Down