utils

package

v0.0.27 Latest Latest Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 28 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/softwarefactory-project/sf-operator

Links

Open Source Insights

Documentation ¶

Overview ¶

Package utils provides CLI utility functions and structs

Index ¶

func ConvertMapOfBytesToMapOfStrings(contentMap map[string][]byte) map[string]string
func CreateDirectory(dirPath string, mode fs.FileMode)
func CreateKubernetesClient(contextName string) (client.Client, error)
func CreateKubernetesClientOrDie(contextName string) client.Client
func CreateROrDie(env *ENV, obj client.Object)
func DeleteAllOfOrDie(env *ENV, obj client.Object, opts ...client.DeleteAllOfOption)
func DeleteOrDie(env *ENV, obj client.Object, opts ...client.DeleteOption) bool
func EnsureNamespaceOrDie(env *ENV, name string)
func EnsureServiceAccountOrDie(env *ENV, name string)
func GetCRUDSubcommands() (*cobra.Command, *cobra.Command, *cobra.Command)
func GetClientset(kubeContext string) (*rest.Config, *kubernetes.Clientset)
func GetFileContent(filePath string) ([]byte, error)
func GetM(env *ENV, name string, obj client.Object) (bool, error)
func GetMOrDie(env *ENV, name string, obj client.Object) bool
func GetPodByName(podName string, ns string, kubeClientSet *kubernetes.Clientset) *apiv1.Pod
func GetSecretByName(secretName string, ns string, kubeClientSet *kubernetes.Clientset) *apiv1.Secret
func GetSecretValue(ns string, kubeClientSet *kubernetes.Clientset, secretName string) *string
func RunCmdOrDie(cmd string, args ...string) string
func RunCmdWithEnvOrDie(environ []string, cmd string, args ...string) string
func RunRemoteCmd(kubeContext string, namespace string, podName string, containerName string, ...) *bytes.Buffer
func UpdateROrDie(env *ENV, obj client.Object)
func VarListToMap(varsList []string) map[string]string
func WriteContentToFile(filePath string, content []byte, mode fs.FileMode)
type ENV
type SoftwareFactoryConfig
type SoftwareFactoryConfigContext
- func GetCLIContext(command *cobra.Command) (SoftwareFactoryConfigContext, error)
- func GetCLIctxOrDie(kmd *cobra.Command, args []string, allowedArgs []string) SoftwareFactoryConfigContext

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ConvertMapOfBytesToMapOfStrings ¶ added in v0.0.26

func ConvertMapOfBytesToMapOfStrings(contentMap map[string][]byte) map[string]string

func CreateDirectory ¶ added in v0.0.26

func CreateDirectory(dirPath string, mode fs.FileMode)

func CreateKubernetesClient ¶

func CreateKubernetesClient(contextName string) (client.Client, error)

func CreateKubernetesClientOrDie ¶

func CreateKubernetesClientOrDie(contextName string) client.Client

func CreateROrDie ¶

func CreateROrDie(env *ENV, obj client.Object)

func DeleteAllOfOrDie ¶

func DeleteAllOfOrDie(env *ENV, obj client.Object, opts ...client.DeleteAllOfOption)

func DeleteOrDie ¶

func DeleteOrDie(env *ENV, obj client.Object, opts ...client.DeleteOption) bool

func EnsureNamespaceOrDie ¶ added in v0.0.24

func EnsureNamespaceOrDie(env *ENV, name string)

func EnsureServiceAccountOrDie ¶ added in v0.0.24

func EnsureServiceAccountOrDie(env *ENV, name string)

func GetCRUDSubcommands ¶

func GetCRUDSubcommands() (*cobra.Command, *cobra.Command, *cobra.Command)

func GetClientset ¶ added in v0.0.26

func GetClientset(kubeContext string) (*rest.Config, *kubernetes.Clientset)

func GetFileContent ¶

func GetFileContent(filePath string) ([]byte, error)

func GetM ¶

func GetM(env *ENV, name string, obj client.Object) (bool, error)

func GetMOrDie ¶

func GetMOrDie(env *ENV, name string, obj client.Object) bool

func GetPodByName ¶ added in v0.0.26

func GetPodByName(podName string, ns string, kubeClientSet *kubernetes.Clientset) *apiv1.Pod

func GetSecretByName ¶ added in v0.0.26

func GetSecretByName(secretName string, ns string, kubeClientSet *kubernetes.Clientset) *apiv1.Secret

func GetSecretValue ¶ added in v0.0.26

func GetSecretValue(ns string, kubeClientSet *kubernetes.Clientset, secretName string) *string

func RunCmdOrDie ¶ added in v0.0.23

func RunCmdOrDie(cmd string, args ...string) string

func RunCmdWithEnvOrDie ¶ added in v0.0.23

func RunCmdWithEnvOrDie(environ []string, cmd string, args ...string) string

func RunRemoteCmd ¶ added in v0.0.26

func RunRemoteCmd(kubeContext string, namespace string, podName string, containerName string, cmdArgs []string) *bytes.Buffer

func UpdateROrDie ¶

func UpdateROrDie(env *ENV, obj client.Object)

func VarListToMap ¶ added in v0.0.24

func VarListToMap(varsList []string) map[string]string

func WriteContentToFile ¶ added in v0.0.26

func WriteContentToFile(filePath string, content []byte, mode fs.FileMode)

Types ¶

type ENV ¶

type ENV struct {
	Cli client.Client
	Ns  string
	Ctx context.Context
}

Moving code from cli/sfconfig/cmd/utils/utils.go as we need it to avoid dead code

type SoftwareFactoryConfig ¶

type SoftwareFactoryConfig struct {
	Contexts map[string]SoftwareFactoryConfigContext `json:"contexts" mapstructure:"contexts"`
	Default  string                                  `json:"default-context" mapstructure:"default-context"`
}

type SoftwareFactoryConfigContext ¶

type SoftwareFactoryConfigContext struct {
	ConfigRepository string `json:"config-repository-path" mapstructure:"config-repository-path"`
	Manifest         string `json:"manifest-file" mapstructure:"manifest-file"`
	IsStandalone     bool   `json:"standalone" mapstructure:"standalone"`
	Namespace        string `json:"namespace" mapstructure:"namespace"`
	KubeContext      string `json:"kube-context" mapstructure:"kube-context"`
	FQDN             string `json:"fqdn" mapstructure:"fqdn"`
	Dev              struct {
		AnsibleMicroshiftRolePath string `json:"ansible-microshift-role-path" mapstructure:"ansible-microshift-role-path"`
		SFOperatorRepositoryPath  string `json:"sf-operator-repository-path" mapstructure:"sf-operator-repository-path"`
		Microshift                struct {
			Host                string `json:"host" mapstructure:"host"`
			User                string `json:"user" mapstructure:"user"`
			OpenshiftPullSecret string `json:"openshift-pull-secret" mapstructure:"openshift-pull-secret"`
			DiskFileSize        string `json:"disk-file-size" mapstructure:"disk-file-size"`
		} `json:"microshift" mapstructure:"microshift"`
		Tests struct {
			DemoReposPath string            `json:"demo-repos-path" mapstructure:"demo-repos-path"`
			ExtraVars     map[string]string `json:"extra-vars" mapstructure:"extra-vars"`
		} `json:"tests" mapstructure:"tests"`
	} `json:"development" mapstructure:"development"`
	Components struct {
		Nodepool struct {
			CloudsFile string `json:"clouds-file" mapstructure:"clouds-file"`
			KubeFile   string `json:"kube-file" mapstructure:"kube-file"`
		} `json:"nodepool" mapstructure:"nodepool"`
	} `json:"components" mapstructure:"components"`
}

CLI config struct

func GetCLIContext ¶

func GetCLIContext(command *cobra.Command) (SoftwareFactoryConfigContext, error)

func GetCLIctxOrDie ¶

func GetCLIctxOrDie(kmd *cobra.Command, args []string, allowedArgs []string) SoftwareFactoryConfigContext

Source Files ¶

View all Source files

utils.go

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