mirror of
https://github.com/ceph/go-ceph
synced 2024-12-27 00:32:08 +00:00
c362706640
Removes some old reminder comments. Adds doc comments with the keyword "Similar To" followed by block quoted text that shows a cli command the function will behave similarly to. Signed-off-by: John Mulligan <jmulligan@redhat.com>
80 lines
2.4 KiB
Go
80 lines
2.4 KiB
Go
// +build !luminous,!mimic
|
|
|
|
package admin
|
|
|
|
// this is the internal type used to create JSON for ceph.
|
|
// See SubVolumeGroupOptions for the type that users of the library
|
|
// interact with.
|
|
// note that the ceph json takes mode as a string.
|
|
type subVolumeGroupFields struct {
|
|
Prefix string `json:"prefix"`
|
|
Format string `json:"format"`
|
|
VolName string `json:"vol_name"`
|
|
GroupName string `json:"group_name"`
|
|
Uid int `json:"uid,omitempty"`
|
|
Gid int `json:"gid,omitempty"`
|
|
Mode string `json:"mode,omitempty"`
|
|
PoolLayout string `json:"pool_layout,omitempty"`
|
|
}
|
|
|
|
// SubVolumeGroupOptions are used to specify optional, non-identifying, values
|
|
// to be used when creating a new subvolume group.
|
|
type SubVolumeGroupOptions struct {
|
|
Uid int
|
|
Gid int
|
|
Mode int
|
|
PoolLayout string
|
|
}
|
|
|
|
func (s *SubVolumeGroupOptions) toFields(v, g string) *subVolumeGroupFields {
|
|
return &subVolumeGroupFields{
|
|
Prefix: "fs subvolumegroup create",
|
|
Format: "json",
|
|
VolName: v,
|
|
GroupName: g,
|
|
Uid: s.Uid,
|
|
Gid: s.Gid,
|
|
Mode: modeString(s.Mode, false),
|
|
PoolLayout: s.PoolLayout,
|
|
}
|
|
}
|
|
|
|
// CreateSubVolumeGroup sends a request to create a subvolume group in a volume.
|
|
//
|
|
// Similar To:
|
|
// ceph fs subvolumegroup create <volume> <group_name> ...
|
|
func (fsa *FSAdmin) CreateSubVolumeGroup(volume, name string, o *SubVolumeGroupOptions) error {
|
|
if o == nil {
|
|
o = &SubVolumeGroupOptions{}
|
|
}
|
|
r, s, err := fsa.marshalMgrCommand(o.toFields(volume, name))
|
|
return checkEmptyResponseExpected(r, s, err)
|
|
}
|
|
|
|
// ListSubVolumeGroups returns a list of subvolume groups belonging to the
|
|
// specified volume.
|
|
//
|
|
// Similar To:
|
|
// ceph fs subvolumegroup ls cephfs <volume>
|
|
func (fsa *FSAdmin) ListSubVolumeGroups(volume string) ([]string, error) {
|
|
r, s, err := fsa.marshalMgrCommand(map[string]string{
|
|
"prefix": "fs subvolumegroup ls",
|
|
"vol_name": volume,
|
|
"format": "json",
|
|
})
|
|
return parseListNames(r, s, err)
|
|
}
|
|
|
|
// RemoveSubVolumeGroup will delete a subvolume group in a volume.
|
|
// Similar To:
|
|
// ceph fs subvolumegroup rm <volume> <group_name>
|
|
func (fsa *FSAdmin) RemoveSubVolumeGroup(volume, name string) error {
|
|
r, s, err := fsa.marshalMgrCommand(map[string]string{
|
|
"prefix": "fs subvolumegroup rm",
|
|
"vol_name": volume,
|
|
"group_name": name,
|
|
"format": "json",
|
|
})
|
|
return checkEmptyResponseExpected(r, s, err)
|
|
}
|