common

Documentation

Index

• Constants
• Variables
• func AskToChooseOneNamespace(c client.Client, envMeta *types.EnvMeta) error
• func ClusterObject2Map(refs []common.ClusterObjectReference) map[string]string
• func FilterObjectsByCondition(objs []*unstructured.Unstructured, ...) (outs []*unstructured.Unstructured)
• func GenOpenAPI(val cue.Value) (b []byte, err error)
• func GenerateUnstructuredObj(name, ns string, gvk schema.GroupVersionKind) *unstructured.Unstructured
• func GetCUEParameterValue(cueStr string, pd *packages.PackageDiscover) (cue.Value, error)
• func GetClient() (client.Client, error)
• func HTTPGetKubernetesObjects(ctx context.Context, url string) ([]*unstructured.Unstructured, error)
• func HTTPGetResponse(ctx context.Context, url string, opts *HTTPOption) (*http.Response, error)
• func HTTPGetWithOption(ctx context.Context, url string, opts *HTTPOption) ([]byte, error)
• func NewK8sClient() (client.Client, error)
• func ParseTerraformVariables(configuration string) (map[string]*tfconfig.Variable, map[string]*tfconfig.Output, error)
• func ReadYamlToObject(path string, object k8sruntime.Object) error
• func RealtimePrintCommandOutput(cmd *exec.Cmd, logFile string) error
• func RefineParameterValue(val cue.Value) (cue.Value, error)
• func SetGlobalClient(clt client.Client) error
• func SetSpecObjIntoUnstructuredObj(spec interface{}, u *unstructured.Unstructured) error
• type Args
  • func InitBaseRestConfig() (Args, error)
  • func (a *Args) GetClient() (client.Client, error)
  • func (a *Args) GetConfig() (*rest.Config, error)
  • func (a *Args) GetDiscoveryClient() (*discovery.DiscoveryClient, error)
  • func (a *Args) GetDiscoveryMapper() (discoverymapper.DiscoveryMapper, error)
  • func (a *Args) GetFakeClient(defs []oam.Object) (client.Client, error)
  • func (a *Args) GetPackageDiscover() (*packages.PackageDiscover, error)
  • func (a *Args) SetClient(c client.Client)
  • func (a *Args) SetConfig(c *rest.Config) error
• type HTTPOption
• type ResourceLocation

Constants

const (
	// AddonObservabilityApplication is the application name for Addon Observability
	AddonObservabilityApplication = "addon-observability"
	// AddonObservabilityGrafanaSvc is grafana service name for Addon Observability
	AddonObservabilityGrafanaSvc = "grafana"
)

const CreateCustomNamespace = "create new namespace"

CreateCustomNamespace display the create namespace message

Variables

var (
	// Scheme defines the default KubeVela schema
	Scheme = k8sruntime.NewScheme()
)

Functions

func AskToChooseOneNamespace

func AskToChooseOneNamespace(c client.Client, envMeta *types.EnvMeta) error

AskToChooseOneNamespace ask for choose one namespace as env

func ClusterObject2Map

func ClusterObject2Map(refs []common.ClusterObjectReference) map[string]string

ClusterObject2Map convert ClusterObjectReference to a readable map

func FilterObjectsByCondition

func FilterObjectsByCondition(objs []*unstructured.Unstructured, filter func(unstructured2 *unstructured.Unstructured) bool) (outs []*unstructured.Unstructured)

FilterObjectsByCondition filter object slices by condition function

func GenOpenAPI

func GenOpenAPI(val cue.Value) (b []byte, err error)

GenOpenAPI generates OpenAPI json schema from cue.Instance

func GenerateUnstructuredObj

func GenerateUnstructuredObj(name, ns string, gvk schema.GroupVersionKind) *unstructured.Unstructured

GenerateUnstructuredObj generate UnstructuredObj

func GetCUEParameterValue

func GetCUEParameterValue(cueStr string, pd *packages.PackageDiscover) (cue.Value, error)

GetCUEParameterValue converts definitions to cue format nolint:staticcheck

func GetClient

func GetClient() (client.Client, error)

GetClient will K8s client in args

func HTTPGetKubernetesObjects

func HTTPGetKubernetesObjects(ctx context.Context, url string) ([]*unstructured.Unstructured, error)

HTTPGetKubernetesObjects use HTTP requests to load resources from remote url

func HTTPGetResponse

func HTTPGetResponse(ctx context.Context, url string, opts *HTTPOption) (*http.Response, error)

HTTPGetResponse use HTTP option and default client to send request and get raw response

func HTTPGetWithOption

func HTTPGetWithOption(ctx context.Context, url string, opts *HTTPOption) ([]byte, error)

HTTPGetWithOption use HTTP option and default client to send get request

func NewK8sClient

func NewK8sClient() (client.Client, error)

NewK8sClient init a local k8s client which add oamcore scheme

func ParseTerraformVariables

func ParseTerraformVariables(configuration string) (map[string]*tfconfig.Variable, map[string]*tfconfig.Output, error)

ParseTerraformVariables get variables from Terraform Configuration

func ReadYamlToObject

func ReadYamlToObject(path string, object k8sruntime.Object) error

ReadYamlToObject will read a yaml K8s object to runtime.Object

func RealtimePrintCommandOutput

func RealtimePrintCommandOutput(cmd *exec.Cmd, logFile string) error

RealtimePrintCommandOutput prints command output in real time If logFile is "", it will prints the stdout, or it will write to local file

func RefineParameterValue

func RefineParameterValue(val cue.Value) (cue.Value, error)

RefineParameterValue refines cue value to merely include `parameter` identifier nolint:staticcheck

func SetGlobalClient

func SetGlobalClient(clt client.Client) error

SetGlobalClient will set a client for one cli command

func SetSpecObjIntoUnstructuredObj

func SetSpecObjIntoUnstructuredObj(spec interface{}, u *unstructured.Unstructured) error

SetSpecObjIntoUnstructuredObj set UnstructuredObj spec field

Types

type Args

type Args struct {
	Schema *runtime.Scheme
	// contains filtered or unexported fields
}

Args is args for controller-runtime client

func InitBaseRestConfig

func InitBaseRestConfig() (Args, error)

InitBaseRestConfig will return reset config for create controller runtime client

func (*Args) GetClient

func (a *Args) GetClient() (client.Client, error)

GetClient get client if exist

func (*Args) GetConfig

func (a *Args) GetConfig() (*rest.Config, error)

GetConfig get config, if not exist, will create

func (*Args) GetDiscoveryClient

func (a *Args) GetDiscoveryClient() (*discovery.DiscoveryClient, error)

GetDiscoveryClient return a discovery client from cli args

func (*Args) GetDiscoveryMapper

func (a *Args) GetDiscoveryMapper() (discoverymapper.DiscoveryMapper, error)

GetDiscoveryMapper get discoveryMapper client if exist, create if not exist.

func (*Args) GetFakeClient

func (a *Args) GetFakeClient(defs []oam.Object) (client.Client, error)

GetFakeClient returns a fake client with the definition objects preloaded

func (*Args) GetPackageDiscover

func (a *Args) GetPackageDiscover() (*packages.PackageDiscover, error)

GetPackageDiscover get PackageDiscover client if exist, create if not exist.

func (*Args) SetClient

func (a *Args) SetClient(c client.Client)

SetClient set custom client

func (*Args) SetConfig

func (a *Args) SetConfig(c *rest.Config) error

SetConfig insert kubeconfig into Args

type HTTPOption

type HTTPOption struct {
	Username        string
	Password        string
	CaFile          string
	CertFile        string
	KeyFile         string
	InsecureSkipTLS bool
}

HTTPOption define the https options

type ResourceLocation

type ResourceLocation struct {
	Cluster   string
	Namespace string
}

ResourceLocation indicates the resource location