services

Documentation

Index

• type Credentials
• type Service
• type Services
  • func DefaultServices(platform platform.Platform, logger logger.Logger) (Services, error)

Types

type Credentials

type Credentials map[string]interface{}

Credentials is the collection of credentials available exposed by a service. Great care should be used when handling credentials, as they expose sensitive information. Buildpacks should only extract values at startup/runtime and not embed them in the image.

type Service

type Service struct {
	// BindingName is the binding name of this service.
	BindingName string `json:"binding_name"`

	// Credentials is the collection of credential keys.
	Credentials Credentials `json:"credentials"`

	// InstanceName is the instance name of this service.
	InstanceName string `json:"instance_name"`

	// Label is the type of service.
	Label string `json:"label"`

	// Plan is the plan type of this service.
	Plan string `json:"plan"`

	// Tags is the collection of tags of the service.
	Tags []string `json:"tags"`
}

Service represents a service bound to the application.

type Services

type Services []Service

Services is a collection of services bound to the application.

func DefaultServices

func DefaultServices(platform platform.Platform, logger logger.Logger) (Services, error)

DefaultServices creates a new instance of Services.