utils

Documentation

Index

• Constants
• Variables
• func CreateDest(dest string) error
• func GetDefaultAK() (string, string, string)
• func GetFileContent(fileName string) string
• func GetLocalAK() (string, string)
• func GetMetaData(resource string) (string, error)
• func GetMetrics(path string) (*csi.NodeGetVolumeStatsResponse, error)
• func GetPodRunTime(req *csi.NodePublishVolumeRequest, clientSet *kubernetes.Clientset) string
• func GetRegionAndInstanceID() (string, string, error)
• func GetRegionIDAndInstanceID(nodeName string) (string, string, error)
• func GetSTSAK() (string, string, string)
• func IsDir(path string) bool
• func IsDirEmpty(name string) (bool, error)
• func IsFileExisting(filename string) bool
• func IsMountPointRunv(mountPoint string) bool
• func IsMounted(mountPath string) bool
• func NewEcsClient(accessKeyID, accessKeySecret, accessToken string) (ecsClient *ecs.Client)
• func ReadJSONFile(file string) (map[string]string, error)
• func Run(cmd string) (string, error)
• func Umount(mountPath string) bool
• func WriteJSONFile(obj interface{}, file string) error
• func WriteJosnFile(obj interface{}, file string) error
• type DefaultOptions
• type Mounter
  • func NewMounter() Mounter
• type Result
  • func Fail(a ...interface{}) Result
  • func NotSupport(a ...interface{}) Result
  • func Succeed(a ...interface{}) Result
• type RoleAuth

Constants

const (
	// UserAKID is user AK ID
	UserAKID = "/etc/.volumeak/akId"
	// UserAKSecret is user AK Secret
	UserAKSecret = "/etc/.volumeak/akSecret"
	// MetadataURL is metadata url
	MetadataURL = "http://100.100.100.200/latest/meta-data/"
	// RegionIDTag is region id
	RegionIDTag = "region-id"
	// InstanceIDTag is instance id
	InstanceIDTag = "instance-id"
	// DefaultRegion is default region
	DefaultRegion = "cn-hangzhou"
	// CsiPluginRunTimeFlagFile tag
	CsiPluginRunTimeFlagFile = "../alibabacloudcsiplugin.json"
	// RuncRunTimeTag tag
	RuncRunTimeTag = "runc"
	// RunvRunTimeTag tag
	RunvRunTimeTag = "runv"
)

Variables

var KubernetesAlicloudIdentity = fmt.Sprintf("Kubernetes.Alicloud/CsiPlugin")

KubernetesAlicloudIdentity set a identity label

Functions

func CreateDest

func CreateDest(dest string) error

CreateDest create de destination dir

func GetDefaultAK

func GetDefaultAK() (string, string, string)

GetDefaultAK read default ak from local file or from STS

func GetFileContent

func GetFileContent(fileName string) string

GetFileContent get file content

func GetLocalAK

func GetLocalAK() (string, string)

GetLocalAK read ossfs ak from local or from secret file

func GetMetaData

func GetMetaData(resource string) (string, error)

GetMetaData get metadata from ecs meta-server

func GetMetrics

func GetMetrics(path string) (*csi.NodeGetVolumeStatsResponse, error)

GetMetrics get path metric

func GetPodRunTime

func GetPodRunTime(req *csi.NodePublishVolumeRequest, clientSet *kubernetes.Clientset) string

GetPodRunTime Get Pod runtimeclass config Default as runc.

func GetRegionAndInstanceID

func GetRegionAndInstanceID() (string, string, error)

GetRegionAndInstanceID get region and instanceID object

func GetRegionIDAndInstanceID

func GetRegionIDAndInstanceID(nodeName string) (string, string, error)

GetRegionIDAndInstanceID get regionID and instanceID object

func GetSTSAK

func GetSTSAK() (string, string, string)

GetSTSAK get STS AK and token from ecs meta server

func IsDir

func IsDir(path string) bool

IsDir check file is directory

func IsDirEmpty

func IsDirEmpty(name string) (bool, error)

IsDirEmpty return status of dir empty or not

func IsFileExisting

func IsFileExisting(filename string) bool

IsFileExisting check file exist in volume driver or not

func IsMountPointRunv

func IsMountPointRunv(mountPoint string) bool

IsMountPointRunv check the mountpoint is runv style

func IsMounted

func IsMounted(mountPath string) bool

IsMounted return status of mount operation

func NewEcsClient

func NewEcsClient(accessKeyID, accessKeySecret, accessToken string) (ecsClient *ecs.Client)

NewEcsClient create a ecsClient object

func ReadJSONFile

func ReadJSONFile(file string) (map[string]string, error)

ReadJSONFile return a json object

func Run

func Run(cmd string) (string, error)

Run run shell command

func Umount

func Umount(mountPath string) bool

Umount do an unmount operation

func WriteJSONFile

func WriteJSONFile(obj interface{}, file string) error

WriteJSONFile write a json object

func WriteJosnFile

func WriteJosnFile(obj interface{}, file string) error

WriteJosnFile save json data to file

Types

type DefaultOptions

type DefaultOptions struct {
	Global struct {
		KubernetesClusterTag string
		AccessKeyID          string `json:"accessKeyID"`
		AccessKeySecret      string `json:"accessKeySecret"`
		Region               string `json:"region"`
	}
}

DefaultOptions used for global ak

type Mounter

type Mounter interface {
	// If the folder doesn't exist, it will call 'mkdir -p'
	EnsureFolder(target string) error
	// If the block doesn't exist, create it
	EnsureBlock(target string) error
	// Format formats the source with the given filesystem type
	Format(source, fsType string) error

	// Mount mounts source to target with the given fstype and options.
	Mount(source, target, fsType string, options ...string) error

	// Mount mounts source to target for block file.
	MountBlock(source, target string, options ...string) error
	// Unmount unmounts the given target
	Unmount(target string) error

	// IsFormatted checks whether the source device is formatted or not. It
	// returns true if the source device is already formatted.
	IsFormatted(source string) (bool, error)

	// IsMounted checks whether the target path is a correct mount (i.e:
	// propagated). It returns true if it's mounted. An error is returned in
	// case of system errors or if it's mounted incorrectly.
	IsMounted(target string) (bool, error)

	SafePathRemove(target string) error

	HasMountRefs(mountPath string, mountRefs []string) bool
}

Mounter is responsible for formatting and mounting volumes

func NewMounter

func NewMounter() Mounter

NewMounter returns a new mounter instance

type Result

type Result struct {
	Status  string `json:"status"`
	Message string `json:"message,omitempty"`
	Device  string `json:"device,omitempty"`
}

Result struct definition

func Fail

func Fail(a ...interface{}) Result

Fail return a Fail Result

func NotSupport

func NotSupport(a ...interface{}) Result

NotSupport return a NotSupport Result

func Succeed

func Succeed(a ...interface{}) Result

Succeed return a Succeed Result

type RoleAuth

type RoleAuth struct {
	AccessKeyID     string
	AccessKeySecret string
	Expiration      time.Time
	SecurityToken   string
	LastUpdated     time.Time
	Code            string
}

RoleAuth define STS Token Response