tenancy

Documentation

Index

• func CreateTenants(ctx context.Context, tenants []Tenant, c client.Client) error
• func ExportTenants(tenants []Tenant, out io.Writer) error
• func GenerateTenantResources(tenants ...Tenant) ([]runtime.Object, error)
• type Tenant
  • func Parse(filename string) ([]Tenant, error)
  • func (t Tenant) Validate() error

Functions

func CreateTenants

func CreateTenants(ctx context.Context, tenants []Tenant, c client.Client) error

CreateTenants creates resources for tenants given a file for definition.

func ExportTenants

func ExportTenants(tenants []Tenant, out io.Writer) error

ExportTenants exports all the tenants to a file.

func GenerateTenantResources

func GenerateTenantResources(tenants ...Tenant) ([]runtime.Object, error)

GenerateTenantResources creates all the resources for tenants.

Types

type Tenant

type Tenant struct {
	Name        string            `yaml:"name"`
	Namespaces  []string          `yaml:"namespaces"`
	ClusterRole string            `yaml:"clusterRole"`
	Labels      map[string]string `yaml:"labels"`
}

Tenant represents a tenant that we generate resources for in the tenancy system.

func Parse

func Parse(filename string) ([]Tenant, error)

Parse a raw tenant declaration, and parses it from the YAML and returns the extracted Tenants.

func (Tenant) Validate

func (t Tenant) Validate() error

Validate returns an error if any of the fields isn't valid