docs

Documentation

Index

• type ClusterProvider
  • func NewClusterProvider(dynamicClient client.Client, log logrus.FieldLogger) *ClusterProvider
  • func (d *ClusterProvider) EnsureAssetGroup(addon *internal.Addon) error
  • func (d *ClusterProvider) EnsureAssetGroupRemoved(id string) error
  • func (d *ClusterProvider) SetNamespace(namespace string)
• type DummyProvider
  • func (s *DummyProvider) EnsureAssetGroup(addon *internal.Addon) error
  • func (*DummyProvider) EnsureAssetGroupRemoved(id string) error
  • func (*DummyProvider) SetNamespace(namespace string)
• type Provider
  • func NewProvider(dynamicClient client.Client, log logrus.FieldLogger) *Provider
  • func (d *Provider) EnsureAssetGroup(addon *internal.Addon) error
  • func (d *Provider) EnsureAssetGroupRemoved(id string) error
  • func (d *Provider) SetNamespace(namespace string)

Types

type ClusterProvider

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

ClusterProvider allows to maintain the addons cluster-wide documentation

func NewClusterProvider

func NewClusterProvider(dynamicClient client.Client, log logrus.FieldLogger) *ClusterProvider

NewClusterProvider creates a new Provider

func (*ClusterProvider) EnsureAssetGroup

func (d *ClusterProvider) EnsureAssetGroup(addon *internal.Addon) error

EnsureAssetGroup creates ClusterAssetGroup for a given addon or updates it in case it already exists

func (*ClusterProvider) EnsureAssetGroupRemoved

func (d *ClusterProvider) EnsureAssetGroupRemoved(id string) error

EnsureAssetGroupRemoved removes ClusterAssetGroup for a given addon

func (*ClusterProvider) SetNamespace

func (d *ClusterProvider) SetNamespace(namespace string)

SetNamespace sets service's working namespace

type DummyProvider

type DummyProvider struct {
}

DummyProvider is an implementation which does not perform any work but have the same interface as the Provider

func (*DummyProvider) EnsureAssetGroup

func (s *DummyProvider) EnsureAssetGroup(addon *internal.Addon) error

EnsureAssetGroup fulfills the docsFacade interface

func (*DummyProvider) EnsureAssetGroupRemoved

func (*DummyProvider) EnsureAssetGroupRemoved(id string) error

EnsureAssetGroupRemoved fulfills the docsFacade interface

func (*DummyProvider) SetNamespace

func (*DummyProvider) SetNamespace(namespace string)

SetNamespace fulfills the docsFacade interface

type Provider

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

Provider allows to maintain the addons namespace-scoped documentation

func NewProvider

func NewProvider(dynamicClient client.Client, log logrus.FieldLogger) *Provider

NewProvider creates a new Provider

func (*Provider) EnsureAssetGroup

func (d *Provider) EnsureAssetGroup(addon *internal.Addon) error

EnsureAssetGroup creates AssetGroup for a given addon or updates it in case it already exists

func (*Provider) EnsureAssetGroupRemoved

func (d *Provider) EnsureAssetGroupRemoved(id string) error

EnsureAssetGroupRemoved removes AssetGroup for a given addon

func (*Provider) SetNamespace

func (d *Provider) SetNamespace(namespace string)

SetNamespace sets service's working namespace