organization

Documentation

Index

• Variables
• type Client
  • func NewClient(client client.Client) *Client
  • func (c *Client) Create(ctx context.Context, name string) error
  • func (c *Client) Delete(ctx context.Context, name string) error
  • func (c *Client) GetMetadata(ctx context.Context, name string) (*Meta, error)
  • func (c *Client) GetOrCreateMetadata(ctx context.Context, name string) (*Meta, error)
• type Meta

Variables

var (
	// ErrResourceDeleting is raised when the resource is being deleted.
	ErrResourceDeleting = goerrors.New("resource is being deleted")

	// ErrNamespaceUnset is raised when the namespace hasn't been created
	// yet.
	ErrNamespaceUnset = goerrors.New("resource namespace is unset")
)

Types

type Client

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

Client wraps up organization related management handling.

func NewClient

func NewClient(client client.Client) *Client

NewClient returns a new client with required parameters.

func (*Client) Create

func (c *Client) Create(ctx context.Context, name string) error

Create creates the implicit organization indentified by the JTW claims.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, name string) error

Delete deletes the implicit organization indentified by the JTW claims.

func (*Client) GetMetadata

func (c *Client) GetMetadata(ctx context.Context, name string) (*Meta, error)

GetMetadata retrieves the organization metadata. Clients should consult at least the Active status before doing anything with the organization.

func (*Client) GetOrCreateMetadata

func (c *Client) GetOrCreateMetadata(ctx context.Context, name string) (*Meta, error)

type Meta

type Meta struct {
	// Name is the organization's Kubernetes name, so a higher level resource
	// can reference it.
	Name string

	// Namespace is the namespace that is provisioned by the organization.
	// Should be usable set when the organization is active.
	Namespace string

	// Deleting tells us if we should allow new child objects to be created
	// in this resource's namespace.
	Deleting bool
}

Meta describes the organization.