internal

Documentation

Index

• Constants
• type APIEntry
  • func (a *APIEntry) String() string
• type APIPackageCredential
• type Application
• type ApplicationName
• type ApplicationServiceID
• type CompassMetadata
• type Entry
• type Instance
• type InstanceBindData
• type InstanceCredentials
• type InstanceID
  • func (id InstanceID) IsZero() bool
• type InstanceOperation
• type InstanceState
• type Namespace
• type OperationID
  • func (id OperationID) IsZero() bool
• type OperationState
  • func (os OperationState) String() string
• type OperationType
• type Service
  • func (s *Service) IsBindable() bool
• type ServiceID
• type ServicePlanID

Constants

const (
	// OperationDescriptionProvisioningSucceeded means that the provisioning succeeded
	OperationDescriptionProvisioningSucceeded string = "provisioning succeeded"
	// OperationDescriptionDeprovisioningSucceeded means that the deprovisioning succeeded
	OperationDescriptionDeprovisioningSucceeded string = "deprovisioning succeeded"
)

const (
	APIEntryType   = "API"
	EventEntryType = "Events"
)

Types

type APIEntry

type APIEntry struct {
	Name      string
	TargetURL string
	ID        string

	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	GatewayURL string
	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	AccessLabel string
}

APIEntry represents API of the application.

func (*APIEntry) String

func (a *APIEntry) String() string

type APIPackageCredential

type APIPackageCredential struct {
	ID     string
	Type   proxyconfig.AuthType
	Config proxyconfig.Configuration
}

APIPackageCredential holds all information necessary to auth with a given Application API service.

type Application

type Application struct {
	Name                ApplicationName
	Description         string
	Services            []Service
	CompassMetadata     CompassMetadata
	DisplayName         string
	ProviderDisplayName string
	LongDescription     string
	Labels              map[string]string
	Tags                []string

	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	AccessLabel string
}

Application represents Application as defined by OSB API.

type ApplicationName

type ApplicationName string

ApplicationName is a Application name

type ApplicationServiceID

type ApplicationServiceID string

ApplicationServiceID is an ID of Service defined in Application

type CompassMetadata

type CompassMetadata struct {
	ApplicationID string
}

type Entry

type Entry struct {
	Type string
	*APIEntry
}

Entry is a generic type for all type of entries.

type Instance

type Instance struct {
	ID            InstanceID
	ServiceID     ServiceID
	ServicePlanID ServicePlanID
	Namespace     Namespace
	State         InstanceState
}

Instance contains info about Service exposed via Service Catalog.

type InstanceBindData

type InstanceBindData struct {
	InstanceID  InstanceID
	Credentials InstanceCredentials
}

InstanceBindData contains data about service instance and it's credentials.

type InstanceCredentials

type InstanceCredentials map[string]string

InstanceCredentials are created when we bind a service instance.

type InstanceID

type InstanceID string

InstanceID is a service instance identifier.

func (InstanceID) IsZero

func (id InstanceID) IsZero() bool

IsZero checks if InstanceID equals zero.

type InstanceOperation

type InstanceOperation struct {
	InstanceID       InstanceID
	OperationID      OperationID
	Type             OperationType
	State            OperationState
	StateDescription *string

	// CreatedAt points to creation time of the operation.
	// Field should be treated as immutable and is responsibility of storage implementation.
	// It should be set by storage Insert method.
	CreatedAt time.Time
}

InstanceOperation represents single operation.

type InstanceState

type InstanceState string

InstanceState defines the possible states of the Instance in the storage.

const (
	// InstanceStatePending is when provision is in progress
	InstanceStatePending InstanceState = "pending"
	// InstanceStatePendingDeletion is when deprovision is in progress
	InstanceStatePendingDeletion InstanceState = "removing"
	// InstanceStateFailed is when provision was failed
	InstanceStateFailed InstanceState = "failed"
	// InstanceStateSucceeded is when provision was succeeded
	InstanceStateSucceeded InstanceState = "succeeded"
)

type Namespace

type Namespace string

Namespace is the name of namespace in k8s

type OperationID

type OperationID string

OperationID is used as binding operation identifier.

func (OperationID) IsZero

func (id OperationID) IsZero() bool

IsZero checks if OperationID equals zero

type OperationState

type OperationState string

OperationState defines the possible states of an asynchronous request to a broker.

const (
	// OperationStateInProgress means that operation is in progress
	OperationStateInProgress OperationState = "in progress"
	// OperationStateSucceeded means that request succeeded
	OperationStateSucceeded OperationState = "succeeded"
	// OperationStateFailed means that request failed
	OperationStateFailed OperationState = "failed"
)

func (OperationState) String

func (os OperationState) String() string

String returns state of the operation.

type OperationType

type OperationType string

OperationType defines the possible types of an asynchronous operation to a broker.

const (
	// OperationTypeCreate means creating OperationType
	OperationTypeCreate OperationType = "create"
	// OperationTypeRemove means removing OperationType
	OperationTypeRemove OperationType = "remove"
	// OperationTypeUndefined means undefined OperationType
	OperationTypeUndefined OperationType = ""
)

type Service

type Service struct {
	ID                                   ApplicationServiceID
	Name                                 string
	DisplayName                          string
	Description                          string
	Entries                              []Entry
	EventProvider                        bool
	ServiceInstanceCreateParameterSchema map[string]interface{}

	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	LongDescription string
	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	ProviderDisplayName string
	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	Tags []string
	// Deprecated, remove in https://github.com/kyma-project/kyma/issues/7415
	Labels map[string]string
}

Service represents service defined in the application which is mapped to service class in the service catalog.

func (*Service) IsBindable

func (s *Service) IsBindable() bool

type ServiceID

type ServiceID string

ServiceID is an ID of the Service exposed via Service Catalog.

type ServicePlanID

type ServicePlanID string

ServicePlanID is an ID of the Plan of Service exposed via Service Catalog.