util

package
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 4, 2021 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Overview

Copyright 2019 The KubeEdge Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const (
	KubeEdgeDownloadURL  = "https://github.com/kubeedge/kubeedge/releases/download"
	EdgeServiceFile      = "edgecore.service"
	CloudServiceFile     = "cloudcore.service"
	ServiceFileURLFormat = "https://raw.githubusercontent.com/kubeedge/kubeedge/release-%s/build/tools/%s"
	KubeEdgePath         = "/etc/kubeedge/"
	KubeEdgeUsrBinPath   = "/usr/local/bin"
	KubeEdgeBinaryName   = "edgecore"

	KubeCloudBinaryName = "cloudcore"

	KubeEdgeConfigDir        = KubeEdgePath + "config/"
	KubeEdgeCloudCoreNewYaml = KubeEdgeConfigDir + "cloudcore.yaml"
	KubeEdgeEdgeCoreNewYaml  = KubeEdgeConfigDir + "edgecore.yaml"

	KubeEdgeLogPath = "/var/log/kubeedge/"
	KubeEdgeCrdPath = KubeEdgePath + "crds"

	KubeEdgeSocketPath = "/var/lib/kubeedge/"

	EdgeRootDir = "/var/lib/edged"

	SystemdBootPath = "/run/systemd/system"

	KubeEdgeCRDDownloadURL = "https://raw.githubusercontent.com/kubeedge/kubeedge/release-%s/build/crds"

	RetryTimes = 5

	OSArchAMD64 string = "amd64"
	OSArchARM64 string = "arm64"
	OSArchARM32 string = "arm"

	APT    string = "apt"
	YUM    string = "yum"
	PACMAN string = "pacman"
)

Constants used by installers

Variables

This section is empty.

Functions

func AddToolVals 

func AddToolVals(f *pflag.Flag, flagData map[string]types.FlagData)

AddToolVals gets the value and default values of each flags and collects them in temporary cache

func BuildConfig 

func BuildConfig(kubeConfig, master string) (conf *rest.Config, err error)

build Config from flags

func CheckIfAvailable 

func CheckIfAvailable(val, defval string) string

CheckIfAvailable checks is val of a flag is empty then return the default value

func Compress 

func Compress(tarName string, paths []string) (err error)

Compressed folders or files

func ExecShellFilter 

func ExecShellFilter(c string) (string, error)

Execute shell script and filter

func FileExists 

func FileExists(path string) bool

func GetLatestVersion 

func GetLatestVersion() (string, error)

GetLatestVersion return the latest non-prerelease, non-draft version of kubeedge in releases

func GetOSInterface 

func GetOSInterface() types.OSTypeInstaller

GetOSInterface helps in returning OS specific object which implements OSTypeInstaller interface.

func GetPackageManager 

func GetPackageManager() string

GetPackageManager get package manager of OS

func IsContain 

func IsContain(items []string, item string) bool

Determine if it is in the array

func KubeClient 

func KubeClient(kubeConfigPath string) (*kubernetes.Clientset, error)

KubeClient from config

func ParseEdgecoreConfig 

func ParseEdgecoreConfig(edgecorePath string) (*v1alpha1.EdgeCoreConfig, error)

func PrintFail 

func PrintFail(cmd string, s string)

print fail

func PrintSucceed 

func PrintSucceed(cmd string, s string)

print success

func RunningModule 

func RunningModule() (types.ModuleRunning, error)

RunningModule identifies cloudcore/edgecore running or not.

Types

type Command 

type Command struct {
	Cmd      *exec.Cmd
	StdOut   []byte
	StdErr   []byte
	ExitCode int
}

Command defines commands to be executed and captures std out and std error

func NewCommand 

func NewCommand(command string) *Command

func (*Command) Exec 

func (cmd *Command) Exec() error

Exec run command and exit formatted error, callers can print err directly Any running error or non-zero exitcode is consider as error

func (Command) GetCommand 

func (cmd Command) GetCommand() string

func (Command) GetStdErr 

func (cmd Command) GetStdErr() string

func (Command) GetStdOut 

func (cmd Command) GetStdOut() string

type Common 

type Common struct {
	types.OSTypeInstaller
	OSVersion   string
	ToolVersion semver.Version
	KubeConfig  string
	Master      string
}

Common struct contains OS and Tool version properties and also embeds OS interface

func (*Common) SetOSInterface 

func (co *Common) SetOSInterface(intf types.OSTypeInstaller)

SetOSInterface defines a method to set the implemtation of the OS interface

type DebOS 

type DebOS struct {
	KubeEdgeVersion semver.Version
	IsEdgeNode      bool //True - Edgenode False - Cloudnode
}

DebOS struct objects shall have information of the tools version to be installed on Hosts having Ubuntu OS. It implements OSTypeInstaller interface

func (*DebOS) InstallKubeEdge 

func (d *DebOS) InstallKubeEdge(options types.InstallOptions) error

InstallKubeEdge downloads the provided version of KubeEdge. Untar's in the specified location /etc/kubeedge/ and then copies the binary to excecutables' path (eg: /usr/local/bin)

func (*DebOS) InstallMQTT 

func (d *DebOS) InstallMQTT() error

InstallMQTT checks if MQTT is already installed and running, if not then install it from OS repo

func (*DebOS) IsK8SComponentInstalled 

func (d *DebOS) IsK8SComponentInstalled(kubeConfig, master string) error

IsK8SComponentInstalled checks if said K8S version is already installed in the host

func (*DebOS) IsKubeEdgeProcessRunning 

func (d *DebOS) IsKubeEdgeProcessRunning(proc string) (bool, error)

IsKubeEdgeProcessRunning checks if the given process is running or not

func (*DebOS) IsProcessRunning 

func (d *DebOS) IsProcessRunning(proc string) (bool, error)

func (*DebOS) KillKubeEdgeBinary 

func (d *DebOS) KillKubeEdgeBinary(proc string) error

KillKubeEdgeBinary will search for KubeEdge process and forcefully kill it

func (*DebOS) RunEdgeCore 

func (d *DebOS) RunEdgeCore() error

RunEdgeCore starts edgecore with logs being captured

func (*DebOS) SetKubeEdgeVersion 

func (d *DebOS) SetKubeEdgeVersion(version semver.Version)

SetKubeEdgeVersion sets the KubeEdge version for the objects instance

type K8SInstTool 

type K8SInstTool struct {
	Common
}

K8SInstTool embedes Common struct and contains the default K8S version and a flag depicting if host is an edge or cloud node It implements ToolsInstaller interface

func (*K8SInstTool) InstallTools 

func (ks *K8SInstTool) InstallTools() error

InstallTools sets the OS interface, checks if K8S installation is required or not. If required then install the said version.

func (*K8SInstTool) TearDown 

func (ks *K8SInstTool) TearDown() error

TearDown shoud uninstall K8S, but it is not required either for cloud or edge node. It is defined so that K8SInstTool implements ToolsInstaller interface

type KubeCloudInstTool 

type KubeCloudInstTool struct {
	Common
	AdvertiseAddress string
	DNSName          string
	TarballPath      string
}

KubeCloudInstTool embedes Common struct It implements ToolsInstaller interface

func (*KubeCloudInstTool) InstallTools 

func (cu *KubeCloudInstTool) InstallTools() error

InstallTools downloads KubeEdge for the specified version and makes the required configuration changes and initiates cloudcore.

func (*KubeCloudInstTool) RunCloudCore 

func (cu *KubeCloudInstTool) RunCloudCore() error

RunCloudCore starts cloudcore process

func (*KubeCloudInstTool) TearDown 

func (cu *KubeCloudInstTool) TearDown() error

TearDown method will remove the edge node from api-server and stop cloudcore process

type KubeEdgeInstTool 

type KubeEdgeInstTool struct {
	Common
	CertPath              string
	CloudCoreIP           string
	EdgeNodeName          string
	RuntimeType           string
	RemoteRuntimeEndpoint string
	Token                 string
	CertPort              string
	CGroupDriver          string
	TarballPath           string
}

KubeEdgeInstTool embedes Common struct and contains cloud node ip:port information It implements ToolsInstaller interface

func (*KubeEdgeInstTool) InstallTools 

func (ku *KubeEdgeInstTool) InstallTools() error

InstallTools downloads KubeEdge for the specified verssion and makes the required configuration changes and initiates edgecore.

func (*KubeEdgeInstTool) TearDown 

func (ku *KubeEdgeInstTool) TearDown() error

TearDown method will remove the edge node from api-server and stop edgecore process

type MQTTInstTool 

type MQTTInstTool struct {
	Common
}

MQTTInstTool embedes Common struct and It implements ToolsInstaller interface

func (*MQTTInstTool) InstallTools 

func (m *MQTTInstTool) InstallTools() error

InstallTools sets the OS interface, it simply installs the said version

func (*MQTTInstTool) TearDown 

func (m *MQTTInstTool) TearDown() error

TearDown shoud uninstall MQTT, but it is not required either for cloud or edge node. It is defined so that MQTTInstTool implements ToolsInstaller interface

type PacmanOS 

type PacmanOS struct {
	KubeEdgeVersion semver.Version
	IsEdgeNode      bool
}

PacmanOS struct objects shall have information of the tools version to be installed on Hosts having PacmanOS. It implements OSTypeInstaller interface

func (*PacmanOS) InstallKubeEdge 

func (o *PacmanOS) InstallKubeEdge(options types.InstallOptions) error

InstallKubeEdge downloads the provided version of KubeEdge. Untar's in the specified location /etc/kubeedge/ and then copies the binary to excecutables' path (eg: /usr/local/bin)

func (*PacmanOS) InstallMQTT 

func (o *PacmanOS) InstallMQTT() error

InstallMQTT checks if MQTT is already installed and running, if not then install it from OS repo

func (*PacmanOS) IsK8SComponentInstalled 

func (o *PacmanOS) IsK8SComponentInstalled(kubeConfig, master string) error

IsK8SComponentInstalled checks if said K8S version is already installed in the host

func (*PacmanOS) IsKubeEdgeProcessRunning 

func (o *PacmanOS) IsKubeEdgeProcessRunning(proc string) (bool, error)

IsKubeEdgeProcessRunning checks if the given process is running or not

func (*PacmanOS) IsProcessRunning 

func (o *PacmanOS) IsProcessRunning(proc string) (bool, error)

IsKubeEdgeProcessRunning checks if the given process is running or not

func (*PacmanOS) KillKubeEdgeBinary 

func (o *PacmanOS) KillKubeEdgeBinary(proc string) error

KillKubeEdgeBinary will search for KubeEdge process and forcefully kill it

func (*PacmanOS) RunEdgeCore 

func (o *PacmanOS) RunEdgeCore() error

RunEdgeCore sets the environment variable GOARCHAIUS_CONFIG_PATH for the configuration path and the starts edgecore with logs being captured

func (*PacmanOS) SetKubeEdgeVersion 

func (o *PacmanOS) SetKubeEdgeVersion(version semver.Version)

SetKubeEdgeVersion sets the KubeEdge version for the objects instance

type RpmOS 

type RpmOS struct {
	KubeEdgeVersion semver.Version
	IsEdgeNode      bool //True - Edgenode False - Cloudnode
}

RpmOS struct objects shall have information of the tools version to be installed on Hosts having RpmOS OS. It implements OSTypeInstaller interface

func (*RpmOS) InstallKubeEdge 

func (r *RpmOS) InstallKubeEdge(options types.InstallOptions) error

InstallKubeEdge downloads the provided version of KubeEdge. Untar's in the specified location /etc/kubeedge/ and then copies the binary to excecutables' path (eg: /usr/local/bin)

func (*RpmOS) InstallMQTT 

func (r *RpmOS) InstallMQTT() error

InstallMQTT checks if MQTT is already installed and running, if not then install it from OS repo Information is used from https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-the-mosquitto-mqtt-messaging-broker-on-centos-7

func (*RpmOS) IsK8SComponentInstalled 

func (r *RpmOS) IsK8SComponentInstalled(kubeConfig, master string) error

IsK8SComponentInstalled checks if said K8S version is already installed in the host

func (*RpmOS) IsKubeEdgeProcessRunning 

func (r *RpmOS) IsKubeEdgeProcessRunning(proc string) (bool, error)

IsKubeEdgeProcessRunning checks if the given process is running or not

func (*RpmOS) IsProcessRunning 

func (r *RpmOS) IsProcessRunning(proc string) (bool, error)

IsKubeEdgeProcessRunning checks if the given process is running or not

func (*RpmOS) KillKubeEdgeBinary 

func (r *RpmOS) KillKubeEdgeBinary(proc string) error

KillKubeEdgeBinary will search for KubeEdge process and forcefully kill it

func (*RpmOS) RunEdgeCore 

func (r *RpmOS) RunEdgeCore() error

RunEdgeCore starts edgecore with logs being captured

func (*RpmOS) SetKubeEdgeVersion 

func (r *RpmOS) SetKubeEdgeVersion(version semver.Version)

SetKubeEdgeVersion sets the KubeEdge version for the objects instance

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.