commands Package¶
config
Module¶
exceptions
Module¶
Exception definitions.
-
exception
kolla_cli.commands.exceptions.
CommandError
(message, *args)¶ Bases:
Exception
CLI command error
group
Module¶
-
class
kolla_cli.commands.group.
GroupAdd
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Add group to openstack-kolla.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.group.
GroupAddhost
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Add host to group.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.group.
GroupList
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
Only list all groups
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.group.
GroupListhosts
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List all groups and their hosts.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.group.
GroupListservices
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List all groups and their services.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.group.
GroupRemove
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Remove group from openstack-kolla.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.group.
GroupRemovehost
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Remove host group from group.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
host
Module¶
-
class
kolla_cli.commands.host.
HostAdd
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Add host to openstack-kolla.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.host.
HostCheck
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Check an ssh check of host(s).
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.host.
HostDestroy
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Destroy all kolla containers on host(s).
Stops and removes all kolla related docker containers on either the specified host or all hosts if the hostname all is used.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.host.
HostList
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List hosts and their groups.
If a hostname is provided, only list information about that host.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.host.
HostRemove
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Remove host from openstack-kolla.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
kolla_action
Module¶
-
class
kolla_cli.commands.kolla_action.
CertificateInit
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Generates self-signed certificate
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Check
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Do post-deployment smoke tests.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Deploy
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Deploy and start all kolla containers.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Genconfig
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Generate configuration files for enabled OpenStack services.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
PostDeploy
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Do post deploy on deploy node.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Prechecks
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Do pre-deployment checks for hosts.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Pull
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Pull all images for containers (only pulls, no running container).
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Reconfigure
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Reconfigure OpenStack service.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Stop
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Stop all kolla containers on host(s).
Stops all kolla related docker containers on either the specified host or all hosts if the hostname all is used.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.kolla_action.
Upgrade
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Upgrades existing OpenStack Environment.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
mode
Module¶
-
class
kolla_cli.commands.mode.
Getdeploy
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
get deploy mode from either local or remote.
Local indicates that the openstack deployment will be to the local host. Remote means that the deployment is on remote hosts.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.mode.
Setdeploy
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Set deploy mode to either local or remote.
Local indicates that the openstack deployment will be to the local host. Remote means that the deployment is on remote hosts.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
password
Module¶
-
class
kolla_cli.commands.password.
PasswordClear
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Password Clear
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.password.
PasswordInit
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Init all empty passwords and ssh keys.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.password.
PasswordList
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List all password names.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
property
Module¶
-
class
kolla_cli.commands.property.
PropertyClear
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Property Clear
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.property.
PropertyList
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List all properties.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
service
Module¶
-
class
kolla_cli.commands.service.
ServiceAddGroup
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Add group to service.
Associated the service to a group. If this is a sub-service, the inherit flag will be cleared.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
-
class
kolla_cli.commands.service.
ServiceList
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List services and their sub-services.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.service.
ServiceListGroups
(app, app_args, cmd_name=None)¶ Bases:
cliff.lister.Lister
List services and their groups.
-
take_action
(parsed_args)¶ Return a tuple containing the column names and an iterable containing the data to be listed.
-
-
class
kolla_cli.commands.service.
ServiceRemoveGroup
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Remove group from service.
-
get_parser
(prog_name)¶ Return an
argparse.ArgumentParser
.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-
support
Module¶
-
class
kolla_cli.commands.support.
Dump
(app, app_args, cmd_name=None)¶ Bases:
cliff.command.Command
Dumps configuration data for debugging.
Dumps most files in /etc/kolla and /usr/share/kolla into a tar file so be given to support / development to help with debugging problems.
-
take_action
(parsed_args)¶ Override to do something useful.
The returned value will be returned by the program.
-