Crossplane Provider for SAP BTP

About this project

crossplane-provider-btp is a Crossplane Provider that handles the orchestration of account related resources on SAP Business Technology Platform:

• Subaccount
• User Management
• Entitlements
• Service Manager
• Cloud Management
• Environments

Check the documentation for more detailed information on available capabilities for different kinds.

Requirements and Setup

To install this provider in a kubernetes cluster running crossplane, you can use the provider custom resource, replacing the <version>placeholder with the current version of this provider:

apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-btp
spec:
  package: ghcr.io/sap/crossplane-provider-btp/crossplane/provider-btp:<VERSION>

You should then see the crossplane controller create a deployment for this provider. Once it becomes healthy, you can connect the provider to you BTP global account following the documentation.

Developing

For local development, clone this repo and run make to initialize the "build" Make submodule we use for running, building and testing first.

Running the provider locally requires kind and docker to be installed on the system.

There are two different make commands for local development:

1. make dev creates a kind cluster, installs the CRDs and runs the provider directly.
2. make dev-debug only creates a kind cluster and installs the CRDs. You then run/debug the provider with any tool by using the KUBECONFIG environment variable set to the kind clusters kubeconfig.

For deleting the cluster again, run make dev-clean.

The Crossplane Provider Development guide may be of use to add new types to the controller.

E2E Tests

To run the end2end tests, a technical user within the BTP is necessary for creation of environments (Kyma & CF). .username & .password is necessary for futher actions on CloudFoundryEnvironment.

BTP_TECHNICAL_USER

{
  "email": "email",
  "username": "PuserId",
  "password": "mypass"
}

CIS_CENTRAL_BINDING Contents from the service binding of a cis-central service, like

{
  "endpoints": {
    "accounts_service_url": "...",
    "cloud_automation_url": "...",
    "entitlements_service_url": "...",
    "events_service_url": "...",
    "external_provider_registry_url": "...",
    "metadata_service_url": "...",
    "order_processing_url": "...",
    "provisioning_service_url": "...",
    "saas_registry_service_url": "..."
  },
  "grant_type": "client_credentials",
  "sap.cloud.service": "com.sap.core.commercial.service.central",
  "uaa": {
      …
  }
}

Contains the CLI server URL, for example:

https://cli.btp.cloud.sap/

GLOBAL_ACCOUNT Contains the subdomain of the global account.

IDP_URL Contains the URL of an IDP that can be connected to the global account.

SECOND_DIRECTORY_ADMIN_EMAIL Contains a second email (different from the technical user's email) for the directory admin field.

TECHNICAL_USER_EMAIL Contains the email of the BTP_TECHNICAL_USER.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and crossplane-provider-btp contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.