clusterd

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.

Index

• func DiscoverDevices(executor exec.Executor) ([]*sys.LocalDisk, error)
• func GetDeviceEmpty(device *sys.LocalDisk) bool
• func PopulateDeviceInfo(d string, executor exec.Executor) (*sys.LocalDisk, error)
• func PopulateDeviceUdevInfo(d string, executor exec.Executor, disk *sys.LocalDisk) (*sys.LocalDisk, error)
• func VerifyNetworkInfo(networkInfo NetworkInfo) error
• type Context
• type NetworkInfo
  • func (in NetworkInfo) Simplify() NetworkInfo

Functions

func DiscoverDevices

func DiscoverDevices(executor exec.Executor) ([]*sys.LocalDisk, error)

DiscoverDevices returns all the details of devices available on the local node

func GetDeviceEmpty

func GetDeviceEmpty(device *sys.LocalDisk) bool

GetDeviceEmpty check whether a device is completely empty

func PopulateDeviceInfo

func PopulateDeviceInfo(d string, executor exec.Executor) (*sys.LocalDisk, error)

PopulateDeviceInfo returns the information of the specified block device

func PopulateDeviceUdevInfo

func PopulateDeviceUdevInfo(d string, executor exec.Executor, disk *sys.LocalDisk) (*sys.LocalDisk, error)

PopulateDeviceUdevInfo fills the udev info into the block device information

func VerifyNetworkInfo

func VerifyNetworkInfo(networkInfo NetworkInfo) error

Types

type Context

type Context struct {

	// The kubernetes config used for this context
	KubeConfig *rest.Config

	// Clientset is a connection to the core kubernetes API
	Clientset kubernetes.Interface

	// APIExtensionClientset is a connection to the API Extension kubernetes API
	APIExtensionClientset apiextensionsclient.Interface

	// RookClientset is a typed connection to the rook API
	RookClientset rookclient.Interface

	// The implementation of executing a console command
	Executor exec.Executor

	// The root configuration directory used by services
	ConfigDir string

	// A value indicating the desired logging/tracing level
	LogLevel capnslog.LogLevel

	// The full path to a config file that can be used to override generated settings
	ConfigFileOverride string

	// Information about the network for this machine and its cluster
	NetworkInfo NetworkInfo

	// NetworkClient is a connection to the CNI plugin API
	NetworkClient netclient.K8sCniCncfIoV1Interface

	// The local devices detected on the node
	Devices []*sys.LocalDisk
}

Context for loading or applying the configuration state of a service.

type NetworkInfo

type NetworkInfo struct {
	PublicAddr     string
	ClusterAddr    string
	PublicNetwork  string // public network and subnet mask in CIDR notation
	ClusterNetwork string // cluster network and subnet mask in CIDR notation

	// deprecated ipv4 format address
	// TODO: remove these legacy fields in the future
	PublicAddrIPv4  string
	ClusterAddrIPv4 string
}

func (NetworkInfo) Simplify

func (in NetworkInfo) Simplify() NetworkInfo

Simplify adapts deprecated fields TODO: remove this function in the future