applications

Documentation

Overview

Package applications contains components for accessing/modifying Application CRD

Index

• type Credentials
• type Manager
• type Service
• type ServiceAPI
• type ServiceRepository
  • func NewServiceRepository(appManager Manager) ServiceRepository

Types

type Credentials

type Credentials struct {
	Type                 string
	SecretName           string
	URL                  string
	CSRFTokenEndpointURL string
}

Credentials stores information about credentials needed to call an API

type Manager

type Manager interface {
	Get(ctx context.Context, name string, options v1.GetOptions) (*v1alpha1.Application, error)
}

Manager contains operations for managing Application CRD

type Service

type Service struct {
	// Mapped to id in Application CRD
	ID string
	// Mapped to name in Application CRD
	Name string
	// Mapped to displayName in Application CRD
	DisplayName string
	// Mapped to longDescription in Application CRD
	LongDescription string
	// Mapped to providerDisplayName in Application CRD
	ProviderDisplayName string
	// Mapped to tags in Application CRD
	Tags []string
	// Mapped to type property under entries element (type: API)
	API *ServiceAPI
}

Service represents a service stored in Application

type ServiceAPI

type ServiceAPI struct {
	TargetURL                   string
	Credentials                 *Credentials
	RequestParametersSecretName string
	SkipVerify                  bool
	EncodeURL                   bool
}

ServiceAPI stores information needed to call an API

type ServiceRepository

type ServiceRepository interface {
	GetByServiceName(appName, serviceName string) (Service, apperrors.AppError)
	GetByEntryName(appName, serviceName, entryName string) (Service, apperrors.AppError)
}

ServiceRepository contains operations for managing services stored in Application CRD

func NewServiceRepository

func NewServiceRepository(appManager Manager) ServiceRepository

NewServiceRepository creates a new ApplicationServiceRepository