Remotenet start/status/stop added to Makefile to create a DO validator network
This commit is contained in:
parent
975668a314
commit
220afc7cf4
26
Makefile
26
Makefile
|
@ -126,7 +126,31 @@ devdoc_update:
|
||||||
docker pull tendermint/devdoc
|
docker pull tendermint/devdoc
|
||||||
|
|
||||||
|
|
||||||
|
########################################
|
||||||
|
### Remote validator nodes using terraform and ansible
|
||||||
|
|
||||||
|
# Build linux binary
|
||||||
|
build-linux:
|
||||||
|
GOOS=linux GOARCH=amd64 $(MAKE) build
|
||||||
|
|
||||||
|
TESTNET_NAME?=remotenet
|
||||||
|
SERVERS?=4
|
||||||
|
BINARY=$(CURDIR)/build/gaiad
|
||||||
|
remotenet-start:
|
||||||
|
@if [ -z "$(DO_API_TOKEN)" ]; then echo "DO_API_TOKEN environment variable not set." ; false ; fi
|
||||||
|
@if ! [ -f $(HOME)/.ssh/id_rsa.pub ]; then ssh-keygen ; fi
|
||||||
|
cd networks/remote/terraform && terraform init && terraform apply -var DO_API_TOKEN="$(DO_API_TOKEN)" -var SSH_PUBLIC_FILE="$(HOME)/.ssh/id_rsa.pub" -var SSH_PRIVATE_FILE="$(HOME)/.ssh/id_rsa" -var TESTNET_NAME="$(TESTNET_NAME)" -var SERVERS="$(SERVERS)"
|
||||||
|
cd networks/remote/ansible && ANSIBLE_HOST_KEY_CHECKING=False ansible-playbook -i inventory/digital_ocean.py -l "$(TESTNET_NAME)" -e BINARY=$(BINARY) -e TESTNET_NAME="$(TESTNET_NAME)" setup-validators.yml
|
||||||
|
cd networks/remote/ansible && ansible-playbook -i inventory/digital_ocean.py -l "$(TESTNET_NAME)" start.yml
|
||||||
|
|
||||||
|
remotenet-stop:
|
||||||
|
@if [ -z "$(DO_API_TOKEN)" ]; then echo "DO_API_TOKEN environment variable not set." ; false ; fi
|
||||||
|
cd networks/remote/terraform && terraform destroy -var DO_API_TOKEN="$(DO_API_TOKEN)" -var SSH_PUBLIC_FILE="$(HOME)/.ssh/id_rsa.pub" -var SSH_PRIVATE_FILE="$(HOME)/.ssh/id_rsa"
|
||||||
|
|
||||||
|
remotenet-status:
|
||||||
|
cd networks/remote/ansible && ansible-playbook -i inventory/digital_ocean.py -l "$(TESTNET_NAME)" status.yml
|
||||||
|
|
||||||
# To avoid unintended conflicts with file names, always add to .PHONY
|
# To avoid unintended conflicts with file names, always add to .PHONY
|
||||||
# unless there is a reason not to.
|
# unless there is a reason not to.
|
||||||
# https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
|
# https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
|
||||||
.PHONY: build build_examples install install_examples dist check_tools get_tools get_vendor_deps draw_deps test test_cli test_unit test_cover test_lint benchmark devdoc_init devdoc devdoc_save devdoc_update
|
.PHONY: build build_examples install install_examples dist check_tools get_tools get_vendor_deps draw_deps test test_cli test_unit test_cover test_lint benchmark devdoc_init devdoc devdoc_save devdoc_update remotenet-start remotenet-stop remotenet-status
|
||||||
|
|
|
@ -0,0 +1,53 @@
|
||||||
|
Terraform & Ansible
|
||||||
|
===================
|
||||||
|
|
||||||
|
Automated deployments are done using `Terraform <https://www.terraform.io/>`__ to create servers on Digital Ocean then
|
||||||
|
`Ansible <http://www.ansible.com/>`__ to create and manage testnets on those servers.
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Install `Terraform <https://www.terraform.io/downloads.html>`__ and `Ansible <http://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`__ on a Linux machine.
|
||||||
|
- Create a `DigitalOcean API token <https://cloud.digitalocean.com/settings/api/tokens>`__ with read and write capability.
|
||||||
|
- Install the python dopy package (``pip install dopy``) (This is necessary for the digitalocean.py script for ansible.)
|
||||||
|
- Create SSH keys
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
export DO_API_TOKEN="abcdef01234567890abcdef01234567890"
|
||||||
|
export TESTNET_NAME="remotenet"
|
||||||
|
export SSH_PRIVATE_FILE="$HOME/.ssh/id_rsa"
|
||||||
|
export SSH_PUBLIC_FILE="$HOME/.ssh/id_rsa.pub"
|
||||||
|
|
||||||
|
These will be used by both ``terraform`` and ``ansible``.
|
||||||
|
|
||||||
|
Create a remote network
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
make remotenet-start
|
||||||
|
|
||||||
|
|
||||||
|
Optionally, you can set the number of servers you want to launch and the name of the testnet (which defaults to remotenet):
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
TESTNET_NAME="mytestnet" SERVERS=7 make remotenet-start
|
||||||
|
|
||||||
|
|
||||||
|
Quickly see the /status endpoint
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
make remotenet-status
|
||||||
|
|
||||||
|
|
||||||
|
Delete servers
|
||||||
|
--------------
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
make remotenet-stop
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
*.retry
|
||||||
|
files/*
|
|
@ -0,0 +1,4 @@
|
||||||
|
[defaults]
|
||||||
|
retry_files_enabled = False
|
||||||
|
host_key_checking = False
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- hosts: all
|
||||||
|
user: root
|
||||||
|
any_errors_fatal: true
|
||||||
|
gather_facts: no
|
||||||
|
roles:
|
||||||
|
- clear-config
|
||||||
|
|
|
@ -0,0 +1,675 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
# Ansible DigitalOcean external inventory script settings
|
||||||
|
#
|
||||||
|
|
||||||
|
[digital_ocean]
|
||||||
|
|
||||||
|
# The module needs your DigitalOcean API Token.
|
||||||
|
# It may also be specified on the command line via --api-token
|
||||||
|
# or via the environment variables DO_API_TOKEN or DO_API_KEY
|
||||||
|
#
|
||||||
|
#api_token = 123456abcdefg
|
||||||
|
|
||||||
|
|
||||||
|
# API calls to DigitalOcean may be slow. For this reason, we cache the results
|
||||||
|
# of an API call. Set this to the path you want cache files to be written to.
|
||||||
|
# One file will be written to this directory:
|
||||||
|
# - ansible-digital_ocean.cache
|
||||||
|
#
|
||||||
|
cache_path = /tmp
|
||||||
|
|
||||||
|
|
||||||
|
# The number of seconds a cache file is considered valid. After this many
|
||||||
|
# seconds, a new API call will be made, and the cache file will be updated.
|
||||||
|
#
|
||||||
|
cache_max_age = 300
|
||||||
|
|
||||||
|
# Use the private network IP address instead of the public when available.
|
||||||
|
#
|
||||||
|
use_private_network = False
|
||||||
|
|
||||||
|
# Pass variables to every group, e.g.:
|
||||||
|
#
|
||||||
|
# group_variables = { 'ansible_user': 'root' }
|
||||||
|
#
|
||||||
|
group_variables = {}
|
|
@ -0,0 +1,471 @@
|
||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
'''
|
||||||
|
DigitalOcean external inventory script
|
||||||
|
======================================
|
||||||
|
|
||||||
|
Generates Ansible inventory of DigitalOcean Droplets.
|
||||||
|
|
||||||
|
In addition to the --list and --host options used by Ansible, there are options
|
||||||
|
for generating JSON of other DigitalOcean data. This is useful when creating
|
||||||
|
droplets. For example, --regions will return all the DigitalOcean Regions.
|
||||||
|
This information can also be easily found in the cache file, whose default
|
||||||
|
location is /tmp/ansible-digital_ocean.cache).
|
||||||
|
|
||||||
|
The --pretty (-p) option pretty-prints the output for better human readability.
|
||||||
|
|
||||||
|
----
|
||||||
|
Although the cache stores all the information received from DigitalOcean,
|
||||||
|
the cache is not used for current droplet information (in --list, --host,
|
||||||
|
--all, and --droplets). This is so that accurate droplet information is always
|
||||||
|
found. You can force this script to use the cache with --force-cache.
|
||||||
|
|
||||||
|
----
|
||||||
|
Configuration is read from `digital_ocean.ini`, then from environment variables,
|
||||||
|
then and command-line arguments.
|
||||||
|
|
||||||
|
Most notably, the DigitalOcean API Token must be specified. It can be specified
|
||||||
|
in the INI file or with the following environment variables:
|
||||||
|
export DO_API_TOKEN='abc123' or
|
||||||
|
export DO_API_KEY='abc123'
|
||||||
|
|
||||||
|
Alternatively, it can be passed on the command-line with --api-token.
|
||||||
|
|
||||||
|
If you specify DigitalOcean credentials in the INI file, a handy way to
|
||||||
|
get them into your environment (e.g., to use the digital_ocean module)
|
||||||
|
is to use the output of the --env option with export:
|
||||||
|
export $(digital_ocean.py --env)
|
||||||
|
|
||||||
|
----
|
||||||
|
The following groups are generated from --list:
|
||||||
|
- ID (droplet ID)
|
||||||
|
- NAME (droplet NAME)
|
||||||
|
- image_ID
|
||||||
|
- image_NAME
|
||||||
|
- distro_NAME (distribution NAME from image)
|
||||||
|
- region_NAME
|
||||||
|
- size_NAME
|
||||||
|
- status_STATUS
|
||||||
|
|
||||||
|
For each host, the following variables are registered:
|
||||||
|
- do_backup_ids
|
||||||
|
- do_created_at
|
||||||
|
- do_disk
|
||||||
|
- do_features - list
|
||||||
|
- do_id
|
||||||
|
- do_image - object
|
||||||
|
- do_ip_address
|
||||||
|
- do_private_ip_address
|
||||||
|
- do_kernel - object
|
||||||
|
- do_locked
|
||||||
|
- do_memory
|
||||||
|
- do_name
|
||||||
|
- do_networks - object
|
||||||
|
- do_next_backup_window
|
||||||
|
- do_region - object
|
||||||
|
- do_size - object
|
||||||
|
- do_size_slug
|
||||||
|
- do_snapshot_ids - list
|
||||||
|
- do_status
|
||||||
|
- do_tags
|
||||||
|
- do_vcpus
|
||||||
|
- do_volume_ids
|
||||||
|
|
||||||
|
-----
|
||||||
|
```
|
||||||
|
usage: digital_ocean.py [-h] [--list] [--host HOST] [--all]
|
||||||
|
[--droplets] [--regions] [--images] [--sizes]
|
||||||
|
[--ssh-keys] [--domains] [--pretty]
|
||||||
|
[--cache-path CACHE_PATH]
|
||||||
|
[--cache-max_age CACHE_MAX_AGE]
|
||||||
|
[--force-cache]
|
||||||
|
[--refresh-cache]
|
||||||
|
[--api-token API_TOKEN]
|
||||||
|
|
||||||
|
Produce an Ansible Inventory file based on DigitalOcean credentials
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
--list List all active Droplets as Ansible inventory
|
||||||
|
(default: True)
|
||||||
|
--host HOST Get all Ansible inventory variables about a specific
|
||||||
|
Droplet
|
||||||
|
--all List all DigitalOcean information as JSON
|
||||||
|
--droplets List Droplets as JSON
|
||||||
|
--regions List Regions as JSON
|
||||||
|
--images List Images as JSON
|
||||||
|
--sizes List Sizes as JSON
|
||||||
|
--ssh-keys List SSH keys as JSON
|
||||||
|
--domains List Domains as JSON
|
||||||
|
--pretty, -p Pretty-print results
|
||||||
|
--cache-path CACHE_PATH
|
||||||
|
Path to the cache files (default: .)
|
||||||
|
--cache-max_age CACHE_MAX_AGE
|
||||||
|
Maximum age of the cached items (default: 0)
|
||||||
|
--force-cache Only use data from the cache
|
||||||
|
--refresh-cache Force refresh of cache by making API requests to
|
||||||
|
DigitalOcean (default: False - use cache files)
|
||||||
|
--api-token API_TOKEN, -a API_TOKEN
|
||||||
|
DigitalOcean API Token
|
||||||
|
```
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
# (c) 2013, Evan Wies <evan@neomantra.net>
|
||||||
|
#
|
||||||
|
# Inspired by the EC2 inventory plugin:
|
||||||
|
# https://github.com/ansible/ansible/blob/devel/contrib/inventory/ec2.py
|
||||||
|
#
|
||||||
|
# This file is part of Ansible,
|
||||||
|
#
|
||||||
|
# Ansible is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# Ansible is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
######################################################################
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import re
|
||||||
|
import argparse
|
||||||
|
from time import time
|
||||||
|
import ConfigParser
|
||||||
|
import ast
|
||||||
|
|
||||||
|
try:
|
||||||
|
import json
|
||||||
|
except ImportError:
|
||||||
|
import simplejson as json
|
||||||
|
|
||||||
|
try:
|
||||||
|
from dopy.manager import DoManager
|
||||||
|
except ImportError as e:
|
||||||
|
sys.exit("failed=True msg='`dopy` library required for this script'")
|
||||||
|
|
||||||
|
|
||||||
|
class DigitalOceanInventory(object):
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Main execution path
|
||||||
|
###########################################################################
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
''' Main execution path '''
|
||||||
|
|
||||||
|
# DigitalOceanInventory data
|
||||||
|
self.data = {} # All DigitalOcean data
|
||||||
|
self.inventory = {} # Ansible Inventory
|
||||||
|
|
||||||
|
# Define defaults
|
||||||
|
self.cache_path = '.'
|
||||||
|
self.cache_max_age = 0
|
||||||
|
self.use_private_network = False
|
||||||
|
self.group_variables = {}
|
||||||
|
|
||||||
|
# Read settings, environment variables, and CLI arguments
|
||||||
|
self.read_settings()
|
||||||
|
self.read_environment()
|
||||||
|
self.read_cli_args()
|
||||||
|
|
||||||
|
# Verify credentials were set
|
||||||
|
if not hasattr(self, 'api_token'):
|
||||||
|
sys.stderr.write('''Could not find values for DigitalOcean api_token.
|
||||||
|
They must be specified via either ini file, command line argument (--api-token),
|
||||||
|
or environment variables (DO_API_TOKEN)\n''')
|
||||||
|
sys.exit(-1)
|
||||||
|
|
||||||
|
# env command, show DigitalOcean credentials
|
||||||
|
if self.args.env:
|
||||||
|
print("DO_API_TOKEN=%s" % self.api_token)
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
# Manage cache
|
||||||
|
self.cache_filename = self.cache_path + "/ansible-digital_ocean.cache"
|
||||||
|
self.cache_refreshed = False
|
||||||
|
|
||||||
|
if self.is_cache_valid():
|
||||||
|
self.load_from_cache()
|
||||||
|
if len(self.data) == 0:
|
||||||
|
if self.args.force_cache:
|
||||||
|
sys.stderr.write('''Cache is empty and --force-cache was specified\n''')
|
||||||
|
sys.exit(-1)
|
||||||
|
|
||||||
|
self.manager = DoManager(None, self.api_token, api_version=2)
|
||||||
|
|
||||||
|
# Pick the json_data to print based on the CLI command
|
||||||
|
if self.args.droplets:
|
||||||
|
self.load_from_digital_ocean('droplets')
|
||||||
|
json_data = {'droplets': self.data['droplets']}
|
||||||
|
elif self.args.regions:
|
||||||
|
self.load_from_digital_ocean('regions')
|
||||||
|
json_data = {'regions': self.data['regions']}
|
||||||
|
elif self.args.images:
|
||||||
|
self.load_from_digital_ocean('images')
|
||||||
|
json_data = {'images': self.data['images']}
|
||||||
|
elif self.args.sizes:
|
||||||
|
self.load_from_digital_ocean('sizes')
|
||||||
|
json_data = {'sizes': self.data['sizes']}
|
||||||
|
elif self.args.ssh_keys:
|
||||||
|
self.load_from_digital_ocean('ssh_keys')
|
||||||
|
json_data = {'ssh_keys': self.data['ssh_keys']}
|
||||||
|
elif self.args.domains:
|
||||||
|
self.load_from_digital_ocean('domains')
|
||||||
|
json_data = {'domains': self.data['domains']}
|
||||||
|
elif self.args.all:
|
||||||
|
self.load_from_digital_ocean()
|
||||||
|
json_data = self.data
|
||||||
|
elif self.args.host:
|
||||||
|
json_data = self.load_droplet_variables_for_host()
|
||||||
|
else: # '--list' this is last to make it default
|
||||||
|
self.load_from_digital_ocean('droplets')
|
||||||
|
self.build_inventory()
|
||||||
|
json_data = self.inventory
|
||||||
|
|
||||||
|
if self.cache_refreshed:
|
||||||
|
self.write_to_cache()
|
||||||
|
|
||||||
|
if self.args.pretty:
|
||||||
|
print(json.dumps(json_data, sort_keys=True, indent=2))
|
||||||
|
else:
|
||||||
|
print(json.dumps(json_data))
|
||||||
|
# That's all she wrote...
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Script configuration
|
||||||
|
###########################################################################
|
||||||
|
|
||||||
|
def read_settings(self):
|
||||||
|
''' Reads the settings from the digital_ocean.ini file '''
|
||||||
|
config = ConfigParser.SafeConfigParser()
|
||||||
|
config.read(os.path.dirname(os.path.realpath(__file__)) + '/digital_ocean.ini')
|
||||||
|
|
||||||
|
# Credentials
|
||||||
|
if config.has_option('digital_ocean', 'api_token'):
|
||||||
|
self.api_token = config.get('digital_ocean', 'api_token')
|
||||||
|
|
||||||
|
# Cache related
|
||||||
|
if config.has_option('digital_ocean', 'cache_path'):
|
||||||
|
self.cache_path = config.get('digital_ocean', 'cache_path')
|
||||||
|
if config.has_option('digital_ocean', 'cache_max_age'):
|
||||||
|
self.cache_max_age = config.getint('digital_ocean', 'cache_max_age')
|
||||||
|
|
||||||
|
# Private IP Address
|
||||||
|
if config.has_option('digital_ocean', 'use_private_network'):
|
||||||
|
self.use_private_network = config.getboolean('digital_ocean', 'use_private_network')
|
||||||
|
|
||||||
|
# Group variables
|
||||||
|
if config.has_option('digital_ocean', 'group_variables'):
|
||||||
|
self.group_variables = ast.literal_eval(config.get('digital_ocean', 'group_variables'))
|
||||||
|
|
||||||
|
def read_environment(self):
|
||||||
|
''' Reads the settings from environment variables '''
|
||||||
|
# Setup credentials
|
||||||
|
if os.getenv("DO_API_TOKEN"):
|
||||||
|
self.api_token = os.getenv("DO_API_TOKEN")
|
||||||
|
if os.getenv("DO_API_KEY"):
|
||||||
|
self.api_token = os.getenv("DO_API_KEY")
|
||||||
|
|
||||||
|
def read_cli_args(self):
|
||||||
|
''' Command line argument processing '''
|
||||||
|
parser = argparse.ArgumentParser(description='Produce an Ansible Inventory file based on DigitalOcean credentials')
|
||||||
|
|
||||||
|
parser.add_argument('--list', action='store_true', help='List all active Droplets as Ansible inventory (default: True)')
|
||||||
|
parser.add_argument('--host', action='store', help='Get all Ansible inventory variables about a specific Droplet')
|
||||||
|
|
||||||
|
parser.add_argument('--all', action='store_true', help='List all DigitalOcean information as JSON')
|
||||||
|
parser.add_argument('--droplets', '-d', action='store_true', help='List Droplets as JSON')
|
||||||
|
parser.add_argument('--regions', action='store_true', help='List Regions as JSON')
|
||||||
|
parser.add_argument('--images', action='store_true', help='List Images as JSON')
|
||||||
|
parser.add_argument('--sizes', action='store_true', help='List Sizes as JSON')
|
||||||
|
parser.add_argument('--ssh-keys', action='store_true', help='List SSH keys as JSON')
|
||||||
|
parser.add_argument('--domains', action='store_true', help='List Domains as JSON')
|
||||||
|
|
||||||
|
parser.add_argument('--pretty', '-p', action='store_true', help='Pretty-print results')
|
||||||
|
|
||||||
|
parser.add_argument('--cache-path', action='store', help='Path to the cache files (default: .)')
|
||||||
|
parser.add_argument('--cache-max_age', action='store', help='Maximum age of the cached items (default: 0)')
|
||||||
|
parser.add_argument('--force-cache', action='store_true', default=False, help='Only use data from the cache')
|
||||||
|
parser.add_argument('--refresh-cache', '-r', action='store_true', default=False,
|
||||||
|
help='Force refresh of cache by making API requests to DigitalOcean (default: False - use cache files)')
|
||||||
|
|
||||||
|
parser.add_argument('--env', '-e', action='store_true', help='Display DO_API_TOKEN')
|
||||||
|
parser.add_argument('--api-token', '-a', action='store', help='DigitalOcean API Token')
|
||||||
|
|
||||||
|
self.args = parser.parse_args()
|
||||||
|
|
||||||
|
if self.args.api_token:
|
||||||
|
self.api_token = self.args.api_token
|
||||||
|
|
||||||
|
# Make --list default if none of the other commands are specified
|
||||||
|
if (not self.args.droplets and not self.args.regions and
|
||||||
|
not self.args.images and not self.args.sizes and
|
||||||
|
not self.args.ssh_keys and not self.args.domains and
|
||||||
|
not self.args.all and not self.args.host):
|
||||||
|
self.args.list = True
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Data Management
|
||||||
|
###########################################################################
|
||||||
|
|
||||||
|
def load_from_digital_ocean(self, resource=None):
|
||||||
|
'''Get JSON from DigitalOcean API'''
|
||||||
|
if self.args.force_cache and os.path.isfile(self.cache_filename):
|
||||||
|
return
|
||||||
|
# We always get fresh droplets
|
||||||
|
if self.is_cache_valid() and not (resource == 'droplets' or resource is None):
|
||||||
|
return
|
||||||
|
if self.args.refresh_cache:
|
||||||
|
resource = None
|
||||||
|
|
||||||
|
if resource == 'droplets' or resource is None:
|
||||||
|
self.data['droplets'] = self.manager.all_active_droplets()
|
||||||
|
self.cache_refreshed = True
|
||||||
|
if resource == 'regions' or resource is None:
|
||||||
|
self.data['regions'] = self.manager.all_regions()
|
||||||
|
self.cache_refreshed = True
|
||||||
|
if resource == 'images' or resource is None:
|
||||||
|
self.data['images'] = self.manager.all_images(filter=None)
|
||||||
|
self.cache_refreshed = True
|
||||||
|
if resource == 'sizes' or resource is None:
|
||||||
|
self.data['sizes'] = self.manager.sizes()
|
||||||
|
self.cache_refreshed = True
|
||||||
|
if resource == 'ssh_keys' or resource is None:
|
||||||
|
self.data['ssh_keys'] = self.manager.all_ssh_keys()
|
||||||
|
self.cache_refreshed = True
|
||||||
|
if resource == 'domains' or resource is None:
|
||||||
|
self.data['domains'] = self.manager.all_domains()
|
||||||
|
self.cache_refreshed = True
|
||||||
|
|
||||||
|
def build_inventory(self):
|
||||||
|
'''Build Ansible inventory of droplets'''
|
||||||
|
self.inventory = {
|
||||||
|
'all': {
|
||||||
|
'hosts': [],
|
||||||
|
'vars': self.group_variables
|
||||||
|
},
|
||||||
|
'_meta': {'hostvars': {}}
|
||||||
|
}
|
||||||
|
|
||||||
|
# add all droplets by id and name
|
||||||
|
for droplet in self.data['droplets']:
|
||||||
|
# when using private_networking, the API reports the private one in "ip_address".
|
||||||
|
if 'private_networking' in droplet['features'] and not self.use_private_network:
|
||||||
|
for net in droplet['networks']['v4']:
|
||||||
|
if net['type'] == 'public':
|
||||||
|
dest = net['ip_address']
|
||||||
|
else:
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
dest = droplet['ip_address']
|
||||||
|
|
||||||
|
self.inventory['all']['hosts'].append(dest)
|
||||||
|
|
||||||
|
self.inventory[droplet['id']] = [dest]
|
||||||
|
self.inventory[droplet['name']] = [dest]
|
||||||
|
|
||||||
|
# groups that are always present
|
||||||
|
for group in ('region_' + droplet['region']['slug'],
|
||||||
|
'image_' + str(droplet['image']['id']),
|
||||||
|
'size_' + droplet['size']['slug'],
|
||||||
|
'distro_' + self.to_safe(droplet['image']['distribution']),
|
||||||
|
'status_' + droplet['status']):
|
||||||
|
if group not in self.inventory:
|
||||||
|
self.inventory[group] = {'hosts': [], 'vars': {}}
|
||||||
|
self.inventory[group]['hosts'].append(dest)
|
||||||
|
|
||||||
|
# groups that are not always present
|
||||||
|
for group in (droplet['image']['slug'],
|
||||||
|
droplet['image']['name']):
|
||||||
|
if group:
|
||||||
|
image = 'image_' + self.to_safe(group)
|
||||||
|
if image not in self.inventory:
|
||||||
|
self.inventory[image] = {'hosts': [], 'vars': {}}
|
||||||
|
self.inventory[image]['hosts'].append(dest)
|
||||||
|
|
||||||
|
if droplet['tags']:
|
||||||
|
for tag in droplet['tags']:
|
||||||
|
if tag not in self.inventory:
|
||||||
|
self.inventory[tag] = {'hosts': [], 'vars': {}}
|
||||||
|
self.inventory[tag]['hosts'].append(dest)
|
||||||
|
|
||||||
|
# hostvars
|
||||||
|
info = self.do_namespace(droplet)
|
||||||
|
self.inventory['_meta']['hostvars'][dest] = info
|
||||||
|
|
||||||
|
def load_droplet_variables_for_host(self):
|
||||||
|
'''Generate a JSON response to a --host call'''
|
||||||
|
host = int(self.args.host)
|
||||||
|
droplet = self.manager.show_droplet(host)
|
||||||
|
info = self.do_namespace(droplet)
|
||||||
|
return {'droplet': info}
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Cache Management
|
||||||
|
###########################################################################
|
||||||
|
|
||||||
|
def is_cache_valid(self):
|
||||||
|
''' Determines if the cache files have expired, or if it is still valid '''
|
||||||
|
if os.path.isfile(self.cache_filename):
|
||||||
|
mod_time = os.path.getmtime(self.cache_filename)
|
||||||
|
current_time = time()
|
||||||
|
if (mod_time + self.cache_max_age) > current_time:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def load_from_cache(self):
|
||||||
|
''' Reads the data from the cache file and assigns it to member variables as Python Objects'''
|
||||||
|
try:
|
||||||
|
cache = open(self.cache_filename, 'r')
|
||||||
|
json_data = cache.read()
|
||||||
|
cache.close()
|
||||||
|
data = json.loads(json_data)
|
||||||
|
except IOError:
|
||||||
|
data = {'data': {}, 'inventory': {}}
|
||||||
|
|
||||||
|
self.data = data['data']
|
||||||
|
self.inventory = data['inventory']
|
||||||
|
|
||||||
|
def write_to_cache(self):
|
||||||
|
''' Writes data in JSON format to a file '''
|
||||||
|
data = {'data': self.data, 'inventory': self.inventory}
|
||||||
|
json_data = json.dumps(data, sort_keys=True, indent=2)
|
||||||
|
|
||||||
|
cache = open(self.cache_filename, 'w')
|
||||||
|
cache.write(json_data)
|
||||||
|
cache.close()
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Utilities
|
||||||
|
###########################################################################
|
||||||
|
|
||||||
|
def push(self, my_dict, key, element):
|
||||||
|
''' Pushed an element onto an array that may not have been defined in the dict '''
|
||||||
|
if key in my_dict:
|
||||||
|
my_dict[key].append(element)
|
||||||
|
else:
|
||||||
|
my_dict[key] = [element]
|
||||||
|
|
||||||
|
def to_safe(self, word):
|
||||||
|
''' Converts 'bad' characters in a string to underscores so they can be used as Ansible groups '''
|
||||||
|
return re.sub("[^A-Za-z0-9\-\.]", "_", word)
|
||||||
|
|
||||||
|
def do_namespace(self, data):
|
||||||
|
''' Returns a copy of the dictionary with all the keys put in a 'do_' namespace '''
|
||||||
|
info = {}
|
||||||
|
for k, v in data.items():
|
||||||
|
info['do_' + k] = v
|
||||||
|
return info
|
||||||
|
|
||||||
|
|
||||||
|
###########################################################################
|
||||||
|
# Run the script
|
||||||
|
DigitalOceanInventory()
|
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: Stop service
|
||||||
|
service: name=gaiad state=stopped
|
||||||
|
|
||||||
|
- name: Delete files
|
||||||
|
file: "path={{item}} state=absent"
|
||||||
|
with_items:
|
||||||
|
- /usr/bin/gaiad
|
||||||
|
- /home/gaiad/.gaiad
|
||||||
|
- /home/gaiad/.gaiacli
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
TESTNET_NAME: remotenet
|
||||||
|
|
|
@ -0,0 +1,50 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: Copy binary
|
||||||
|
copy:
|
||||||
|
src: "{{BINARY}}"
|
||||||
|
dest: /usr/bin
|
||||||
|
mode: 0755
|
||||||
|
|
||||||
|
- name: Get node ID
|
||||||
|
command: "cat /etc/gaiad-nodeid"
|
||||||
|
changed_when: false
|
||||||
|
register: nodeid
|
||||||
|
|
||||||
|
- name: Create initial transaction
|
||||||
|
command: "/usr/bin/gaiad init gen-tx --name=node{{nodeid.stdout_lines[0]}}"
|
||||||
|
become: yes
|
||||||
|
become_user: gaiad
|
||||||
|
args:
|
||||||
|
creates: /home/gaiad/.gaiad/config/gentx
|
||||||
|
|
||||||
|
- name: Find gentx file
|
||||||
|
command: "ls /home/gaiad/.gaiad/config/gentx"
|
||||||
|
changed_when: false
|
||||||
|
register: gentxfile
|
||||||
|
|
||||||
|
- name: Clear local gen-tx list
|
||||||
|
file: path=files/ state=absent
|
||||||
|
connection: local
|
||||||
|
run_once: yes
|
||||||
|
|
||||||
|
- name: Get gen-tx
|
||||||
|
fetch:
|
||||||
|
dest: files/
|
||||||
|
src: "/home/gaiad/.gaiad/config/gentx/{{gentxfile.stdout_lines[0]}}"
|
||||||
|
flat: yes
|
||||||
|
|
||||||
|
- name: Copy generated transactions to all nodes
|
||||||
|
copy:
|
||||||
|
src: files/
|
||||||
|
dest: /home/gaiad/.gaiad/config/gentx/
|
||||||
|
become: yes
|
||||||
|
become_user: gaiad
|
||||||
|
|
||||||
|
- name: Generate genesis.json
|
||||||
|
command: "/usr/bin/gaiad init --gen-txs --name=node{{nodeid.stdout_lines[0]}} --chain-id={{TESTNET_NAME}}"
|
||||||
|
become: yes
|
||||||
|
become_user: gaiad
|
||||||
|
args:
|
||||||
|
creates: /home/gaiad/.gaiad/config/genesis.json
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: start service
|
||||||
|
service: "name={{service}} state=started"
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: stop service
|
||||||
|
service: "name={{service}} state=stopped"
|
||||||
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- hosts: all
|
||||||
|
user: root
|
||||||
|
any_errors_fatal: true
|
||||||
|
gather_facts: no
|
||||||
|
roles:
|
||||||
|
- setup-validators
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- hosts: all
|
||||||
|
user: root
|
||||||
|
any_errors_fatal: true
|
||||||
|
gather_facts: no
|
||||||
|
vars:
|
||||||
|
- service: gaiad
|
||||||
|
roles:
|
||||||
|
- start
|
||||||
|
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- hosts: all
|
||||||
|
connection: local
|
||||||
|
any_errors_fatal: true
|
||||||
|
gather_facts: no
|
||||||
|
|
||||||
|
tasks:
|
||||||
|
- name: Gather status
|
||||||
|
uri:
|
||||||
|
body_format: json
|
||||||
|
url: "http://{{inventory_hostname}}:46657/status"
|
||||||
|
register: status
|
||||||
|
|
||||||
|
- name: Print status
|
||||||
|
debug: var=status.json.result
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
- hosts: all
|
||||||
|
user: root
|
||||||
|
any_errors_fatal: true
|
||||||
|
gather_facts: no
|
||||||
|
vars:
|
||||||
|
- service: gaiad
|
||||||
|
roles:
|
||||||
|
- stop
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
.terraform
|
||||||
|
terraform.tfstate
|
||||||
|
terraform.tfstate.backup
|
||||||
|
terraform.tfstate.d
|
|
@ -0,0 +1,53 @@
|
||||||
|
Using Terraform
|
||||||
|
===============
|
||||||
|
|
||||||
|
This is a `Terraform <https://www.terraform.io/>`__ configuration that sets up DigitalOcean droplets.
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Install `HashiCorp Terraform <https://www.terraform.io>`__ on a linux machine.
|
||||||
|
- Create a `DigitalOcean API token <https://cloud.digitalocean.com/settings/api/tokens>`__ with read and write capability.
|
||||||
|
- Create SSH keys
|
||||||
|
|
||||||
|
Build
|
||||||
|
-----
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
export DO_API_TOKEN="abcdef01234567890abcdef01234567890"
|
||||||
|
export TESTNET_NAME="remotenet"
|
||||||
|
export SSH_PUBLIC_FILE="$HOME/.ssh/id_rsa.pub"
|
||||||
|
export SSH_PRIVATE_FILE="$HOME/.ssh/id_rsa"
|
||||||
|
|
||||||
|
terraform init
|
||||||
|
terraform apply -var DO_API_TOKEN="$DO_API_TOKEN" -var SSH_PUBLIC_FILE="$SSH_PUBLIC_FILE" -var SSH_PRIVATE_FILE="$SSH_PRIVATE_FILE"
|
||||||
|
|
||||||
|
At the end you will get a list of IP addresses that belongs to your new droplets.
|
||||||
|
|
||||||
|
Destroy
|
||||||
|
-------
|
||||||
|
|
||||||
|
Run the below:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
terraform destroy -var DO_API_TOKEN="$DO_API_TOKEN" -var SSH_PUBLIC_FILE="$SSH_PUBLIC_FILE" -var SSH_PRIVATE_FILE="$SSH_PRIVATE_FILE"
|
||||||
|
|
||||||
|
Good to know
|
||||||
|
------------
|
||||||
|
|
||||||
|
The DigitalOcean API was not very reliable for me. If you find that terraform fails to install a specific server (for example cluster[2]), check
|
||||||
|
the regions variable and remove data center names that you find unreliable. The variable is at cluster/variables.tf
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
variable "regions" {
|
||||||
|
description = "Regions to launch in"
|
||||||
|
type = "list"
|
||||||
|
default = ["TOR1", "LON1"]
|
||||||
|
}
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,46 @@
|
||||||
|
resource "digitalocean_tag" "cluster" {
|
||||||
|
name = "${var.name}"
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "digitalocean_ssh_key" "cluster" {
|
||||||
|
name = "${var.name}"
|
||||||
|
public_key = "${file(var.ssh_public_file)}"
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "digitalocean_droplet" "cluster" {
|
||||||
|
name = "${var.name}-node${count.index}"
|
||||||
|
image = "centos-7-x64"
|
||||||
|
size = "${var.instance_size}"
|
||||||
|
region = "${element(var.regions, count.index)}"
|
||||||
|
ssh_keys = ["${digitalocean_ssh_key.cluster.id}"]
|
||||||
|
count = "${var.servers}"
|
||||||
|
tags = ["${digitalocean_tag.cluster.id}"]
|
||||||
|
|
||||||
|
lifecycle = {
|
||||||
|
prevent_destroy = false
|
||||||
|
}
|
||||||
|
|
||||||
|
connection {
|
||||||
|
private_key = "${file(var.ssh_private_file)}"
|
||||||
|
timeout = "30s"
|
||||||
|
}
|
||||||
|
|
||||||
|
provisioner "file" {
|
||||||
|
source = "files/terraform.sh"
|
||||||
|
destination = "/tmp/terraform.sh"
|
||||||
|
}
|
||||||
|
|
||||||
|
provisioner "file" {
|
||||||
|
source = "files/gaiad.service"
|
||||||
|
destination = "/etc/systemd/system/gaiad.service"
|
||||||
|
}
|
||||||
|
|
||||||
|
provisioner "remote-exec" {
|
||||||
|
inline = [
|
||||||
|
"chmod +x /tmp/terraform.sh",
|
||||||
|
"/tmp/terraform.sh ${var.name} ${count.index}",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
|
@ -0,0 +1,15 @@
|
||||||
|
// The cluster name
|
||||||
|
output "name" {
|
||||||
|
value = "${var.name}"
|
||||||
|
}
|
||||||
|
|
||||||
|
// The list of cluster instance IDs
|
||||||
|
output "instances" {
|
||||||
|
value = ["${digitalocean_droplet.cluster.*.id}"]
|
||||||
|
}
|
||||||
|
|
||||||
|
// The list of cluster instance public IPs
|
||||||
|
output "public_ips" {
|
||||||
|
value = ["${digitalocean_droplet.cluster.*.ipv4_address}"]
|
||||||
|
}
|
||||||
|
|
|
@ -0,0 +1,30 @@
|
||||||
|
variable "name" {
|
||||||
|
description = "The cluster name, e.g remotenet"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "regions" {
|
||||||
|
description = "Regions to launch in"
|
||||||
|
type = "list"
|
||||||
|
default = ["AMS2", "TOR1", "LON1", "NYC3", "SFO2", "SGP1", "FRA1"]
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_private_file" {
|
||||||
|
description = "SSH private key filename to use to connect to the nodes"
|
||||||
|
type = "string"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_public_file" {
|
||||||
|
description = "SSH public key filename to copy to the nodes"
|
||||||
|
type = "string"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "instance_size" {
|
||||||
|
description = "The instance size to use"
|
||||||
|
default = "2gb"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "servers" {
|
||||||
|
description = "Desired instance count"
|
||||||
|
default = 4
|
||||||
|
}
|
||||||
|
|
|
@ -0,0 +1,17 @@
|
||||||
|
[Unit]
|
||||||
|
Description=gaiad
|
||||||
|
Requires=network-online.target
|
||||||
|
After=network-online.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Restart=on-failure
|
||||||
|
User=gaiad
|
||||||
|
Group=gaiad
|
||||||
|
PermissionsStartOnly=true
|
||||||
|
ExecStart=/usr/bin/gaiad start
|
||||||
|
ExecReload=/bin/kill -HUP $MAINPID
|
||||||
|
KillSignal=SIGTERM
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Script to initialize a testnet settings on a server
|
||||||
|
|
||||||
|
#Usage: terraform.sh <testnet_name> <testnet_node_number>
|
||||||
|
|
||||||
|
#Add gaiad node number for remote identification
|
||||||
|
echo "$2" > /etc/gaiad-nodeid
|
||||||
|
|
||||||
|
#Create gaiad user
|
||||||
|
useradd -m -s /bin/bash gaiad
|
||||||
|
#cp -r /root/.ssh /home/gaiad/.ssh
|
||||||
|
#chown -R gaiad.gaiad /home/gaiad/.ssh
|
||||||
|
#chmod -R 700 /home/gaiad/.ssh
|
||||||
|
|
||||||
|
#Reload services to enable the gaiad service (note that the gaiad binary is not available yet)
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable gaiad
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,43 @@
|
||||||
|
#Terraform Configuration
|
||||||
|
|
||||||
|
variable "DO_API_TOKEN" {
|
||||||
|
description = "DigitalOcean Access Token"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "TESTNET_NAME" {
|
||||||
|
description = "Name of the testnet"
|
||||||
|
default = "remotenet"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "SSH_PRIVATE_FILE" {
|
||||||
|
description = "SSH private key file to be used to connect to the nodes"
|
||||||
|
type = "string"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "SSH_PUBLIC_FILE" {
|
||||||
|
description = "SSH public key file to be used on the nodes"
|
||||||
|
type = "string"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "SERVERS" {
|
||||||
|
description = "Number of nodes in testnet"
|
||||||
|
default = "4"
|
||||||
|
}
|
||||||
|
|
||||||
|
provider "digitalocean" {
|
||||||
|
token = "${var.DO_API_TOKEN}"
|
||||||
|
}
|
||||||
|
|
||||||
|
module "cluster" {
|
||||||
|
source = "./cluster"
|
||||||
|
name = "${var.TESTNET_NAME}"
|
||||||
|
ssh_private_file = "${var.SSH_PRIVATE_FILE}"
|
||||||
|
ssh_public_file = "${var.SSH_PUBLIC_FILE}"
|
||||||
|
servers = "${var.SERVERS}"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
output "public_ips" {
|
||||||
|
value = "${module.cluster.public_ips}"
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue