_const

Documentation

Index

• Constants
• Variables
• func GetRuntimeDir() string
• func GetWorkDir() string
• func RuntimeDirFromPipeline(obj kkcorev1.Pipeline) string
• func SetWorkDir(wd string)

Constants

const (
	// VariableLocalHost is the default local host name in inventory.
	VariableLocalHost = "localhost"
	// VariableIPv4 is the ipv4 in inventory.
	VariableIPv4 = "internal_ipv4"
	// VariableIPv6 is the ipv6 in inventory.
	VariableIPv6 = "internal_ipv6"
	// VariableGroups the value is a host_name slice
	VariableGroups = "groups"
	// VariableConnector is connector parameter in inventory.
	VariableConnector = "connector"
	// VariableConnectorType is connected type for VariableConnector.
	VariableConnectorType = "type"
	// VariableConnectorHost is connected address for VariableConnector.
	VariableConnectorHost = "host"
	// VariableConnectorPort is connected address for VariableConnector.
	VariableConnectorPort = "port"
	// VariableConnectorUser is connected user for VariableConnector.
	VariableConnectorUser = "user"
	// VariableConnectorPassword is connected type for VariableConnector.
	VariableConnectorPassword = "password"
	// VariableConnectorPrivateKey is connected auth key for VariableConnector.
	VariableConnectorPrivateKey = "private_key"
	// VariableConnectorKubeconfig is connected auth key for VariableConnector.
	VariableConnectorKubeconfig = "kubeconfig"
)

variable specific key in system

const (
	// VariableInventoryName the value which defined in inventory.spec.host.
	VariableInventoryName = "inventory_name"
	// VariableHostName the value is node hostname, default VariableInventoryName.
	// If VariableInventoryName is "localhost". try to set the actual name.
	VariableHostName = "hostname"
	// VariableGlobalHosts the value is host_var which defined in inventory.
	VariableGlobalHosts = "inventory_hosts"
	// VariableGroupsAll the value is a all host_name slice of VariableGroups.
	VariableGroupsAll = "all"
)

const (
	// VariableOS the value is os information.
	VariableOS = "os"
	// VariableOSRelease the value is os-release of VariableOS.
	VariableOSRelease = "release"
	// VariableOSKernelVersion the value is kernel version of VariableOS.
	VariableOSKernelVersion = "kernel_version"
	// VariableOSHostName the value is hostname of VariableOS.
	VariableOSHostName = "hostname"
	// VariableOSArchitecture the value is architecture of VariableOS.
	VariableOSArchitecture = "architecture"
	// VariableProcess the value is process information.
	VariableProcess = "process"
	// VariableProcessCPU the value is cpu info of VariableProcess.
	VariableProcessCPU = "cpuInfo"
	// VariableProcessMemory the value is memory info of VariableProcess.
	VariableProcessMemory = "memInfo"
)

const ArtifactDir = "kubekey"

ArtifactDir is the default directory name under the working directory. It is used to store files required when executing the kubekey command (such as: docker, etcd, image packages, etc.). These files will be downloaded locally and distributed to remote nodes.

const ArtifactImagesDir = "images"

ArtifactImagesDir store images files. contains blobs and manifests.

const KubernetesDir = "kubernetes"

KubernetesDir represents the remote host directory for each kubernetes connection

const ProjectDir = "projects"

ProjectDir is a fixed directory name under workdir, used to store the Ansible project.

const ProjectPlaybooksDir = "playbooks"

ProjectPlaybooksDir is a fixed directory name under ansible-project. used to store executable playbook files.

const ProjectRolesDefaultsDir = "defaults"

ProjectRolesDefaultsDir is a fixed directory name under roleName. it set default variables to role.

const ProjectRolesDefaultsMainFile = "main"

ProjectRolesDefaultsMainFile is a fixed file under defaults. support *.yaml or *yml

const ProjectRolesDir = "roles"

ProjectRolesDir is a fixed directory name under ansible-project. used to store roles which playbook need.

const ProjectRolesFilesDir = "files"

ProjectRolesFilesDir is a fixed directory name under roleName. used to store files which task need.

const ProjectRolesTasksDir = "tasks"

ProjectRolesTasksDir is a fixed directory name under roleName. used to store task which role need.

const ProjectRolesTasksMainFile = "main"

ProjectRolesTasksMainFile is a fixed file under tasks. it must run if the role run. support *.yaml or *yml

const ProjectRolesTemplateDir = "templates"

ProjectRolesTemplateDir is a fixed directory name under roleName. used to store template which task need.

const RuntimeDir = "runtime"

RuntimeDir is a fixed directory name under workdir, used to store the runtime data of the current task execution.

const RuntimePipelineDir = "pipelines"

RuntimePipelineDir store Pipeline resources

const RuntimePipelineVariableDir = "variable"

RuntimePipelineVariableDir is a fixed directory name under runtime, used to store the task execution parameters.

const (
	// VariableItem for "loop" argument when run a task.
	VariableItem = "item"
)

Variables

var (
	// Scheme is the default instance of runtime.Scheme to which types in the Kubernetes API are already registered.
	// NOTE: If you are copying this file to start a new api group, STOP! Copy the
	// extensions group instead. This Scheme is special and should appear ONLY in
	// the api group, unless you really know what you're doing.
	Scheme = newScheme()

	// Codecs provides access to encoding and decoding for the scheme
	Codecs = serializer.NewCodecFactory(Scheme)

	// ParameterCodec handles versioning of objects that are converted to query parameters.
	ParameterCodec = runtime.NewParameterCodec(Scheme)
)

Functions

func GetRuntimeDir

func GetRuntimeDir() string

GetRuntimeDir returns the absolute path of the runtime directory.

func GetWorkDir

func GetWorkDir() string

GetWorkDir returns the workdir.

func RuntimeDirFromPipeline

func RuntimeDirFromPipeline(obj kkcorev1.Pipeline) string

RuntimeDirFromPipeline returns the absolute path of the runtime directory for specify Pipeline

func SetWorkDir

func SetWorkDir(wd string)

SetWorkDir sets the workdir once.