stellar-core-backup 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6155ceecee6b25c41b2489c31f68781f194eb610
+  data.tar.gz: b3a29645d58230e00a817c3a80152d193e597295
+SHA512:
+  metadata.gz: 86ea0707f78f3e6002d93cfecf50781c6cd8688861b14fbddff685d531c28f14a46e81b6164468f3cdc1f551c5962f5c28e03f872b603b743fe1fe49807edcef
+  data.tar.gz: 0070acbe82d29852503aad3d990e58572d6cdab4368da34a6f7585188d47d2ab4117ac8ffc6f4d450148174fa3ed79c913c9988bace047a2d873e48057a195b2

data/.gitignore

@@ -0,0 +1,18 @@
+stellar-core-backup-*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+out.sql
+.DS_Store
+*.swp

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# How to contribute
+
+Your contributions to the Stellar network will help improve the world’s financial
+infrastructure, faster.
+
+We want to make it as easy as possible to contribute changes that
+help the Stellar network grow and thrive. There are a few guidelines that we
+ask contributors to follow so that we can merge your changes quickly.
+
+## Getting Started
+
+* Create a GitHub issue for your contribution, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce if it is a bug.
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Please avoid working directly on the `master` branch.
+* Make sure you have added the necessary tests for your changes, and make sure all tests pass.
+
+## Submitting Changes
+
+* <a href="https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form">Sign the Contributor License Agreement</a>.
+* All content, comments, and pull requests must follow the [Stellar Community Guidelines](https://www.stellar.org/community-guidelines/). 
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the [stellar-core-backup repository](https://github.com/stellar/stellar-core-backup) in the Stellar organization.
+ * Include a descriptive [commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).
+ * Changes contributed via pull request should focus on a single issue at a time.
+ * Rebase your local changes against the master branch. Resolve any conflicts that arise.
+ 
+At this point you're waiting on us. We like to at least comment on pull requests within three 
+business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+## Making Trivial Changes
+
+### Documentation
+For changes of a trivial nature to comments and documentation, it is not
+always necessary to create a new GitHub issue. In this case, it is
+appropriate to start the first line of a commit with 'doc' instead of
+an issue number. 
+
+# Additional Resources
+
+* [Bug tracker (Github)](https://github.com/stellar/stellar-core-backup/issues)
+* <a href="https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form">Contributor License Agreement</a>
+* [Readme for stellar-core-backup](https://github.com/stellar/stellar-core-backup/blob/master/README.md)
+* #dev channel on [Slack](http://slack.stellar.org)
+
+
+This document is inspired by:
+
+https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md 
+
+https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md 
+
+https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2015] [Stellar Development Foundation]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,92 @@
+# StellarCoreBackup
+
+This application is a simple backup/restore library which creates offline/cold backups and pushes them to S3. Backups can be restored automatically but the bucket data directory needs to be emptied first as stellar-core-backup doesn't overwrite existing data. This clean out can be done manually or by using the `--clean` option with `--restore`.
+
+All options are configurable in a config file passed in with the `--config` argument.
+
+## Assumptions about environment
+
+At present `stellar-core-backup` makes a few assumptions about the environment and it expects stellar-core to be installed using the official Debian binary packages available at [https://github.com/stellar/packages](). In the event that your own environment differs from this, `stellar-core-backup` will likely break.
+
+AWS credentials can be exported as environment variables or permissions can be granted by an IAM instance role.
+
+## GPG Backup Signing and Verification
+
+To ensure archive consistency and integrity `stellar-core-backup` can use GPG signing and verification. This is enabled by default but can be disabled using the `--no-verify` argument.
+
+The GPG key needs to be installed first which can be done using the `--getkey` command.
+
+We are using SKS Keyservers for public key distribution available at hkp://pool.sks-keyservers.net.
+
+## Configuration
+
+| config param | description |
+|--------------|-------------|
+|working_dir| Path to working directory which will hold temporary files, needs sufficient space to store and untar 1 backup|
+|core_config| Path to stellar-core configuration file of the node we are backing up, retrieves database credentials, etc.|
+|backup_dir| Path to directory which will hold the final backup|
+|s3_region| S3 region|
+|s3_bucket| S3 bucket to store/retrieve buckets to/from|
+|s3_path| S3 Path prefix, can be used for backing up multiple core nodes to the same bucket|
+|gpg_key| GPG key ID used for signing and verification of the stellar-core backups. The provided ID is the Stellar public key|
+
+## Usage As Command Line Tool
+
+##### install public GPG key
+
+```
+stellar-core-backup --config /etc/stellar/stellar-core-backup.conf --getkey
+```
+
+##### backup data, create SHA256SUMS file, GPG sign it and push to S3
+
+```
+stellar-core-backup --config /etc/stellar/stellar-core-backup.conf --backup
+```
+
+##### restore latest backup from S3 with auto-clean
+
+```
+stellar-core-backup --config /etc/stellar/stellar-core-backup.conf --restore --clean
+```
+
+##### list arbitrary number of backups in S3 bucket
+
+```
+stellar-core-backup --config /etc/stellar/stellar-core-backup.conf --list [num]
+```
+
+##### restore from selected backup file with auto-clean
+
+```
+stellar-core-backup --config /etc/stellar/stellar-core-backup.conf --restore --clean --select [bucket-prefix/core-backup-name]
+```
+
+## Usage as a Library
+
+```ruby
+require 'stellar-core-backup'
+
+if options[:backup] then
+  scb = StellarCoreBackup::Job.new(
+    :config => '/etc/stellar/stellar-core-backup.conf',
+    :type   => 'backup'
+  )
+  scb.run()
+elsif options[:restore]
+  scb = StellarCoreBackup::Job.new(
+    :config => '/etc/stellar/stellar-core-backup.conf',
+    :type   => 'restore'
+  )
+  scb.run()
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/stellar-core-backup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,9 @@
+task :build do
+  system "gem build stellar-core-backup.gemspec"
+end
+
+task :install => :build do
+  system "gem install --local --user-install stellar-core-backup"
+  system "sudo gem install --local stellar-core-backup"
+end
+

data/bin/stellar-core-backup

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# requires IAM role/Environment variables for aws auth
+require 'stellar-core-backup'
+require 'optparse'
+
+
+options = { listlen: 1, verify: true}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+  opts.on("-b", "--backup", "cold backup stellar-core") do |backup|
+    options[:type] = 'backup'
+  end
+  opts.on("-c CONFIG", "--config", "configuration file to use") do |config|
+    options[:config] = config
+  end
+  opts.on("-C", "--clean", "auto-clean buckets directory") do |clean|
+    options[:clean] = 'clean'
+  end
+  opts.on("-g", "--getkey", "load or update the configured public GPG key") do |getkey|
+    options[:type] = 'getkey'
+  end
+    opts.on("-l", "--list [NUM]", Numeric, "list latest backup or display NUM backups") do |list|
+    options[:type] = 'list'
+    options[:listlen] = list if list
+  end
+  opts.on("-r", "--restore", "offline restore, uses latest backup") do |restore|
+    options[:type] = 'restore'
+  end
+  opts.on("-s", "--select backup_file", "select archive for point in time restore") do |select|
+    options[:select] = select
+  end
+  opts.on("--no-verify", "don't PGP sign backed up shasum file or verify restore files integrity (default on)") do |notverify|
+    options.delete(:verify)
+  end
+end.parse!
+
+if ! options[:type] then
+  puts "error: no operation specified; exiting\n"
+else
+  scb = StellarCoreBackup::Job.new(options)
+  scb.run()
+end
+
+exit
+

data/config/sample.yaml

@@ -0,0 +1,7 @@
+working_dir: /mnt/xvdf
+core_config: /etc/stellar/stellar-core.cfg
+backup_dir: /var/lib/stellar/backups
+s3_region: us-east-1
+s3_bucket: stellar002-core-backups
+s3_path: testnet
+gpg_key: 'D99E1D15ACC358AB'