tenant

Documentation

Overview

Package tenant provides multi-tenant protocol library isolation.

Index

• type AuditEntry
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) AddProtocol(tenantID, protocol string) error
  • func (m *Manager) CreateTenant(id, name string, quota Quota) error
  • func (m *Manager) Describe() string
  • func (m *Manager) GetAuditLog(tenantID string) []AuditEntry
• type Quota
• type Tenant

Types

type AuditEntry

type AuditEntry struct {
	TenantID string `json:"tenant_id"`
	Action   string `json:"action"`
	Resource string `json:"resource"`
}

AuditEntry represents an audit log entry.

type Manager

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

Manager manages multi-tenant protocol libraries.

func NewManager

func NewManager() *Manager

NewManager creates a new tenant manager.

func (*Manager) AddProtocol

func (m *Manager) AddProtocol(tenantID, protocol string) error

AddProtocol adds a protocol to a tenant.

func (*Manager) CreateTenant

func (m *Manager) CreateTenant(id, name string, quota Quota) error

CreateTenant creates a new tenant.

func (*Manager) Describe

func (m *Manager) Describe() string

Describe returns a description of all tenants.

func (*Manager) GetAuditLog

func (m *Manager) GetAuditLog(tenantID string) []AuditEntry

GetAuditLog returns audit entries for a tenant.

type Quota

type Quota struct {
	MaxProtocols int `json:"max_protocols"`
	MaxRequests  int `json:"max_requests_per_min"`
}

Quota represents tenant resource quotas.

type Tenant

type Tenant struct {
	ID        string   `json:"id"`
	Name      string   `json:"name"`
	Protocols []string `json:"protocols"`
	Quota     Quota    `json:"quota"`
}

Tenant represents a tenant with isolated protocol library.