mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-18 11:00:25 +00:00
c8271fe64c
This new journal package isolates journal logic from the rest of util and helps draw bright lines between what is a generic utility function and what is csi journal logic. Done partly as preparation for making use of go-ceph in journal. No functional changes are made except to update references to allow the code to compile. Signed-off-by: John Mulligan <jmulligan@redhat.com>
630 lines
24 KiB
Go
630 lines
24 KiB
Go
/*
|
|
Copyright 2019 The Ceph-CSI Authors.
|
|
|
|
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.
|
|
*/
|
|
|
|
package journal
|
|
|
|
import (
|
|
"context"
|
|
"encoding/binary"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/ceph/ceph-csi/internal/util"
|
|
|
|
"github.com/pborman/uuid"
|
|
"github.com/pkg/errors"
|
|
"k8s.io/klog"
|
|
)
|
|
|
|
// Length of string representation of uuid, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx is 36 bytes
|
|
const uuidEncodedLength = 36
|
|
|
|
/*
|
|
RADOS omaps usage:
|
|
|
|
This note details how we preserve idempotent nature of create requests and retain the relationship
|
|
between orchestrator (CO) generated names and plugin generated names for volumes and snapshots.
|
|
|
|
NOTE: volume denotes an rbd image or a CephFS subvolume
|
|
|
|
The implementation uses Ceph RADOS omaps to preserve the relationship between request name and
|
|
generated volume (or snapshot) name. There are 4 types of omaps in use,
|
|
- A "csi.volumes.[csi-id]" (or "csi.volumes"+.+CSIInstanceID), (referred to using csiDirectory variable)
|
|
- stores keys named using the CO generated names for volume requests (prefixed with csiNameKeyPrefix)
|
|
- keys are named "csi.volume."+[CO generated VolName]
|
|
- Key value contains the volume uuid that is created, for the CO provided name
|
|
|
|
- A "csi.snaps.[csi-id]" (or "csi.snaps"+.+CSIInstanceID), (referred to using csiDirectory variable)
|
|
- stores keys named using the CO generated names for snapshot requests (prefixed with csiNameKeyPrefix)
|
|
- keys are named "csi.snap."+[CO generated SnapName]
|
|
- Key value contains the snapshot uuid that is created, for the CO provided name
|
|
|
|
- A per volume omap named "csi.volume."+[volume uuid], (referred to as CephUUIDDirectory)
|
|
- stores the key named "csi.volname", that has the value of the CO generated VolName that
|
|
this volume refers to (referred to using csiNameKey value)
|
|
- stores the key named "csi.imagename", that has the value of the Ceph RBD image name
|
|
this volume refers to (referred to using csiImageKey value)
|
|
|
|
- A per snapshot omap named "rbd.csi.snap."+[RBD snapshot uuid], (referred to as CephUUIDDirectory)
|
|
- stores a key named "csi.snapname", that has the value of the CO generated SnapName that this
|
|
snapshot refers to (referred to using csiNameKey value)
|
|
- stores the key named "csi.imagename", that has the value of the Ceph RBD image name
|
|
this snapshot refers to (referred to using csiImageKey value)
|
|
- stores a key named "csi.source", that has the value of the volume name that is the
|
|
source of the snapshot (referred to using cephSnapSourceKey value)
|
|
|
|
Creation of omaps:
|
|
When a volume create request is received (or a snapshot create, the snapshot is not detailed in this
|
|
comment further as the process is similar),
|
|
- The csiDirectory is consulted to find if there is already a key with the CO VolName, and if present,
|
|
it is used to read its references to reach the UUID that backs this VolName, to check if the
|
|
UUID based volume can satisfy the requirements for the request
|
|
- If during the process of checking the same, it is found that some linking information is stale
|
|
or missing, the corresponding keys upto the key in the csiDirectory is cleaned up, to start afresh
|
|
|
|
- If the key with the CO VolName is not found, or was cleaned up, the request is treated as a
|
|
new create request, and an CephUUIDDirectory is created first with a generated uuid, this ensures
|
|
that we do not use a uuid that is already in use
|
|
|
|
- Next, a key with the VolName is created in the csiDirectory, and its value is updated to store the
|
|
generated uuid
|
|
|
|
- This is followed by updating the CephUUIDDirectory with the VolName in the csiNameKey and the RBD image
|
|
name in the csiImageKey
|
|
|
|
- Finally, the volume is created (or promoted from a snapshot, if content source was provided),
|
|
using the uuid and a corresponding name prefix (namingPrefix) as the volume name
|
|
|
|
The entire operation is locked based on VolName hash, to ensure there is only ever a single entity
|
|
modifying the related omaps for a given VolName.
|
|
|
|
This ensures idempotent nature of creates, as the same CO generated VolName would attempt to use
|
|
the same volume uuid to serve the request, as the relations are saved in the respective omaps.
|
|
|
|
Deletion of omaps:
|
|
Delete requests would not contain the VolName, hence deletion uses the volume ID, which is encoded
|
|
with the volume uuid in it, to find the volume and the CephUUIDDirectory. The CephUUIDDirectory is
|
|
read to get the VolName that this image points to. This VolName can be further used to read and
|
|
delete the key from the csiDirectory.
|
|
|
|
As we trace back and find the VolName, we also take a hash based lock on the VolName before
|
|
proceeding with deleting the volume and the related omap entries, to ensure there is only ever a
|
|
single entity modifying the related omaps for a given VolName.
|
|
*/
|
|
|
|
const (
|
|
defaultVolumeNamingPrefix string = "csi-vol-"
|
|
defaultSnapshotNamingPrefix string = "csi-snap-"
|
|
)
|
|
|
|
// CSIJournal defines the interface and the required key names for the above RADOS based OMaps
|
|
type CSIJournal struct {
|
|
// csiDirectory is the name of the CSI volumes object map that contains CSI volume-name (or
|
|
// snapshot name) based keys
|
|
csiDirectory string
|
|
|
|
// CSI volume-name keyname prefix, for key in csiDirectory, suffix is the CSI passed volume name
|
|
csiNameKeyPrefix string
|
|
|
|
// Per Ceph volume (RBD/FS-subvolume) object map name prefix, suffix is the generated volume uuid
|
|
cephUUIDDirectoryPrefix string
|
|
|
|
// CSI volume-name key in per Ceph volume object map, containing CSI volume-name for which the
|
|
// Ceph volume was created
|
|
csiNameKey string
|
|
|
|
// CSI image-name key in per Ceph volume object map, containing RBD image-name
|
|
// of this Ceph volume
|
|
csiImageKey string
|
|
|
|
// pool ID where csiDirectory is maintained, as it can be different from where the ceph volume
|
|
// object map is maintained, during topology based provisioning
|
|
csiJournalPool string
|
|
|
|
// source volume name key in per Ceph snapshot object map, containing Ceph source volume uuid
|
|
// for which the snapshot was created
|
|
cephSnapSourceKey string
|
|
|
|
// namespace in which the RADOS objects are stored, default is no namespace
|
|
namespace string
|
|
|
|
// encryptKMS in which encryption passphrase was saved, default is no encryption
|
|
encryptKMSKey string
|
|
}
|
|
|
|
// NewCSIVolumeJournal returns an instance of CSIJournal for volumes
|
|
func NewCSIVolumeJournal() *CSIJournal {
|
|
return &CSIJournal{
|
|
csiDirectory: "csi.volumes",
|
|
csiNameKeyPrefix: "csi.volume.",
|
|
cephUUIDDirectoryPrefix: "csi.volume.",
|
|
csiNameKey: "csi.volname",
|
|
csiImageKey: "csi.imagename",
|
|
csiJournalPool: "csi.journalpool",
|
|
cephSnapSourceKey: "",
|
|
namespace: "",
|
|
encryptKMSKey: "csi.volume.encryptKMS",
|
|
}
|
|
}
|
|
|
|
// NewCSISnapshotJournal returns an instance of CSIJournal for snapshots
|
|
func NewCSISnapshotJournal() *CSIJournal {
|
|
return &CSIJournal{
|
|
csiDirectory: "csi.snaps",
|
|
csiNameKeyPrefix: "csi.snap.",
|
|
cephUUIDDirectoryPrefix: "csi.snap.",
|
|
csiNameKey: "csi.snapname",
|
|
csiImageKey: "csi.imagename",
|
|
csiJournalPool: "csi.journalpool",
|
|
cephSnapSourceKey: "csi.source",
|
|
namespace: "",
|
|
encryptKMSKey: "csi.volume.encryptKMS",
|
|
}
|
|
}
|
|
|
|
// GetNameForUUID returns volume name
|
|
func (cj *CSIJournal) GetNameForUUID(prefix, uid string, isSnapshot bool) string {
|
|
if prefix == "" {
|
|
if isSnapshot {
|
|
prefix = defaultSnapshotNamingPrefix
|
|
} else {
|
|
prefix = defaultVolumeNamingPrefix
|
|
}
|
|
}
|
|
return prefix + uid
|
|
}
|
|
|
|
// SetCSIDirectorySuffix sets the given suffix for the csiDirectory omap
|
|
func (cj *CSIJournal) SetCSIDirectorySuffix(suffix string) {
|
|
cj.csiDirectory = cj.csiDirectory + "." + suffix
|
|
}
|
|
|
|
// SetNamespace sets the namespace in which all RADOS objects would be created
|
|
func (cj *CSIJournal) SetNamespace(ns string) {
|
|
cj.namespace = ns
|
|
}
|
|
|
|
// ImageData contains image name and stored CSI properties
|
|
type ImageData struct {
|
|
ImageUUID string
|
|
ImagePool string
|
|
ImagePoolID int64
|
|
ImageAttributes *ImageAttributes
|
|
}
|
|
|
|
/*
|
|
CheckReservation checks if given request name contains a valid reservation
|
|
- If there is a valid reservation, then the corresponding UUID for the volume/snapshot is returned
|
|
- If there is a reservation that is stale (or not fully cleaned up), it is garbage collected using
|
|
the UndoReservation call, as appropriate
|
|
- If a snapshot is being checked, then its source is matched to the parentName that is provided
|
|
|
|
NOTE: As the function manipulates omaps, it should be called with a lock against the request name
|
|
held, to prevent parallel operations from modifying the state of the omaps for this request name.
|
|
|
|
Return values:
|
|
- string: Contains the UUID that was reserved for the passed in reqName, empty if
|
|
there was no reservation found
|
|
- error: non-nil in case of any errors
|
|
*/
|
|
func (cj *CSIJournal) CheckReservation(ctx context.Context, monitors string, cr *util.Credentials,
|
|
journalPool, reqName, namePrefix, parentName, kmsConfig string) (*ImageData, error) {
|
|
var (
|
|
snapSource bool
|
|
objUUID string
|
|
savedImagePool string
|
|
savedImagePoolID int64 = util.InvalidPoolID
|
|
)
|
|
|
|
if parentName != "" {
|
|
if cj.cephSnapSourceKey == "" {
|
|
err := errors.New("invalid request, cephSnapSourceKey is nil")
|
|
return nil, err
|
|
}
|
|
snapSource = true
|
|
}
|
|
|
|
// check if request name is already part of the directory omap
|
|
objUUIDAndPool, err := util.GetOMapValue(ctx, monitors, cr, journalPool, cj.namespace, cj.csiDirectory,
|
|
cj.csiNameKeyPrefix+reqName)
|
|
if err != nil {
|
|
// error should specifically be not found, for volume to be absent, any other error
|
|
// is not conclusive, and we should not proceed
|
|
switch err.(type) {
|
|
case util.ErrKeyNotFound, util.ErrPoolNotFound:
|
|
return nil, nil
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
// check UUID only encoded value
|
|
if len(objUUIDAndPool) == uuidEncodedLength {
|
|
objUUID = objUUIDAndPool
|
|
savedImagePool = journalPool
|
|
} else { // check poolID/UUID encoding; extract the vol UUID and pool name
|
|
var buf64 []byte
|
|
components := strings.Split(objUUIDAndPool, "/")
|
|
objUUID = components[1]
|
|
savedImagePoolIDStr := components[0]
|
|
|
|
buf64, err = hex.DecodeString(savedImagePoolIDStr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
savedImagePoolID = int64(binary.BigEndian.Uint64(buf64))
|
|
|
|
savedImagePool, err = util.GetPoolName(ctx, monitors, cr, savedImagePoolID)
|
|
if err != nil {
|
|
if _, ok := err.(util.ErrPoolNotFound); ok {
|
|
err = cj.UndoReservation(ctx, monitors, cr, journalPool, "", "", reqName)
|
|
}
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
savedImageAttributes, err := cj.GetImageAttributes(ctx, monitors, cr, savedImagePool,
|
|
objUUID, snapSource)
|
|
if err != nil {
|
|
// error should specifically be not found, for image to be absent, any other error
|
|
// is not conclusive, and we should not proceed
|
|
if _, ok := err.(util.ErrKeyNotFound); ok {
|
|
err = cj.UndoReservation(ctx, monitors, cr, journalPool, savedImagePool,
|
|
cj.GetNameForUUID(namePrefix, objUUID, snapSource), reqName)
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
// check if UUID key points back to the request name
|
|
if savedImageAttributes.RequestName != reqName {
|
|
// NOTE: This should never be possible, hence no cleanup, but log error
|
|
// and return, as cleanup may need to occur manually!
|
|
return nil, fmt.Errorf("internal state inconsistent, omap names mismatch,"+
|
|
" request name (%s) volume UUID (%s) volume omap name (%s)",
|
|
reqName, objUUID, savedImageAttributes.RequestName)
|
|
}
|
|
|
|
if kmsConfig != "" {
|
|
if savedImageAttributes.KmsID != kmsConfig {
|
|
return nil, fmt.Errorf("internal state inconsistent, omap encryption KMS"+
|
|
" mismatch, request KMS (%s) volume UUID (%s) volume omap KMS (%s)",
|
|
kmsConfig, objUUID, savedImageAttributes.KmsID)
|
|
}
|
|
}
|
|
|
|
// TODO: skipping due to excessive poolID to poolname call, also this should never happen!
|
|
// check if journal pool points back to the passed in journal pool
|
|
// if savedJournalPoolID != journalPoolID {
|
|
|
|
if snapSource {
|
|
// check if source UUID key points back to the parent volume passed in
|
|
if savedImageAttributes.SourceName != parentName {
|
|
// NOTE: This can happen if there is a snapname conflict, and we already have a snapshot
|
|
// with the same name pointing to a different UUID as the source
|
|
err = fmt.Errorf("snapname points to different volume, request name (%s)"+
|
|
" source name (%s) saved source name (%s)",
|
|
reqName, parentName, savedImageAttributes.SourceName)
|
|
return nil, util.NewErrSnapNameConflict(reqName, err)
|
|
}
|
|
}
|
|
|
|
imageData := &ImageData{
|
|
ImageUUID: objUUID,
|
|
ImagePool: savedImagePool,
|
|
ImagePoolID: savedImagePoolID,
|
|
ImageAttributes: savedImageAttributes,
|
|
}
|
|
|
|
return imageData, nil
|
|
}
|
|
|
|
/*
|
|
UndoReservation undoes a reservation, in the reverse order of ReserveName
|
|
- The UUID directory is cleaned up before the VolName key in the csiDirectory is cleaned up
|
|
|
|
NOTE: Ensure that the Ceph volume (image or FS subvolume) backing the reservation is cleaned up
|
|
prior to cleaning up the reservation
|
|
|
|
NOTE: As the function manipulates omaps, it should be called with a lock against the request name
|
|
held, to prevent parallel operations from modifying the state of the omaps for this request name.
|
|
|
|
Input arguments:
|
|
- csiJournalPool: Pool name that holds the CSI request name based journal
|
|
- volJournalPool: Pool name that holds the image/subvolume and the per-image journal (may be
|
|
different if image is created in a topology constrained pool)
|
|
*/
|
|
func (cj *CSIJournal) UndoReservation(ctx context.Context, monitors string, cr *util.Credentials,
|
|
csiJournalPool, volJournalPool, volName, reqName string) error {
|
|
// delete volume UUID omap (first, inverse of create order)
|
|
|
|
if volName != "" {
|
|
if len(volName) < 36 {
|
|
return fmt.Errorf("unable to parse UUID from %s, too short", volName)
|
|
}
|
|
|
|
imageUUID := volName[len(volName)-36:]
|
|
if valid := uuid.Parse(imageUUID); valid == nil {
|
|
return fmt.Errorf("failed parsing UUID in %s", volName)
|
|
}
|
|
|
|
err := util.RemoveObject(ctx, monitors, cr, volJournalPool, cj.namespace, cj.cephUUIDDirectoryPrefix+imageUUID)
|
|
if err != nil {
|
|
if _, ok := err.(util.ErrObjectNotFound); !ok {
|
|
klog.Errorf(util.Log(ctx, "failed removing oMap %s (%s)"), cj.cephUUIDDirectoryPrefix+imageUUID, err)
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
|
|
// delete the request name key (last, inverse of create order)
|
|
err := util.RemoveOMapKey(ctx, monitors, cr, csiJournalPool, cj.namespace, cj.csiDirectory,
|
|
cj.csiNameKeyPrefix+reqName)
|
|
if err != nil {
|
|
klog.Errorf(util.Log(ctx, "failed removing oMap key %s (%s)"), cj.csiNameKeyPrefix+reqName, err)
|
|
return err
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
// reserveOMapName creates an omap with passed in oMapNamePrefix and a generated <uuid>.
|
|
// It ensures generated omap name does not already exist and if conflicts are detected, a set
|
|
// number of retires with newer uuids are attempted before returning an error
|
|
func reserveOMapName(ctx context.Context, monitors string, cr *util.Credentials, pool, namespace, oMapNamePrefix string) (string, error) {
|
|
var iterUUID string
|
|
|
|
maxAttempts := 5
|
|
attempt := 1
|
|
for attempt <= maxAttempts {
|
|
// generate a uuid for the image name
|
|
iterUUID = uuid.NewUUID().String()
|
|
|
|
err := util.CreateObject(ctx, monitors, cr, pool, namespace, oMapNamePrefix+iterUUID)
|
|
if err != nil {
|
|
if _, ok := err.(util.ErrObjectExists); ok {
|
|
attempt++
|
|
// try again with a different uuid, for maxAttempts tries
|
|
klog.V(4).Infof(util.Log(ctx, "uuid (%s) conflict detected, retrying (attempt %d of %d)"),
|
|
iterUUID, attempt, maxAttempts)
|
|
continue
|
|
}
|
|
|
|
return "", err
|
|
}
|
|
|
|
return iterUUID, nil
|
|
}
|
|
|
|
return "", errors.New("uuid conflicts exceeds retry threshold")
|
|
}
|
|
|
|
/*
|
|
ReserveName adds respective entries to the csiDirectory omaps, post generating a target
|
|
UUIDDirectory for use. Further, these functions update the UUIDDirectory omaps, to store back
|
|
pointers to the CSI generated request names.
|
|
|
|
NOTE: As the function manipulates omaps, it should be called with a lock against the request name
|
|
held, to prevent parallel operations from modifying the state of the omaps for this request name.
|
|
|
|
Input arguments:
|
|
- journalPool: Pool where the CSI journal is stored (maybe different than the pool where the
|
|
image/subvolume is created duw to topology constraints)
|
|
- journalPoolID: pool ID of the journalPool
|
|
- imagePool: Pool where the image/subvolume is created
|
|
- imagePoolID: pool ID of the imagePool
|
|
- reqName: Name of the volume request received
|
|
- namePrefix: Prefix to use when generating the image/subvolume name (suffix is an auto-genetated UUID)
|
|
- parentName: Name of the parent image/subvolume if reservation is for a snapshot (optional)
|
|
- kmsConf: Name of the key management service used to encrypt the image (optional)
|
|
|
|
Return values:
|
|
- string: Contains the UUID that was reserved for the passed in reqName
|
|
- string: Contains the image name that was reserved for the passed in reqName
|
|
- error: non-nil in case of any errors
|
|
*/
|
|
func (cj *CSIJournal) ReserveName(ctx context.Context, monitors string, cr *util.Credentials,
|
|
journalPool string, journalPoolID int64,
|
|
imagePool string, imagePoolID int64,
|
|
reqName, namePrefix, parentName, kmsConf string) (string, string, error) {
|
|
// TODO: Take in-arg as ImageAttributes?
|
|
var (
|
|
snapSource bool
|
|
nameKeyVal string
|
|
)
|
|
|
|
if parentName != "" {
|
|
if cj.cephSnapSourceKey == "" {
|
|
err := errors.New("invalid request, cephSnapSourceKey is nil")
|
|
return "", "", err
|
|
}
|
|
snapSource = true
|
|
}
|
|
|
|
// Create the UUID based omap first, to reserve the same and avoid conflicts
|
|
// NOTE: If any service loss occurs post creation of the UUID directory, and before
|
|
// setting the request name key (csiNameKey) to point back to the UUID directory, the
|
|
// UUID directory key will be leaked
|
|
volUUID, err := reserveOMapName(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
|
|
imageName := cj.GetNameForUUID(namePrefix, volUUID, snapSource)
|
|
|
|
// Create request name (csiNameKey) key in csiDirectory and store the UUID based
|
|
// volume name and optionally the image pool location into it
|
|
if journalPool != imagePool && imagePoolID != util.InvalidPoolID {
|
|
buf64 := make([]byte, 8)
|
|
binary.BigEndian.PutUint64(buf64, uint64(imagePoolID))
|
|
poolIDEncodedHex := hex.EncodeToString(buf64)
|
|
nameKeyVal = poolIDEncodedHex + "/" + volUUID
|
|
} else {
|
|
nameKeyVal = volUUID
|
|
}
|
|
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, journalPool, cj.namespace, cj.csiDirectory,
|
|
cj.csiNameKeyPrefix+reqName, nameKeyVal)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
defer func() {
|
|
if err != nil {
|
|
klog.Warningf(util.Log(ctx, "reservation failed for volume: %s"), reqName)
|
|
errDefer := cj.UndoReservation(ctx, monitors, cr, imagePool, journalPool, imageName, reqName)
|
|
if errDefer != nil {
|
|
klog.Warningf(util.Log(ctx, "failed undoing reservation of volume: %s (%v)"), reqName, errDefer)
|
|
}
|
|
}
|
|
}()
|
|
|
|
// NOTE: UUID directory is stored on the same pool as the image, helps determine image attributes
|
|
// and also CSI journal pool, when only the VolumeID is passed in (e.g DeleteVolume/DeleteSnapshot,
|
|
// VolID during CreateSnapshot).
|
|
// Update UUID directory to store CSI request name
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix+volUUID,
|
|
cj.csiNameKey, reqName)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
|
|
// Update UUID directory to store image name
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix+volUUID,
|
|
cj.csiImageKey, imageName)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
|
|
// Update UUID directory to store encryption values
|
|
if kmsConf != "" {
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix+volUUID,
|
|
cj.encryptKMSKey, kmsConf)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
}
|
|
|
|
if journalPool != imagePool && journalPoolID != util.InvalidPoolID {
|
|
buf64 := make([]byte, 8)
|
|
binary.BigEndian.PutUint64(buf64, uint64(journalPoolID))
|
|
journalPoolIDStr := hex.EncodeToString(buf64)
|
|
|
|
// Update UUID directory to store CSI journal pool name (prefer ID instead of name to be pool rename proof)
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix+volUUID,
|
|
cj.csiJournalPool, journalPoolIDStr)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
}
|
|
|
|
if snapSource {
|
|
// Update UUID directory to store source volume UUID in case of snapshots
|
|
err = util.SetOMapKeyValue(ctx, monitors, cr, imagePool, cj.namespace, cj.cephUUIDDirectoryPrefix+volUUID,
|
|
cj.cephSnapSourceKey, parentName)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
}
|
|
|
|
return volUUID, imageName, nil
|
|
}
|
|
|
|
// ImageAttributes contains all CSI stored image attributes, typically as OMap keys
|
|
type ImageAttributes struct {
|
|
RequestName string // Contains the request name for the passed in UUID
|
|
SourceName string // Contains the parent image name for the passed in UUID, if it is a snapshot
|
|
ImageName string // Contains the image or subvolume name for the passed in UUID
|
|
KmsID string // Contains encryption KMS, if it is an encrypted image
|
|
JournalPoolID int64 // Pool ID of the CSI journal pool, stored in big endian format (on-disk data)
|
|
}
|
|
|
|
// GetImageAttributes fetches all keys and their values, from a UUID directory, returning ImageAttributes structure
|
|
func (cj *CSIJournal) GetImageAttributes(ctx context.Context, monitors string, cr *util.Credentials, pool, objectUUID string, snapSource bool) (*ImageAttributes, error) {
|
|
var (
|
|
err error
|
|
imageAttributes *ImageAttributes = &ImageAttributes{}
|
|
)
|
|
|
|
if snapSource && cj.cephSnapSourceKey == "" {
|
|
err = errors.New("invalid request, cephSnapSourceKey is nil")
|
|
return nil, err
|
|
}
|
|
|
|
// TODO: fetch all omap vals in one call, than make multiple listomapvals
|
|
imageAttributes.RequestName, err = util.GetOMapValue(ctx, monitors, cr, pool, cj.namespace,
|
|
cj.cephUUIDDirectoryPrefix+objectUUID, cj.csiNameKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// image key was added at some point, so not all volumes will have this key set
|
|
// when ceph-csi was upgraded
|
|
imageAttributes.ImageName, err = util.GetOMapValue(ctx, monitors, cr, pool, cj.namespace,
|
|
cj.cephUUIDDirectoryPrefix+objectUUID, cj.csiImageKey)
|
|
if err != nil {
|
|
// if the key was not found, assume the default key + UUID
|
|
// otherwise return error
|
|
switch err.(type) {
|
|
default:
|
|
return nil, err
|
|
case util.ErrKeyNotFound, util.ErrPoolNotFound:
|
|
}
|
|
|
|
if snapSource {
|
|
imageAttributes.ImageName = defaultSnapshotNamingPrefix + objectUUID
|
|
} else {
|
|
imageAttributes.ImageName = defaultVolumeNamingPrefix + objectUUID
|
|
}
|
|
}
|
|
|
|
imageAttributes.KmsID, err = util.GetOMapValue(ctx, monitors, cr, pool, cj.namespace,
|
|
cj.cephUUIDDirectoryPrefix+objectUUID, cj.encryptKMSKey)
|
|
if err != nil {
|
|
// ErrKeyNotFound means no encryption KMS was used
|
|
switch err.(type) {
|
|
default:
|
|
return nil, fmt.Errorf("OMapVal for %s/%s failed to get encryption KMS value: %s",
|
|
pool, cj.cephUUIDDirectoryPrefix+objectUUID, err)
|
|
case util.ErrKeyNotFound, util.ErrPoolNotFound:
|
|
}
|
|
}
|
|
|
|
journalPoolIDStr, err := util.GetOMapValue(ctx, monitors, cr, pool, cj.namespace,
|
|
cj.cephUUIDDirectoryPrefix+objectUUID, cj.csiJournalPool)
|
|
if err != nil {
|
|
if _, ok := err.(util.ErrKeyNotFound); !ok {
|
|
return nil, err
|
|
}
|
|
imageAttributes.JournalPoolID = util.InvalidPoolID
|
|
} else {
|
|
var buf64 []byte
|
|
buf64, err = hex.DecodeString(journalPoolIDStr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
imageAttributes.JournalPoolID = int64(binary.BigEndian.Uint64(buf64))
|
|
}
|
|
|
|
if snapSource {
|
|
imageAttributes.SourceName, err = util.GetOMapValue(ctx, monitors, cr, pool, cj.namespace,
|
|
cj.cephUUIDDirectoryPrefix+objectUUID, cj.cephSnapSourceKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
return imageAttributes, nil
|
|
}
|