zhongwei/gh-secondsky-sap-skills-skills-sap-btp-service-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
gh-secondsky-sap-skills-ski…/references/service-catalog-legacy.md
Zhongwei Li 0e7a2dc56e Initial commit
2025-11-30 08:55:15 +08:00

8.2 KiB
Raw Permalink Blame History

Service Catalog (svcat) and Broker Proxy Reference

Legacy Kubernetes integration using Service Catalog and Service Manager Broker Proxy.

Note: For new installations, prefer the SAP BTP Service Operator. See kubernetes-operator.md.

Documentation: https://github.com/SAP-docs/sap-btp-service-manager/tree/main/docs/Service-Consumption/Consuming-SAP-BTP-Services-from-Various-Environments

Table of Contents

  1. Overview
  2. Prerequisites
  3. Installation
  4. Usage
  5. Migration to Service Operator
  6. Troubleshooting
  7. Deprecation Notice

Overview

Before the SAP BTP Service Operator, Kubernetes clusters used:

  1. Service Catalog (svcat) - Kubernetes SIG project for service management
  2. Service Manager Broker Proxy - Connects Service Catalog to SAP Service Manager

This approach is now deprecated in favor of the SAP BTP Service Operator.

Prerequisites

  • Kubernetes cluster with kubeconfig
  • kubectl v1.17.4+ compatible
  • Helm v3.x
  • SMCTL CLI installed and logged in
  • SAP Service Manager subscription

Cluster Configuration

Step 1: Register the Cluster as a Platform

# Register Kubernetes cluster with Service Manager
smctl register-platform <platform-name> kubernetes

# Note: Platform name must be unique within the region
# Returns credentials (username/password) needed for broker proxy

Save the returned credentials - they are needed for the broker proxy installation.

Step 2: Install Service Catalog

# Add Service Catalog Helm repository
helm repo add svc-cat [https://svc-catalog-charts.storage.googleapis.com](https://svc-catalog-charts.storage.googleapis.com)

# Create catalog namespace
kubectl create namespace catalog

# Install Service Catalog
helm install catalog svc-cat/catalog --namespace catalog

Version Note: svcat v0.3.0 is required for compatibility with Kubernetes v1.17.4+.

Verify Installation:

kubectl get pods -n catalog

Step 3: Install Service Manager Broker Proxy

# Add Peripli Helm repository
helm repo add peripli [https://peripli.github.io](https://peripli.github.io)

# Create namespace
kubectl create namespace service-broker-proxy

# Install broker proxy
helm install service-broker-proxy peripli/service-broker-proxy \
  --namespace service-broker-proxy \
  --version 0.7.0 \
  --set config.sm.url=[https://service-manager.cfapps.<region>.hana.ondemand.com](https://service-manager.cfapps.<region>.hana.ondemand.com) \
  --set sm.user=<username-from-step-1> \
  --set sm.password=<password-from-step-1>

SM_URL Format: [https://service-manager.cfapps.<landscape](https://service-manager.cfapps.<landscape) domain>

Regional Examples:

Service Catalog CLI (svcat)

Installation

Mac OS:

# Download binary
curl -sLO [https://download.svcat.sh/cli/latest/darwin/amd64/svcat](https://download.svcat.sh/cli/latest/darwin/amd64/svcat)

# Make executable
chmod +x ./svcat

# Move to PATH
sudo mv ./svcat /usr/local/bin/

# Verify
svcat version --client

Windows:

# Download executable
iwr [https://download.svcat.sh/cli/latest/windows/amd64/svcat.exe](https://download.svcat.sh/cli/latest/windows/amd64/svcat.exe) -o svcat.exe

# Create bin directory
mkdir ~\bin

# Move executable
Move-Item svcat.exe ~\bin\

# Add to PATH (PowerShell profile)
$env:PATH += ";$HOME\bin"

# Verify
svcat version --client

Reference: https://svc-cat.io/docs/install/#installing-the-service-catalog-cli

svcat Commands

Browse Marketplace

# List all available services
svcat marketplace

# Short form
svcat mp

Provision Service Instance

# Create service instance
svcat provision <instance-name> --class <service-name> --plan <plan-name>

# Example: Create XSUAA instance
svcat provision my-xsuaa --class xsuaa --plan application

# With parameters
svcat provision my-hana --class hana --plan hdi-shared \
  --param database_id=<hana-db-guid>

List Instances

# List all provisioned instances
svcat get instances

Deprovision Service Instance

# Delete service instance
svcat deprovision <instance-name>

Create Binding

# Create binding for instance
svcat bind <instance-name>

# With specific binding name
svcat bind <instance-name> --name <binding-name>

List Bindings

# List all bindings
svcat get bindings

Delete Binding

# Remove binding
svcat unbind <instance-name> --name <binding-name>

Get Credentials

# View binding credentials (stored in Kubernetes secret)
kubectl get secret <binding-name> -o yaml

Migration to SAP BTP Service Operator

Important: Service Catalog is deprecated. Migrate to SAP BTP Service Operator.

See kubernetes-operator.md for:

  • SAP BTP Service Operator setup
  • Migration procedure from svcat
  • ServiceInstance and ServiceBinding CRDs

Quick Migration Overview

  1. Install SAP BTP Service Operator (see kubernetes-operator.md)
  2. Install migration CLI tool
  3. Prepare platform: smctl curl -X PATCH "/v1/platforms/<platformID>" -d '{"credentials":{"rotatable":true}}'
  4. Dry run: btpmigrate --dry-run
  5. Execute: btpmigrate

Warning: Once migration starts, the platform becomes suspended. The process is reversible until actual resource migration begins.

Troubleshooting

Service Catalog Not Finding Services

Check:

  1. Broker proxy running: kubectl get pods -n service-broker-proxy
  2. Service Manager credentials valid
  3. Platform registered: smctl list-platforms

Provisioning Fails

Check:

  1. Service entitled in subaccount
  2. Correct plan name
  3. Broker proxy logs: kubectl logs -n service-broker-proxy deployment/service-broker-proxy

svcat Command Not Found

Solution: Ensure svcat is in PATH:

# Mac/Linux
export PATH=$PATH:/usr/local/bin

# Or reinstall
curl -sLO [https://download.svcat.sh/cli/latest/darwin/amd64/svcat](https://download.svcat.sh/cli/latest/darwin/amd64/svcat)
chmod +x svcat
sudo mv svcat /usr/local/bin/

Documentation Links

Reference in New Issue View Git Blame Copy Permalink