tenant

package

v0.7.1 Latest Latest Go to latest Published: Jul 25, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/raystack/optimus

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Namespace
- func NewNamespace(name string, projName ProjectName, config map[string]string) (*Namespace, error)
- func (n *Namespace) GetConfig(key string) (string, error)
- func (n *Namespace) GetConfigs() map[string]string
- func (n *Namespace) Name() NamespaceName
- func (n *Namespace) ProjectName() ProjectName
type NamespaceName
- func NamespaceNameFrom(name string) (NamespaceName, error)
- func (n NamespaceName) String() string
type PlainTextSecret
- func NewPlainTextSecret(name, value string) (*PlainTextSecret, error)
- func (p *PlainTextSecret) Name() SecretName
- func (p *PlainTextSecret) Value() string
type PlainTextSecrets
- func (p PlainTextSecrets) ToMap() map[string]string
type Project
- func NewProject(name string, config map[string]string) (*Project, error)
- func (p *Project) GetConfig(key string) (string, error)
- func (p *Project) GetConfigs() map[string]string
- func (p *Project) Name() ProjectName
type ProjectName
- func ProjectNameFrom(name string) (ProjectName, error)
- func (pn ProjectName) String() string
type Secret
- func NewSecret(name, encodedValue string, projName ProjectName, nsName string) (*Secret, error)
- func (s *Secret) EncodedValue() string
- func (s *Secret) Name() SecretName
- func (s *Secret) NamespaceName() string
- func (s *Secret) ProjectName() ProjectName
type SecretName
- func SecretNameFrom(name string) (SecretName, error)
- func (sn SecretName) String() string
type Tenant
- func NewTenant(projectName, namespaceName string) (Tenant, error)
- func (t Tenant) IsInvalid() bool
- func (t Tenant) NamespaceName() NamespaceName
- func (t Tenant) ProjectName() ProjectName
type WithDetails
- func NewTenantDetails(proj *Project, namespace *Namespace, secrets PlainTextSecrets) (*WithDetails, error)
- func (w *WithDetails) GetConfig(key string) (string, error)
- func (w *WithDetails) GetConfigs() map[string]string
- func (w *WithDetails) Namespace() *Namespace
- func (w *WithDetails) Project() *Project
- func (w *WithDetails) SecretsMap() map[string]string
- func (w *WithDetails) ToTenant() Tenant

Constants ¶

View Source

const (
	EntityProject = "project"

	ProjectStoragePathKey = "STORAGE_PATH"
	ProjectSchedulerHost  = "SCHEDULER_HOST"
)

View Source

const (
	EntitySecret = "secret"

	SecretStorageKey    = "STORAGE"
	SecretSchedulerAuth = "SCHEDULER_AUTH"
	SecretNotifySlack   = "NOTIFY_SLACK"
)

View Source

const EntityNamespace = "namespace"

View Source

const EntityTenant = "tenant"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Namespace ¶

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

func NewNamespace ¶

func NewNamespace(name string, projName ProjectName, config map[string]string) (*Namespace, error)

func (*Namespace) GetConfig ¶

func (n *Namespace) GetConfig(key string) (string, error)

func (*Namespace) GetConfigs ¶

func (n *Namespace) GetConfigs() map[string]string

GetConfigs returns a clone on project configurations

func (*Namespace) Name ¶

func (n *Namespace) Name() NamespaceName

func (*Namespace) ProjectName ¶

func (n *Namespace) ProjectName() ProjectName

type NamespaceName ¶

type NamespaceName string

func NamespaceNameFrom ¶

func NamespaceNameFrom(name string) (NamespaceName, error)

func (NamespaceName) String ¶

func (n NamespaceName) String() string

type PlainTextSecret ¶

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

func NewPlainTextSecret ¶

func NewPlainTextSecret(name, value string) (*PlainTextSecret, error)

func (*PlainTextSecret) Name ¶

func (p *PlainTextSecret) Name() SecretName

func (*PlainTextSecret) Value ¶

func (p *PlainTextSecret) Value() string

type PlainTextSecrets ¶

type PlainTextSecrets []*PlainTextSecret

func (PlainTextSecrets) ToMap ¶

func (p PlainTextSecrets) ToMap() map[string]string

type Project ¶

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

func NewProject ¶

func NewProject(name string, config map[string]string) (*Project, error)

func (*Project) GetConfig ¶

func (p *Project) GetConfig(key string) (string, error)

func (*Project) GetConfigs ¶

func (p *Project) GetConfigs() map[string]string

GetConfigs returns a clone of project configurations

func (*Project) Name ¶

func (p *Project) Name() ProjectName

type ProjectName ¶

type ProjectName string

func ProjectNameFrom ¶

func ProjectNameFrom(name string) (ProjectName, error)

func (ProjectName) String ¶

func (pn ProjectName) String() string

type Secret ¶

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

func NewSecret ¶

func NewSecret(name, encodedValue string, projName ProjectName, nsName string) (*Secret, error)

func (*Secret) EncodedValue ¶

func (s *Secret) EncodedValue() string

func (*Secret) Name ¶

func (s *Secret) Name() SecretName

func (*Secret) NamespaceName ¶

func (s *Secret) NamespaceName() string

func (*Secret) ProjectName ¶

func (s *Secret) ProjectName() ProjectName

type SecretName ¶

type SecretName string

func SecretNameFrom ¶

func SecretNameFrom(name string) (SecretName, error)

func (SecretName) String ¶

func (sn SecretName) String() string

type Tenant ¶

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

func NewTenant ¶

func NewTenant(projectName, namespaceName string) (Tenant, error)

func (Tenant) IsInvalid ¶

func (t Tenant) IsInvalid() bool

func (Tenant) NamespaceName ¶

func (t Tenant) NamespaceName() NamespaceName

func (Tenant) ProjectName ¶

func (t Tenant) ProjectName() ProjectName

type WithDetails ¶

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

func NewTenantDetails ¶

func NewTenantDetails(proj *Project, namespace *Namespace, secrets PlainTextSecrets) (*WithDetails, error)

func (*WithDetails) GetConfig ¶

func (w *WithDetails) GetConfig(key string) (string, error)

func (*WithDetails) GetConfigs ¶

func (w *WithDetails) GetConfigs() map[string]string

func (*WithDetails) Namespace ¶

func (w *WithDetails) Namespace() *Namespace

func (*WithDetails) Project ¶

func (w *WithDetails) Project() *Project

func (*WithDetails) SecretsMap ¶

func (w *WithDetails) SecretsMap() map[string]string

func (*WithDetails) ToTenant ¶

func (w *WithDetails) ToTenant() Tenant

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dto
handler
v1beta1
service

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL