api

Documentation

Index

• func GetConfigHome() string
• func GetCustomBundleHome(site *v2alpha1.Site, customBaseDir string) string
• func GetCustomSiteHome(site *v2alpha1.Site, customBaseDir string) string
• func GetDataHome() string
• func GetDefaultBundleOutputPath(namespace string) string
• func GetDefaultOutputBundlesPath() string
• func GetDefaultOutputNamespacesPath() string
• func GetDefaultOutputPath(namespace string) string
• func GetHostBundlesPath() string
• func GetHostDataHome() string
• func GetHostNamespaceHome(ns string) string
• func GetHostNamespacesPath() string
• func GetHostSiteHome(site *v2alpha1.Site) string
• func GetHostSiteInternalPath(site *v2alpha1.Site, internalPath InternalPath) string
• func GetInternalBundleOutputPath(namespace string, internalPath InternalPath) string
• func GetInternalOutputPath(namespace string, internalPath InternalPath) string
• func GetRuntimeDir() string
• func IsRunningInContainer() bool
• func MarshalSiteState(siteState SiteState, outputDirectory string) error
• type IdGetter
• type InternalPath
• type InternalPathProvider
• type SiteState
  • func NewSiteState(bundle bool) *SiteState
  • func (s *SiteState) CreateBridgeCertificates()
  • func (s *SiteState) CreateLinkAccessesCertificates()
  • func (s *SiteState) CreateRouterAccess(name string, port int)
  • func (s *SiteState) GetNamespace() string
  • func (s *SiteState) HasRouterAccess() bool
  • func (s *SiteState) IsBundle() bool
  • func (s *SiteState) IsInterior() bool
  • func (s *SiteState) SetNamespace(namespace string)
  • func (s *SiteState) ToRouterConfig(sslProfileBasePath string, platform string) qdr.RouterConfig
• type SiteStateLoader
• type SiteStateValidator
• type StaticSiteStateRenderer
• type Token
  • func CreateTokens(routerAccess v2alpha1.RouterAccess, serverSecret v1.Secret, ...) []*Token
  • func (t *Token) Marshal() ([]byte, error)

Functions

func GetConfigHome

func GetConfigHome() string

func GetCustomBundleHome

func GetCustomBundleHome(site *v2alpha1.Site, customBaseDir string) string

func GetCustomSiteHome

func GetCustomSiteHome(site *v2alpha1.Site, customBaseDir string) string

func GetDataHome

func GetDataHome() string

func GetDefaultBundleOutputPath

func GetDefaultBundleOutputPath(namespace string) string

func GetDefaultOutputBundlesPath

func GetDefaultOutputBundlesPath() string

func GetDefaultOutputNamespacesPath

func GetDefaultOutputNamespacesPath() string

func GetDefaultOutputPath

func GetDefaultOutputPath(namespace string) string

func GetHostBundlesPath

func GetHostBundlesPath() string

func GetHostDataHome

func GetHostDataHome() string

GetHostDataHome returns the value of the SKUPPER_OUTPUT_PATH environment variable when running via container or the result of GetDataHome() otherwise. This is only useful during the bootstrap process.

func GetHostNamespaceHome

func GetHostNamespaceHome(ns string) string

func GetHostNamespacesPath

func GetHostNamespacesPath() string

func GetHostSiteHome

func GetHostSiteHome(site *v2alpha1.Site) string

func GetHostSiteInternalPath

func GetHostSiteInternalPath(site *v2alpha1.Site, internalPath InternalPath) string

func GetInternalBundleOutputPath

func GetInternalBundleOutputPath(namespace string, internalPath InternalPath) string

func GetInternalOutputPath

func GetInternalOutputPath(namespace string, internalPath InternalPath) string

func GetRuntimeDir

func GetRuntimeDir() string

func IsRunningInContainer

func IsRunningInContainer() bool

func MarshalSiteState

func MarshalSiteState(siteState SiteState, outputDirectory string) error

Types

type IdGetter

type IdGetter func() int

type InternalPath

type InternalPath string

const (
	InputIssuersPath      InternalPath = "input/issuers"
	InputCertificatesPath InternalPath = "input/certs"
	InputSiteStatePath    InternalPath = "input/resources"
	RouterConfigPath      InternalPath = "runtime/router"
	CertificatesPath      InternalPath = "runtime/certs"
	IssuersPath           InternalPath = "runtime/issuers"
	RuntimePath           InternalPath = "runtime"
	RuntimeSiteStatePath  InternalPath = "runtime/resources"
	RuntimeTokenPath      InternalPath = "runtime/links"
	InternalBasePath      InternalPath = "internal"
	LoadedSiteStatePath   InternalPath = "internal/snapshot"
	ScriptsPath           InternalPath = "internal/scripts"
)

type InternalPathProvider

type InternalPathProvider func(namespace string, internalPath InternalPath) string

type SiteState

type SiteState struct {
	SiteId          string
	Site            *v2alpha1.Site
	Listeners       map[string]*v2alpha1.Listener
	Connectors      map[string]*v2alpha1.Connector
	RouterAccesses  map[string]*v2alpha1.RouterAccess
	Grants          map[string]*v2alpha1.AccessGrant
	Links           map[string]*v2alpha1.Link
	Secrets         map[string]*corev1.Secret
	Claims          map[string]*v2alpha1.AccessToken
	Certificates    map[string]*v2alpha1.Certificate
	SecuredAccesses map[string]*v2alpha1.SecuredAccess
	// contains filtered or unexported fields
}

func NewSiteState

func NewSiteState(bundle bool) *SiteState

func (*SiteState) CreateBridgeCertificates

func (s *SiteState) CreateBridgeCertificates()

func (*SiteState) CreateLinkAccessesCertificates

func (s *SiteState) CreateLinkAccessesCertificates()

func (*SiteState) CreateRouterAccess

func (s *SiteState) CreateRouterAccess(name string, port int)

func (*SiteState) GetNamespace

func (s *SiteState) GetNamespace() string

func (*SiteState) HasRouterAccess

func (s *SiteState) HasRouterAccess() bool

func (*SiteState) IsBundle

func (s *SiteState) IsBundle() bool

func (*SiteState) IsInterior

func (s *SiteState) IsInterior() bool

func (*SiteState) SetNamespace

func (s *SiteState) SetNamespace(namespace string)

func (*SiteState) ToRouterConfig

func (s *SiteState) ToRouterConfig(sslProfileBasePath string, platform string) qdr.RouterConfig

type SiteStateLoader

type SiteStateLoader interface {
	Load() (*SiteState, error)
}

type SiteStateValidator

type SiteStateValidator interface {
	Validate(site *SiteState) error
}

type StaticSiteStateRenderer

type StaticSiteStateRenderer interface {
	Render(state *SiteState, reload bool) error
}

type Token

type Token struct {
	Links  []*v2alpha1.Link
	Secret *v1.Secret
}

func CreateTokens

func CreateTokens(routerAccess v2alpha1.RouterAccess, serverSecret v1.Secret, clientSecret v1.Secret) []*Token

func (*Token) Marshal

func (t *Token) Marshal() ([]byte, error)