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.

Index

• Constants
• func CheckIfDeviceAvailable(executor exec.Executor, name string, pvcBacked bool) (bool, string, error)
• func CheckKernelModuleParam(name, param string, executor pkgexec.Executor) (bool, error)
• func GetDeviceFilesystems(device 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 GetUdevInfo(device string, executor exec.Executor) (map[string]string, error)
• func Grep(input, searchFor string) string
• func IsBuiltinKernelModule(name string, executor pkgexec.Executor) (bool, error)
• func IsLV(devicePath string, executor exec.Executor) (bool, error)
• func ListDevices(executor exec.Executor) ([]string, error)
• func ListDevicesChild(executor exec.Executor, device string) ([]string, error)
• func LoadKernelModule(name string, options []string, executor pkgexec.Executor) error
• type CephVolumeInventory
• type LocalDisk
• type Partition
  • func GetDevicePartitions(device string, executor exec.Executor) (partitions []Partition, unusedSpace uint64, err error)

Constants

const (
	// DiskType is a disk type
	DiskType = "disk"
	// SSDType is an sdd type
	SSDType = "ssd"
	// PartType is a partition type
	PartType = "part"
	// CryptType is an encrypted type
	CryptType = "crypt"
	// LVMType is an LVM type
	LVMType = "lvm"
	// LinearType is a linear type
	LinearType = "linear"

	// CephLVPrefix is the prefix of a LV owned by ceph-volume
	CephLVPrefix = "ceph--"
	// DeviceMapperPrefix is the prefix of a LV from the device mapper interface
	DeviceMapperPrefix = "dm-"
)

Functions

func CheckIfDeviceAvailable

func CheckIfDeviceAvailable(executor exec.Executor, name string, pvcBacked bool) (bool, string, error)

CheckIfDeviceAvailable checks if a device is available for consumption. The caller needs to decide based on the return values whether it is available.

func CheckKernelModuleParam

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

func GetDeviceFilesystems

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

GetDeviceFilesystems get the file systems available

func GetDeviceProperties

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

GetDeviceProperties gets device properties

func GetDevicePropertiesFromPath

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

GetDevicePropertiesFromPath gets a device property from a path

func GetDiskUUID

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

GetDiskUUID look up the UUID for a disk.

func GetUdevInfo

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

GetUdevInfo gets udev information

func Grep

func Grep(input, searchFor string) string

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

func IsBuiltinKernelModule

func IsBuiltinKernelModule(name string, executor pkgexec.Executor) (bool, error)

func IsLV

func IsLV(devicePath string, executor exec.Executor) (bool, error)

IsLV returns if a device is owned by LVM, is a logical volume

func ListDevices

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

ListDevices list all devices available on a machine

func ListDevicesChild

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

ListDevicesChild list all child available on a device

func LoadKernelModule

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

Types

type CephVolumeInventory

type CephVolumeInventory struct {
	Path            string          `json:"path"`
	Available       bool            `json:"available"`
	RejectedReasons json.RawMessage `json:"rejected_reasons"`
	SysAPI          json.RawMessage `json:"sys_api"`
	LVS             json.RawMessage `json:"lvs"`
}

CephVolumeInventory represents the output of the ceph-volume inventory command

type LocalDisk

type LocalDisk struct {
	// Name is the device name
	Name string `json:"name"`
	// Parent is the device parent's name
	Parent string `json:"parent"`
	// HasChildren is whether the device has a children device
	HasChildren bool `json:"hasChildren"`
	// DevLinks is the persistent device path on the host
	DevLinks string `json:"devLinks"`
	// Size is the device capacity in byte
	Size uint64 `json:"size"`
	// UUID is used by /dev/disk/by-uuid
	UUID string `json:"uuid"`
	// Serial is the disk serial used by /dev/disk/by-id
	Serial string `json:"serial"`
	// Type is disk type
	Type string `json:"type"`
	// Rotational is the boolean whether the device is rotational: true for hdd, false for ssd and nvme
	Rotational bool `json:"rotational"`
	// ReadOnly is the boolean whether the device is readonly
	Readonly bool `json:"readOnly"`
	// Partitions is a partition slice
	Partitions []Partition
	// Filesystem is the filesystem currently on the device
	Filesystem string `json:"filesystem"`
	// Vendor is the device vendor
	Vendor string `json:"vendor"`
	// Model is the device model
	Model string `json:"model"`
	// WWN is the world wide name of the device
	WWN string `json:"wwn"`
	// WWNVendorExtension is the WWN_VENDOR_EXTENSION from udev info
	WWNVendorExtension string `json:"wwnVendorExtension"`
	// Empty checks whether the device is completely empty
	Empty bool `json:"empty"`
	// Information provided by Ceph Volume Inventory
	CephVolumeData string `json:"cephVolumeData,omitempty"`
	// RealName is the device behind the PVC, behind /mnt/<pvc>/name
	RealName string `json:"real-name,omitempty"`
}

LocalDisk contains information about an unformatted block device

type Partition

type Partition struct {
	Name       string
	Size       uint64
	Label      string
	Filesystem string
}

Partition represents a partition metadata

func GetDevicePartitions

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

GetDevicePartitions gets partitions on a given device