helpers

package

v1.0.12 Latest Latest Go to latest Published: Jun 14, 2022 License: Apache-2.0 Imports: 36 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

Repository

github.com/stolostron/cm-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ConvertReaderFileToValuesMap(path string, reader *asset.ScenarioResourcesReader) (values map[string]interface{}, err error)
func ConvertValuesFileToValuesMap(path, prefix string) (values map[string]interface{}, err error)
func ExecuteWithContext(context string, args []string, dryRun bool, ...) error
func GetACMVersion(cmFlags *genericclioptions.CMFlags, kubeClient kubernetes.Interface, ...) (version, snapshot string, err error)
func GetExampleHeader() string
func GetMCEVersion(cmFlags *genericclioptions.CMFlags, kubeClient kubernetes.Interface, ...) (version, snapshot string, err error)
func GetVersion(cmFlags *genericclioptions.CMFlags, isCPHCommand bool, cphName string) (version string, platform string, err error)
func IsHypershift(cmFlags *genericclioptions.CMFlags) (bool, error)
func IsIDPInstalled(cmFlags *genericclioptions.CMFlags, skipIDPCheck bool) (isIDPInstalled bool, err error)
func IsMCE(cmFlags *genericclioptions.CMFlags) bool
func IsOpenshift(cmFlags *genericclioptions.CMFlags) (bool, error)
func IsRHACM(cmFlags *genericclioptions.CMFlags) bool
func IsSupported(cmFlags *genericclioptions.CMFlags) (isSupported bool, err error)
func IsSupportedVersion(cmFlags *genericclioptions.CMFlags, isCPHCommand bool, cphName string, ...) (isSupported bool, platform string, err error)
func NestedExists(obj map[string]interface{}, dotedPath string) (bool, error)
func NestedString(obj map[string]interface{}, dotedPath string) (string, error)
func Openbrowser(url string) error
func Print(obj runtime.Object, printFlags *get.PrintFlags) error
func RandStringRunes_az09(n int) string
func SetComponentEnable(cmFlags *genericclioptions.CMFlags, componentName string, enable bool) error
func SetNestedField(obj map[string]interface{}, value interface{}, dotedPath string) error
func TimeDiff(t time.Time, precision time.Duration) string
func WaitKlusterlet(clusterClient clusterclientset.Interface, clusterName string, timeout int) error
func WaitKlusterletAddons(workClient workclientset.Interface, clusterName string, timeout int) error

Constants ¶

View Source

const (
	QPS   = 200
	Burst = 200
)

View Source

const (
	YamlFormat            string = "yaml"
	JsonFormat            string = "json"
	JsonPathFormat        string = "jsonpath="
	CustomColumnsFormat   string = "columns="
	ColumnsSeparator      string = ","
	SupportedOutputFormat string = YamlFormat + "|" + JsonFormat + "|" + JsonPathFormat + "|" + CustomColumnsFormat + "..."
)

View Source

const (
	RHACM      string = "RHACM"
	MCE        string = "MCE"
	HYPERSHIFT string = "Hypershift"
)

Variables ¶

View Source

var (
	GvrCC                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "hive.openshift.io", Version: "v1", Resource: "clusterclaims"}
	GvrCP                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "hive.openshift.io", Version: "v1", Resource: "clusterpools"}
	GvrCD                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "hive.openshift.io", Version: "v1", Resource: "clusterdeployments"}
	GvrCIS                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "hive.openshift.io", Version: "v1", Resource: "clusterimagesets"}
	GvrPol                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "policy.open-cluster-management.io", Version: "v1", Resource: "policies"}
	GvrMCH                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "operator.open-cluster-management.io", Version: "v1", Resource: "multiclusterhubs"}
	GvrMCEV1alpha1              schema.GroupVersionResource = schema.GroupVersionResource{Group: "multicluster.openshift.io", Version: "v1alpha1", Resource: "multiclusterengines"}
	GvrMCEV1                    schema.GroupVersionResource = schema.GroupVersionResource{Group: "multicluster.openshift.io", Version: "v1", Resource: "multiclusterengines"}
	GvrMC                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "cluster.open-cluster-management.io", Version: "v1", Resource: "managedclusters"}
	GvrCSV                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "operators.coreos.com", Version: "v1alpha1", Resource: "clusterserviceversions"}
	GvrPLC                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "cluster.open-cluster-management.io", Version: "v1alpha1", Resource: "placements"}
	GvrMCS                      schema.GroupVersionResource = schema.GroupVersionResource{Group: "cluster.open-cluster-management.io", Version: "v1beta1", Resource: "managedclustersets"}
	GvrMCSB                     schema.GroupVersionResource = schema.GroupVersionResource{Group: "cluster.open-cluster-management.io", Version: "v1beta1", Resource: "managedclustersetbindings"}
	GvrIDPConfig                schema.GroupVersionResource = schema.GroupVersionResource{Group: "identityconfig.identitatem.io", Version: "v1alpha1", Resource: "idpconfigs"}
	GvrOpenshiftClusterVersions schema.GroupVersionResource = schema.GroupVersionResource{Group: "config.openshift.io", Version: "v1", Resource: "clusterversions"}
	GvrHC                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "hypershift.openshift.io", Version: "v1alpha1", Resource: "hostedclusters"}
	GvrHD                       schema.GroupVersionResource = schema.GroupVersionResource{Group: "cluster.open-cluster-management.io", Version: "v1alpha1", Resource: "hypershiftdeployments"}
)

Functions ¶

func ConvertReaderFileToValuesMap ¶

func ConvertReaderFileToValuesMap(path string,
	reader *asset.ScenarioResourcesReader) (values map[string]interface{}, err error)

func ConvertValuesFileToValuesMap ¶

func ConvertValuesFileToValuesMap(path, prefix string) (values map[string]interface{}, err error)

func ExecuteWithContext ¶

func ExecuteWithContext(context string, args []string, dryRun bool, streams genericclioptions.IOStreams, outputFile string) error

func GetACMVersion ¶

func GetACMVersion(cmFlags *genericclioptions.CMFlags, kubeClient kubernetes.Interface, dynamicClient dynamic.Interface) (version, snapshot string, err error)

func GetExampleHeader ¶

func GetExampleHeader() string

func GetMCEVersion ¶

func GetMCEVersion(cmFlags *genericclioptions.CMFlags, kubeClient kubernetes.Interface, dynamicClient dynamic.Interface) (version, snapshot string, err error)

func GetVersion ¶

func GetVersion(cmFlags *genericclioptions.CMFlags, isCPHCommand bool, cphName string) (version string, platform string, err error)

func IsHypershift ¶ added in v1.0.7

func IsHypershift(cmFlags *genericclioptions.CMFlags) (bool, error)

func IsIDPInstalled ¶ added in v1.0.6

func IsIDPInstalled(cmFlags *genericclioptions.CMFlags, skipIDPCheck bool) (isIDPInstalled bool, err error)

func IsMCE ¶

func IsMCE(cmFlags *genericclioptions.CMFlags) bool

func IsOpenshift ¶ added in v1.0.6

func IsOpenshift(cmFlags *genericclioptions.CMFlags) (bool, error)

func IsRHACM ¶

func IsRHACM(cmFlags *genericclioptions.CMFlags) bool

func IsSupported ¶

func IsSupported(cmFlags *genericclioptions.CMFlags) (isSupported bool, err error)

func IsSupportedVersion ¶

func IsSupportedVersion(cmFlags *genericclioptions.CMFlags, isCPHCommand bool, cphName string, rhacmConstraint string, mceConstraint string) (isSupported bool, platform string, err error)

IsSupportedVersion returns boolean true if the constraint is statified along with the platform ACM/MCE. Returns an error if it can not determine the version if the platform.

func NestedExists ¶ added in v1.0.11

func NestedExists(obj map[string]interface{}, dotedPath string) (bool, error)

NestedExists returns true if the nested field exists and an error if unable to traverse obj.

func NestedString ¶ added in v1.0.11

func NestedString(obj map[string]interface{}, dotedPath string) (string, error)

func Openbrowser ¶

func Openbrowser(url string) error

func Print ¶

func Print(obj runtime.Object, printFlags *get.PrintFlags) error

func RandStringRunes_az09 ¶

func RandStringRunes_az09(n int) string

func SetComponentEnable ¶ added in v1.0.11

func SetComponentEnable(cmFlags *genericclioptions.CMFlags, componentName string, enable bool) error

func SetNestedField ¶ added in v1.0.11

func SetNestedField(obj map[string]interface{}, value interface{}, dotedPath string) error

func TimeDiff ¶

func TimeDiff(t time.Time, precision time.Duration) string

func WaitKlusterlet ¶

func WaitKlusterlet(clusterClient clusterclientset.Interface,
	clusterName string,
	timeout int) error

func WaitKlusterletAddons ¶

func WaitKlusterletAddons(workClient workclientset.Interface,
	clusterName string,
	timeout int) error

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL