client

type AccessControlList ¶

type AccessControlList struct {
	Entries    []string // Access Control Entries in short string format
	Owner      string   // User that owns the resource
	OwnerGroup string   // Group that owns the resource
}

AccessControlList is a structure for the access control list.

func (acl *AccessControlList) Empty() bool

func (acl *AccessControlList) HasOwner() bool

func (acl *AccessControlList) HasOwnerGroup() bool

func (acl *AccessControlList) String() string

type Addresses ¶

type Addresses []string

Addresses is an alias for a slice of <ipv4/hostname>:<port> addresses.

type ClientBioResult ¶

type ClientBioResult struct {
	Address string
	Stats   *mgmtpb.BioHealthResp
	Err     error
}

ClientBioResult is a container for output of BIO health query client requests.

func (cr ClientBioResult) String() string

type ClientResult ¶

type ClientResult struct {
	Address string
	Value   interface{}
	Err     error
}

ClientResult is a container for output of any type of client request.

func (cr ClientResult) String() string

type ClientSmdResult ¶

type ClientSmdResult struct {
	Address string
	Devs    *mgmtpb.SmdDevResp
	Pools   *mgmtpb.SmdPoolResp
	Err     error
}

ClientSmdResult is a container for output of SMD dev list query client requests.

func (cr ClientSmdResult) String() string

type ClientStateResult ¶ added in v0.9.0

type ClientStateResult struct {
	Address string
	Dev     *mgmtpb.DevStateResp
	Err     error
}

ClientStateResult is a container for output of device state query requests

func (cr ClientStateResult) String() string

type Configuration ¶

type Configuration struct {
	SystemName      string   `yaml:"name"`
	AccessPoints    []string `yaml:"access_points"`
	ControlPort     int      `yaml:"port"`
	HostList        []string `yaml:"hostlist"`
	RuntimeDir      string   `yaml:"runtime_dir"`
	HostFile        string   `yaml:"host_file"`
	LogFile         string   `yaml:"log_file"`
	LogFileFormat   string   `yaml:"log_file_format"`
	Path            string
	TransportConfig *security.TransportConfig `yaml:"transport_config"`
	Ext             External
}

Configuration contains all known configuration variables available to the client

func GetConfig(log logging.Logger, inPath string) (*Configuration, error)

func NewConfiguration() *Configuration

func (c *Configuration) Load() error

func (c *Configuration) SetPath(inPath string) error

func (c *Configuration) Validate(log logging.Logger) (err error)

type Connect ¶

type Connect interface {
	BioHealthQuery(*mgmtpb.BioHealthReq) ResultQueryMap
	ClearConns() ResultMap
	ConnectClients(Addresses) ResultMap
	GetActiveConns(ResultMap) ResultMap
	NetworkListProviders() ResultMap
	NetworkScanDevices(searchProvider string) NetworkScanResultMap
	PoolCreate(*PoolCreateReq) (*PoolCreateResp, error)
	PoolDestroy(*PoolDestroyReq) error
	PoolQuery(PoolQueryReq) (*PoolQueryResp, error)
	PoolSetProp(PoolSetPropReq) (*PoolSetPropResp, error)
	PoolGetACL(PoolGetACLReq) (*PoolGetACLResp, error)
	PoolOverwriteACL(PoolOverwriteACLReq) (*PoolOverwriteACLResp, error)
	PoolUpdateACL(PoolUpdateACLReq) (*PoolUpdateACLResp, error)
	PoolDeleteACL(PoolDeleteACLReq) (*PoolDeleteACLResp, error)
	SetTransportConfig(*security.TransportConfig)
	SmdListDevs(*mgmtpb.SmdDevReq) ResultSmdMap
	SmdListPools(*mgmtpb.SmdPoolReq) ResultSmdMap
	StorageScan(*StorageScanReq) *StorageScanResp
	StorageFormat(reformat bool) StorageFormatResults
	StoragePrepare(*ctlpb.StoragePrepareReq) ResultMap
	DevStateQuery(*mgmtpb.DevStateReq) ResultStateMap
	StorageSetFaulty(*mgmtpb.DevStateReq) ResultStateMap
	SystemQuery(SystemQueryReq) (*SystemQueryResp, error)
	SystemStop(SystemStopReq) (*SystemStopResp, error)
	SystemStart(SystemStartReq) (*SystemStartResp, error)
	LeaderQuery(LeaderQueryReq) (*LeaderQueryResp, error)
	ListPools(ListPoolsReq) (*ListPoolsResp, error)
}

Connect is an external interface providing functionality across multiple connected clients (controllers).

func NewConnect(log logging.Logger) Connect

type Control ¶

type Control interface {
	// contains filtered or unexported methods
}

Control interface provides connection handling capabilities.

type ControllerFactory ¶

type ControllerFactory interface {
	// contains filtered or unexported methods
}

ControllerFactory is an interface providing capability to connect clients.

type External ¶

type External interface {
	Getenv(string) string
	RunCommand(string) error
}

External interface provides methods to support various os operations.

type LeaderQueryReq ¶ added in v0.8.0

type LeaderQueryReq struct {
	System string
}

LeaderQueryReq contains the inputs for the leader query command.

type LeaderQueryResp ¶ added in v0.8.0

type LeaderQueryResp struct {
	Leader   string
	Replicas []string
}

LeaderQueryResp contains the status of the request and, if successful, the MS leader and set of replicas in the system.

type ListPoolsReq ¶ added in v0.8.0

type ListPoolsReq struct {
	SysName string
}

ListPoolsReq contains the inputs for the list pools command.

type ListPoolsResp ¶ added in v0.8.0

type ListPoolsResp struct {
	Status int32
	Pools  []*PoolDiscovery
}

ListPoolsResp contains the status of the request and, if successful, the list of pools in the system.

type NetworkScanResult ¶

type NetworkScanResult struct {
	// contains filtered or unexported fields
}

func (nsr NetworkScanResult) String() string

type NetworkScanResultMap ¶

type NetworkScanResultMap map[string][]NetworkScanResult

func (nsrm NetworkScanResultMap) String() string

type NvmeScanResult ¶

type NvmeScanResult struct {
	Ctrlrs proto.NvmeControllers
	Err    error
}

NvmeScanResult represents the result of scanning for SCM modules installed on a storage node.

func (result *NvmeScanResult) String() string

func (result *NvmeScanResult) StringHealthStats() string

func (result *NvmeScanResult) Summary() (out string)

type NvmeScanResults ¶

type NvmeScanResults map[string]*NvmeScanResult

NvmeScanResults maps NvmeScanResult structs to the addresses of remote servers identified by an address string.

type PoolCreateReq ¶

type PoolCreateReq struct {
	ScmBytes   uint64
	NvmeBytes  uint64
	RankList   []uint32
	NumSvcReps uint32
	Sys        string
	Usr        string
	Grp        string
	ACL        *AccessControlList
	UUID       string
}

PoolCreateReq struct contains request

type PoolCreateResp ¶

type PoolCreateResp struct {
	UUID    string
	SvcReps []uint32
}

PoolCreateResp struct contains response

type PoolDeleteACLReq ¶

type PoolDeleteACLReq struct {
	UUID      string // UUID of the pool
	Principal string // Principal whose entry will be removed
}

PoolDeleteACLReq contains the input parameters for PoolDeleteACL.

type PoolDeleteACLResp ¶

type PoolDeleteACLResp struct {
	ACL *AccessControlList // actual ACL of the pool
}

PoolDeleteACLResp returns the updated ACL for the pool.

type PoolDestroyReq ¶

type PoolDestroyReq struct {
	UUID  string
	Force bool
}

PoolDestroyReq struct contains request

type PoolDiscovery ¶ added in v0.8.0

type PoolDiscovery struct {
	UUID        string   // Unique identifier
	SvcReplicas []uint32 // Ranks of pool service replicas
}

PoolDiscovery represents the basic discovery information for a pool.

type PoolGetACLReq ¶

type PoolGetACLReq struct {
	UUID string // pool UUID
}

PoolGetACLReq contains the input parameters for PoolGetACL

type PoolGetACLResp ¶

type PoolGetACLResp struct {
	ACL *AccessControlList
}

PoolGetACLResp contains the output results for PoolGetACL

type PoolOverwriteACLReq ¶

type PoolOverwriteACLReq struct {
	UUID string             // pool UUID
	ACL  *AccessControlList // new ACL for the pool
}

PoolOverwriteACLReq contains the input parameters for PoolOverwriteACL

type PoolOverwriteACLResp ¶

type PoolOverwriteACLResp struct {
	ACL *AccessControlList // actual ACL of the pool
}

PoolOverwriteACLResp returns the updated ACL for the pool

type PoolQueryReq ¶ added in v0.9.0

type PoolQueryReq struct {
	UUID string
}

PoolQueryReq contains pool query parameters.

type PoolQueryResp ¶ added in v0.9.0

type PoolQueryResp struct {
	Status          int32
	UUID            string
	TotalTargets    uint32
	ActiveTargets   uint32
	DisabledTargets uint32
	Rebuild         *PoolRebuildStatus
	Scm             *StorageUsageStats
	Nvme            *StorageUsageStats
}

PoolQueryResp contains the pool query response.

type PoolRebuildState ¶ added in v0.9.0

type PoolRebuildState uint

PoolRebuildState indicates the current state of the pool rebuild process.

const (
	// PoolRebuildStateIdle indicates that the rebuild process is idle.
	PoolRebuildStateIdle PoolRebuildState = iota
	// PoolRebuildStateDone indicates that the rebuild process has completed.
	PoolRebuildStateDone
	// PoolRebuildStateBusy indicates that the rebuild process is in progress.
	PoolRebuildStateBusy
)

func (prs PoolRebuildState) String() string

type PoolRebuildStatus ¶ added in v0.9.0

type PoolRebuildStatus struct {
	Status  int32
	State   PoolRebuildState
	Objects uint64
	Records uint64
}

PoolRebuildStatus contains detailed information about the pool rebuild process.

type PoolSetPropReq ¶ added in v0.9.0

type PoolSetPropReq struct {
	// UUID identifies the pool for which this property should be set.
	UUID string
	// Property is always a string representation of the pool property.
	// It will be resolved into the C representation prior to being
	// forwarded over dRPC.
	Property string
	// Value is an approximation of the union in daos_prop_entry.
	// It can be either a string or a uint64. Struct-based properties
	// are not supported via this API.
	Value interface{}
}

PoolSetPropReq contains pool set-prop parameters.

func (pspr *PoolSetPropReq) SetNumber(numVal uint64)

func (pspr *PoolSetPropReq) SetString(strVal string)

type PoolSetPropResp ¶ added in v0.9.0

type PoolSetPropResp struct {
	UUID     string
	Property string
	Value    string
}

PoolSetPropResp contains the response to a pool set-prop operation.

type PoolUpdateACLReq ¶

type PoolUpdateACLReq struct {
	UUID string             // pool UUID
	ACL  *AccessControlList // ACL entries to add to the pool
}

PoolUpdateACLReq contains the input parameters for PoolUpdateACL

type PoolUpdateACLResp ¶

type PoolUpdateACLResp struct {
	ACL *AccessControlList // actual ACL of the pool
}

PoolUpdateACLResp returns the updated ACL for the pool

type ProviderListResult ¶

type ProviderListResult struct {
	// contains filtered or unexported fields
}

type ResultMap ¶

type ResultMap map[string]ClientResult

ResultMap map client addresses to method call ClientResults

func (rm ResultMap) String() string

type ResultQueryMap ¶

type ResultQueryMap map[string]ClientBioResult

func (rm ResultQueryMap) String() string

type ResultSmdMap ¶

type ResultSmdMap map[string]ClientSmdResult

func (rm ResultSmdMap) String() string

type ResultStateMap ¶ added in v0.9.0

type ResultStateMap map[string]ClientStateResult

func (rm ResultStateMap) String() string

type ScmScanResult ¶

type ScmScanResult struct {
	Modules    storage.ScmModules
	Namespaces storage.ScmNamespaces
	Err        error
}

ScmScanResult represents the result of scanning for SCM modules installed on a storage node and SCM namespaces.

func (result *ScmScanResult) String() string

func (result *ScmScanResult) Summary() (out string)

type ScmScanResults ¶

type ScmScanResults map[string]*ScmScanResult

ScmScanMap maps ScmModuleScanResult structs to the addresses of remote servers identified by an address string.

type StorageFormatReq ¶ added in v0.8.0

type StorageFormatReq struct {
	Reformat bool
}

StorageFormatReq encapsulated subsystem format parameters.

type StorageFormatResult ¶

type StorageFormatResult struct {
	Nvme proto.NvmeControllerResults
	Scm  proto.ScmMountResults
	Err  error
}

func (sfr *StorageFormatResult) HasErrors() bool

type StorageFormatResults ¶ added in v0.8.0

type StorageFormatResults map[string]StorageFormatResult

StorageFormatResults stores results of format operations on NVMe controllers and SCM mountpoints.

func (sfr StorageFormatResults) Keys() (keys []string)

type StorageScanReq ¶

type StorageScanReq struct{}

StorageScanReq encapsulated subsystem scan parameters.

type StorageScanResp ¶

type StorageScanResp struct {
	Servers []string
	Nvme    NvmeScanResults
	Scm     ScmScanResults
}

StorageScanResp encapsulated subsystem results.

func MockScanResp(cs *NvmeControllers, ms *ScmModules, nss *ScmNamespaces, addrs Addresses) *StorageScanResp

func (ssr *StorageScanResp) StringHealthStats() string

type StorageUsageStats ¶ added in v0.9.0

type StorageUsageStats struct {
	Total uint64
	Free  uint64
	Min   uint64
	Max   uint64
	Mean  uint64
}

StorageUsageStats represents DAOS storage usage statistics.

type SystemQueryReq ¶ added in v0.9.0

type SystemQueryReq struct {
	Ranks []uint32
}

SystemQueryReq contains the inputs for the system query request.

type SystemQueryResp ¶ added in v0.9.0

type SystemQueryResp struct {
	Members system.Members
}

SystemQueryResp contains the request response.

type SystemStartReq ¶ added in v0.9.0

type SystemStartReq struct {
	Ranks []uint32
}

SystemStartReq contains the inputs for the system start request.

type SystemStartResp ¶ added in v0.9.0

type SystemStartResp struct {
	Results system.MemberResults // resulting from harness starts
}

SystemStartResp contains the request response.

type SystemStopReq ¶ added in v0.9.0

type SystemStopReq struct {
	Prep  bool
	Kill  bool
	Ranks []uint32
	Force bool
}

SystemStopReq contains the inputs for the system stop command.

type SystemStopResp ¶ added in v0.9.0

type SystemStopResp struct {
	Results system.MemberResults
}

SystemStopResp contains the request response.