helpers

Documentation

Overview

Copyright Contributors to the Open Cluster Management project

Index

• func DryRunMessage(dryRun bool)
• func GetAPIServer(kubeClient kubernetes.Interface) (string, error)
• func GetBootstrapSecret(kubeClient kubernetes.Interface) (*corev1.Secret, error)
• func GetBootstrapSecretFromSA(kubeClient kubernetes.Interface) (*corev1.Secret, error)
• func GetBootstrapToken(kubeClient kubernetes.Interface) (string, error)
• func GetBootstrapTokenFromSA(kubeClient kubernetes.Interface) (string, error)
• func GetCACert(kubeClient kubernetes.Interface) ([]byte, error)
• func GetClients(f util.Factory) (kubeClient kubernetes.Interface, ...)
• func GetExampleHeader() string
• func GetSpinnerPodStatus(pod *corev1.Pod) string
• func IsClusterManagerInstalled(apiExtensionsClient apiextensionsclient.Interface) (bool, error)
• func NewSpinner(suffix string, interval time.Duration) *spinner.Spinner
• func NewSpinnerWithStatus(suffix string, interval time.Duration, final string, statusFunc func() string) *spinner.Spinner
• func RandStringRunes_az09(n int) string
• func UsageTempate(cmd *cobra.Command, reader asset.ScenarioReader, valuesTemplatePath string) string
• func WaitCRDToBeReady(apiExtensionsClient apiextensionsclient.Interface, name string, b wait.Backoff) error
• func WatchUntil(watchFunc func() (watch.Interface, error), ...) error
• type TokenType
  • func GetToken(kubeClient kubernetes.Interface) (string, TokenType, error)

Functions

func DryRunMessage

func DryRunMessage(dryRun bool)

func GetAPIServer

func GetAPIServer(kubeClient kubernetes.Interface) (string, error)

GetAPIServer gets the api server url

func GetBootstrapSecret

func GetBootstrapSecret(kubeClient kubernetes.Interface) (*corev1.Secret, error)

GetBootstrapSecret returns the secret in kube-system

func GetBootstrapSecretFromSA

func GetBootstrapSecretFromSA(
	kubeClient kubernetes.Interface) (*corev1.Secret, error)

func GetBootstrapToken

func GetBootstrapToken(kubeClient kubernetes.Interface) (string, error)

GetBootstrapToken returns the token in kube-system

func GetBootstrapTokenFromSA

func GetBootstrapTokenFromSA(
	kubeClient kubernetes.Interface) (string, error)

GetBootstrapSecretFromSA retrieves the service-account token secret

func GetCACert

func GetCACert(kubeClient kubernetes.Interface) ([]byte, error)

GetCACert returns the CA cert. First by looking in the cluster-info configmap of the kube-public ns and if not found, it searches in the kube-root-ca.crt configmap.

func GetClients

func GetClients(f util.Factory) (
	kubeClient kubernetes.Interface,
	apiExtensionsClient apiextensionsclient.Interface,
	dynamicClient dynamic.Interface,
	err error)

func GetExampleHeader

func GetExampleHeader() string

func GetSpinnerPodStatus

func GetSpinnerPodStatus(pod *corev1.Pod) string

func IsClusterManagerInstalled

func IsClusterManagerInstalled(apiExtensionsClient apiextensionsclient.Interface) (bool, error)

IsClusterManagerInstalled checks if the hub is already initialized. It checks if the crd is already present to find out that the hub is already initialized.

func NewSpinner

func NewSpinner(suffix string, interval time.Duration) *spinner.Spinner

func NewSpinnerWithStatus

func NewSpinnerWithStatus(suffix string, interval time.Duration, final string, statusFunc func() string) *spinner.Spinner

func RandStringRunes_az09

func RandStringRunes_az09(n int) string

func UsageTempate

func UsageTempate(cmd *cobra.Command, reader asset.ScenarioReader, valuesTemplatePath string) string

func WaitCRDToBeReady

func WaitCRDToBeReady(apiExtensionsClient apiextensionsclient.Interface, name string, b wait.Backoff) error

WaitCRDToBeReady waits if a crd is ready

func WatchUntil

func WatchUntil(
	watchFunc func() (watch.Interface, error),
	assertEvent func(event watch.Event) bool) error

WatchUntil starts a watch stream and holds until the condition is satisfied.

Types

type TokenType

type TokenType string

const (
	BootstrapToken      TokenType = "bootstrap-token"
	ServiceAccountToken TokenType = "service-account-token"
	UnknownToken        TokenType = "unknown-token"
)

func GetToken

func GetToken(kubeClient kubernetes.Interface) (string, TokenType, error)

GetToken returns the bootstrap token. It searchs first for the service-account token and then if it is not found it looks for the bootstrap token in kube-system.