sys

Documentation

Overview

Copyright 2016 The Rook Authors. All rights reserved.

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.

Copyright 2016 The Rook Authors. All rights reserved.

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.

Copyright 2016 The Rook Authors. All rights reserved.

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.

Copyright 2016 The Rook Authors. All rights reserved.

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
• func Awk(input string, position int) string
• func CheckKernelModuleParam(name, param string, executor exec.Executor) (bool, error)
• func CreatePartitions(device string, args []string, executor exec.Executor) error
• func DoesDeviceHaveChildren(device string, executor exec.Executor) (bool, error)
• func FormatDevice(devicePath string, executor exec.Executor) error
• func GetDeviceFilesystems(device string, executor exec.Executor) (string, error)
• func GetDeviceFromMountPoint(mountPoint string, executor exec.Executor) (string, error)
• func GetDeviceMountPoint(deviceName string, executor exec.Executor) (string, error)
• func GetDeviceProperties(device string, executor exec.Executor) (map[string]string, error)
• func GetDevicePropertiesFromPath(devicePath string, executor exec.Executor) (map[string]string, error)
• func GetDiskUUID(device string, executor exec.Executor) (string, error)
• func GetPartitionLabel(deviceName string, executor exec.Executor) (string, error)
• func Grep(input, searchFor string) string
• func ListDevices(executor exec.Executor) ([]string, error)
• func LoadKernelModule(name string, options []string, executor exec.Executor) error
• func MountDevice(devicePath, mountPath string, executor exec.Executor) error
• func MountDeviceWithOptions(devicePath, mountPath, fstype, options string, executor exec.Executor) error
• func RemovePartitions(device string, executor exec.Executor) error
• func UnmountDevice(devicePath string, executor exec.Executor) error
• type Partition
  • func GetDevicePartitions(device string, executor exec.Executor) (partitions []*Partition, unusedSpace uint64, err error)

Constants

const (
	DiskType = "disk"
	SSDType  = "ssd"
	PartType = "part"
)

Functions

func Awk

func Awk(input string, position int) string

awk finds the space-delimited token at the given position. 0 returns the whole line, while 1 is the first token.

func CheckKernelModuleParam

func CheckKernelModuleParam(name, param string, executor exec.Executor) (bool, error)

func CreatePartitions

func CreatePartitions(device string, args []string, executor exec.Executor) error

func DoesDeviceHaveChildren

func DoesDeviceHaveChildren(device string, executor exec.Executor) (bool, error)

func FormatDevice

func FormatDevice(devicePath string, executor exec.Executor) error

func GetDeviceFilesystems

func GetDeviceFilesystems(device string, executor exec.Executor) (string, error)

get the file systems availab

func GetDeviceFromMountPoint

func GetDeviceFromMountPoint(mountPoint string, executor exec.Executor) (string, error)

func GetDeviceMountPoint

func GetDeviceMountPoint(deviceName string, executor exec.Executor) (string, error)

look up the mount point of the given device. empty string returned if device is not mounted.

func GetDeviceProperties

func GetDeviceProperties(device string, executor exec.Executor) (map[string]string, error)

func GetDevicePropertiesFromPath

func GetDevicePropertiesFromPath(devicePath string, executor exec.Executor) (map[string]string, error)

func GetDiskUUID

func GetDiskUUID(device string, executor exec.Executor) (string, error)

look up the UUID for a disk.

func GetPartitionLabel

func GetPartitionLabel(deviceName string, executor exec.Executor) (string, error)

func Grep

func Grep(input, searchFor string) string

grep finds the *first* line that matches, rather than multiple lines

func ListDevices

func ListDevices(executor exec.Executor) ([]string, error)

func LoadKernelModule

func LoadKernelModule(name string, options []string, executor exec.Executor) error

func MountDevice

func MountDevice(devicePath, mountPath string, executor exec.Executor) error

func MountDeviceWithOptions

func MountDeviceWithOptions(devicePath, mountPath, fstype, options string, executor exec.Executor) error

comma-separated list of mount options passed directly to mount command

func RemovePartitions

func RemovePartitions(device string, executor exec.Executor) error

func UnmountDevice

func UnmountDevice(devicePath string, executor exec.Executor) error

Types

type Partition

type Partition struct {
	Name  string
	Size  uint64
	Label string
}

func GetDevicePartitions

func GetDevicePartitions(device string, executor exec.Executor) (partitions []*Partition, unusedSpace uint64, err error)