services

Documentation

Index

• Constants
• func GetInternalRoutes(ctx context.Context, servicesGetter v1.ServiceInterface, name string) ([]string, error)
• func NewServiceStatusFromHelmRelease(status helm.ReleaseStatus) models.ServiceStatus
• type ServiceClient
  • func NewKubernetesServiceClient(kubeClient *kubernetes.Cluster) (*ServiceClient, error)
  • func (s *ServiceClient) Create(ctx context.Context, namespace, name string, wait bool, ...) error
  • func (s *ServiceClient) Delete(ctx context.Context, namespace, name string) error
  • func (s *ServiceClient) DeleteAll(ctx context.Context, namespace string) error
  • func (s *ServiceClient) DeployOrUpdate(ctx context.Context, namespace, name string, wait bool, ...) error
  • func (s *ServiceClient) Get(ctx context.Context, namespace, name string) (*models.Service, error)
  • func (s *ServiceClient) GetCatalogService(ctx context.Context, serviceName string) (*models.CatalogService, error)
  • func (s *ServiceClient) ListAll(ctx context.Context) (models.ServiceList, error)
  • func (s *ServiceClient) ListCatalogServices(ctx context.Context) ([]*models.CatalogService, error)
  • func (s *ServiceClient) ListInNamespace(ctx context.Context, namespace string) (models.ServiceList, error)
  • func (s *ServiceClient) ReplaceService(ctx context.Context, cluster *kubernetes.Cluster, service *models.Service, ...) (bool, error)
  • func (s *ServiceClient) UpdateService(ctx context.Context, cluster *kubernetes.Cluster, service *models.Service, ...) error

Constants

const (
	// Only Helmcharts with this label are considered Epinio "Services".
	// Used to filter out Helmcharts created by other means (manually, k3s etc).
	CatalogServiceLabelKey              = "application.epinio.io/catalog-service-name"
	CatalogServiceSecretTypesAnnotation = "application.epinio.io/catalog-service-secret-types"
	CatalogServiceVersionLabelKey       = "application.epinio.io/catalog-service-version"
	// COMPATIBILITY SUPPORT for services from before https://github.com/epinio/epinio/issues/1704 fix
	TargetNamespaceLabelKey = "application.epinio.io/target-namespace"
	// ServiceNameLabelKey is used to keep the original name
	// since the name in the metadata is combined with the namespace
	ServiceNameLabelKey = "application.epinio.io/service-name"
)

Functions

func GetInternalRoutes

func GetInternalRoutes(ctx context.Context, servicesGetter v1.ServiceInterface, name string) ([]string, error)

GetInternalRoutes returns the internal routes of the service, finding them from the kubernetes services of the Helm release

func NewServiceStatusFromHelmRelease

func NewServiceStatusFromHelmRelease(status helm.ReleaseStatus) models.ServiceStatus

Types

type ServiceClient

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

func NewKubernetesServiceClient

func NewKubernetesServiceClient(kubeClient *kubernetes.Cluster) (*ServiceClient, error)

func (*ServiceClient) Create

func (s *ServiceClient) Create(ctx context.Context,
	namespace, name string,
	wait bool,
	settings models.ChartValueSettings,
	catalogService *models.CatalogService,
	hook helm.PostDeployFunction,
) error

func (*ServiceClient) Delete

func (s *ServiceClient) Delete(ctx context.Context, namespace, name string) error

Delete deletes the helmcharts that matches the given service which is installed on the namespace

func (*ServiceClient) DeleteAll

func (s *ServiceClient) DeleteAll(ctx context.Context, namespace string) error

DeleteAll deletes all helmcharts installed on the specified namespace. It's used to cleanup before a namespace is deleted.

func (*ServiceClient) DeployOrUpdate

func (s *ServiceClient) DeployOrUpdate(
	ctx context.Context,
	namespace, name string,
	wait bool,
	settings models.ChartValueSettings,
	catalogService *models.CatalogService,
	hook helm.PostDeployFunction) error

Deploy deploys the helm chart of a service, or updates its release.

func (*ServiceClient) Get

func (s *ServiceClient) Get(ctx context.Context, namespace, name string) (*models.Service, error)

Get returns a Service "instance" object if one is exist, or nil otherwise. Also returns an error if one occurs.

func (*ServiceClient) GetCatalogService

func (s *ServiceClient) GetCatalogService(ctx context.Context, serviceName string) (*models.CatalogService, error)

func (*ServiceClient) ListAll

func (s *ServiceClient) ListAll(ctx context.Context) (models.ServiceList, error)

ListAll will return all the Epinio Service instances

func (*ServiceClient) ListCatalogServices

func (s *ServiceClient) ListCatalogServices(ctx context.Context) ([]*models.CatalogService, error)

func (*ServiceClient) ListInNamespace

func (s *ServiceClient) ListInNamespace(ctx context.Context, namespace string) (models.ServiceList, error)

ListInNamespace will return all the Epinio Services available in the specified namespace

func (*ServiceClient) ReplaceService

func (s *ServiceClient) ReplaceService(ctx context.Context, cluster *kubernetes.Cluster, service *models.Service,
	data models.ServiceReplaceRequest, hook helm.PostDeployFunction) (bool, error)

ReplaceService replaces an existing service

func (*ServiceClient) UpdateService

func (s *ServiceClient) UpdateService(ctx context.Context, cluster *kubernetes.Cluster, service *models.Service,
	changes models.ServiceUpdateRequest, hook helm.PostDeployFunction) error

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