python-magnumclient/magnumclient/osc/v1/clusters.py

549 lines
19 KiB
Python

# Copyright 2016 EasyStack. All rights reserved.
#
# 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.
import os
from magnumclient.common import utils as magnum_utils
from magnumclient import exceptions
from magnumclient.i18n import _
from osc_lib.command import command
from osc_lib import utils
CLUSTER_ATTRIBUTES = [
'status',
'health_status',
'cluster_template_id',
'node_addresses',
'uuid',
'stack_id',
'status_reason',
'created_at',
'updated_at',
'coe_version',
'labels',
'labels_overridden',
'labels_skipped',
'labels_added',
'fixed_network',
'fixed_subnet',
'floating_ip_enabled',
'faults',
'keypair',
'api_address',
'master_addresses',
'master_lb_enabled',
'create_timeout',
'node_count',
'discovery_url',
'docker_volume_size',
'master_count',
'container_version',
'name',
'master_flavor_id',
'flavor_id',
'health_status_reason',
'project_id',
]
class CreateCluster(command.Command):
_description = _("Create a cluster")
def get_parser(self, prog_name):
parser = super(CreateCluster, self).get_parser(prog_name)
# NOTE: All arguments are positional and, if not provided
# with a default, required.
parser.add_argument('--cluster-template',
dest='cluster_template',
required=True,
metavar='<cluster-template>',
help='ID or name of the cluster template.')
parser.add_argument('--discovery-url',
dest='discovery_url',
metavar='<discovery-url>',
help=('Specifies custom delivery url for '
'node discovery.'))
parser.add_argument('--docker-volume-size',
dest='docker_volume_size',
type=int,
metavar='<docker-volume-size>',
help=('The size in GB for the docker volume to '
'use.'))
parser.add_argument('--labels',
metavar='<KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>',
action='append',
help=_('Arbitrary labels in the form of key=value '
'pairs to associate with a cluster '
'template. May be used multiple times.'))
parser.add_argument('--keypair',
default=None,
metavar='<keypair>',
help='UUID or name of the keypair to use.')
parser.add_argument('--master-count',
dest='master_count',
type=int,
default=1,
metavar='<master-count>',
help='The number of master nodes for the cluster.')
parser.add_argument('name',
metavar='<name>',
help='Name of the cluster to create.')
parser.add_argument('--node-count',
dest='node_count',
type=int,
default=1,
metavar='<node-count>',
help='The cluster node count.')
parser.add_argument('--timeout',
type=int,
default=60,
metavar='<timeout>',
help=('The timeout for cluster creation time. The '
'default is 60 minutes.'))
parser.add_argument(
'--master-flavor',
dest='master_flavor',
metavar='<master-flavor>',
help=_('The nova flavor name or UUID to use when launching the '
'master node of the Cluster.'))
parser.add_argument(
'--flavor',
metavar='<flavor>',
help=_('The nova flavor name or UUID to use when launching the '
'Cluster.'))
parser.add_argument(
'--fixed-network',
dest='fixed_network',
metavar='<fixed-network>',
help=_('The private Neutron network name to connect to this '
'Cluster template.'))
parser.add_argument(
'--fixed-subnet',
dest='fixed_subnet',
metavar='<fixed-subnet>',
help=_('The private Neutron subnet name to connect to Cluster.'))
parser.add_argument(
'--floating-ip-enabled',
dest='floating_ip_enabled',
default=[],
action='append_const',
const=True,
help=_('Indicates whether created Clusters should have a '
'floating ip.'))
parser.add_argument(
'--floating-ip-disabled',
dest='floating_ip_enabled',
action='append_const',
const=False,
help=_('Disables floating ip creation on the new Cluster'))
parser.add_argument(
'--merge-labels',
dest='merge_labels',
action='store_true',
default=False,
help=_('The labels provided will be merged with the labels '
'configured in the specified cluster template.'))
parser.add_argument(
'--master-lb-enabled',
dest='master_lb_enabled',
action='append_const',
default=[],
const=True,
help=_('Enable master LB creation on the new cluster'))
parser.add_argument(
'--master-lb-disabled',
dest='master_lb_enabled',
action='append_const',
const=False,
help=_('Disable master LB creation on the new cluster'))
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
args = {
'cluster_template_id': parsed_args.cluster_template,
'create_timeout': parsed_args.timeout,
'discovery_url': parsed_args.discovery_url,
'keypair': parsed_args.keypair,
'master_count': parsed_args.master_count,
'name': parsed_args.name,
'node_count': parsed_args.node_count,
}
if len(parsed_args.floating_ip_enabled) > 1:
raise exceptions.InvalidAttribute(
'--floating-ip-enabled and '
'--floating-ip-disabled are '
'mutually exclusive and '
'should be specified only once.')
elif len(parsed_args.floating_ip_enabled) == 1:
args['floating_ip_enabled'] = parsed_args.floating_ip_enabled[0]
if parsed_args.labels is not None:
args['labels'] = magnum_utils.handle_labels(parsed_args.labels)
if parsed_args.docker_volume_size is not None:
args['docker_volume_size'] = parsed_args.docker_volume_size
if parsed_args.master_flavor is not None:
args['master_flavor_id'] = parsed_args.master_flavor
if parsed_args.flavor is not None:
args['flavor_id'] = parsed_args.flavor
if parsed_args.fixed_network is not None:
args["fixed_network"] = parsed_args.fixed_network
if parsed_args.fixed_subnet is not None:
args["fixed_subnet"] = parsed_args.fixed_subnet
if parsed_args.merge_labels:
# We are only sending this if it's True. This
# way we avoid breaking older APIs.
args["merge_labels"] = parsed_args.merge_labels
if parsed_args.master_lb_enabled:
args["master_lb_enabled"] = parsed_args.master_lb_enabled
if len(parsed_args.master_lb_enabled) > 1:
raise exceptions.InvalidAttribute(
'--master-lb-enabled and '
'--master-lb-disabled are '
'mutually exclusive and '
'should be specified only once.')
elif len(parsed_args.master_lb_enabled) == 1:
args['master_lb_enabled'] = parsed_args.master_lb_enabled[0]
if (not args['master_lb_enabled'] and
parsed_args.master_count > 1):
raise exceptions.InvalidAttribute(
'Master node count can only be one if master '
'loadbalancer is disabled.')
cluster = mag_client.clusters.create(**args)
print("Request to create cluster %s accepted"
% cluster.uuid)
class DeleteCluster(command.Command):
_description = _("Delete a cluster")
def get_parser(self, prog_name):
parser = super(DeleteCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
nargs='+',
metavar='<cluster>',
help='ID or name of the cluster(s) to delete.')
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
for cluster in parsed_args.cluster:
mag_client.clusters.delete(cluster)
print("Request to delete cluster %s has been accepted." % cluster)
class ListCluster(command.Lister):
_description = _("List clusters")
def get_parser(self, prog_name):
parser = super(ListCluster, self).get_parser(prog_name)
parser.add_argument(
'--limit',
metavar='<limit>',
type=int,
help=_('Maximum number of clusters to return'))
parser.add_argument(
'--sort-key',
metavar='<sort-key>',
help=_('Column to sort results by'))
parser.add_argument(
'--sort-dir',
metavar='<sort-dir>',
choices=['desc', 'asc'],
help=_('Direction to sort. "asc" or "desc".'))
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
columns = [
'uuid', 'name', 'keypair', 'node_count', 'master_count', 'status',
'health_status']
clusters = mag_client.clusters.list(limit=parsed_args.limit,
sort_key=parsed_args.sort_key,
sort_dir=parsed_args.sort_dir)
return (
columns,
(utils.get_item_properties(c, columns) for c in clusters)
)
class ShowCluster(command.ShowOne):
_description = _("Show a Cluster")
def get_parser(self, prog_name):
parser = super(ShowCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
metavar='<cluster>',
help=_('ID or name of the cluster to show.')
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
columns = CLUSTER_ATTRIBUTES
mag_client = self.app.client_manager.container_infra
cluster = mag_client.clusters.get(parsed_args.cluster)
return (columns, utils.get_item_properties(cluster, columns))
class UpdateCluster(command.Command):
_description = _("Update a Cluster")
def get_parser(self, prog_name):
parser = super(UpdateCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
metavar='<cluster>',
help=_('The name or UUID of cluster to update'))
parser.add_argument(
'op',
metavar='<op>',
choices=['add', 'replace', 'remove'],
help=_("Operations: one of 'add', 'replace' or 'remove'"))
parser.add_argument(
'attributes',
metavar='<path=value>',
nargs='+',
action='append',
default=[],
help=_(
"Attributes to add/replace or remove (only PATH is necessary "
"on remove)"))
parser.add_argument(
'--rollback',
action='store_true',
dest='rollback',
default=False,
help=_('Rollback cluster on update failure.'))
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
patch = magnum_utils.args_array_to_patch(parsed_args.op,
parsed_args.attributes[0])
mag_client.clusters.update(parsed_args.cluster,
patch)
print("Request to update cluster %s has been accepted." %
parsed_args.cluster)
class ConfigCluster(command.Command):
_description = _("Get Configuration for a Cluster")
def get_parser(self, prog_name):
parser = super(ConfigCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
metavar='<cluster>',
help=_('The name or UUID of cluster to update'))
parser.add_argument(
'--dir',
metavar='<dir>',
default='.',
help=_('Directory to save the certificate and config files.'))
parser.add_argument(
'--force',
action='store_true',
dest='force',
default=False,
help=_('Overwrite files if existing.'))
parser.add_argument(
'--output-certs',
action='store_true',
dest='output_certs',
default=False,
help=_('Output certificates in separate files.'))
parser.add_argument(
'--use-certificate',
action='store_true',
dest='use_certificate',
default=True,
help=_('Use certificate in config files.'))
parser.add_argument(
'--use-keystone',
action='store_true',
dest='use_keystone',
default=False,
help=_('Use Keystone token in config files.'))
return parser
def take_action(self, parsed_args):
"""Configure native client to access cluster.
You can source the output of this command to get the native client of
the corresponding COE configured to access the cluster.
"""
if parsed_args.use_keystone:
parsed_args.use_certificate = False
if not parsed_args.use_certificate:
parsed_args.use_keystone = True
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
parsed_args.dir = os.path.abspath(parsed_args.dir)
cluster = mag_client.clusters.get(parsed_args.cluster)
if cluster.api_address is None:
self.log.warning("WARNING: The cluster's api_address is"
" not known yet.")
cluster_template = mag_client.cluster_templates.get(
cluster.cluster_template_id)
opts = {
'cluster_uuid': cluster.uuid,
}
tls = None
if not cluster_template.tls_disabled:
tls = magnum_utils.generate_csr_and_key()
tls['ca'] = mag_client.certificates.get(**opts).pem
opts['csr'] = tls['csr']
tls['cert'] = mag_client.certificates.create(**opts).pem
if parsed_args.output_certs:
for k in ('key', 'cert', 'ca'):
fname = "%s/%s.pem" % (parsed_args.dir, k)
if os.path.exists(fname) and not parsed_args.force:
raise Exception("File %s exists, aborting." % fname)
else:
with open(fname, "w") as f:
f.write(tls[k])
print(magnum_utils.config_cluster(
cluster, cluster_template, parsed_args.dir,
force=parsed_args.force, certs=tls,
use_keystone=parsed_args.use_keystone))
class ResizeCluster(command.Command):
_description = _("Resize a Cluster")
def get_parser(self, prog_name):
parser = super(ResizeCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
metavar='<cluster>',
help=_('The name or UUID of cluster to update'))
parser.add_argument(
'node_count',
type=int,
help=_("Desired node count of the cluser."))
parser.add_argument(
'--nodes-to-remove',
metavar='<Server UUID>',
action='append',
help=_('Server ID of the nodes to be removed. Repeat to add '
'more server ID'))
parser.add_argument(
'--nodegroup',
metavar='<nodegroup>',
help=_('The name or UUID of the nodegroup of current cluster.'))
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
cluster = mag_client.clusters.get(parsed_args.cluster)
mag_client.clusters.resize(cluster.uuid,
parsed_args.node_count,
parsed_args.nodes_to_remove,
parsed_args.nodegroup)
print("Request to resize cluster %s has been accepted." %
parsed_args.cluster)
class UpgradeCluster(command.Command):
_description = _("Upgrade a Cluster")
def get_parser(self, prog_name):
parser = super(UpgradeCluster, self).get_parser(prog_name)
parser.add_argument(
'cluster',
metavar='<cluster>',
help=_('The name or UUID of cluster to update'))
parser.add_argument(
'cluster_template',
help=_("The new cluster template ID will be upgraded to."))
parser.add_argument(
'--max-batch-size',
metavar='<max_batch_size>',
type=int,
default=1,
help=_("The max batch size for upgrading each time."))
parser.add_argument(
'--nodegroup',
metavar='<nodegroup>',
help=_('The name or UUID of the nodegroup of current cluster.'))
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
mag_client = self.app.client_manager.container_infra
cluster = mag_client.clusters.get(parsed_args.cluster)
mag_client.clusters.upgrade(cluster.uuid,
parsed_args.cluster_template,
parsed_args.max_batch_size,
parsed_args.nodegroup)
print("Request to upgrade cluster %s has been accepted." %
parsed_args.cluster)