marketplace

Documentation

Overview

Package marketplace provides access to the resources provided by service brokers for consumption by developers.

Index

• type Client
  • func (c *Client) Marketplace(ctx context.Context, namespace string) (*KfMarketplace, error)
• type ClientInterface
  • func NewClient(kfclient kfclientv1alpha1.KfV1alpha1Interface) ClientInterface
• type KfMarketplace
  • func (m *KfMarketplace) ListClusterPlans(filter ListPlanOptions) []PlanLineage
  • func (m *KfMarketplace) ListNamespacedPlans(namespace string, filter ListPlanOptions) []PlanLineage
  • func (m *KfMarketplace) WalkServiceOfferings(callback func(OfferingLineage))
  • func (m *KfMarketplace) WalkServicePlans(callback func(PlanLineage))
• type ListPlanOptions
• type OfferingLineage
  • func (o *OfferingLineage) String() string
• type PlanLineage
  • func (o *PlanLineage) String() string

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an implementation of ClientInterface that works with the Service Catalog.

func (*Client) Marketplace

func (c *Client) Marketplace(ctx context.Context, namespace string) (*KfMarketplace, error)

Marketplace lists available services and plans in the Kf OSB marketplace.

type ClientInterface

type ClientInterface interface {
	// Marketplace lists available services and plans in the Kf OSB marketplace.
	Marketplace(ctx context.Context, namespace string) (*KfMarketplace, error)
}

ClientInterface is a client capable of interacting with service catalog services and mapping the CF to Kubernetes concepts.

func NewClient

func NewClient(kfclient kfclientv1alpha1.KfV1alpha1Interface) ClientInterface

NewClient creates a new client capable of interacting with service catalog services.

type KfMarketplace

type KfMarketplace struct {
	Brokers []v1alpha1.CommonServiceBroker
}

KfMarketplace contains information to describe the services and plans available in the catalog.

func (*KfMarketplace) ListClusterPlans

func (m *KfMarketplace) ListClusterPlans(filter ListPlanOptions) []PlanLineage

ListClusterPlans gets cluster-wide plans matching the given filter.

func (*KfMarketplace) ListNamespacedPlans

func (m *KfMarketplace) ListNamespacedPlans(namespace string, filter ListPlanOptions) []PlanLineage

ListNamespacedPlans gets namespaced plans matching the given filter.

func (*KfMarketplace) WalkServiceOfferings

func (m *KfMarketplace) WalkServiceOfferings(callback func(OfferingLineage))

WalkServiceOfferings iterates through each broker/service tuple.

func (*KfMarketplace) WalkServicePlans

func (m *KfMarketplace) WalkServicePlans(callback func(PlanLineage))

WalkServicePlans iterates through each broker/service/plan tuple.

type ListPlanOptions

type ListPlanOptions struct {
	PlanName    string
	ServiceName string
	BrokerName  string
}

ListPlanOptions holds additional filtering options used when listing plans.

type OfferingLineage

type OfferingLineage struct {
	Broker          v1alpha1.CommonServiceBroker
	ServiceOffering v1alpha1.ServiceOffering
}

OfferingLineage holds a broker/offering tuple where the broker is the parent of the offering.

func (*OfferingLineage) String

func (o *OfferingLineage) String() string

String implements fmt.Stringer.

type PlanLineage

type PlanLineage struct {
	OfferingLineage
	ServicePlan v1alpha1.ServicePlan
}

PlanLineage holds a broker/offering/plan tuple where the broker is the parent of the offering which is the parent of the plan.

func (*PlanLineage) String

func (o *PlanLineage) String() string

String implements fmt.Stringer.