externalresource

package

v0.0.0-...-fa857ea Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 16 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

This section is empty.

This section is empty.

This section is empty.

type ERFilesystemManager struct {
	Fs               afero.Fs
	ExternalResource ExternalResource
}

ERFilesystemManager represents ExternalResource information with the filesystem injected

func (ef *ERFilesystemManager) LoadMarkdownContent(manifestPath string) error

LoadMarkdownContent loads and store markdown content related to external resource

type ExternalEndpoint struct {
	Name string
	Url  string
}

ExternalEndpoint represents information about an endpoint

type ExternalResource struct {
	Icon      string
	Notes     *Notes
	Endpoints []*ExternalEndpoint
}

ExternalResource represents information on an external resource

func (er *ExternalResource) SetDefaults(externalName string)

SetDefaults creates the necessary environment variables given an external resource

func (er *ExternalResource) SetURLUsingEnvironFile(name string, dynamicEnvs map[string]string) error

func (er *ExternalResource) UnmarshalYAML(unmarshal func(interface{}) error) error

type K8sControl struct {
	ClientProvider func(*rest.Config) (k8s.ExternalResourceV1Interface, error)
	Cfg            *rest.Config
}

K8sControl represents the controller that performs the actions with k8s

func NewExternalK8sControl(cfg *rest.Config) *K8sControl

func (c *K8sControl) Deploy(ctx context.Context, name, ns string, er *ExternalResource) error

func (c *K8sControl) List(ctx context.Context, ns string, labelSelector string) ([]ExternalResource, error)

type Notes struct {
	Path     string
	Markdown string // base64 encoded content of the path
}

Notes represents information about the location and content of the external resource markdown

func (notes *Notes) MarshalYAML() (interface{}, error)

type Section map[string]*ExternalResource

Section represents the map of external resources at a manifest

Path	Synopsis
k8s
fake