mist - Provision, monitor and manage machines with the mist.io service¶
Author: | Mist.io Inc |
---|
Synopsis¶
New in version 1.7.1.
Manage machines in all of your added backends You can add/remove multiple backends from multiple providers through mist.io service. mist_email and mist_password can be skipped if ~/.mist config file is present. See mist.client documentation for config file http://mistclient.readthedocs.org/en/latest/cmd/cmd.html
Options¶
parameter | required | default | choices | comments |
---|---|---|---|---|
backend | yes | Can be either the backend's id or name | ||
image_extra | no | Needed only when provisioning to Linode Provider | ||
image_id | no | Id of the OS image you want to use to provision your machine | ||
key | no | Name of the SSH-Key you want to associate with the machine. If None, the default SSH Key will be used | ||
location_id | no | Id of the location/region you want to provision your machine to | ||
metric | no | It will be either the metric id for the supported metrics, or the name in case python_file is providedwait_for_stats needs to be true | ||
mist_email | no | Email to login to the mist.io service | ||
mist_password | no | Password to login to the mist.io service | ||
mist_uri | no | https://mist.io | Url of the mist.io service. By default https://mist.io. But if you have a custom installation of mist.io you can provide the url here | |
monitoring | no | If True, it will enable monitor to the machine | ||
name | no | The name you want the machine to have | ||
python_file | no | This is the path of a python file in case you want to add a custom python metric | ||
size_id | no | Id of the machine size you want to use | ||
state | no |
|
If provided it will instruct the module to trigger machine actions, otherwise it will only list information | |
unit | no | The unit of the metric you add. Can be left none | ||
value_type | no | gauge |
|
What type of value has the plugin |
wait | no | If True, the module will wait for the machine's SSH Daemon to be up and running and the SSH Key associated | ||
wait_for_stats | no | When enabling monitoring for the first time, it may take some time for the collectd agent to be installed.If True, it will wait for the monitoring stats to start | ||
wait_time | no | 600 | Time to wait when waiting for machine to be probed or monitor to be up and running |
Note
Requires mist.client
Examples¶
- name: Provision Ubuntu machine to EC2
mist:
mist_email: your@email.com
mist_password: yourpassword
backend: EC2
state: present
name: MyMachine
key: myKey
image_id: ami-bddaa2bc
size_id: m1.small
location_id: 0
- name: Provision SUSE machine on EC2 and enable monitoring
mist:
mist_email: your@email.com
mist_password: yourpassword
backend: EC2
state: present
name: MyMachine
key: myKey
image_id: ami-9178e890
size_id: m1.small
location_id: 0
monitoring: true
wait_for_stats: true
- name: List info for machine with name dbServer
mist:
mist_email: your@email.com
mist_password: yourpassword
backend: EC2
name: dbServer
register: machine
- name: Enable monitoring and add custom plugin.py
mist:
mist_email: your@email.com
mist_password: yourpassword
backend: EC2
name: dbServer
state: present
key: newKey
wait: true
monitoring: true
wait_for_stats: true
metric: MyPlugin
python_file: /home/user/plugin.py