The command line tool for OpenLab
Project description
OpenLab management tool
This is the command line tool for OpenLab management.
How to use
You can install from source or just use pip install openlabcmd
.
Before use openlabcmd
, you should create or update the config file
openlab.conf
. Use -c
to specified one. The tool will try to find
the file in paths /etc/openlab/openlab.conf
, ~/openlab.conf
and
/usr/local/etc/openlab/openlab.conf
if it's not provided by user.
Supported features
check
Health check tool for checking OpenLab CI infrastructures.
usage: openlab check [-h] [--type TYPE] [--cloud CLOUD] [--nocolor]
[--recover]
optional arguments:
-h, --help show this help message and exit
--type TYPE Specify a plugin type, like 'nodepool', 'jobs'. Default is
'all'.
--cloud CLOUD Specify a cloud provider, like 'otc', 'vexxhost'. Default is
'all'.
--nocolor Enable the no color mode.
--recover Enable the auto recover mode.
ha
OpenLab HA cluster management commands.
node
CRUD for node
- openlab ha node list
usage: openlab ha node list [-h] [--type {nodepool,zuul,zookeeper}] [--role {master,slave,zookeeper}] optional arguments: -h, --help show this help message and exit --type {nodepool,zuul,zookeeper} Filter the services with the specified node type. --role {master,slave,zookeeper} Filter the services with the specified node role.
- openlab ha node get
usage: openlab ha node get [-h] name positional arguments: name The node hostname.
- openlab ha node init
usage: openlab ha node init [-h] --type {nodepool,zuul,zookeeper} --role {master,slave} --ip IP name positional arguments: name The new node hostname, it should be global unique. Format: {cloud-provider}-openlab-{type} optional arguments: -h, --help show this help message and exit --type {nodepool,zuul,zookeeper} The new node type. Choose from 'nodepool', 'zuul' and 'zookeeper' --role {master,slave} The new node role. It should be either 'master' or 'slave'. --ip IP The new node's public IP.
- openlab ha node set
usage: openlab ha node set [-h] [--maintain {yes, no}] [--role {master,slave}] name positional arguments: name The node hostname. optional arguments: -h, --help show this help message and exit --maintain MAINTAIN Set the node to maintained status. --role {master,slave} Update node role. It should be either 'master' or 'slave'. Be careful to update the role, you should not update role except emergency situations, because it will impact checking scope of HA monitor , HA monitor will check and update it with built-in policy automatically.
- openlab ha node delete
usage: openlab ha node delete [-h] name positional arguments: name The node hostname.
service
Get or list the service running in cluster.
- openlab ha service list
usage: openlab ha service list [-h] [--node NODE] [--role {master,slave,zookeeper}] [--status {up,down,restarting}] optional arguments: -h, --help show this help message and exit --node NODE Filter the services with the specified node name. --role {master,slave,zookeeper} Filter the services with the specified node role. --status {up,down,restarting} Filter the services with the specified status.
- openlab ha service get
usage: openlab ha service get [-h] --node NODE name positional arguments: name service name. optional arguments: -h, --help show this help message and exit --node NODE The node where the service run.
cluster
Manage the HA cluster action or check existing HA cluster deployment.
-
openlab ha cluster switch
usage: openlab ha cluster switch [-h] optional arguments: -h, --help show this help message and exit
-
openlab ha cluster repair ''' usage: openlab ha cluster repair [-h] --security-group [--dry-run]
optional arguments: -h, --help show this help message and exit --security-group Repair the Security Group of HA deployment. --dry-run Only report the check list of HA deployment, not try to fix if there is a check error.
'''
config
Mange the HA cluster configuration
- openlab ha config list
usage: openlab ha config list [-h] optional arguments: -h, --help show this help message and exit
- openlab ha config set
usage: openlab ha config set [-h] name value positional arguments: name The name of config option. value The value of config option. optional arguments: -h, --help show this help message and exit
repo
The management tool for the repos which enable the OpenLab.
usage: openlab repo list [-h] [--server SERVER] [--app-id APP_ID]
[--app-key APP_KEY]
optional arguments:
-h, --help show this help message and exit
--server SERVER Specify base server url. Default is github.com
--app-id APP_ID Specify the github APP ID, Default is 6778 (allinone:
7102, OpenLab: 6778).
--app-key APP_KEY Specify the app key file path. Default is
/var/lib/zuul/openlab-app-key.pem
hint
The help tool to print hints info.
usage: openlab hint [-h] [--type TYPE]
optional arguments:
-h, --help show this help message and exit
--type TYPE Specify a hint type, like 'resource', 'redundant'.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.