projutil

Documentation

Index

• Constants
• func CheckAndGetProjectGoPkg() string
• func CombineManifests(base, manifest []byte) []byte
• func GenerateCombinedGlobalManifest() (*os.File, error)
• func GenerateCombinedNamespacedManifest() (*os.File, error)
• func GetGopath() string
• func MustGetwd() string
• func MustGoProjectCmd(cmd *cobra.Command)
• func MustInProjectRoot()
• func SetGopath(currentGopath string) string
• type OperatorType
  • func GetOperatorType() OperatorType

Constants

const (
	GopathEnv = "GOPATH"
)

const (
	SrcDir = "src"
)

Functions

func CheckAndGetProjectGoPkg

func CheckAndGetProjectGoPkg() string

CheckAndGetProjectGoPkg checks if this project's repository path is rooted under $GOPATH and returns the current directory's import path e.g: "github.com/example-inc/app-operator"

func CombineManifests

func CombineManifests(base, manifest []byte) []byte

CombineManifests combines a given manifest with a base manifest and adds yaml style separation. Nothing is appended if the manifest is empty.

func GenerateCombinedGlobalManifest

func GenerateCombinedGlobalManifest() (*os.File, error)

GenerateCombinedGlobalManifest creates a temporary manifest yaml containing all standard global resource manifests combined into 1 file

func GenerateCombinedNamespacedManifest

func GenerateCombinedNamespacedManifest() (*os.File, error)

GenerateCombinedNamespacedManifest creates a temporary manifest yaml containing all standard namespaced resource manifests combined into 1 file

func GetGopath

func GetGopath() string

GetGopath gets GOPATH and makes sure it is set and non-empty.

func MustGetwd

func MustGetwd() string

func MustGoProjectCmd

func MustGoProjectCmd(cmd *cobra.Command)

func MustInProjectRoot

func MustInProjectRoot()

MustInProjectRoot checks if the current dir is the project root and returns the current repo's import path e.g github.com/example-inc/app-operator

func SetGopath

func SetGopath(currentGopath string) string

SetGopath sets GOPATH=currentGopath after processing a path list, if any, then returns the set path.

Types

type OperatorType

type OperatorType = string

OperatorType - the type of operator

const (
	// OperatorTypeGo - golang type of operator.
	OperatorTypeGo OperatorType = "go"
	// OperatorTypeAnsible - ansible type of operator.
	OperatorTypeAnsible OperatorType = "ansible"
	// OperatorTypeHelm - helm type of operator.
	OperatorTypeHelm OperatorType = "helm"
	// OperatorTypeUnknown - unknown type of operator.
	OperatorTypeUnknown OperatorType = "unknown"
)

func GetOperatorType

func GetOperatorType() OperatorType

GetOperatorType returns type of operator is in cwd This function should be called after verifying the user is in project root e.g: "go", "ansible"