btp-manager

README

BTP Manager

Overview

BTP Manager is an operator for the SAP BTP service operator based on the Kubebuilder framework. It extends Kubernetes API by providing BtpOperator CustomResourceDefinition (CRD), which allows you to manage the SAP BTP service operator resource through custom resource (CR).

Installation

To enable the SAP BTP Operator module from the latest release, you must install BTP Manager and the SAP BTP service operator.

Prerequisites

• kubectl
• Kubernetes cluster, or k3d for local installation
• jq

[!WARNING] You also need the kyma-system Namespace. If you don't have it in your cluster, use the following command to create it:

kubectl create namespace kyma-system

Steps

1. To install BTP Manager, use the following commands:

   kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml
   

   TIP: Use the same command to upgrade the module to the latest version.

1. To install the SAP BTP service operator, apply the sample BtpOperator CR:

   kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml
   

2. To check the BtpOperator CR status, run the following command:

   kubectl get btpoperators btpoperator
   

   NOTE: The CR is in the Warning state and the message is Secret resource not found reason: MissingSecret. To create a Secret, follow the instructions in Use BTP Manager to Manage SAP BTP Service Operator.

For more installation options, read the Install and Uninstall BTP Manager document.

Usage

Use BTP Manager to deploy an SAP BTP service in your Kyma cluster. To find out how to do it, read the usage document.

Uninstallation

To uninstall the SAP BTP service operator, run the following commands:

kubectl delete -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml
kubectl delete -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml

Read More

If you want to provide new features for BTP Manager, visit the contributor folder. You will find detailed information on BTP Manager's:

• configuration
• operations
• release pipeline
• GitHub Actions workflows
• unit tests
• E2E tests
• certification management
• informer's cache
• metrics

In the user folder, you will find the following documents:

• SAP BTP Operator Module
• Use BTP Manager to Manage SAP BTP Service Operator
• SAP BTP Service Operator Examples

Contributing

See the Contributing guidelines.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.