Documentation
¶
Overview ¶
Package nvmegw from common/admin contains set of APIs used to manage NVMe-oF gateways for a Storage Ceph cluster.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Admin ¶
type Admin struct {
// contains filtered or unexported fields
}
Admin is used to administer ceph nvme gateway features.
func NewFromConn ¶
func NewFromConn(conn ccom.RadosCommander) *Admin
NewFromConn creates an new management object from a preexisting rados connection. The existing connection can be rados.Conn or any type implementing the RadosCommander interface.
func (*Admin) CreateGateway ¶
CreateGateway will create a new NVMe-oF gateway for accessing RBD-image.
Similar To:
ceph nvme-gw create gw pool group
func (*Admin) DeleteGateway ¶
DeleteGateway will delete a NVMe-oF gateway for accessing RBD-image.
Similar To:
ceph nvme-gw delete gw pool group
func (*Admin) ShowGateways ¶
func (nvmea *Admin) ShowGateways(pool, group string) (*GatewayList, error)
ShowGateways returns a list of gateways for the pool and group.
Similar To:
ceph nvme-gw show pool group
type GatewayInfo ¶
type GatewayInfo struct {
ID string `json:"gw-id"`
ANAGroupID int `json:"anagrp-id"`
PerformedFullStartup int `json:"performed-full-startup"`
Availability string `json:"Availability"`
ANAStates string `json:"ana states"`
}
GatewayInfo describes an NVMe-oF gateway.
type GatewayList ¶
type GatewayList struct {
Epoch int `json:"epoch"`
Pool string `json:"pool"`
Group string `json:"group"`
Features string `json:"features"`
RebalanceANAGroup int `json:"rebalance_ana_group,omitempty"`
GatewayEpoch int `json:"GW-epoch,omitempty"`
ANAGroupList string `json:"Anagrp list,omitempty"`
Gateways []GatewayInfo `json:"Created Gateways:,omitempty"`
}
GatewayList describes the status and details of the gateways for a pool and ANA-group.
Source Files