console

Documentation

Index

• Constants
• func ConsoleExternalLogLinkEnabled(client client.Client) bool
• func ConsoleExternalLogLinkEqual(current, desired *consolev1.ConsoleExternalLogLink) bool
• func ConsoleLinkEnabled(client client.Client) bool
• func ConsoleLinksEqual(current, desired *consolev1.ConsoleLink) bool
• func CreateOrUpdateConsoleExternalLogLink(ctx context.Context, c client.Client, cll *consolev1.ConsoleExternalLogLink, ...) error
• func CreateOrUpdateConsoleLink(ctx context.Context, c client.Client, cl *consolev1.ConsoleLink, ...) error
• func DeleteConsoleExternalLogLink(ctx context.Context, c client.Client, log logr.Logger) error
• func DeleteKibanaConsoleLink(ctx context.Context, c client.Client, log logr.Logger) error
• func MutateConsoleExternalLogLink(current, desired *consolev1.ConsoleExternalLogLink)
• func MutateConsoleLinkSpecOnly(current, desired *consolev1.ConsoleLink)
• func NewConsoleExternalLogLink(consoleText, hrefTemplate string, labels map[string]string) *consolev1.ConsoleExternalLogLink
• func NewConsoleLink(name, href, text, icon, section string) *consolev1.ConsoleLink
• type ConsoleExternalLogLinkEqualityFunc
• type ConsoleLinkEqualityFunc
• type MutateConsoleExternalLogLinkFunc
• type MutateConsoleLinkFunc

Constants

const ExternalLogLinkName = "kibana"

const KibanaConsoleLinkName = "kibana-public-url"

Functions

func ConsoleExternalLogLinkEnabled

func ConsoleExternalLogLinkEnabled(client client.Client) bool

func ConsoleExternalLogLinkEqual

func ConsoleExternalLogLinkEqual(current, desired *consolev1.ConsoleExternalLogLink) bool

ConsoleExternalLogLinkEqual returns true href template and text are equal.

func ConsoleLinkEnabled

func ConsoleLinkEnabled(client client.Client) bool

func ConsoleLinksEqual

func ConsoleLinksEqual(current, desired *consolev1.ConsoleLink) bool

ConsoleLinksEqual returns true all of the following are equal: - location - link text - link href - application menu section

func CreateOrUpdateConsoleExternalLogLink

func CreateOrUpdateConsoleExternalLogLink(ctx context.Context, c client.Client, cll *consolev1.ConsoleExternalLogLink, equal ConsoleExternalLogLinkEqualityFunc, mutate MutateConsoleExternalLogLinkFunc) error

CreateOrUpdateConsoleExternalLogLink attempts first to get the given consoleexternalloglink. If the consoleexternalloglink does not exist, the consoleexternalloglink will be created. Otherwise, if the consoleexternalloglink exists and the provided comparison func detects any changes an update is attempted. Updates are retried with backoff (See retry.DefaultRetry). Returns on failure an non-nil error.

func CreateOrUpdateConsoleLink

func CreateOrUpdateConsoleLink(ctx context.Context, c client.Client, cl *consolev1.ConsoleLink, equal ConsoleLinkEqualityFunc, mutate MutateConsoleLinkFunc) error

CreateOrUpdateConsoleLink attempts first to get the given consolelink. If the consolelink does not exist, the consolelink will be created. Otherwise, if the consolelink exists and the provided comparison func detects any changes an update is attempted. Updates are retried with backoff (See retry.DefaultRetry). Returns on failure an non-nil error.

func DeleteConsoleExternalLogLink

func DeleteConsoleExternalLogLink(ctx context.Context, c client.Client, log logr.Logger) error

func DeleteKibanaConsoleLink

func DeleteKibanaConsoleLink(ctx context.Context, c client.Client, log logr.Logger) error

func MutateConsoleExternalLogLink

func MutateConsoleExternalLogLink(current, desired *consolev1.ConsoleExternalLogLink)

MutateConsoleExternalLogLink is a default mutate implementation that copies only the href template and text from desired to current consoleexternalloglink.

func MutateConsoleLinkSpecOnly

func MutateConsoleLinkSpecOnly(current, desired *consolev1.ConsoleLink)

MutateSpecOnly is a default mutate implementation that copies only the spec from desired to current consolelink.

func NewConsoleExternalLogLink

func NewConsoleExternalLogLink(consoleText, hrefTemplate string, labels map[string]string) *consolev1.ConsoleExternalLogLink

NewConsoleExternalLogLink returns a new opensnfhit api ConsoleExternalLogLink

func NewConsoleLink

func NewConsoleLink(name, href, text, icon, section string) *consolev1.ConsoleLink

NewConsoleLink returns a new openshift api console link

Types

type ConsoleExternalLogLinkEqualityFunc

type ConsoleExternalLogLinkEqualityFunc func(current, desired *consolev1.ConsoleExternalLogLink) bool

EqualityFunc is the type for functions that compare two consoleexternalloglinks. Return true if two consoleexternalloglinks are not not equal.

type ConsoleLinkEqualityFunc

type ConsoleLinkEqualityFunc func(current, desired *consolev1.ConsoleLink) bool

ConsoleLinkEqualityFunc is the type for functions that compare two consolelinks. Return true if two consolelinks are equal.

type MutateConsoleExternalLogLinkFunc

type MutateConsoleExternalLogLinkFunc func(current, desired *consolev1.ConsoleExternalLogLink)

MutateFunc is the type for functions that mutate the current consoleexternalloglink by applying the values from the desired consoleexternalloglink.

type MutateConsoleLinkFunc

type MutateConsoleLinkFunc func(current, desired *consolev1.ConsoleLink)

MutateConsoleLinkFunc is the type for functions that mutate the current consolelink by applying the values from the desired consolelink.