Ethan Buchman
7 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
108 changed files with 4012 additions and 1073 deletions
Split View
Diff Options
-
+18 -3CHANGELOG.md
-
+1 -0DOCKER/.gitignore
-
+24 -30DOCKER/Dockerfile
-
+13 -12Gopkg.lock
-
+3 -5Gopkg.toml
-
+46 -1Makefile
-
+6 -3README.md
-
+27 -18benchmarks/codec_test.go
-
+476 -466benchmarks/proto/test.pb.go
-
+5 -1benchmarks/proto/test.proto
-
+11 -4cmd/tendermint/commands/init.go
-
+124 -40cmd/tendermint/commands/testnet.go
-
+11 -6config/toml.go
-
+1 -1consensus/common_test.go
-
+2 -1consensus/replay_file.go
-
+24 -0consensus/types/height_vote_set.go
-
+0 -0consensus/types/peer_round_state.go
-
+25 -24consensus/types/round_state.go
-
+95 -0consensus/types/round_state_test.go
-
+12 -0consensus/types/wire.go
-
+1 -2consensus/wal_generator.go
-
+68 -0docker-compose.yml
-
+32 -36docs/getting-started.rst
-
+1 -1docs/how-to-read-logs.rst
-
+3 -2docs/install.rst
-
+2 -2docs/specification/genesis.rst
-
+69 -0docs/specification/new-spec/abci.md
-
+223 -109docs/specification/new-spec/encoding.md
-
+2 -2docs/specification/new-spec/p2p/peer.md
-
+246 -0docs/specification/new-spec/pre-amino.md
-
+125 -0docs/specification/new-spec/scripts/crypto.go
-
+0 -3docs/specification/new-spec/state.md
-
+0 -80docs/specification/new-spec/wire.go
-
+60 -67docs/using-tendermint.rst
-
+1 -1lite/client/provider.go
-
+7 -0networks/local/Makefile
-
+40 -0networks/local/README.rst
-
+16 -0networks/local/localnode/Dockerfile
-
+35 -0networks/local/localnode/wrapper.sh
-
+1 -0networks/remote/ansible/.gitignore
-
+52 -0networks/remote/ansible/README.rst
-
+4 -0networks/remote/ansible/ansible.cfg
-
BINnetworks/remote/ansible/assets/a_plus_t.png
-
+18 -0networks/remote/ansible/config.yml
-
+11 -0networks/remote/ansible/install.yml
-
+675 -0networks/remote/ansible/inventory/COPYING
-
+34 -0networks/remote/ansible/inventory/digital_ocean.ini
-
+471 -0networks/remote/ansible/inventory/digital_ocean.py
-
+14 -0networks/remote/ansible/logzio.yml
-
+14 -0networks/remote/ansible/reset.yml
-
+12 -0networks/remote/ansible/restart.yml
-
+17 -0networks/remote/ansible/roles/config/tasks/main.yml
-
+5 -0networks/remote/ansible/roles/install/handlers/main.yml
-
+15 -0networks/remote/ansible/roles/install/tasks/main.yml
-
+17 -0networks/remote/ansible/roles/install/templates/systemd.service.j2
-
+15 -0networks/remote/ansible/roles/logzio/files/journalbeat.service
-
+8 -0networks/remote/ansible/roles/logzio/handlers/main.yml
-
+27 -0networks/remote/ansible/roles/logzio/tasks/main.yml
-
+342 -0networks/remote/ansible/roles/logzio/templates/journalbeat.yml.j2
-
+5 -0networks/remote/ansible/roles/start/tasks/main.yml
-
+10 -0networks/remote/ansible/roles/status/tasks/main.yml
-
+5 -0networks/remote/ansible/roles/stop/tasks/main.yml
-
+4 -0networks/remote/ansible/roles/unsafe_reset/tasks/main.yml
-
+11 -0networks/remote/ansible/start.yml
-
+11 -0networks/remote/ansible/status.yml
-
+11 -0networks/remote/ansible/stop.yml
-
+4 -0networks/remote/terraform/.gitignore
-
+33 -0networks/remote/terraform/README.rst
-
+28 -0networks/remote/terraform/cluster/main.tf
-
+15 -0networks/remote/terraform/cluster/outputs.tf
-
+25 -0networks/remote/terraform/cluster/variables.tf
-
+37 -0networks/remote/terraform/main.tf
-
+14 -14node/node.go
-
+4 -3p2p/fuzz.go
-
+12 -16p2p/node_info.go
-
+1 -1p2p/peer.go
-
+2 -2p2p/peer_set_test.go
-
+2 -2p2p/peer_test.go
-
+3 -4p2p/pex/addrbook.go
-
+4 -5p2p/pex/pex_reactor.go
-
+3 -3p2p/pex/pex_reactor_test.go
-
+7 -7p2p/switch.go
-
+2 -2p2p/switch_test.go
-
+4 -5p2p/test_util.go
-
+1 -1rpc/client/helpers.go
-
+4 -4rpc/client/helpers_test.go
-
+9 -7rpc/client/mock/status_test.go
-
+2 -2rpc/client/rpc_test.go
-
+1 -1rpc/core/abci.go
-
+0 -1rpc/core/net.go
-
+1 -1rpc/core/routes.go
-
+31 -25rpc/core/status.go
-
+15 -11rpc/core/types/responses.go
-
+1 -2rpc/lib/client/ws_client.go
-
+1 -1test/README.md
-
+7 -7test/p2p/atomic_broadcast/test.sh
-
+2 -2test/p2p/basic/test.sh
-
+4 -4test/p2p/fast_sync/check_peer.sh
-
+2 -2test/p2p/kill_all/check_peers.sh
-
+6 -6test/persist/test_failure_indices.sh
+ 18
- 3
CHANGELOG.md
View File
+ 1
- 0
DOCKER/.gitignore
View File
| @ -0,0 +1 @@ | |||
| tendermint | |||
+ 24
- 30
DOCKER/Dockerfile
View File
| @ -1,45 +1,39 @@ | |||
| FROM alpine:3.7 | |||
| MAINTAINER Greg Szabo <greg@tendermint.com> | |||
| # This is the release of tendermint to pull in. | |||
| ENV TM_VERSION 0.17.1 | |||
| ENV TM_SHA256SUM d57008c63d2d9176861137e38ed203da486febf20ae7d388fb810a75afff8f24 | |||
| # Tendermint will be looking for genesis file in /tendermint (unless you change | |||
| # `genesis_file` in config.toml). You can put your config.toml and private | |||
| # validator file into /tendermint. | |||
| # Tendermint will be looking for the genesis file in /tendermint/config/genesis.json | |||
| # (unless you change `genesis_file` in config.toml). You can put your config.toml and | |||
| # private validator file into /tendermint/config. | |||
| # | |||
| # The /tendermint/data dir is used by tendermint to store state. | |||
| ENV DATA_ROOT /tendermint | |||
| ENV TMHOME $DATA_ROOT | |||
| # Set user right away for determinism | |||
| RUN addgroup tmuser && \ | |||
| adduser -S -G tmuser tmuser | |||
| # Create directory for persistence and give our user ownership | |||
| RUN mkdir -p $DATA_ROOT && \ | |||
| chown -R tmuser:tmuser $DATA_ROOT | |||
| ENV TMHOME /tendermint | |||
| # OS environment setup | |||
| # Set user right away for determinism, create directory for persistence and give our user ownership | |||
| # jq and curl used for extracting `pub_key` from private validator while | |||
| # deploying tendermint with Kubernetes. It is nice to have bash so the users | |||
| # could execute bash commands. | |||
| RUN apk add --no-cache bash curl jq | |||
| RUN apk update && \ | |||
| apk upgrade && \ | |||
| apk --no-cache add curl jq bash && \ | |||
| addgroup tmuser && \ | |||
| adduser -S -G tmuser tmuser -h "$TMHOME" | |||
| RUN apk add --no-cache openssl && \ | |||
| wget https://github.com/tendermint/tendermint/releases/download/v${TM_VERSION}/tendermint_${TM_VERSION}_linux_amd64.zip && \ | |||
| echo "${TM_SHA256SUM} tendermint_${TM_VERSION}_linux_amd64.zip" | sha256sum -c && \ | |||
| unzip -d /bin tendermint_${TM_VERSION}_linux_amd64.zip && \ | |||
| apk del openssl && \ | |||
| rm -f tendermint_${TM_VERSION}_linux_amd64.zip | |||
| # Run the container with tmuser by default. (UID=100, GID=1000) | |||
| USER tmuser | |||
| # Expose the data directory as a volume since there's mutable state in there | |||
| VOLUME $DATA_ROOT | |||
| VOLUME [ $TMHOME ] | |||
| # p2p port | |||
| EXPOSE 46656 | |||
| # rpc port | |||
| EXPOSE 46657 | |||
| WORKDIR $TMHOME | |||
| ENTRYPOINT ["tendermint"] | |||
| # p2p and rpc port | |||
| EXPOSE 46656 46657 | |||
| ENTRYPOINT ["/usr/bin/tendermint"] | |||
| CMD ["node", "--moniker=`hostname`"] | |||
| STOPSIGNAL SIGTERM | |||
| ARG BINARY=tendermint | |||
| COPY $BINARY /usr/bin/tendermint | |||
+ 13
- 12
Gopkg.lock
View File
+ 3
- 5
Gopkg.toml
View File
+ 46
- 1
Makefile
View File
+ 6
- 3
README.md
View File
+ 27
- 18
benchmarks/codec_test.go
View File
+ 476
- 466
benchmarks/proto/test.pb.go
File diff suppressed because it is too large
View File
+ 5
- 1
benchmarks/proto/test.proto
View File
+ 11
- 4
cmd/tendermint/commands/init.go
View File
+ 124
- 40
cmd/tendermint/commands/testnet.go
View File
+ 11
- 6
config/toml.go
View File
+ 1
- 1
consensus/common_test.go
View File
+ 2
- 1
consensus/replay_file.go
View File
+ 24
- 0
consensus/types/height_vote_set.go
View File
consensus/types/reactor.go → consensus/types/peer_round_state.go
View File
consensus/types/state.go → consensus/types/round_state.go
View File
+ 95
- 0
consensus/types/round_state_test.go
View File
| @ -0,0 +1,95 @@ | |||
| package types | |||
| import ( | |||
| "testing" | |||
| "time" | |||
| "github.com/tendermint/go-amino" | |||
| "github.com/tendermint/go-crypto" | |||
| "github.com/tendermint/tendermint/types" | |||
| cmn "github.com/tendermint/tmlibs/common" | |||
| ) | |||
| func BenchmarkRoundStateDeepCopy(b *testing.B) { | |||
| b.StopTimer() | |||
| // Random validators | |||
| nval, ntxs := 100, 100 | |||
| vset, _ := types.RandValidatorSet(nval, 1) | |||
| precommits := make([]*types.Vote, nval) | |||
| blockID := types.BlockID{ | |||
| Hash: cmn.RandBytes(20), | |||
| PartsHeader: types.PartSetHeader{ | |||
| Hash: cmn.RandBytes(20), | |||
| }, | |||
| } | |||
| sig := crypto.SignatureEd25519{} | |||
| for i := 0; i < nval; i++ { | |||
| precommits[i] = &types.Vote{ | |||
| ValidatorAddress: types.Address(cmn.RandBytes(20)), | |||
| Timestamp: time.Now(), | |||
| BlockID: blockID, | |||
| Signature: sig, | |||
| } | |||
| } | |||
| txs := make([]types.Tx, ntxs) | |||
| for i := 0; i < ntxs; i++ { | |||
| txs[i] = cmn.RandBytes(100) | |||
| } | |||
| // Random block | |||
| block := &types.Block{ | |||
| Header: &types.Header{ | |||
| ChainID: cmn.RandStr(12), | |||
| Time: time.Now(), | |||
| LastBlockID: blockID, | |||
| LastCommitHash: cmn.RandBytes(20), | |||
| DataHash: cmn.RandBytes(20), | |||
| ValidatorsHash: cmn.RandBytes(20), | |||
| ConsensusHash: cmn.RandBytes(20), | |||
| AppHash: cmn.RandBytes(20), | |||
| LastResultsHash: cmn.RandBytes(20), | |||
| EvidenceHash: cmn.RandBytes(20), | |||
| }, | |||
| Data: &types.Data{ | |||
| Txs: txs, | |||
| }, | |||
| Evidence: types.EvidenceData{}, | |||
| LastCommit: &types.Commit{ | |||
| BlockID: blockID, | |||
| Precommits: precommits, | |||
| }, | |||
| } | |||
| parts := block.MakePartSet(4096) | |||
| // Random Proposal | |||
| proposal := &types.Proposal{ | |||
| Timestamp: time.Now(), | |||
| BlockPartsHeader: types.PartSetHeader{ | |||
| Hash: cmn.RandBytes(20), | |||
| }, | |||
| POLBlockID: blockID, | |||
| Signature: sig, | |||
| } | |||
| // Random HeightVoteSet | |||
| // TODO: hvs := | |||
| rs := &RoundState{ | |||
| StartTime: time.Now(), | |||
| CommitTime: time.Now(), | |||
| Validators: vset, | |||
| Proposal: proposal, | |||
| ProposalBlock: block, | |||
| ProposalBlockParts: parts, | |||
| LockedBlock: block, | |||
| LockedBlockParts: parts, | |||
| ValidBlock: block, | |||
| ValidBlockParts: parts, | |||
| Votes: nil, // TODO | |||
| LastCommit: nil, // TODO | |||
| LastValidators: vset, | |||
| } | |||
| b.StartTimer() | |||
| for i := 0; i < b.N; i++ { | |||
| amino.DeepCopy(rs) | |||
| } | |||
| } | |||
+ 12
- 0
consensus/types/wire.go
View File
| @ -0,0 +1,12 @@ | |||
| package types | |||
| import ( | |||
| "github.com/tendermint/go-amino" | |||
| "github.com/tendermint/go-crypto" | |||
| ) | |||
| var cdc = amino.NewCodec() | |||
| func init() { | |||
| crypto.RegisterAmino(cdc) | |||
| } | |||
+ 1
- 2
consensus/wal_generator.go
View File
+ 68
- 0
docker-compose.yml
View File
| @ -0,0 +1,68 @@ | |||
| version: '3' | |||
| services: | |||
| node0: | |||
| container_name: node0 | |||
| image: "tendermint/localnode" | |||
| ports: | |||
| - "46656-46657:46656-46657" | |||
| environment: | |||
| - ID=0 | |||
| - LOG=${LOG:-tendermint.log} | |||
| volumes: | |||
| - ${FOLDER:-./build}:/tendermint:Z | |||
| networks: | |||
| localnet: | |||
| ipv4_address: 192.167.10.2 | |||
| node1: | |||
| container_name: node1 | |||
| image: "tendermint/localnode" | |||
| ports: | |||
| - "46659-46660:46656-46657" | |||
| environment: | |||
| - ID=1 | |||
| - LOG=${LOG:-tendermint.log} | |||
| volumes: | |||
| - ${FOLDER:-./build}:/tendermint:Z | |||
| networks: | |||
| localnet: | |||
| ipv4_address: 192.167.10.3 | |||
| node2: | |||
| container_name: node2 | |||
| image: "tendermint/localnode" | |||
| environment: | |||
| - ID=2 | |||
| - LOG=${LOG:-tendermint.log} | |||
| ports: | |||
| - "46661-46662:46656-46657" | |||
| volumes: | |||
| - ${FOLDER:-./build}:/tendermint:Z | |||
| networks: | |||
| localnet: | |||
| ipv4_address: 192.167.10.4 | |||
| node3: | |||
| container_name: node3 | |||
| image: "tendermint/localnode" | |||
| environment: | |||
| - ID=3 | |||
| - LOG=${LOG:-tendermint.log} | |||
| ports: | |||
| - "46663-46664:46656-46657" | |||
| volumes: | |||
| - ${FOLDER:-./build}:/tendermint:Z | |||
| networks: | |||
| localnet: | |||
| ipv4_address: 192.167.10.5 | |||
| networks: | |||
| localnet: | |||
| driver: bridge | |||
| ipam: | |||
| driver: default | |||
| config: | |||
| - | |||
| subnet: 192.167.10.0/16 | |||
+ 32
- 36
docs/getting-started.rst
View File
+ 1
- 1
docs/how-to-read-logs.rst
View File
+ 3
- 2
docs/install.rst
View File
+ 2
- 2
docs/specification/genesis.rst
View File
+ 69
- 0
docs/specification/new-spec/abci.md
View File
| @ -0,0 +1,69 @@ | |||
| # Application Blockchain Interface (ABCI) | |||
| ABCI is the interface between Tendermint (a state-machine replication engine) | |||
| and an application (the actual state machine). | |||
| The ABCI message types are defined in a [protobuf | |||
| file](https://github.com/tendermint/abci/blob/master/types/types.proto). | |||
| For full details on the ABCI message types and protocol, see the [ABCI | |||
| specificaiton](https://github.com/tendermint/abci/blob/master/specification.rst). | |||
| For additional details on server implementation, see the [ABCI | |||
| readme](https://github.com/tendermint/abci#implementation). | |||
| Here we provide some more details around the use of ABCI by Tendermint and | |||
| clarify common "gotchas". | |||
| ## Validator Updates | |||
| Updates to the Tendermint validator set can be made by returning `Validator` | |||
| objects in the `ResponseBeginBlock`: | |||
| ``` | |||
| message Validator { | |||
| bytes pub_key = 1; | |||
| int64 power = 2; | |||
| } | |||
| ``` | |||
| The `pub_key` is the Amino encoded public key for the validator. For details on | |||
| Amino encoded public keys, see the [section of the encoding spec](./encoding.md#public-key-cryptography). | |||
| For Ed25519 pubkeys, the Amino prefix is always "1624DE6220". For example, the 32-byte Ed25519 pubkey | |||
| `76852933A4686A721442E931A8415F62F5F1AEDF4910F1F252FB393F74C40C85` would be | |||
| Amino encoded as | |||
| `1624DE622076852933A4686A721442E931A8415F62F5F1AEDF4910F1F252FB393F74C40C85` | |||
| (Note: in old versions of Tendermint (pre-v0.19.0), the pubkey is just prefixed with a | |||
| single type byte, so for ED25519 we'd have `pub_key = 0x1 | pub`) | |||
| The `power` is the new voting power for the validator, with the | |||
| following rules: | |||
| - power must be non-negative | |||
| - if power is 0, the validator must already exist, and will be removed from the | |||
| validator set | |||
| - if power is non-0: | |||
| - if the validator does not already exist, it will be added to the validator | |||
| set with the given power | |||
| - if the validator does already exist, its power will be adjusted to the given power | |||
| ## Query | |||
| Query is a generic message type with lots of flexibility to enable diverse sets | |||
| of queries from applications. Tendermint has no requirements from the Query | |||
| message for normal operation - that is, the ABCI app developer need not implement Query functionality if they do not wish too. | |||
| That said, Tendermint makes a number of queries to support some optional | |||
| features. These are: | |||
| ### Peer Filtering | |||
| When Tendermint connects to a peer, it sends two queries to the ABCI application | |||
| using the following paths, with no additional data: | |||
| - `/p2p/filter/addr/<IP:PORT>`, where `<IP:PORT>` denote the IP address and | |||
| the port of the connection | |||
| - `p2p/filter/pubkey/<ID>`, where `<ID>` is the peer node ID (ie. the | |||
| pubkey.Address() for the peer's PubKey) | |||
| If either of these queries return a non-zero ABCI code, Tendermint will refuse | |||
| to connect to the peer. | |||
+ 223
- 109
docs/specification/new-spec/encoding.md
View File
+ 2
- 2
docs/specification/new-spec/p2p/peer.md
View File
+ 246
- 0
docs/specification/new-spec/pre-amino.md
View File
| @ -0,0 +1,246 @@ | |||
| # Tendermint Encoding (Pre-Amino) | |||
| ## PubKeys and Addresses | |||
| PubKeys are prefixed with a type-byte, followed by the raw bytes of the public | |||
| key. | |||
| Two keys are supported with the following type bytes: | |||
| ``` | |||
| TypeByteEd25519 = 0x1 | |||
| TypeByteSecp256k1 = 0x2 | |||
| ``` | |||
| ``` | |||
| // TypeByte: 0x1 | |||
| type PubKeyEd25519 [32]byte | |||
| func (pub PubKeyEd25519) Encode() []byte { | |||
| return 0x1 | pub | |||
| } | |||
| func (pub PubKeyEd25519) Address() []byte { | |||
| // NOTE: the length (0x0120) is also included | |||
| return RIPEMD160(0x1 | 0x0120 | pub) | |||
| } | |||
| // TypeByte: 0x2 | |||
| // NOTE: OpenSSL compressed pubkey (x-cord with 0x2 or 0x3) | |||
| type PubKeySecp256k1 [33]byte | |||
| func (pub PubKeySecp256k1) Encode() []byte { | |||
| return 0x2 | pub | |||
| } | |||
| func (pub PubKeySecp256k1) Address() []byte { | |||
| return RIPEMD160(SHA256(pub)) | |||
| } | |||
| ``` | |||
| See https://github.com/tendermint/go-crypto/blob/v0.5.0/pub_key.go for more. | |||
| ## Binary Serialization (go-wire) | |||
| Tendermint aims to encode data structures in a manner similar to how the corresponding Go structs | |||
| are laid out in memory. | |||
| Variable length items are length-prefixed. | |||
| While the encoding was inspired by Go, it is easily implemented in other languages as well, given its intuitive design. | |||
| XXX: This is changing to use real varints and 4-byte-prefixes. | |||
| See https://github.com/tendermint/go-wire/tree/sdk2. | |||
| ### Fixed Length Integers | |||
| Fixed length integers are encoded in Big-Endian using the specified number of bytes. | |||
| So `uint8` and `int8` use one byte, `uint16` and `int16` use two bytes, | |||
| `uint32` and `int32` use 3 bytes, and `uint64` and `int64` use 4 bytes. | |||
| Negative integers are encoded via twos-complement. | |||
| Examples: | |||
| ```go | |||
| encode(uint8(6)) == [0x06] | |||
| encode(uint32(6)) == [0x00, 0x00, 0x00, 0x06] | |||
| encode(int8(-6)) == [0xFA] | |||
| encode(int32(-6)) == [0xFF, 0xFF, 0xFF, 0xFA] | |||
| ``` | |||
| ### Variable Length Integers | |||
| Variable length integers are encoded as length-prefixed Big-Endian integers. | |||
| The length-prefix consists of a single byte and corresponds to the length of the encoded integer. | |||
| Negative integers are encoded by flipping the leading bit of the length-prefix to a `1`. | |||
| Zero is encoded as `0x00`. It is not length-prefixed. | |||
| Examples: | |||
| ```go | |||
| encode(uint(6)) == [0x01, 0x06] | |||
| encode(uint(70000)) == [0x03, 0x01, 0x11, 0x70] | |||
| encode(int(-6)) == [0xF1, 0x06] | |||
| encode(int(-70000)) == [0xF3, 0x01, 0x11, 0x70] | |||
| encode(int(0)) == [0x00] | |||
| ``` | |||
| ### Strings | |||
| An encoded string is length-prefixed followed by the underlying bytes of the string. | |||
| The length-prefix is itself encoded as an `int`. | |||
| The empty string is encoded as `0x00`. It is not length-prefixed. | |||
| Examples: | |||
| ```go | |||
| encode("") == [0x00] | |||
| encode("a") == [0x01, 0x01, 0x61] | |||
| encode("hello") == [0x01, 0x05, 0x68, 0x65, 0x6C, 0x6C, 0x6F] | |||
| encode("¥") == [0x01, 0x02, 0xC2, 0xA5] | |||
| ``` | |||
| ### Arrays (fixed length) | |||
| An encoded fix-lengthed array is the concatenation of the encoding of its elements. | |||
| There is no length-prefix. | |||
| Examples: | |||
| ```go | |||
| encode([4]int8{1, 2, 3, 4}) == [0x01, 0x02, 0x03, 0x04] | |||
| encode([4]int16{1, 2, 3, 4}) == [0x00, 0x01, 0x00, 0x02, 0x00, 0x03, 0x00, 0x04] | |||
| encode([4]int{1, 2, 3, 4}) == [0x01, 0x01, 0x01, 0x02, 0x01, 0x03, 0x01, 0x04] | |||
| encode([2]string{"abc", "efg"}) == [0x01, 0x03, 0x61, 0x62, 0x63, 0x01, 0x03, 0x65, 0x66, 0x67] | |||
| ``` | |||
| ### Slices (variable length) | |||
| An encoded variable-length array is length-prefixed followed by the concatenation of the encoding of | |||
| its elements. | |||
| The length-prefix is itself encoded as an `int`. | |||
| An empty slice is encoded as `0x00`. It is not length-prefixed. | |||
| Examples: | |||
| ```go | |||
| encode([]int8{}) == [0x00] | |||
| encode([]int8{1, 2, 3, 4}) == [0x01, 0x04, 0x01, 0x02, 0x03, 0x04] | |||
| encode([]int16{1, 2, 3, 4}) == [0x01, 0x04, 0x00, 0x01, 0x00, 0x02, 0x00, 0x03, 0x00, 0x04] | |||
| encode([]int{1, 2, 3, 4}) == [0x01, 0x04, 0x01, 0x01, 0x01, 0x02, 0x01, 0x03, 0x01, 0x4] | |||
| encode([]string{"abc", "efg"}) == [0x01, 0x02, 0x01, 0x03, 0x61, 0x62, 0x63, 0x01, 0x03, 0x65, 0x66, 0x67] | |||
| ``` | |||
| ### BitArray | |||
| BitArray is encoded as an `int` of the number of bits, and with an array of `uint64` to encode | |||
| value of each array element. | |||
| ```go | |||
| type BitArray struct { | |||
| Bits int | |||
| Elems []uint64 | |||
| } | |||
| ``` | |||
| ### Time | |||
| Time is encoded as an `int64` of the number of nanoseconds since January 1, 1970, | |||
| rounded to the nearest millisecond. | |||
| Times before then are invalid. | |||
| Examples: | |||
| ```go | |||
| encode(time.Time("Jan 1 00:00:00 UTC 1970")) == [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00] | |||
| encode(time.Time("Jan 1 00:00:01 UTC 1970")) == [0x00, 0x00, 0x00, 0x00, 0x3B, 0x9A, 0xCA, 0x00] // 1,000,000,000 ns | |||
| encode(time.Time("Mon Jan 2 15:04:05 -0700 MST 2006")) == [0x0F, 0xC4, 0xBB, 0xC1, 0x53, 0x03, 0x12, 0x00] | |||
| ``` | |||
| ### Structs | |||
| An encoded struct is the concatenation of the encoding of its elements. | |||
| There is no length-prefix. | |||
| Examples: | |||
| ```go | |||
| type MyStruct struct{ | |||
| A int | |||
| B string | |||
| C time.Time | |||
| } | |||
| encode(MyStruct{4, "hello", time.Time("Mon Jan 2 15:04:05 -0700 MST 2006")}) == | |||
| [0x01, 0x04, 0x01, 0x05, 0x68, 0x65, 0x6C, 0x6C, 0x6F, 0x0F, 0xC4, 0xBB, 0xC1, 0x53, 0x03, 0x12, 0x00] | |||
| ``` | |||
| ## Merkle Trees | |||
| Simple Merkle trees are used in numerous places in Tendermint to compute a cryptographic digest of a data structure. | |||
| RIPEMD160 is always used as the hashing function. | |||
| The function `SimpleMerkleRoot` is a simple recursive function defined as follows: | |||
| ```go | |||
| func SimpleMerkleRoot(hashes [][]byte) []byte{ | |||
| switch len(hashes) { | |||
| case 0: | |||
| return nil | |||
| case 1: | |||
| return hashes[0] | |||
| default: | |||
| left := SimpleMerkleRoot(hashes[:(len(hashes)+1)/2]) | |||
| right := SimpleMerkleRoot(hashes[(len(hashes)+1)/2:]) | |||
| return RIPEMD160(append(left, right)) | |||
| } | |||
| } | |||
| ``` | |||
| Note: we abuse notion and call `SimpleMerkleRoot` with arguments of type `struct` or type `[]struct`. | |||
| For `struct` arguments, we compute a `[][]byte` by sorting elements of the `struct` according to | |||
| field name and then hashing them. | |||
| For `[]struct` arguments, we compute a `[][]byte` by hashing the individual `struct` elements. | |||
| ## JSON (TMJSON) | |||
| Signed messages (eg. votes, proposals) in the consensus are encoded in TMJSON, rather than TMBIN. | |||
| TMJSON is JSON where `[]byte` are encoded as uppercase hex, rather than base64. | |||
| When signing, the elements of a message are sorted by key and the sorted message is embedded in an | |||
| outer JSON that includes a `chain_id` field. | |||
| We call this encoding the CanonicalSignBytes. For instance, CanonicalSignBytes for a vote would look | |||
| like: | |||
| ```json | |||
| {"chain_id":"my-chain-id","vote":{"block_id":{"hash":DEADBEEF,"parts":{"hash":BEEFDEAD,"total":3}},"height":3,"round":2,"timestamp":1234567890, "type":2} | |||
| ``` | |||
| Note how the fields within each level are sorted. | |||
| ## Other | |||
| ### MakeParts | |||
| Encode an object using TMBIN and slice it into parts. | |||
| ```go | |||
| MakeParts(object, partSize) | |||
| ``` | |||
| ### Part | |||
| ```go | |||
| type Part struct { | |||
| Index int | |||
| Bytes byte[] | |||
| Proof byte[] | |||
| } | |||
| ``` | |||
+ 125
- 0
docs/specification/new-spec/scripts/crypto.go
View File
| @ -0,0 +1,125 @@ | |||
| package main | |||
| import ( | |||
| "fmt" | |||
| crypto "github.com/tendermint/go-crypto" | |||
| ) | |||
| // SECRET | |||
| var SECRET = []byte("some secret") | |||
| func printEd() { | |||
| priv := crypto.GenPrivKeyEd25519FromSecret(SECRET) | |||
| pub := priv.PubKey().(crypto.PubKeyEd25519) | |||
| sig := priv.Sign([]byte("hello")).(crypto.SignatureEd25519) | |||
| name := "tendermint/PubKeyEd25519" | |||
| length := len(pub[:]) | |||
| fmt.Println("### PubKeyEd25519") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Printf("// Name: %s\n", name) | |||
| fmt.Printf("// PrefixBytes: 0x%X \n", pub.Bytes()[:4]) | |||
| fmt.Printf("// Length: 0x%X \n", length) | |||
| fmt.Println("// Notes: raw 32-byte Ed25519 pubkey") | |||
| fmt.Println("type PubKeyEd25519 [32]byte") | |||
| fmt.Println("") | |||
| fmt.Println(`func (pubkey PubKeyEd25519) Address() []byte { | |||
| // NOTE: hash of the Amino encoded bytes! | |||
| return RIPEMD160(AminoEncode(pubkey)) | |||
| }`) | |||
| fmt.Println("```") | |||
| fmt.Println("") | |||
| fmt.Printf("For example, the 32-byte Ed25519 pubkey `%X` would be encoded as `%X`.\n\n", pub[:], pub.Bytes()) | |||
| fmt.Printf("The address would then be `RIPEMD160(0x%X)` or `%X`\n", pub.Bytes(), pub.Address()) | |||
| fmt.Println("") | |||
| name = "tendermint/SignatureKeyEd25519" | |||
| length = len(sig[:]) | |||
| fmt.Println("### SignatureEd25519") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Printf("// Name: %s\n", name) | |||
| fmt.Printf("// PrefixBytes: 0x%X \n", sig.Bytes()[:4]) | |||
| fmt.Printf("// Length: 0x%X \n", length) | |||
| fmt.Println("// Notes: raw 64-byte Ed25519 signature") | |||
| fmt.Println("type SignatureEd25519 [64]byte") | |||
| fmt.Println("```") | |||
| fmt.Println("") | |||
| fmt.Printf("For example, the 64-byte Ed25519 signature `%X` would be encoded as `%X`\n", sig[:], sig.Bytes()) | |||
| fmt.Println("") | |||
| name = "tendermint/PrivKeyEd25519" | |||
| fmt.Println("### PrivKeyEd25519") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Println("// Name:", name) | |||
| fmt.Println("// Notes: raw 32-byte priv key concatenated to raw 32-byte pub key") | |||
| fmt.Println("type PrivKeyEd25519 [64]byte") | |||
| fmt.Println("```") | |||
| } | |||
| func printSecp() { | |||
| priv := crypto.GenPrivKeySecp256k1FromSecret(SECRET) | |||
| pub := priv.PubKey().(crypto.PubKeySecp256k1) | |||
| sig := priv.Sign([]byte("hello")).(crypto.SignatureSecp256k1) | |||
| name := "tendermint/PubKeySecp256k1" | |||
| length := len(pub[:]) | |||
| fmt.Println("### PubKeySecp256k1") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Printf("// Name: %s\n", name) | |||
| fmt.Printf("// PrefixBytes: 0x%X \n", pub.Bytes()[:4]) | |||
| fmt.Printf("// Length: 0x%X \n", length) | |||
| fmt.Println("// Notes: OpenSSL compressed pubkey prefixed with 0x02 or 0x03") | |||
| fmt.Println("type PubKeySecp256k1 [33]byte") | |||
| fmt.Println("") | |||
| fmt.Println(`func (pubkey PubKeySecp256k1) Address() []byte { | |||
| // NOTE: hash of the raw pubkey bytes (not Amino encoded!). | |||
| // Compatible with Bitcoin addresses. | |||
| return RIPEMD160(SHA256(pubkey[:])) | |||
| }`) | |||
| fmt.Println("```") | |||
| fmt.Println("") | |||
| fmt.Printf("For example, the 33-byte Secp256k1 pubkey `%X` would be encoded as `%X`\n\n", pub[:], pub.Bytes()) | |||
| fmt.Printf("The address would then be `RIPEMD160(SHA256(0x%X))` or `%X`\n", pub[:], pub.Address()) | |||
| fmt.Println("") | |||
| name = "tendermint/SignatureKeySecp256k1" | |||
| fmt.Println("### SignatureSecp256k1") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Printf("// Name: %s\n", name) | |||
| fmt.Printf("// PrefixBytes: 0x%X \n", sig.Bytes()[:4]) | |||
| fmt.Printf("// Length: Variable\n") | |||
| fmt.Printf("// Encoding prefix: Variable\n") | |||
| fmt.Println("// Notes: raw bytes of the Secp256k1 signature") | |||
| fmt.Println("type SignatureSecp256k1 []byte") | |||
| fmt.Println("```") | |||
| fmt.Println("") | |||
| fmt.Printf("For example, the Secp256k1 signature `%X` would be encoded as `%X`\n", []byte(sig[:]), sig.Bytes()) | |||
| fmt.Println("") | |||
| name = "tendermint/PrivKeySecp256k1" | |||
| fmt.Println("### PrivKeySecp256k1") | |||
| fmt.Println("") | |||
| fmt.Println("```") | |||
| fmt.Println("// Name:", name) | |||
| fmt.Println("// Notes: raw 32-byte priv key") | |||
| fmt.Println("type PrivKeySecp256k1 [32]byte") | |||
| fmt.Println("```") | |||
| } | |||
| func main() { | |||
| printEd() | |||
| fmt.Println("") | |||
| printSecp() | |||
| } | |||
+ 0
- 3
docs/specification/new-spec/state.md
View File
+ 0
- 80
docs/specification/new-spec/wire.go
View File
| @ -1,80 +0,0 @@ | |||
| package main | |||
| import ( | |||
| "fmt" | |||
| "time" | |||
| wire "github.com/tendermint/go-wire" | |||
| ) | |||
| func main() { | |||
| encode(uint8(6)) | |||
| encode(uint32(6)) | |||
| encode(int8(-6)) | |||
| encode(int32(-6)) | |||
| Break() | |||
| encode(uint(6)) | |||
| encode(uint(70000)) | |||
| encode(int(0)) | |||
| encode(int(-6)) | |||
| encode(int(-70000)) | |||
| Break() | |||
| encode("") | |||
| encode("a") | |||
| encode("hello") | |||
| encode("¥") | |||
| Break() | |||
| encode([4]int8{1, 2, 3, 4}) | |||
| encode([4]int16{1, 2, 3, 4}) | |||
| encode([4]int{1, 2, 3, 4}) | |||
| encode([2]string{"abc", "efg"}) | |||
| Break() | |||
| encode([]int8{}) | |||
| encode([]int8{1, 2, 3, 4}) | |||
| encode([]int16{1, 2, 3, 4}) | |||
| encode([]int{1, 2, 3, 4}) | |||
| encode([]string{"abc", "efg"}) | |||
| Break() | |||
| timeFmt := "Mon Jan 2 15:04:05 -0700 MST 2006" | |||
| t1, _ := time.Parse(timeFmt, timeFmt) | |||
| n := (t1.UnixNano() / 1000000.) * 1000000 | |||
| encode(n) | |||
| encode(t1) | |||
| t2, _ := time.Parse(timeFmt, "Thu Jan 1 00:00:00 -0000 UTC 1970") | |||
| encode(t2) | |||
| t2, _ = time.Parse(timeFmt, "Thu Jan 1 00:00:01 -0000 UTC 1970") | |||
| fmt.Println("N", t2.UnixNano()) | |||
| encode(t2) | |||
| Break() | |||
| encode(struct { | |||
| A int | |||
| B string | |||
| C time.Time | |||
| }{ | |||
| 4, | |||
| "hello", | |||
| t1, | |||
| }) | |||
| } | |||
| func encode(i interface{}) { | |||
| Println(wire.BinaryBytes(i)) | |||
| } | |||
| func Println(b []byte) { | |||
| s := "[" | |||
| for _, x := range b { | |||
| s += fmt.Sprintf("0x%.2X, ", x) | |||
| } | |||
| s = s[:len(s)-2] + "]" | |||
| fmt.Println(s) | |||
| } | |||
| func Break() { | |||
| fmt.Println("------") | |||
| } | |||
+ 60
- 67
docs/using-tendermint.rst
View File
+ 1
- 1
lite/client/provider.go
View File
+ 7
- 0
networks/local/Makefile
View File
| @ -0,0 +1,7 @@ | |||
| # Makefile for the "localnode" docker image. | |||
| all: | |||
| docker build --tag tendermint/localnode localnode | |||
| .PHONY: all | |||
+ 40
- 0
networks/local/README.rst
View File
| @ -0,0 +1,40 @@ | |||
| localnode | |||
| ========= | |||
| It is assumed that you have already `setup docker <https://docs.docker.com/engine/installation/>`__. | |||
| Description | |||
| ----------- | |||
| Image for local testnets. | |||
| Add the tendermint binary to the image by attaching it in a folder to the `/tendermint` mount point. | |||
| It assumes that the configuration was created by the `tendermint testnet` command and it is also attached to the `/tendermint` mount point. | |||
| Example: | |||
| This example builds a linux tendermint binary under the `build/` folder, creates tendermint configuration for a single-node validator and runs the node: | |||
| ``` | |||
| cd $GOPATH/src/github.com/tendermint/tendermint | |||
| #Build binary | |||
| make build-linux | |||
| #Create configuration | |||
| docker run -e LOG="stdout" -v `pwd`/build:/tendermint tendermint/localnode testnet --o . --v 1 | |||
| #Run the node | |||
| docker run -v `pwd`/build:/tendermint tendermint/localnode | |||
| ``` | |||
| Logging | |||
| ------- | |||
| Log is saved under the attached volume, in the `tendermint.log` file. If the `LOG` environment variable is set to `stdout` at start, the log is not saved, but printed on the screen. | |||
| Special binaries | |||
| ---------------- | |||
| If you have multiple binaries with different names, you can specify which one to run with the BINARY environment variable. The path of the binary is relative to the attached volume. | |||
| docker-compose.yml | |||
| ================== | |||
| This file creates a 4-node network using the localnode image. The nodes of the network are exposed to the host machine on ports 46656-46657, 46659-46660, 46661-46662, 46663-46664 respectively. | |||
+ 16
- 0
networks/local/localnode/Dockerfile
View File
| @ -0,0 +1,16 @@ | |||
| FROM alpine:3.7 | |||
| MAINTAINER Greg Szabo <greg@tendermint.com> | |||
| RUN apk update && \ | |||
| apk upgrade && \ | |||
| apk --no-cache add curl jq file | |||
| VOLUME [ /tendermint ] | |||
| WORKDIR /tendermint | |||
| EXPOSE 46656 46657 | |||
| ENTRYPOINT ["/usr/bin/wrapper.sh"] | |||
| CMD ["node", "--proxy_app dummy"] | |||
| STOPSIGNAL SIGTERM | |||
| COPY wrapper.sh /usr/bin/wrapper.sh | |||
+ 35
- 0
networks/local/localnode/wrapper.sh
View File
| @ -0,0 +1,35 @@ | |||
| #!/usr/bin/env sh | |||
| ## | |||
| ## Input parameters | |||
| ## | |||
| BINARY=/tendermint/${BINARY:-tendermint} | |||
| ID=${ID:-0} | |||
| LOG=${LOG:-tendermint.log} | |||
| ## | |||
| ## Assert linux binary | |||
| ## | |||
| if ! [ -f "${BINARY}" ]; then | |||
| echo "The binary $(basename "${BINARY}") cannot be found. Please add the binary to the shared folder. Please use the BINARY environment variable if the name of the binary is not 'tendermint' E.g.: -e BINARY=tendermint_my_test_version" | |||
| exit 1 | |||
| fi | |||
| BINARY_CHECK="$(file "$BINARY" | grep 'ELF 64-bit LSB executable, x86-64')" | |||
| if [ -z "${BINARY_CHECK}" ]; then | |||
| echo "Binary needs to be OS linux, ARCH amd64" | |||
| exit 1 | |||
| fi | |||
| ## | |||
| ## Run binary with all parameters | |||
| ## | |||
| export TMHOME="/tendermint/node${ID}" | |||
| if [ -d "`dirname ${TMHOME}/${LOG}`" ]; then | |||
| "$BINARY" "$@" | tee "${TMHOME}/${LOG}" | |||
| else | |||
| "$BINARY" "$@" | |||
| fi | |||
| chmod 777 -R /tendermint | |||
+ 1
- 0
networks/remote/ansible/.gitignore
View File
| @ -0,0 +1 @@ | |||
| *.retry | |||
+ 52
- 0
networks/remote/ansible/README.rst
View File
| @ -0,0 +1,52 @@ | |||
| Using Ansible | |||
| ============= | |||
| .. figure:: assets/a_plus_t.png | |||
| :alt: Ansible plus Tendermint | |||
| Ansible plus Tendermint | |||
| The playbooks in `the ansible directory <https://github.com/tendermint/tendermint/tree/master/networks/remote/ansible>`__ | |||
| run ansible `roles <http://www.ansible.com/>`__ to configure the sentry node architecture. | |||
| Prerequisites | |||
| ------------- | |||
| - Install `Ansible 2.0 or higher <https://www.ansible.com>`__ on a linux machine. | |||
| - Create a `DigitalOcean API token <https://cloud.digitalocean.com/settings/api/tokens>`__ with read and write capability. | |||
| - Create SSH keys | |||
| - Install the python dopy package (for the digital_ocean.py script) | |||
| Build | |||
| ----- | |||
| :: | |||
| export DO_API_TOKEN="abcdef01234567890abcdef01234567890" | |||
| export SSH_KEY_FILE="$HOME/.ssh/id_rsa.pub" | |||
| ansible-playbook -i inventory/digital_ocean.py -l sentrynet install.yml | |||
| # The scripts assume that you have your validator set up already. | |||
| # You can create the folder structure for the sentry nodes using `tendermint testnet`. | |||
| # For example: tendermint testnet --v 0 --n 4 --o build/ | |||
| # Then copy your genesis.json and modify the config.toml as you see fit. | |||
| # Reconfig the sentry nodes with a new BINARY and the configuration files from the build folder: | |||
| ansible-playbook -i inventory/digital_ocean.py -l sentrynet config.yml -e BINARY=`pwd`/build/tendermint -e CONFIGDIR=`pwd`/build | |||
| Shipping logs to logz.io | |||
| ------------------------ | |||
| Logz.io is an Elastic stack (Elastic search, Logstash and Kibana) service provider. You can set up your nodes to log there automatically. Create an account and get your API key from the notes on `this page <https://app.logz.io/#/dashboard/data-sources/Filebeat>`__. | |||
| :: | |||
| yum install systemd-devel || echo "This will only work on RHEL-based systems." | |||
| apt-get install libsystemd-dev || echo "This will only work on Debian-based systems." | |||
| go get github.com/mheese/journalbeat | |||
| ansible-playbook -i inventory/digital_ocean.py -l sentrynet logzio.yml -e LOGZIO_TOKEN=ABCDEFGHIJKLMNOPQRSTUVWXYZ012345 | |||
+ 4
- 0
networks/remote/ansible/ansible.cfg
View File
| @ -0,0 +1,4 @@ | |||
| [defaults] | |||
| retry_files_enabled = False | |||
| host_key_checking = False | |||
BIN
networks/remote/ansible/assets/a_plus_t.png
View File
| Before | After |
|---|---|
|
|
| Width: 250 | Height: 100 | Size: 14 KiB |
+ 18
- 0
networks/remote/ansible/config.yml
View File
| @ -0,0 +1,18 @@ | |||
| --- | |||
| #Requires BINARY and CONFIGDIR variables set. | |||
| #N=4 hosts by default. | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: yes | |||
| vars: | |||
| - service: tendermint | |||
| - N: 4 | |||
| roles: | |||
| - stop | |||
| - config | |||
| - unsafe_reset | |||
| - start | |||
+ 11
- 0
networks/remote/ansible/install.yml
View File
| @ -0,0 +1,11 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - install | |||
+ 675
- 0
networks/remote/ansible/inventory/COPYING
View File
| @ -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>. | |||
+ 34
- 0
networks/remote/ansible/inventory/digital_ocean.ini
View File
| @ -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 = {} | |||
+ 471
- 0
networks/remote/ansible/inventory/digital_ocean.py
View File
| @ -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() | |||
+ 14
- 0
networks/remote/ansible/logzio.yml
View File
| @ -0,0 +1,14 @@ | |||
| --- | |||
| #Note: You need to add LOGZIO_TOKEN variable with your API key. Like tihs: ansible-playbook -e LOGZIO_TOKEN=ABCXYZ123456 | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| - JOURNALBEAT_BINARY: "{{lookup('env', 'GOPATH')}}/bin/journalbeat" | |||
| roles: | |||
| - logzio | |||
+ 14
- 0
networks/remote/ansible/reset.yml
View File
| @ -0,0 +1,14 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - stop | |||
| - unsafe_reset | |||
| - start | |||
+ 12
- 0
networks/remote/ansible/restart.yml
View File
| @ -0,0 +1,12 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - stop | |||
| - start | |||
+ 17
- 0
networks/remote/ansible/roles/config/tasks/main.yml
View File
| @ -0,0 +1,17 @@ | |||
| --- | |||
| - name: Copy binary | |||
| copy: | |||
| src: "{{BINARY}}" | |||
| dest: /usr/bin | |||
| mode: 0755 | |||
| - name: Copy config | |||
| when: item <= N and ansible_hostname == 'sentrynet-node' ~ item | |||
| copy: | |||
| src: "{{CONFIGDIR}}/node{{item}}/" | |||
| dest: "/home/{{service}}/.{{service}}/" | |||
| owner: "{{service}}" | |||
| group: "{{service}}" | |||
| loop: [ 0, 1, 2, 3, 4, 5, 6, 7 ] | |||
+ 5
- 0
networks/remote/ansible/roles/install/handlers/main.yml
View File
| @ -0,0 +1,5 @@ | |||
| --- | |||
| - name: reload services | |||
| systemd: "name={{service}} daemon_reload=yes enabled=yes" | |||
+ 15
- 0
networks/remote/ansible/roles/install/tasks/main.yml
View File
| @ -0,0 +1,15 @@ | |||
| --- | |||
| - name: Create service group | |||
| group: "name={{service}}" | |||
| - name: Create service user | |||
| user: "name={{service}} group={{service}} home=/home/{{service}}" | |||
| - name: Change user folder to more permissive | |||
| file: "path=/home/{{service}} mode=0755" | |||
| - name: Create service | |||
| template: "src=systemd.service.j2 dest=/etc/systemd/system/{{service}}.service" | |||
| notify: reload services | |||
+ 17
- 0
networks/remote/ansible/roles/install/templates/systemd.service.j2
View File
| @ -0,0 +1,17 @@ | |||
| [Unit] | |||
| Description={{service}} | |||
| Requires=network-online.target | |||
| After=network-online.target | |||
| [Service] | |||
| Restart=on-failure | |||
| User={{service}} | |||
| Group={{service}} | |||
| PermissionsStartOnly=true | |||
| ExecStart=/usr/bin/tendermint node --proxy_app=dummy | |||
| ExecReload=/bin/kill -HUP $MAINPID | |||
| KillSignal=SIGTERM | |||
| [Install] | |||
| WantedBy=multi-user.target | |||
+ 15
- 0
networks/remote/ansible/roles/logzio/files/journalbeat.service
View File
| @ -0,0 +1,15 @@ | |||
| [Unit] | |||
| Description=journalbeat | |||
| #propagates activation, deactivation and activation fails. | |||
| Requires=network-online.target | |||
| After=network-online.target | |||
| [Service] | |||
| Restart=on-failure | |||
| ExecStart=/usr/bin/journalbeat -c /etc/journalbeat/journalbeat.yml -path.home /usr/share/journalbeat -path.config /etc/journalbeat -path.data /var/lib/journalbeat -path.logs /var/log/journalbeat | |||
| Restart=always | |||
| [Install] | |||
| WantedBy=multi-user.target | |||
+ 8
- 0
networks/remote/ansible/roles/logzio/handlers/main.yml
View File
| @ -0,0 +1,8 @@ | |||
| --- | |||
| - name: reload daemon | |||
| command: "systemctl daemon-reload" | |||
| - name: restart journalbeat | |||
| service: name=journalbeat state=restarted | |||
+ 27
- 0
networks/remote/ansible/roles/logzio/tasks/main.yml
View File
| @ -0,0 +1,27 @@ | |||
| --- | |||
| - name: Copy journalbeat binary | |||
| copy: src="{{JOURNALBEAT_BINARY}}" dest=/usr/bin/journalbeat mode=0755 | |||
| notify: restart journalbeat | |||
| - name: Create folders | |||
| file: "path={{item}} state=directory recurse=yes" | |||
| with_items: | |||
| - /etc/journalbeat | |||
| - /etc/pki/tls/certs | |||
| - /usr/share/journalbeat | |||
| - /var/log/journalbeat | |||
| - name: Copy journalbeat config | |||
| template: src=journalbeat.yml.j2 dest=/etc/journalbeat/journalbeat.yml mode=0600 | |||
| notify: restart journalbeat | |||
| - name: Get server certificate for Logz.io | |||
| get_url: "url=https://raw.githubusercontent.com/logzio/public-certificates/master/COMODORSADomainValidationSecureServerCA.crt force=yes dest=/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt" | |||
| - name: Copy journalbeat service config | |||
| copy: src=journalbeat.service dest=/etc/systemd/system/journalbeat.service | |||
| notify: | |||
| - reload daemon | |||
| - restart journalbeat | |||
+ 342
- 0
networks/remote/ansible/roles/logzio/templates/journalbeat.yml.j2
View File
| @ -0,0 +1,342 @@ | |||
| #======================== Journalbeat Configuration ============================ | |||
| journalbeat: | |||
| # What position in journald to seek to at start up | |||
| # options: cursor, tail, head (defaults to tail) | |||
| #seek_position: tail | |||
| # If seek_position is set to cursor and seeking to cursor fails | |||
| # fall back to this method. If set to none will it will exit | |||
| # options: tail, head, none (defaults to tail) | |||
| #cursor_seek_fallback: tail | |||
| # Store the cursor of the successfully published events | |||
| #write_cursor_state: true | |||
| # Path to the file to store the cursor (defaults to ".journalbeat-cursor-state") | |||
| #cursor_state_file: .journalbeat-cursor-state | |||
| # How frequently should we save the cursor to disk (defaults to 5s) | |||
| #cursor_flush_period: 5s | |||
| # Path to the file to store the queue of events pending (defaults to ".journalbeat-pending-queue") | |||
| #pending_queue.file: .journalbeat-pending-queue | |||
| # How frequently should we save the queue to disk (defaults to 1s). | |||
| # Pending queue represents the WAL of events queued to be published | |||
| # or being published and waiting for acknowledgement. In case of a | |||
| # regular restart of journalbeat all the events not yet acknowledged | |||
| # will be flushed to disk during the shutdown. | |||
| # In case of disaster most probably journalbeat won't get a chance to shutdown | |||
| # itself gracefully and this flush period option will serve you as a | |||
| # backup creation frequency option. | |||
| #pending_queue.flush_period: 1s | |||
| # Lowercase and remove leading underscores, e.g. "_MESSAGE" -> "message" | |||
| # (defaults to false) | |||
| #clean_field_names: false | |||
| # All journal entries are strings by default. You can try to convert them to numbers. | |||
| # (defaults to false) | |||
| #convert_to_numbers: false | |||
| # Store all the fields of the Systemd Journal entry under this field | |||
| # Can be almost any string suitable to be a field name of an ElasticSearch document. | |||
| # Dots can be used to create nested fields. | |||
| # Two exceptions: | |||
| # - no repeated dots; | |||
| # - no trailing dots, e.g. "journal..field_name." will fail | |||
| # (defaults to "" hence stores on the upper level of the event) | |||
| #move_metadata_to_field: "" | |||
| # Specific units to monitor. | |||
| units: ["{{service}}.service"] | |||
| # Specify Journal paths to open. You can pass an array of paths to Systemd Journal paths. | |||
| # If you want to open Journal from directory just pass an array consisting of one element | |||
| # representing the path. See: https://www.freedesktop.org/software/systemd/man/sd_journal_open.html | |||
| # By default this setting is empty thus journalbeat will attempt to find all journal files automatically | |||
| #journal_paths: ["/var/log/journal"] | |||
| #default_type: journal | |||
| #================================ General ====================================== | |||
| # The name of the shipper that publishes the network data. It can be used to group | |||
| # all the transactions sent by a single shipper in the web interface. | |||
| # If this options is not defined, the hostname is used. | |||
| #name: journalbeat | |||
| # The tags of the shipper are included in their own field with each | |||
| # transaction published. Tags make it easy to group servers by different | |||
| # logical properties. | |||
| tags: ["{{service}}"] | |||
| # Optional fields that you can specify to add additional information to the | |||
| # output. Fields can be scalar values, arrays, dictionaries, or any nested | |||
| # combination of these. | |||
| fields: | |||
| logzio_codec: plain | |||
| token: {{LOGZIO_TOKEN}} | |||
| # If this option is set to true, the custom fields are stored as top-level | |||
| # fields in the output document instead of being grouped under a fields | |||
| # sub-dictionary. Default is false. | |||
| fields_under_root: true | |||
| # Internal queue size for single events in processing pipeline | |||
| #queue_size: 1000 | |||
| # The internal queue size for bulk events in the processing pipeline. | |||
| # Do not modify this value. | |||
| #bulk_queue_size: 0 | |||
| # Sets the maximum number of CPUs that can be executing simultaneously. The | |||
| # default is the number of logical CPUs available in the system. | |||
| #max_procs: | |||
| #================================ Processors =================================== | |||
| # Processors are used to reduce the number of fields in the exported event or to | |||
| # enhance the event with external metadata. This section defines a list of | |||
| # processors that are applied one by one and the first one receives the initial | |||
| # event: | |||
| # | |||
| # event -> filter1 -> event1 -> filter2 ->event2 ... | |||
| # | |||
| # The supported processors are drop_fields, drop_event, include_fields, and | |||
| # add_cloud_metadata. | |||
| # | |||
| # For example, you can use the following processors to keep the fields that | |||
| # contain CPU load percentages, but remove the fields that contain CPU ticks | |||
| # values: | |||
| # | |||
| processors: | |||
| #- include_fields: | |||
| # fields: ["cpu"] | |||
| - drop_fields: | |||
| fields: ["beat.name", "beat.version", "logzio_codec", "SYSLOG_IDENTIFIER", "SYSLOG_FACILITY", "PRIORITY"] | |||
| # | |||
| # The following example drops the events that have the HTTP response code 200: | |||
| # | |||
| #processors: | |||
| #- drop_event: | |||
| # when: | |||
| # equals: | |||
| # http.code: 200 | |||
| # | |||
| # The following example enriches each event with metadata from the cloud | |||
| # provider about the host machine. It works on EC2, GCE, and DigitalOcean. | |||
| # | |||
| #processors: | |||
| #- add_cloud_metadata: | |||
| # | |||
| #================================ Outputs ====================================== | |||
| # Configure what outputs to use when sending the data collected by the beat. | |||
| # Multiple outputs may be used. | |||
| #----------------------------- Logstash output --------------------------------- | |||
| output.logstash: | |||
| # Boolean flag to enable or disable the output module. | |||
| enabled: true | |||
| # The Logstash hosts | |||
| hosts: ["listener.logz.io:5015"] | |||
| # Number of workers per Logstash host. | |||
| #worker: 1 | |||
| # Set gzip compression level. | |||
| #compression_level: 3 | |||
| # Optional load balance the events between the Logstash hosts | |||
| #loadbalance: true | |||
| # Number of batches to be send asynchronously to logstash while processing | |||
| # new batches. | |||
| #pipelining: 0 | |||
| # Optional index name. The default index name is set to name of the beat | |||
| # in all lowercase. | |||
| #index: 'beatname' | |||
| # SOCKS5 proxy server URL | |||
| #proxy_url: socks5://user:password@socks5-server:2233 | |||
| # Resolve names locally when using a proxy server. Defaults to false. | |||
| #proxy_use_local_resolver: false | |||
| # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. | |||
| ssl.enabled: true | |||
| # Configure SSL verification mode. If `none` is configured, all server hosts | |||
| # and certificates will be accepted. In this mode, SSL based connections are | |||
| # susceptible to man-in-the-middle attacks. Use only for testing. Default is | |||
| # `full`. | |||
| ssl.verification_mode: full | |||
| # List of supported/valid TLS versions. By default all TLS versions 1.0 up to | |||
| # 1.2 are enabled. | |||
| #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] | |||
| # Optional SSL configuration options. SSL is off by default. | |||
| # List of root certificates for HTTPS server verifications | |||
| ssl.certificate_authorities: ["/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt"] | |||
| # Certificate for SSL client authentication | |||
| #ssl.certificate: "/etc/pki/client/cert.pem" | |||
| # Client Certificate Key | |||
| #ssl.key: "/etc/pki/client/cert.key" | |||
| # Optional passphrase for decrypting the Certificate Key. | |||
| #ssl.key_passphrase: '' | |||
| # Configure cipher suites to be used for SSL connections | |||
| #ssl.cipher_suites: [] | |||
| # Configure curve types for ECDHE based cipher suites | |||
| #ssl.curve_types: [] | |||
| #------------------------------- File output ----------------------------------- | |||
| #output.file: | |||
| # Boolean flag to enable or disable the output module. | |||
| #enabled: true | |||
| # Path to the directory where to save the generated files. The option is | |||
| # mandatory. | |||
| #path: "/tmp/beatname" | |||
| # Name of the generated files. The default is `beatname` and it generates | |||
| # files: `beatname`, `beatname.1`, `beatname.2`, etc. | |||
| #filename: beatname | |||
| # Maximum size in kilobytes of each file. When this size is reached, and on | |||
| # every beatname restart, the files are rotated. The default value is 10240 | |||
| # kB. | |||
| #rotate_every_kb: 10000 | |||
| # Maximum number of files under path. When this number of files is reached, | |||
| # the oldest file is deleted and the rest are shifted from last to first. The | |||
| # default is 7 files. | |||
| #number_of_files: 7 | |||
| #----------------------------- Console output --------------------------------- | |||
| #output.console: | |||
| # Boolean flag to enable or disable the output module. | |||
| #enabled: true | |||
| # Pretty print json event | |||
| #pretty: false | |||
| #================================= Paths ====================================== | |||
| # The home path for the beatname installation. This is the default base path | |||
| # for all other path settings and for miscellaneous files that come with the | |||
| # distribution (for example, the sample dashboards). | |||
| # If not set by a CLI flag or in the configuration file, the default for the | |||
| # home path is the location of the binary. | |||
| #path.home: | |||
| # The configuration path for the beatname installation. This is the default | |||
| # base path for configuration files, including the main YAML configuration file | |||
| # and the Elasticsearch template file. If not set by a CLI flag or in the | |||
| # configuration file, the default for the configuration path is the home path. | |||
| #path.config: ${path.home} | |||
| # The data path for the beatname installation. This is the default base path | |||
| # for all the files in which beatname needs to store its data. If not set by a | |||
| # CLI flag or in the configuration file, the default for the data path is a data | |||
| # subdirectory inside the home path. | |||
| #path.data: ${path.home}/data | |||
| # The logs path for a beatname installation. This is the default location for | |||
| # the Beat's log files. If not set by a CLI flag or in the configuration file, | |||
| # the default for the logs path is a logs subdirectory inside the home path. | |||
| #path.logs: ${path.home}/logs | |||
| #============================== Dashboards ===================================== | |||
| # These settings control loading the sample dashboards to the Kibana index. Loading | |||
| # the dashboards is disabled by default and can be enabled either by setting the | |||
| # options here, or by using the `-setup` CLI flag. | |||
| #dashboards.enabled: false | |||
| # The URL from where to download the dashboards archive. By default this URL | |||
| # has a value which is computed based on the Beat name and version. For released | |||
| # versions, this URL points to the dashboard archive on the artifacts.elastic.co | |||
| # website. | |||
| #dashboards.url: | |||
| # The directory from where to read the dashboards. It is used instead of the URL | |||
| # when it has a value. | |||
| #dashboards.directory: | |||
| # The file archive (zip file) from where to read the dashboards. It is used instead | |||
| # of the URL when it has a value. | |||
| #dashboards.file: | |||
| # If this option is enabled, the snapshot URL is used instead of the default URL. | |||
| #dashboards.snapshot: false | |||
| # The URL from where to download the snapshot version of the dashboards. By default | |||
| # this has a value which is computed based on the Beat name and version. | |||
| #dashboards.snapshot_url | |||
| # In case the archive contains the dashboards from multiple Beats, this lets you | |||
| # select which one to load. You can load all the dashboards in the archive by | |||
| # setting this to the empty string. | |||
| #dashboards.beat: beatname | |||
| # The name of the Kibana index to use for setting the configuration. Default is ".kibana" | |||
| #dashboards.kibana_index: .kibana | |||
| # The Elasticsearch index name. This overwrites the index name defined in the | |||
| # dashboards and index pattern. Example: testbeat-* | |||
| #dashboards.index: | |||
| #================================ Logging ====================================== | |||
| # There are three options for the log output: syslog, file, stderr. | |||
| # Under Windows systems, the log files are per default sent to the file output, | |||
| # under all other system per default to syslog. | |||
| # Sets log level. The default log level is info. | |||
| # Available log levels are: critical, error, warning, info, debug | |||
| #logging.level: info | |||
| # Enable debug output for selected components. To enable all selectors use ["*"] | |||
| # Other available selectors are "beat", "publish", "service" | |||
| # Multiple selectors can be chained. | |||
| #logging.selectors: [ ] | |||
| # Send all logging output to syslog. The default is false. | |||
| #logging.to_syslog: true | |||
| # If enabled, beatname periodically logs its internal metrics that have changed | |||
| # in the last period. For each metric that changed, the delta from the value at | |||
| # the beginning of the period is logged. Also, the total values for | |||
| # all non-zero internal metrics are logged on shutdown. The default is true. | |||
| #logging.metrics.enabled: true | |||
| # The period after which to log the internal metrics. The default is 30s. | |||
| #logging.metrics.period: 30s | |||
| # Logging to rotating files files. Set logging.to_files to false to disable logging to | |||
| # files. | |||
| logging.to_files: true | |||
| logging.files: | |||
| # Configure the path where the logs are written. The default is the logs directory | |||
| # under the home path (the binary location). | |||
| #path: /var/log/beatname | |||
| # The name of the files where the logs are written to. | |||
| #name: beatname | |||
| # Configure log file size limit. If limit is reached, log file will be | |||
| # automatically rotated | |||
| #rotateeverybytes: 10485760 # = 10MB | |||
| # Number of rotated log files to keep. Oldest files will be deleted first. | |||
| #keepfiles: 7 | |||
+ 5
- 0
networks/remote/ansible/roles/start/tasks/main.yml
View File
| @ -0,0 +1,5 @@ | |||
| --- | |||
| - name: start service | |||
| service: "name={{service}} state=started" | |||
+ 10
- 0
networks/remote/ansible/roles/status/tasks/main.yml
View File
| @ -0,0 +1,10 @@ | |||
| --- | |||
| - name: application service status | |||
| command: "service {{service}} status" | |||
| changed_when: false | |||
| register: status | |||
| - name: Result | |||
| debug: var=status.stdout_lines | |||
+ 5
- 0
networks/remote/ansible/roles/stop/tasks/main.yml
View File
| @ -0,0 +1,5 @@ | |||
| --- | |||
| - name: stop service | |||
| service: "name={{service}} state=stopped" | |||
+ 4
- 0
networks/remote/ansible/roles/unsafe_reset/tasks/main.yml
View File
| @ -0,0 +1,4 @@ | |||
| - command: "{{service}} unsafe_reset_all {{ (service != 'tendermint') | ternary('node','') }} --home /home/{{service}}/.{{service}}" | |||
| become_user: "{{service}}" | |||
| become: yes | |||
+ 11
- 0
networks/remote/ansible/start.yml
View File
| @ -0,0 +1,11 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - start | |||
+ 11
- 0
networks/remote/ansible/status.yml
View File
| @ -0,0 +1,11 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - status | |||
+ 11
- 0
networks/remote/ansible/stop.yml
View File
| @ -0,0 +1,11 @@ | |||
| --- | |||
| - hosts: all | |||
| user: root | |||
| any_errors_fatal: true | |||
| gather_facts: no | |||
| vars: | |||
| - service: tendermint | |||
| roles: | |||
| - stop | |||
+ 4
- 0
networks/remote/terraform/.gitignore
View File
| @ -0,0 +1,4 @@ | |||
| .terraform | |||
| terraform.tfstate | |||
| terraform.tfstate.backup | |||
| terraform.tfstate.d | |||
+ 33
- 0
networks/remote/terraform/README.rst
View File
| @ -0,0 +1,33 @@ | |||
| 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 SSH_KEY_FILE="$HOME/.ssh/id_rsa.pub" | |||
| terraform init | |||
| terraform apply -var DO_API_TOKEN="$DO_API_TOKEN" -var SSH_KEY_FILE="$SSH_KEY_FILE" | |||
| At the end you will get a list of IP addresses that belongs to your new droplets. | |||
| Destroy | |||
| ------- | |||
| Run the below: | |||
| :: | |||
| terraform destroy | |||
+ 28
- 0
networks/remote/terraform/cluster/main.tf
View File
| @ -0,0 +1,28 @@ | |||
| resource "digitalocean_tag" "cluster" { | |||
| name = "${var.name}" | |||
| } | |||
| resource "digitalocean_ssh_key" "cluster" { | |||
| name = "${var.name}" | |||
| public_key = "${file(var.ssh_key)}" | |||
| } | |||
| 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 { | |||
| timeout = "30s" | |||
| } | |||
| } | |||
+ 15
- 0
networks/remote/terraform/cluster/outputs.tf
View File
| @ -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}"] | |||
| } | |||
+ 25
- 0
networks/remote/terraform/cluster/variables.tf
View File
| @ -0,0 +1,25 @@ | |||
| variable "name" { | |||
| description = "The cluster name, e.g cdn" | |||
| } | |||
| variable "regions" { | |||
| description = "Regions to launch in" | |||
| type = "list" | |||
| default = ["AMS2", "FRA1", "LON1", "NYC3", "SFO2", "SGP1", "TOR1"] | |||
| } | |||
| variable "ssh_key" { | |||
| description = "SSH 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 | |||
| } | |||
+ 37
- 0
networks/remote/terraform/main.tf
View File
| @ -0,0 +1,37 @@ | |||
| #Terraform Configuration | |||
| variable "DO_API_TOKEN" { | |||
| description = "DigitalOcean Access Token" | |||
| } | |||
| variable "TESTNET_NAME" { | |||
| description = "Name of the testnet" | |||
| default = "sentrynet" | |||
| } | |||
| variable "SSH_KEY_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_key = "${var.SSH_KEY_FILE}" | |||
| servers = "${var.SERVERS}" | |||
| } | |||
| output "public_ips" { | |||
| value = "${module.cluster.public_ips}" | |||
| } | |||