services

Documentation

Overview

Package services encapsulates all the functionality around Epinio services

Index

• func UpdateService(ctx context.Context, cluster *kubernetes.Cluster, service *Service, ...) error
• type Service
  • func CreateService(ctx context.Context, cluster *kubernetes.Cluster, ...) (*Service, error)
  • func Lookup(ctx context.Context, kubeClient *kubernetes.Cluster, namespace, service string) (*Service, error)
  • func (s *Service) Delete(ctx context.Context) error
  • func (s *Service) Details(ctx context.Context) (map[string]string, error)
  • func (s *Service) GetBinding(ctx context.Context, appName string, _ string) (*corev1.Secret, error)
  • func (s *Service) Name() string
  • func (s *Service) Namespace() string
  • func (s *Service) User() string
• type ServiceList
  • func List(ctx context.Context, cluster *kubernetes.Cluster, namespace string) (ServiceList, error)

Functions

func UpdateService

func UpdateService(ctx context.Context, cluster *kubernetes.Cluster, service *Service, changes models.ServiceUpdateRequest) error

UpdateService modifies an existing service as per the instructions and writes the result back to the resource.

Types

type Service

type Service struct {
	SecretName    string
	NamespaceName string
	Service       string
	Username      string
	// contains filtered or unexported fields
}

Service contains the information needed for Epinio to address a specific service.

func CreateService

func CreateService(ctx context.Context, cluster *kubernetes.Cluster, name, namespace, username string,
	data map[string]string) (*Service, error)

CreateService creates a new service instance from namespace, name, and a map of parameters.

func Lookup

func Lookup(ctx context.Context, kubeClient *kubernetes.Cluster, namespace, service string) (*Service, error)

Lookup locates a Service by namespace and name. It finds the Service instance by looking for the relevant Secret.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context) error

Delete destroys the service instance, i.e. its underlying secret holding the instance's parameters

func (*Service) Details

func (s *Service) Details(ctx context.Context) (map[string]string, error)

Details returns the service instance's configuration. I.e. the parameter data.

func (*Service) GetBinding

func (s *Service) GetBinding(ctx context.Context, appName string, _ string) (*corev1.Secret, error)

GetBinding returns the secret representing the instance's binding to the application. This is actually the instance's secret itself, independent of the application.

func (*Service) Name

func (s *Service) Name() string

Name returns the service instance's name

func (*Service) Namespace

func (s *Service) Namespace() string

Namespace returns the service instance's namespace

func (*Service) User

func (s *Service) User() string

User returns the service's username

type ServiceList

type ServiceList []*Service

func List

func List(ctx context.Context, cluster *kubernetes.Cluster, namespace string) (ServiceList, error)

List returns a ServiceList of all available Services in the specified namespace. If no namespace is specified (empty string) then services across all namespaces are returned.