common

Documentation

Index

• func AddCredentialsSecret(comp InfoGetter, svc *runtime.ServiceRuntime, fieldList []string) (string, error)
• func AddInitialNamespaceQuotas(namespaceKon string) func(context.Context, *runtime.ServiceRuntime) *xfnproto.Result
• func AddSaWithRole(ctx context.Context, svc *runtime.ServiceRuntime, policies []rbacv1.PolicyRule, ...) error
• func AddUserAlerting(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *fnproto.Result
• func BootstrapInstanceNs(ctx context.Context, comp Composite, serviceName, namespaceResName string, ...) error
• func CreateNetworkPolicy(comp Composite, svc *runtime.ServiceRuntime) error
• func CreateTlsCerts(ctx context.Context, ns string, serviceName string, ...) error
• func CustomCreateNetworkPolicy(sourceNS []string, instanceNs, name string, allowAll bool, ...) error
• func DisableBilling(instanceNamespace string, svc *runtime.ServiceRuntime) error
• func GenerateNonSLAPromRules(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *fnproto.Result
• func GetDesiredReleaseValues(svc *runtime.ServiceRuntime, releaseName string) (map[string]interface{}, error)
• func GetObservedReleaseValues(svc *runtime.ServiceRuntime, releaseName string) (map[string]interface{}, error)
• func GetReleaseValues(r *xhelmv1.Release) (map[string]interface{}, error)
• func MailgunAlerting(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *xfnproto.Result
• func NewRelease(ctx context.Context, svc *runtime.ServiceRuntime, comp InfoGetter, ...) (*xhelmv1.Release, error)
• func SetNestedObjectValue(values map[string]interface{}, path []string, val interface{}) error
• func SetRandomSchedules(backup BackupScheduler, maintenance MaintenanceScheduler)
• func SetSELinuxSecurityContextDeployment(depl *appsv1.Deployment, comp InfoGetter, svc *runtime.ServiceRuntime) error
• func SetSELinuxSecurityContextStatefulset(sts *appsv1.StatefulSet, comp InfoGetter, svc *runtime.ServiceRuntime) error
• type Alerter
• type AllowedNamespaceGetter
• type BackupScheduler
• type Composite
• type InfoGetter
• type InstanceNamespaceInfo
• type MaintenanceScheduler
• type Resources
  • func GetResources(size *vshnv1.VSHNSizeSpec, r utils.Resources) Resources

Functions

func AddCredentialsSecret

func AddCredentialsSecret(comp InfoGetter, svc *runtime.ServiceRuntime, fieldList []string) (string, error)

AddCredentialsSecret creates secrets and passwords for use with helm based services. This is to avoid issues with re-generating passwords if helm internal password generators are used. The function accepts a list of fields that should be populated with passwords. It returns the name of the secret resource, so it can be referenced later. The name of the inner secret object is the same as the resource name. Additionally it exposes the generated passwords as connection details, for easier retrieval.

func AddInitialNamespaceQuotas

func AddInitialNamespaceQuotas(namespaceKon string) func(context.Context, *runtime.ServiceRuntime) *xfnproto.Result

AddInitialNamespaceQuotas will add the default quotas to a namespace if they are not yet set. This function takes the name of the namespace resource as it appears in the functionIO, it then returns the actual function that implements the composition function step.

func AddSaWithRole

func AddSaWithRole(ctx context.Context, svc *runtime.ServiceRuntime, policies []rbacv1.PolicyRule, compName, namespace, suffix string) error

AddSaWithRole creates a service account with the given policy and binds it to the role.

func AddUserAlerting

func AddUserAlerting(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *fnproto.Result

AddUserAlerting adds user alerting to the Redis instance.

func BootstrapInstanceNs

func BootstrapInstanceNs(ctx context.Context, comp Composite, serviceName, namespaceResName string, svc *runtime.ServiceRuntime) error

func CreateNetworkPolicy

func CreateNetworkPolicy(comp Composite, svc *runtime.ServiceRuntime) error

CreateNetworkPolicy creates network policy in the instance namespace to allow other namespaces access to the service

func CreateTlsCerts

func CreateTlsCerts(ctx context.Context, ns string, serviceName string, svc *runtime.ServiceRuntime) error

func CustomCreateNetworkPolicy

func CustomCreateNetworkPolicy(sourceNS []string, instanceNs, name string, allowAll bool, svc *runtime.ServiceRuntime) error

CustomCreateNetworkPolicy creates a more flexible network policy Use this method when, for instance, a service needs a sub-service with more refined network policy access

func DisableBilling

func DisableBilling(instanceNamespace string, svc *runtime.ServiceRuntime) error

DisableBilling deploys a special config map to the appcat control namespace. This configMap contains a key that specifies if a given namespace should be billed or not. The configMap can also be used for other configurations in the future.

func GenerateNonSLAPromRules

func GenerateNonSLAPromRules(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *fnproto.Result

func GetDesiredReleaseValues

func GetDesiredReleaseValues(svc *runtime.ServiceRuntime, releaseName string) (map[string]interface{}, error)

GetDesiredReleaseValues returns the desired releaseValues for the given release name.

func GetObservedReleaseValues

func GetObservedReleaseValues(svc *runtime.ServiceRuntime, releaseName string) (map[string]interface{}, error)

GetObservedReleaseValues returns the observed releaseValues for the given release name.

func GetReleaseValues

func GetReleaseValues(r *xhelmv1.Release) (map[string]interface{}, error)

GetReleaseValues returns the parsed values from the given release.

func MailgunAlerting

func MailgunAlerting(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *xfnproto.Result

func NewRelease

func NewRelease(ctx context.Context, svc *runtime.ServiceRuntime, comp InfoGetter, values map[string]any, cd ...xhelmv1.ConnectionDetail) (*xhelmv1.Release, error)

NewRelease returns a new release with some defaults set.

func SetNestedObjectValue

func SetNestedObjectValue(values map[string]interface{}, path []string, val interface{}) error

SetNestedObjectValue is necessary as unstructured can't handle anything except basic values and maps. this is a recursive function, it will traverse the map until it reaches the last element of the path. If it encounters any non-map values while traversing, it will throw an error.

func SetRandomSchedules

func SetRandomSchedules(backup BackupScheduler, maintenance MaintenanceScheduler)

SetRandomSchedules initializes the backup and maintenance schedules if the user did not explicitly provide a schedule. The maintenance will be set to a random time on Tuesday night between 21:00 and 5:00, and the backup schedule will be set to once a day between 20:00 and 4:00. If neither maintenance nor backup is set, the function will make sure that there will be backup scheduled one hour before the maintenance.

func SetSELinuxSecurityContextDeployment

func SetSELinuxSecurityContextDeployment(depl *appsv1.Deployment, comp InfoGetter, svc *runtime.ServiceRuntime) error

func SetSELinuxSecurityContextStatefulset

func SetSELinuxSecurityContextStatefulset(sts *appsv1.StatefulSet, comp InfoGetter, svc *runtime.ServiceRuntime) error

Types

type Alerter

type Alerter interface {
	GetVSHNMonitoring() vshnv1.VSHNMonitoring
	GetInstanceNamespace() string
}

type AllowedNamespaceGetter

type AllowedNamespaceGetter interface {
	GetAllowAllNamespaces() bool
	GetAllowedNamespaces() []string
}

type BackupScheduler

type BackupScheduler interface {
	GetBackupSchedule() string
	SetBackupSchedule(string)
}

BackupScheduler can schedule backups

type Composite

type Composite interface {
	InfoGetter
	client.Object
	SetInstanceNamespaceStatus()
	AllowedNamespaceGetter
}

Composite can get and set the relevant information on a given composite.

type InfoGetter

type InfoGetter interface {
	GetBackupSchedule() string
	GetBackupRetention() vshnv1.K8upRetentionPolicy
	GetServiceName() string
	GetLabels() map[string]string
	InstanceNamespaceInfo
}

InfoGetter will return various information about the given AppCat composite.

type InstanceNamespaceInfo

type InstanceNamespaceInfo interface {
	GetName() string
	GetClaimNamespace() string
	GetInstanceNamespace() string
	GetLabels() map[string]string
}

InstanceNamespaceInfo provides all the necessary information to create an instance namespace.

type MaintenanceScheduler

type MaintenanceScheduler interface {
	GetMaintenanceDayOfWeek() string
	SetMaintenanceDayOfWeek(string)
	GetMaintenanceTimeOfDay() string
	SetMaintenanceTimeOfDay(string)
}

type Resources

type Resources struct {
	ReqMem string
	ReqCPU string
	Mem    string
	CPU    string
	Disk   string
}

func GetResources

func GetResources(size *vshnv1.VSHNSizeSpec, r utils.Resources) Resources