README.md

OCI Service Broker

• Introduction
• Installation
  • Pre-Requisites
  • Install Service Catalog
  • Install svcat tool
  • Deploy OCI Service Broker
    • Build OCI Service Broker Image from the Source
    • Install service-broker chart
      • OCI credentials
      • Quick Setup
      • Recommended Setup
      • etcd for persistence
      • Enable TLS
      • Recommended Setup Command
  • RBAC
    • RBAC required for OCI Service Broker
    • RBAC Permissions for registering OCI Service Broker
  • Register OCI Service Broker
  • Monitoring OCI Service Broker
    • JMX
• Guidelines for Securing OCI Service Broker
  • Restrict access to Service Catalog resources using RBAC
    • Read-only access
    • Full access
  • TLS enable endpoint
  • Restrict access of the OCI User used by OCI Service Broker
    • OCI User Capabilities
    • Policies to allow access to Services
    • Restrict the permissions only to the required Compartments
  • Limit access to OCI Service Broker endpoint using Networkpolicy
    • Strategy 1-Allow access only for Service Catalog running in the same namespace
    • Strategy 2-Allow access only for Service Catalog from any namespace
    • Strategy 3-Allow access for any pods running in a certain namespace
  • Using secured etcd Cluster
  • Configuring Sensitive values in the Parameters
• Troubleshooting
• Services
  • Object Storage Service
    • Introduction
    • Plans
    • OCI User Permission requirement
    • Service Provision Request Parameters
      • Provisioning a new Object Storage Service Instance
      • Using Existing Object Storage Service Instance
    • Service Binding
      • Request Parameters
      • Response Credentials
    • Example
      • Kubernetes
        • Creating a New Object Storage Instance
        • Using Existing Object Storage Service Instance
        • Binding
  • Autonomous Transaction Processing Service
    • Introduction
    • Plans
    • OCI User Permission requirement
    • Service Provision Request Parameters
      • Provisioning a new ADW Service Instance
      • Using Existing ADW Service Instance
    • Service Binding Request Parameters
    • Service Binding Response Credentials
    • Examples
      • Prerequisite
        • OCI Service Broker
        • Sample files
      • Provisioning
        • Creating an ATP Instance
        • Using Existing ATP Instance
        • Get instance status
      • Binding
        • Creating an ATP ServiceBinding resource
        • Get Binding status
      • Connecting to a provisioned ATP instance
        • Create a Kubernetes Secret with passwords
        • Injecting credentials and configurations
      • Deprovision
        • Delete Service Binding
        • Delete Service Instance
      • Use Secret to pass passwords
  • Autonomous Data Warehouse Service
    • Introduction
    • Plans
    • OCI User Permission requirement
    • Service Provision Request Parameters
      • Provisioning a new ADW Service Instance
      • Using Existing ADW Service Instance
    • Service Binding Request Parameters
    • Service Binding Response Credentials
    • Examples
      • Prerequisite
        • OCI Service Broker
        • Sample files
      • Provisioning
        • Creating a new ADW Instance
        • Using Existing ADW Instance
        • Get instance status
      • Binding
        • Creating an ADW ServiceBinding resource
        • Get Binding status
      • Connecting to a provisioned ADW instance
        • Create a Kubernetes Secret with passwords
        • Injecting credentials and configurations
      • Deprovision
        • Delete Service Binding
        • Delete Service Instance
      • Use Secret to pass passwords
  • OracleStreamingService
    • Introduction
    • Plans
    • Service Provision Request Parameters
      • Creating a OSS Service Instance
      • Using Existing OSS Service Instance
    • Service Binding
      • Request Parameters
      • Response Credentials
    • Example
      • Kubernetes
        • Creating a New OSS Instance
        • Using Existing OSS Service Instance
        • Binding

Introduction

The OCI Service Broker is an open source implementation of Open service broker API Spec for OCI services. Customers can use this implementation to install Open Service Broker in Oracle Container Engine for Kubernetes or in other Kubernetes clusters. This implementation is targeted to achieve:

• Easy installation.
• Easy extension.
• Provide OOTB implementations for common OCI services.
• OCI Service Broker Installation.
• Using an Existing Service Instance