mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-25 07:40:19 +00:00
278 lines
8.3 KiB
Go
278 lines
8.3 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 util
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"os/exec"
|
|
"strings"
|
|
|
|
"github.com/ceph/go-ceph/rados"
|
|
"k8s.io/klog"
|
|
)
|
|
|
|
// InvalidPoolID used to denote an invalid pool
|
|
const InvalidPoolID int64 = -1
|
|
|
|
// ExecCommand executes passed in program with args and returns separate stdout and stderr streams
|
|
func ExecCommand(program string, args ...string) (stdout, stderr []byte, err error) {
|
|
var (
|
|
cmd = exec.Command(program, args...) // nolint: gosec, #nosec
|
|
sanitizedArgs = StripSecretInArgs(args)
|
|
stdoutBuf bytes.Buffer
|
|
stderrBuf bytes.Buffer
|
|
)
|
|
|
|
cmd.Stdout = &stdoutBuf
|
|
cmd.Stderr = &stderrBuf
|
|
|
|
if err := cmd.Run(); err != nil {
|
|
return stdoutBuf.Bytes(), stderrBuf.Bytes(), fmt.Errorf("an error (%v)"+
|
|
" occurred while running %s args: %v", err, program, sanitizedArgs)
|
|
}
|
|
|
|
return stdoutBuf.Bytes(), nil, nil
|
|
}
|
|
|
|
// GetPoolID fetches the ID of the pool that matches the passed in poolName
|
|
// parameter
|
|
func GetPoolID(monitors string, cr *Credentials, poolName string) (int64, error) {
|
|
conn, err := connPool.Get(monitors, cr.ID, cr.KeyFile)
|
|
if err != nil {
|
|
return InvalidPoolID, err
|
|
}
|
|
defer connPool.Put(conn)
|
|
|
|
id, err := conn.GetPoolByName(poolName)
|
|
if err == rados.ErrNotFound {
|
|
return InvalidPoolID, ErrPoolNotFound{poolName, fmt.Errorf("pool (%s) not found in Ceph cluster", poolName)}
|
|
} else if err != nil {
|
|
return InvalidPoolID, err
|
|
}
|
|
|
|
return id, nil
|
|
}
|
|
|
|
// GetPoolName fetches the pool whose pool ID is equal to the requested poolID
|
|
// parameter
|
|
func GetPoolName(monitors string, cr *Credentials, poolID int64) (string, error) {
|
|
conn, err := connPool.Get(monitors, cr.ID, cr.KeyFile)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
defer connPool.Put(conn)
|
|
|
|
name, err := conn.GetPoolByID(poolID)
|
|
if err != nil {
|
|
return "", ErrPoolNotFound{string(poolID), fmt.Errorf("pool ID (%d) not found in Ceph cluster", poolID)}
|
|
}
|
|
return name, nil
|
|
}
|
|
|
|
// GetPoolIDs searches a list of pools in a cluster and returns the IDs of the pools that matches
|
|
// the passed in pools
|
|
// TODO this should take in a list and return a map[string(poolname)]int64(poolID)
|
|
func GetPoolIDs(ctx context.Context, monitors, journalPool, imagePool string, cr *Credentials) (int64, int64, error) {
|
|
journalPoolID, err := GetPoolID(monitors, cr, journalPool)
|
|
if err != nil {
|
|
return InvalidPoolID, InvalidPoolID, err
|
|
}
|
|
|
|
imagePoolID := journalPoolID
|
|
if imagePool != journalPool {
|
|
imagePoolID, err = GetPoolID(monitors, cr, imagePool)
|
|
if err != nil {
|
|
return InvalidPoolID, InvalidPoolID, err
|
|
}
|
|
}
|
|
|
|
return journalPoolID, imagePoolID, nil
|
|
}
|
|
|
|
// SetOMapKeyValue sets the given key and value into the provided Ceph omap name
|
|
func SetOMapKeyValue(ctx context.Context, monitors string, cr *Credentials, poolName, namespace, oMapName, oMapKey, keyValue string) error {
|
|
// Command: "rados <options> setomapval oMapName oMapKey keyValue"
|
|
args := []string{
|
|
"-m", monitors,
|
|
"--id", cr.ID,
|
|
"--keyfile=" + cr.KeyFile,
|
|
"-c", CephConfigPath,
|
|
"-p", poolName,
|
|
"setomapval", oMapName, oMapKey, keyValue,
|
|
}
|
|
|
|
if namespace != "" {
|
|
args = append(args, "--namespace="+namespace)
|
|
}
|
|
|
|
_, _, err := ExecCommand("rados", args[:]...)
|
|
if err != nil {
|
|
klog.Errorf(Log(ctx, "failed adding key (%s with value %s), to omap (%s) in "+
|
|
"pool (%s): (%v)"), oMapKey, keyValue, oMapName, poolName, err)
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// GetOMapValue gets the value for the given key from the named omap
|
|
func GetOMapValue(ctx context.Context, monitors string, cr *Credentials, poolName, namespace, oMapName, oMapKey string) (string, error) {
|
|
// Command: "rados <options> getomapval oMapName oMapKey <outfile>"
|
|
// No such key: replicapool/csi.volumes.directory.default/csi.volname
|
|
tmpFile, err := ioutil.TempFile("", "omap-get-")
|
|
if err != nil {
|
|
klog.Errorf(Log(ctx, "failed creating a temporary file for key contents"))
|
|
return "", err
|
|
}
|
|
defer tmpFile.Close()
|
|
defer os.Remove(tmpFile.Name())
|
|
|
|
args := []string{
|
|
"-m", monitors,
|
|
"--id", cr.ID,
|
|
"--keyfile=" + cr.KeyFile,
|
|
"-c", CephConfigPath,
|
|
"-p", poolName,
|
|
"getomapval", oMapName, oMapKey, tmpFile.Name(),
|
|
}
|
|
|
|
if namespace != "" {
|
|
args = append(args, "--namespace="+namespace)
|
|
}
|
|
|
|
stdout, stderr, err := ExecCommand("rados", args[:]...)
|
|
if err != nil {
|
|
// no logs, as attempting to check for non-existent key/value is done even on
|
|
// regular call sequences
|
|
stdoutanderr := strings.Join([]string{string(stdout), string(stderr)}, " ")
|
|
if strings.Contains(stdoutanderr, "No such key: "+poolName+"/"+oMapName+"/"+oMapKey) {
|
|
return "", ErrKeyNotFound{poolName + "/" + oMapName + "/" + oMapKey, err}
|
|
}
|
|
|
|
if strings.Contains(stdoutanderr, "error getting omap value "+
|
|
poolName+"/"+oMapName+"/"+oMapKey+": (2) No such file or directory") {
|
|
return "", ErrKeyNotFound{poolName + "/" + oMapName + "/" + oMapKey, err}
|
|
}
|
|
|
|
if strings.Contains(stdoutanderr, "error opening pool "+
|
|
poolName+": (2) No such file or directory") {
|
|
return "", ErrPoolNotFound{poolName, err}
|
|
}
|
|
|
|
// log other errors for troubleshooting assistance
|
|
klog.Errorf(Log(ctx, "failed getting omap value for key (%s) from omap (%s) in pool (%s): (%v)"),
|
|
oMapKey, oMapName, poolName, err)
|
|
|
|
return "", fmt.Errorf("error (%v) occurred, command output streams is (%s)",
|
|
err.Error(), stdoutanderr)
|
|
}
|
|
|
|
keyValue, err := ioutil.ReadAll(tmpFile)
|
|
return string(keyValue), err
|
|
}
|
|
|
|
// RemoveOMapKey removes the omap key from the given omap name
|
|
func RemoveOMapKey(ctx context.Context, monitors string, cr *Credentials, poolName, namespace, oMapName, oMapKey string) error {
|
|
// Command: "rados <options> rmomapkey oMapName oMapKey"
|
|
args := []string{
|
|
"-m", monitors,
|
|
"--id", cr.ID,
|
|
"--keyfile=" + cr.KeyFile,
|
|
"-c", CephConfigPath,
|
|
"-p", poolName,
|
|
"rmomapkey", oMapName, oMapKey,
|
|
}
|
|
|
|
if namespace != "" {
|
|
args = append(args, "--namespace="+namespace)
|
|
}
|
|
|
|
_, _, err := ExecCommand("rados", args[:]...)
|
|
if err != nil {
|
|
// NOTE: Missing omap key removal does not return an error
|
|
klog.Errorf(Log(ctx, "failed removing key (%s), from omap (%s) in "+
|
|
"pool (%s): (%v)"), oMapKey, oMapName, poolName, err)
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// CreateObject creates the object name passed in and returns ErrObjectExists if the provided object
|
|
// is already present in rados
|
|
func CreateObject(ctx context.Context, monitors string, cr *Credentials, poolName, namespace, objectName string) error {
|
|
// Command: "rados <options> create objectName"
|
|
args := []string{
|
|
"-m", monitors,
|
|
"--id", cr.ID,
|
|
"--keyfile=" + cr.KeyFile,
|
|
"-c", CephConfigPath,
|
|
"-p", poolName,
|
|
"create", objectName,
|
|
}
|
|
|
|
if namespace != "" {
|
|
args = append(args, "--namespace="+namespace)
|
|
}
|
|
|
|
_, stderr, err := ExecCommand("rados", args[:]...)
|
|
if err != nil {
|
|
klog.Errorf(Log(ctx, "failed creating omap (%s) in pool (%s): (%v)"), objectName, poolName, err)
|
|
if strings.Contains(string(stderr), "error creating "+poolName+"/"+objectName+
|
|
": (17) File exists") {
|
|
return ErrObjectExists{objectName, err}
|
|
}
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// RemoveObject removes the entire omap name passed in and returns ErrObjectNotFound is provided omap
|
|
// is not found in rados
|
|
func RemoveObject(ctx context.Context, monitors string, cr *Credentials, poolName, namespace, oMapName string) error {
|
|
// Command: "rados <options> rm oMapName"
|
|
args := []string{
|
|
"-m", monitors,
|
|
"--id", cr.ID,
|
|
"--keyfile=" + cr.KeyFile,
|
|
"-c", CephConfigPath,
|
|
"-p", poolName,
|
|
"rm", oMapName,
|
|
}
|
|
|
|
if namespace != "" {
|
|
args = append(args, "--namespace="+namespace)
|
|
}
|
|
|
|
_, stderr, err := ExecCommand("rados", args[:]...)
|
|
if err != nil {
|
|
klog.Errorf(Log(ctx, "failed removing omap (%s) in pool (%s): (%v)"), oMapName, poolName, err)
|
|
if strings.Contains(string(stderr), "error removing "+poolName+">"+oMapName+
|
|
": (2) No such file or directory") {
|
|
return ErrObjectNotFound{oMapName, err}
|
|
}
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|