@adp-psych/container-tools/lib/create-kubernetes-cluster.js

Tools for using containers for psychology experiments

/*
 * Copyright (C) 2021  Anthony Di Pietro
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * @file Creates a [Kubernetes](https://kubernetes.io/) cluster
 * using [doctl](https://docs.digitalocean.com/reference/doctl/).
 *
 * @module module:create-kubernetes-cluster
 * @requires console-exec
 * @author Anthony Di Pietro <anthony.dipietro@research.uwa.edu.au>
 * @copyright © 2021 Anthony Di Pietro
 * @license AGPL-3.0-or-later
 */

const {consoleSpawn} = require('./console-exec.js');

/**
 * Creates a Kubernetes cluster using doctl.
 *
 * @static
 * @param {String} clusterName - The clusterName of the cluster.
 * @example
 * createKubernetesCluster('kubernetes'); // Creates the kubernetes cluster.
 */
const createKubernetesCluster = async (clusterName) => {
	await consoleSpawn('doctl', [
		'kubernetes',
		'cluster',
		'create',
		clusterName,
	]);
};

module.exports = createKubernetesCluster;