common

Documentation

Index

• 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, compositionName string, serviceName string, ...) error
• func CreateNetworkPolicy(ctx context.Context, sourceNs []string, instanceNs string, instance string, ...) error
• func CreateTlsCerts(ctx context.Context, ns string, instance string, svc *runtime.ServiceRuntime) error
• func GetResources(size *vshnv1.VSHNSizeSpec, r utils.Resources) (string, string, string, string, string)
• func MailgunAlerting(obj client.Object) func(ctx context.Context, svc *runtime.ServiceRuntime) *xfnproto.Result
• func SetRandomSchedules(backup BackupScheduler, maintenance MaintenanceScheduler)
• type Alerter
• type BackupScheduler
• type MaintenanceScheduler

Functions

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, compositionName string, serviceName string, claimNs string, instanceNs string, namespaceResName string, svc *runtime.ServiceRuntime) error

func CreateNetworkPolicy

func CreateNetworkPolicy(ctx context.Context, sourceNs []string, instanceNs string, instance string, svc *runtime.ServiceRuntime) error

func CreateTlsCerts

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

func GetResources

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

func MailgunAlerting

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

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.

Types

type Alerter

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

type BackupScheduler

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

BackupScheduler can schedule backups

type MaintenanceScheduler

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