mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2025-06-14 02:43:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup: do not pass EncodingVersion to GenerateVolID()

Browse Source 
The only encoding version that exists is `1`. There is no need to have
multiple constants for that version across different packages. Because
there is only one version, `GenerateVolID()` does not really require it,
and it can use a default version.

If there is a need in the future to support an other encoding version,
this can be revisited with a cleaner solution.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
This commit is contained in:
Niels de Vos
2024-03-14 10:40:49 +01:00
committed by mergify[bot]
parent c32dfc0ae6
commit 991343d9e5
7 changed files with 29 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
internal/util/volid.go
View File

@ -23,6 +23,11 @@ import (
"strings"
)
const (
// defaultEncodingVersion is only one version for the encoding at the moment.
defaultEncodingVersion = uint16(1)
)
/*
CSIIdentifier contains the elements that form a CSI ID to be returned by the CSI plugin, and
contains enough information to decompose and extract required cluster and pool information to locate
@ -34,7 +39,7 @@ DecomposeCSIID is the inverse of the same function.
The CSIIdentifier structure carries the following fields,
- LocationID: 64 bit integer identifier determining the location of the volume on the Ceph cluster.
It is the ID of the poolname or fsname, for RBD or CephFS backed volumes respectively.
- EncodingVersion: Carries the version number of the encoding scheme used to encode the CSI ID,
- encodingVersion: Carries the version number of the encoding scheme used to encode the CSI ID,
and is preserved for any future proofing w.r.t changes in the encoding scheme, and to retain
ability to parse backward compatible encodings.
- ClusterID: Is a unique ID per cluster that the CSI instance is serving and is restricted to
@ -44,7 +49,7 @@ The CSIIdentifier structure carries the following fields,
*/
type CSIIdentifier struct {
LocationID int64
EncodingVersion uint16
encodingVersion uint16
ClusterID string
ObjectUUID string
}
@ -82,7 +87,13 @@ func (ci CSIIdentifier) ComposeCSIID() (string, error) {
return "", errors.New("CSI ID invalid object uuid")
}
binary.BigEndian.PutUint16(buf16, ci.EncodingVersion)
// set the encoding version, as it is not set by default anywhere else
encodingVersion := ci.encodingVersion
if encodingVersion == 0 {
encodingVersion = defaultEncodingVersion
}
binary.BigEndian.PutUint16(buf16, encodingVersion)
versionEncodedHex := hex.EncodeToString(buf16)
binary.BigEndian.PutUint16(buf16, uint16(len(ci.ClusterID)))
@ -112,7 +123,7 @@ func (ci *CSIIdentifier) DecomposeCSIID(composedCSIID string) error {
if err != nil {
return err
}
ci.EncodingVersion = binary.BigEndian.Uint16(buf16)
ci.encodingVersion = binary.BigEndian.Uint16(buf16)
// 4 for version encoding and 1 for '-' separator
bytesToProcess -= 5