Kwstandby documentation¶
Kwstandby provides a REST API to shutdown and wake up the hosts using their IPMI cards. This documentation offers information on how Kwstandby works.
Installing¶
Installing Kwstandby¶
Clone the Kwstandby git repository to the management server:
$ git clone https://github.com/frossigneux/kwstandby
As a user with root permissions or sudo privileges, run the Kwstandby installer and copy the configuration files:
$ pip install kwstandby $ cp -r kwstandby/etc/kwstandby /etc/
Running Kwstandby service¶
Start the Kwstandby API:
$ kwstandby-api
Configuration Options¶
The following table lists the Kwstandby options in the configuration file. Please note that Kwstandby uses openstack-common extensively, which requires that the other parameters are set appropriately.
| Parameter | Default | Note |
|---|---|---|
| api_port | 5002 | API port |
| acl_enabled | true | Keystone authentication |
| policy_file | /etc/kwstandby/policy.json | Access rules |
| log_file | /var/log/kwstandby.log | Log file |
| ipmi_node | {'interface':'lanplus', 'host':'192.168.0.2', 'username':'user1', 'password':'secret1'} | IPMI card information |
The config file contains also a section dedicated to Keystone authentication.
| Parameter | Default | Note |
|---|---|---|
| auth_node | localhost | Auth node |
| auth_protocol | http | Auth protocol |
| admin_user | kwstandby | Admin |
| admin_password | password | Password |
| admin_tenant_name | service | Tenant name |
A sample configuration file can be found in kwstandby.conf.
API¶
| Verb | URL | Parameters | Expected result |
|---|---|---|---|
| GET | /v1/status/ | Returns all hosts status | |
| GET | /v1/status/<host>/ | host | Returns the host status |
| PUT | /v1/status/<host>/ | host, {"status": "standby" or "wakeup"} | Update the host status |
Project Hosting Details¶
| Code Hosting: | https://github.com/frossigneux/kwstandby |
|---|