do-deploy v0.2.6
do-deploy
Use do-deploy to easily deploy and configure DigitalOcean droplets.
Moreover, do-deploy generates an ansible inventory file. Use this file to quickly configure further DigitalOcean droplets via ansible tool.
Install
$ npm install do-deploy --saveUsage
In order to use do-deploy you have to generate an API token on the DigitalOcean website. In addition to that you must have SSH public key on your local machine. It is used to deploy SSH keys to DO droplet.
See how to generate SSH keys here:
const DoDeploy = require('do-deploy');
const doDeploy = new DoDeploy({
doApiToken: '<YOUR_DO_API_TOKEN>',
ansible: {
createInventoryFile: true,
pythonInterpreter: '/usr/bin/python3'
},
createDomains: true,
droplets: [
{
name: 'ams-001.example.com',
region: 'ams3'
}
]
});
doDeploy.deploy();*Note: Replace <YOUR_DO_API_TOKEN> with your API token.
Options
| Option | Type | Default value | Description |
|---|---|---|---|
| doApiToken | string | DigitalOcean API token | |
| doSshKeyName | string | default | The name of SSH key that will be created on DO and added to each of your droplet |
| localSshKeyFilepath | string | <USER_HOME_DIR>/.ssh/id_rsa.pub | File path to your local SSH public key. Used to deploy SSH keys to DO |
| dropletTimeout | integer | 10 000 ms | Timeout to check whether the server is active and IP-address is assigned |
| dropletGetipAttempts | integer | 6 | The number of attempts |
| createDomains | boolean | false | If true, creates domain on DO. servers[].name is used as hostname for DO domain |
| ansible.createInventoryFile | boolean | false | If true, creates ansible inventory file |
| ansible.inventoryFilename | string | ./hosts | The path to ansible inventory file |
| ansible.pythonInterpreter | string | /usr/bin/python | The value of python_interpriter property in the ansible inventory file |
| dropletDefaults.size | string | s-1vcpu-1gb | Default droplet size |
| dropletDefaults.image | string | ubuntu-16-04-x64 | Default droplet image |
| droplets[].name | string | Droplet name | |
| droplets[].region | string | Droplet region |
Issues
Please submit an issue on GitHub with repro steps.
License
The MIT License
Copyright 2018 Serhii Zvinskyi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.