Documentation
¶
Overview ¶
(C) Copyright 2019 Intel Corporation.
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.
GOVERNMENT LICENSE RIGHTS-OPEN SOURCE SOFTWARE The Government's rights to use, modify, reproduce, release, perform, display, or disclose this software are subject to the terms of the Apache License as provided in Contract No. 8F-30005. Any reproduction of computer software, computer software documentation, or portions thereof marked with this legend must also reproduce the markings.
Index ¶
Constants ¶
const MsgStoragePrepareWarn = "Memory allocation goals for SCM will be changed and " +
"namespaces modified, this will be a destructive operation. Please ensure " +
"namespaces are unmounted and locally attached SCM & NVMe devices " +
"are not in use. Please be patient as it may take several minutes " +
"and subsequent reboot maybe required.\n"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CtrlrResults ¶
type CtrlrResults struct {
Ctrlrs NvmeControllers
Responses NvmeControllerResults
Err error
}
CtrlrResults contains controllers and/or results of operations on controllers and an error signifying a problem in making the request.
func (CtrlrResults) String ¶
func (cr CtrlrResults) String() string
type MountResults ¶
type MountResults struct {
Mounts ScmMounts
Responses ScmMountResults
Err error
}
MountResults contains modules and/or results of operations on mounted SCM regions and an error signifying a problem in making the request.
func (MountResults) String ¶
func (mr MountResults) String() string
type NvmeControllerResults ¶
type NvmeControllerResults []*ctlpb.NvmeControllerResult
NvmeControllerResults is an alias for protobuf NvmeControllerResult messages representing operation results on a number of NVMe controllers.
func (NvmeControllerResults) HasErrors ¶
func (ncr NvmeControllerResults) HasErrors() bool
func (NvmeControllerResults) String ¶
func (ncr NvmeControllerResults) String() string
type NvmeControllers ¶
type NvmeControllers []*ctlpb.NvmeController
NvmeControllers is an alias for protobuf NvmeController message slice representing a number of NVMe SSD controllers installed on a storage node.
func (NvmeControllers) String ¶
func (ncs NvmeControllers) String() string
func (NvmeControllers) StringHealthStats ¶
func (ncs NvmeControllers) StringHealthStats() string
StringHealthStats returns full string representation including NVMe health statistics as well as controller and namespace details.
func (NvmeControllers) Summary ¶
func (ncs NvmeControllers) Summary() string
Summary reports accumulated storage space and the number of controllers.
type NvmeNamespaces ¶
type NvmeNamespaces []*ctlpb.NvmeController_Namespace
NvmeNamespaces is an alias for protobuf NvmeController_Namespace message slice representing namespaces existing on a NVMe SSD.
type ScmModuleResults ¶
type ScmModuleResults []*ctlpb.ScmModuleResult
ScmModuleResults is an alias for protobuf ScmModuleResult message slice representing operation results on a number of SCM modules.
func (ScmModuleResults) String ¶
func (smr ScmModuleResults) String() string
type ScmModules ¶
ScmModules is an alias for protobuf ScmModule message slice representing a number of SCM modules installed on a storage node.
type ScmMountResults ¶
type ScmMountResults []*ctlpb.ScmMountResult
ScmMountResults is an alias for protobuf ScmMountResult message slice representing operation results on a number of SCM mounts.
func (ScmMountResults) HasErrors ¶
func (smr ScmMountResults) HasErrors() bool
func (ScmMountResults) String ¶
func (smr ScmMountResults) String() string
type ScmMounts ¶
ScmMounts are protobuf representations of mounted SCM namespaces identified by mount points
type ScmNamespaces ¶
type ScmNamespaces []*ctlpb.PmemDevice
ScmNamespaces is an alias for protobuf PmemDevice message slice representing a number of PMEM device files created on SCM namespaces on a storage node.
func (ScmNamespaces) String ¶
func (pds ScmNamespaces) String() string
type StoragePrepareCmd ¶
type StoragePrepareCmd struct {
StoragePrepareNvmeCmd
StoragePrepareScmCmd
NvmeOnly bool `short:"n" long:"nvme-only" description:"Only prepare NVMe storage."`
ScmOnly bool `short:"s" long:"scm-only" description:"Only prepare SCM."`
Reset bool `` /* 152-byte string literal not displayed */
Force bool `short:"f" long:"force" description:"Perform format without prompting for confirmation"`
}
func (*StoragePrepareCmd) CheckWarn ¶
func (cmd *StoragePrepareCmd) CheckWarn(log *logging.LeveledLogger, state storage.ScmState) error
func (*StoragePrepareCmd) Validate ¶
func (cmd *StoragePrepareCmd) Validate() (bool, bool, error)
Validate checks both only options are not set and returns flags to direct which subsystem types to prepare.
func (*StoragePrepareCmd) Warn ¶
func (cmd *StoragePrepareCmd) Warn(log *logging.LeveledLogger) error
type StoragePrepareNvmeCmd ¶
type StoragePrepareNvmeCmd struct {
PCIWhiteList string `` /* 180-byte string literal not displayed */
NrHugepages int `short:"p" long:"hugepages" description:"Number of hugepages to allocate (in MB) for use by SPDK (default 1024)"`
TargetUser string `short:"u" long:"target-user" description:"User that will own hugepage mountpoint directory and vfio groups."`
}
type StoragePrepareScmCmd ¶
type StoragePrepareScmCmd struct{}
Source Files