505 lines
15 KiB
JavaScript
505 lines
15 KiB
JavaScript
const _ = require("lodash");
|
|
const { ControllerZfsBaseDriver } = require("../controller-zfs");
|
|
const { GrpcError, grpc } = require("../../utils/grpc");
|
|
const registry = require("../../utils/registry");
|
|
const SshClient = require("../../utils/ssh").SshClient;
|
|
const sleep = require("../../utils/general").sleep;
|
|
const { Zetabyte, ZfsSshProcessManager } = require("../../utils/zfs");
|
|
|
|
const Handlebars = require("handlebars");
|
|
|
|
const ISCSI_ASSETS_NAME_PROPERTY_NAME = "democratic-csi:iscsi_assets_name";
|
|
const __REGISTRY_NS__ = "ControllerZfsGenericDriver";
|
|
class ControllerZfsGenericDriver extends ControllerZfsBaseDriver {
|
|
getExecClient() {
|
|
return registry.get(`${__REGISTRY_NS__}:exec_client`, () => {
|
|
return new SshClient({
|
|
logger: this.ctx.logger,
|
|
connection: this.options.sshConnection,
|
|
});
|
|
});
|
|
}
|
|
|
|
async getZetabyte() {
|
|
return registry.getAsync(`${__REGISTRY_NS__}:zb`, async () => {
|
|
const execClient = this.getExecClient();
|
|
const options = {};
|
|
options.executor = new ZfsSshProcessManager(execClient);
|
|
options.idempotent = true;
|
|
|
|
if (
|
|
this.options.zfs.hasOwnProperty("cli") &&
|
|
this.options.zfs.cli &&
|
|
this.options.zfs.cli.hasOwnProperty("paths")
|
|
) {
|
|
options.paths = this.options.zfs.cli.paths;
|
|
}
|
|
|
|
options.sudo = _.get(this.options, "zfs.cli.sudoEnabled", false);
|
|
|
|
if (typeof this.setZetabyteCustomOptions === "function") {
|
|
await this.setZetabyteCustomOptions(options);
|
|
}
|
|
|
|
return new Zetabyte(options);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* cannot make this a storage class parameter as storage class/etc context is *not* sent
|
|
* into various calls such as GetControllerCapabilities etc
|
|
*/
|
|
getDriverZfsResourceType() {
|
|
switch (this.options.driver) {
|
|
case "zfs-generic-nfs":
|
|
case "zfs-generic-smb":
|
|
return "filesystem";
|
|
case "zfs-generic-iscsi":
|
|
return "volume";
|
|
default:
|
|
throw new Error("unknown driver: " + this.ctx.args.driver);
|
|
}
|
|
}
|
|
|
|
generateSmbShareName(datasetName) {
|
|
const driver = this;
|
|
|
|
driver.ctx.logger.verbose(
|
|
`generating smb share name for dataset: ${typeof datasetName} ${datasetName}`
|
|
);
|
|
|
|
let name = datasetName || "";
|
|
console.log(name);
|
|
name = name.replaceAll("/", "_");
|
|
name = name.replaceAll("-", "_");
|
|
|
|
driver.ctx.logger.verbose(
|
|
`generated smb share name for dataset: ${datasetName} - ${name}`
|
|
);
|
|
|
|
return name;
|
|
}
|
|
|
|
/**
|
|
* should create any necessary share resources
|
|
* should set the SHARE_VOLUME_CONTEXT_PROPERTY_NAME propery
|
|
*
|
|
* @param {*} datasetName
|
|
*/
|
|
async createShare(call, datasetName) {
|
|
const driver = this;
|
|
const zb = await this.getZetabyte();
|
|
const execClient = this.getExecClient();
|
|
|
|
let properties;
|
|
let response;
|
|
let share = {};
|
|
let volume_context = {};
|
|
|
|
switch (this.options.driver) {
|
|
case "zfs-generic-nfs":
|
|
switch (this.options.nfs.shareStrategy) {
|
|
case "setDatasetProperties":
|
|
for (let key of ["share", "sharenfs"]) {
|
|
if (
|
|
this.options.nfs.shareStrategySetDatasetProperties.properties[
|
|
key
|
|
]
|
|
) {
|
|
await zb.zfs.set(datasetName, {
|
|
[key]:
|
|
this.options.nfs.shareStrategySetDatasetProperties
|
|
.properties[key],
|
|
});
|
|
}
|
|
}
|
|
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
properties = await zb.zfs.get(datasetName, ["mountpoint"]);
|
|
properties = properties[datasetName];
|
|
this.ctx.logger.debug("zfs props data: %j", properties);
|
|
|
|
volume_context = {
|
|
node_attach_driver: "nfs",
|
|
server: this.options.nfs.shareHost,
|
|
share: properties.mountpoint.value,
|
|
};
|
|
return volume_context;
|
|
|
|
case "zfs-generic-smb":
|
|
let share;
|
|
switch (this.options.smb.shareStrategy) {
|
|
case "setDatasetProperties":
|
|
for (let key of ["share", "sharesmb"]) {
|
|
if (
|
|
this.options.smb.shareStrategySetDatasetProperties.properties[
|
|
key
|
|
]
|
|
) {
|
|
await zb.zfs.set(datasetName, {
|
|
[key]:
|
|
this.options.smb.shareStrategySetDatasetProperties
|
|
.properties[key],
|
|
});
|
|
}
|
|
}
|
|
|
|
share = driver.generateSmbShareName(datasetName);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
properties = await zb.zfs.get(datasetName, ["mountpoint"]);
|
|
properties = properties[datasetName];
|
|
this.ctx.logger.debug("zfs props data: %j", properties);
|
|
|
|
volume_context = {
|
|
node_attach_driver: "smb",
|
|
server: this.options.smb.shareHost,
|
|
share,
|
|
};
|
|
return volume_context;
|
|
|
|
case "zfs-generic-iscsi":
|
|
let basename;
|
|
let iscsiName;
|
|
|
|
if (this.options.iscsi.nameTemplate) {
|
|
iscsiName = Handlebars.compile(this.options.iscsi.nameTemplate)({
|
|
name: call.request.name,
|
|
parameters: call.request.parameters,
|
|
});
|
|
} else {
|
|
iscsiName = zb.helpers.extractLeafName(datasetName);
|
|
}
|
|
|
|
if (this.options.iscsi.namePrefix) {
|
|
iscsiName = this.options.iscsi.namePrefix + iscsiName;
|
|
}
|
|
|
|
if (this.options.iscsi.nameSuffix) {
|
|
iscsiName += this.options.iscsi.nameSuffix;
|
|
}
|
|
|
|
iscsiName = iscsiName.toLowerCase();
|
|
|
|
let extentDiskName = "zvol/" + datasetName;
|
|
|
|
/**
|
|
* limit is a FreeBSD limitation
|
|
* https://www.ixsystems.com/documentation/freenas/11.2-U5/storage.html#zfs-zvol-config-opts-tab
|
|
*/
|
|
//if (extentDiskName.length > 63) {
|
|
// throw new GrpcError(
|
|
// grpc.status.FAILED_PRECONDITION,
|
|
// `extent disk name cannot exceed 63 characters: ${extentDiskName}`
|
|
// );
|
|
//}
|
|
|
|
switch (this.options.iscsi.shareStrategy) {
|
|
case "targetCli":
|
|
basename = this.options.iscsi.shareStrategyTargetCli.basename;
|
|
let setAttributesText = "";
|
|
let setAuthText = "";
|
|
if (this.options.iscsi.shareStrategyTargetCli.tpg) {
|
|
if (this.options.iscsi.shareStrategyTargetCli.tpg.attributes) {
|
|
for (const attributeName in this.options.iscsi
|
|
.shareStrategyTargetCli.tpg.attributes) {
|
|
const attributeValue =
|
|
this.options.iscsi.shareStrategyTargetCli.tpg.attributes[
|
|
attributeName
|
|
];
|
|
setAttributesText += "\n";
|
|
setAttributesText += `set attribute ${attributeName}=${attributeValue}`;
|
|
}
|
|
}
|
|
|
|
if (this.options.iscsi.shareStrategyTargetCli.tpg.auth) {
|
|
for (const attributeName in this.options.iscsi
|
|
.shareStrategyTargetCli.tpg.auth) {
|
|
const attributeValue =
|
|
this.options.iscsi.shareStrategyTargetCli.tpg.auth[
|
|
attributeName
|
|
];
|
|
setAttributesText += "\n";
|
|
setAttributesText += `set auth ${attributeName}=${attributeValue}`;
|
|
}
|
|
}
|
|
}
|
|
|
|
response = await this.targetCliCommand(
|
|
`
|
|
# create target
|
|
cd /iscsi
|
|
create ${basename}:${iscsiName}
|
|
|
|
# setup tpg
|
|
cd /iscsi/${basename}:${iscsiName}/tpg1
|
|
${setAttributesText}
|
|
${setAuthText}
|
|
|
|
# create extent
|
|
cd /backstores/block
|
|
create ${iscsiName} /dev/${extentDiskName}
|
|
|
|
# add extent to target/tpg
|
|
cd /iscsi/${basename}:${iscsiName}/tpg1/luns
|
|
create /backstores/block/${iscsiName}
|
|
`
|
|
);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
// iqn = target
|
|
let iqn = basename + ":" + iscsiName;
|
|
this.ctx.logger.info("iqn: " + iqn);
|
|
|
|
// store this off to make delete process more bullet proof
|
|
await zb.zfs.set(datasetName, {
|
|
[ISCSI_ASSETS_NAME_PROPERTY_NAME]: iscsiName,
|
|
});
|
|
|
|
volume_context = {
|
|
node_attach_driver: "iscsi",
|
|
portal: this.options.iscsi.targetPortal || "",
|
|
portals: this.options.iscsi.targetPortals
|
|
? this.options.iscsi.targetPortals.join(",")
|
|
: "",
|
|
interface: this.options.iscsi.interface || "",
|
|
iqn: iqn,
|
|
lun: 0,
|
|
};
|
|
return volume_context;
|
|
|
|
default:
|
|
throw new GrpcError(
|
|
grpc.status.FAILED_PRECONDITION,
|
|
`invalid configuration: unknown driver ${this.options.driver}`
|
|
);
|
|
}
|
|
}
|
|
|
|
async deleteShare(call, datasetName) {
|
|
const zb = await this.getZetabyte();
|
|
const execClient = this.getExecClient();
|
|
|
|
let response;
|
|
let properties;
|
|
|
|
switch (this.options.driver) {
|
|
case "zfs-generic-nfs":
|
|
switch (this.options.nfs.shareStrategy) {
|
|
case "setDatasetProperties":
|
|
for (let key of ["share", "sharenfs"]) {
|
|
if (
|
|
this.options.nfs.shareStrategySetDatasetProperties.properties[
|
|
key
|
|
]
|
|
) {
|
|
try {
|
|
await zb.zfs.inherit(datasetName, key);
|
|
} catch (err) {
|
|
if (err.toString().includes("dataset does not exist")) {
|
|
// do nothing
|
|
} else {
|
|
throw err;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
await sleep(2000); // let things settle
|
|
break;
|
|
default:
|
|
throw new GrpcError(
|
|
grpc.status.FAILED_PRECONDITION,
|
|
`invalid configuration: unknown shareStrategy ${this.options.nfs.shareStrategy}`
|
|
);
|
|
}
|
|
break;
|
|
|
|
case "zfs-generic-smb":
|
|
switch (this.options.smb.shareStrategy) {
|
|
case "setDatasetProperties":
|
|
for (let key of ["share", "sharesmb"]) {
|
|
if (
|
|
this.options.smb.shareStrategySetDatasetProperties.properties[
|
|
key
|
|
]
|
|
) {
|
|
try {
|
|
await zb.zfs.inherit(datasetName, key);
|
|
} catch (err) {
|
|
if (err.toString().includes("dataset does not exist")) {
|
|
// do nothing
|
|
} else {
|
|
throw err;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
await sleep(2000); // let things settle
|
|
break;
|
|
default:
|
|
throw new GrpcError(
|
|
grpc.status.FAILED_PRECONDITION,
|
|
`invalid configuration: unknown shareStrategy ${this.options.smb.shareStrategy}`
|
|
);
|
|
}
|
|
break;
|
|
|
|
case "zfs-generic-iscsi":
|
|
let basename;
|
|
let iscsiName;
|
|
|
|
// Delete iscsi assets
|
|
try {
|
|
properties = await zb.zfs.get(datasetName, [
|
|
ISCSI_ASSETS_NAME_PROPERTY_NAME,
|
|
]);
|
|
} catch (err) {
|
|
if (err.toString().includes("dataset does not exist")) {
|
|
return;
|
|
}
|
|
throw err;
|
|
}
|
|
|
|
properties = properties[datasetName];
|
|
this.ctx.logger.debug("zfs props data: %j", properties);
|
|
|
|
iscsiName = properties[ISCSI_ASSETS_NAME_PROPERTY_NAME].value;
|
|
|
|
if (zb.helpers.isPropertyValueSet(iscsiName)) {
|
|
//do nothing
|
|
} else {
|
|
iscsiName = zb.helpers.extractLeafName(datasetName);
|
|
|
|
if (this.options.iscsi.namePrefix) {
|
|
iscsiName = this.options.iscsi.namePrefix + iscsiName;
|
|
}
|
|
|
|
if (this.options.iscsi.nameSuffix) {
|
|
iscsiName += this.options.iscsi.nameSuffix;
|
|
}
|
|
}
|
|
|
|
iscsiName = iscsiName.toLowerCase();
|
|
switch (this.options.iscsi.shareStrategy) {
|
|
case "targetCli":
|
|
basename = this.options.iscsi.shareStrategyTargetCli.basename;
|
|
response = await this.targetCliCommand(
|
|
`
|
|
# delete target
|
|
cd /iscsi
|
|
delete ${basename}:${iscsiName}
|
|
|
|
# delete extent
|
|
cd /backstores/block
|
|
delete ${iscsiName}
|
|
`
|
|
);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
break;
|
|
|
|
default:
|
|
throw new GrpcError(
|
|
grpc.status.FAILED_PRECONDITION,
|
|
`invalid configuration: unknown driver ${this.options.driver}`
|
|
);
|
|
}
|
|
|
|
return {};
|
|
}
|
|
|
|
async expandVolume(call, datasetName) {
|
|
switch (this.options.driver) {
|
|
case "zfs-generic-nfs":
|
|
break;
|
|
|
|
case "zfs-generic-iscsi":
|
|
switch (this.options.iscsi.shareStrategy) {
|
|
case "targetCli":
|
|
// nothing required, just need to rescan on the node
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
async targetCliCommand(data) {
|
|
const execClient = this.getExecClient();
|
|
const driver = this;
|
|
|
|
data = data.trim();
|
|
|
|
let command = "sh";
|
|
let args = ["-c"];
|
|
let taregetCliCommand = [];
|
|
taregetCliCommand.push(`echo "${data}"`.trim());
|
|
taregetCliCommand.push("|");
|
|
taregetCliCommand.push("targetcli");
|
|
|
|
if (
|
|
_.get(this.options, "iscsi.shareStrategyTargetCli.sudoEnabled", false)
|
|
) {
|
|
command = "sudo";
|
|
args.unshift("sh");
|
|
}
|
|
|
|
args.push("'" + taregetCliCommand.join(" ") + "'");
|
|
|
|
let logCommandTmp = command + " " + args.join(" ");
|
|
let logCommand = "";
|
|
|
|
logCommandTmp.split("\n").forEach((line) => {
|
|
if (line.startsWith("set auth password=")) {
|
|
logCommand += "set auth password=<redacted>";
|
|
} else if (line.startsWith("set auth mutual_password=")) {
|
|
logCommand += "set auth mutual_password=<redacted>";
|
|
} else {
|
|
logCommand += line;
|
|
}
|
|
|
|
logCommand += "\n";
|
|
});
|
|
|
|
driver.ctx.logger.verbose("TargetCLI command: " + logCommand);
|
|
|
|
// https://github.com/democratic-csi/democratic-csi/issues/127
|
|
// https://bugs.launchpad.net/ubuntu/+source/python-configshell-fb/+bug/1776761
|
|
// can apply the linked patch with some modifications to overcome the
|
|
// KeyErrors or we can simply start a fake tty which does not seem to have
|
|
// a detrimental effect, only affects Ubuntu 18.04 and older
|
|
let options = {
|
|
pty: true,
|
|
};
|
|
let response = await execClient.exec(
|
|
execClient.buildCommand(command, args),
|
|
options
|
|
);
|
|
if (response.code != 0) {
|
|
throw new Error(JSON.stringify(response));
|
|
}
|
|
driver.ctx.logger.verbose(
|
|
"TargetCLI response: " + JSON.stringify(response)
|
|
);
|
|
return response;
|
|
}
|
|
}
|
|
|
|
module.exports.ControllerZfsGenericDriver = ControllerZfsGenericDriver;
|