aws_minecraft 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b2ac622c911990d68a2392c6e8f5ba779420a40
+  data.tar.gz: 5463cc914cb80dd64576b1984e7e49f2b2eac973
+SHA512:
+  metadata.gz: e0e76fe8c5691fcb5dc8c541152b5f8acdc8111c1d64bf0d6c19dee444b981590438b875156b0dc650c421269983df4b9021fda9518355b32adf1fd5bbaeb027
+  data.tar.gz: a6016d147a7f053addf791ebb7304cc76fa784935b5de75a98b56314f263a5d7380d9b6e23f8fa00fc40911fcd3e33f891f05a8a73acb246dfc94457405e35b8

data/.gitignore

@@ -0,0 +1,7 @@
+*.db
+.tags*
+pkg/
+drop/*
+.DS_Store
+cfg/minecraft.key
+coverage

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 2.3.1
+env:
+  - AWS_REGION=eu-central-1

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rspec', require: 'spec'
+gem 'thor'
+gem 'aws-sdk', '~> 2'
+gem 'rubocop'
+gem 'rake'
+gem 'sqlite3'
+gem 'net-ssh'
+gem 'net-scp'
+gem 'fakefs', require: 'fakefs/safe'

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    aws-sdk (2.6.2)
+      aws-sdk-resources (= 2.6.2)
+    aws-sdk-core (2.6.2)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.6.2)
+      aws-sdk-core (= 2.6.2)
+    diff-lcs (1.2.5)
+    fakefs (0.9.1)
+    jmespath (1.3.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.2.0)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 2)
+  fakefs
+  net-scp
+  net-ssh
+  rake
+  rspec
+  rubocop
+  sqlite3
+  thor
+
+BUNDLED WITH
+   1.13.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-infinity Gergely Brautigam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+Minecraft Server In The Cloud
+=============================
+
+This is a fully provisinable Minecraft server on a configurable EC2 instance under AWS. This Gem
+provides the ability to manage both, an EC2 instance and a Minecraft server which is executed on
+that EC2 instance.
+
+# Reasons
+
+I have a fully operational Minecraft server at home running on my laptop. My problem was, that
+I don't have the infrastructure or the processing power, neither the networking capabilities to host
+a server which can handle more than 2 people. All the other solutions out there, costed a lot of
+money and investment.
+
+All I needed was a good enough server for at least 5-6 hours / week. This is a rough estimate.
+With this kind of usage, my cost, with an t2.large EC2 instance would be around ~3-5 USD / month!
+This is a price none of the services currently providing could beat any time soon. A t2.large can
+handle a fair amount of people without breaking a sweat. I can shut it down, and start it up again
+at any given time. If I'm not using it for a week, it just sits there, and will not incur any costs.
+This is again, something that no competitors would be able to match.
+
+The only thing that competitors are matching is maybe ease of usage. And hence, the reason for this
+Gem. This CLI ruby gem, will make it so that it's easy, and straightforward to manage an instance
+from the command line and to manage a Minecraft server from the command line as well. And here is
+how you do that.
+
+# Setup
+
+## AWS
+
+In order for this to work, you'll have to set up an AWS account, which you can do here:[AWS Account Creation](Create Account - Amazon Web Services).
+Once that is done, you will need to save your api creds. After that, you'll need to set up the CLI
+tool of AWS in order for your environment to be correctly configured for this Gem's CLI tool. To
+do that, run through this document: [AWS CLI Setup Runbook](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).
+
+TL;DR; => Run `aws configure` and enter your `AWS Access Key ID`, `AWS Secret Access Key`, and default
+`region` to use. The region should be a place near you so latency won't be an issue. If you are using
+multiple profiles, please set the environment property accordingly `export AWS_DEFAULT_PROFILE=user2`.
+
+Test your CLI by running an AWS command like this one: `aws ec2 describe-instances --output table --region us-east-1`.
+
+## AWS Minecraft Gem
+
+### Instance
+
+The instance configuration that is used can be found here: [ec2_config](cfg/ec2_config.json). This
+will configure and create an EC2 instance for you. Couple of things to note here. The instance uses
+an ssh key import which is than used to execute commands on the instance. So in order for this to work
+you'll have to create an SSH key with `ssh-keygen`. Enter your **PUBLIC** key, something like `/Users/youruser/.ssh/ida_rsa.pub`,
+into the file called `Minecraft.key` as a *base64* encoded string.
+
+AWS Minecraft uses tmux to run a Minecraft server in the background. The tmux is a multiplexer client
+and will allow us to attach to it later on, if the user would like to run some commands on the server.
+
+All this is pre installed on the starting server by this script: [user_data](cfg/user_data.sh).
+
+### AWS Minecraft
+
+AWS Minecraft uses a sqlite3 database to store some information about the instance that the user just
+created. This is so, that it's readily available should any query occur so as to not continuously
+query amazon for information about the instance.
+
+The [config.yml](cfg/config.yml) file configures this gem. Currently, two settings are available. A
+Logger level setting information which can be overridden any time. And second, it's the location from
+where files will be uploaded to the instance like, Minecraft.jar or craftbukkit.jar. These than will
+be executed during starting a Minecraft server.
+
+### DB
+
+The database also needs to be initialised, for this, there is a cli command called init-db. To
+initialise the database, run `bundle exec ./bin/aws_Minecraft.rb init-db`. This will create a
+Minecraft.db file. In case there is anything wrong and you would like to create a new instance, and
+you are sure that the one which is saved, is not the correct one, just delete this file and run
+`init-db` again.
+
+# Usage
+
+The following commands are available from the CLI tool:
+```
+Commands:
+  aws_minecraft.rb attach-to-server    # Attach to a Minecraft server.
+  aws_minecraft.rb create-instance     # Creates an EC2 instance.
+  aws_minecraft.rb help [COMMAND]      # Describe available commands or one specific command
+  aws_minecraft.rb init-db             # Initialize the databse.
+  aws_minecraft.rb ssh                 # SSH into a running EC2 instance.
+  aws_minecraft.rb start-instance      # Starts an EC2 instance.
+  aws_minecraft.rb start-server NAME   # Starts a Minecraft server.
+  aws_minecraft.rb stop-instance       # Stops an EC2 instance.
+  aws_minecraft.rb stop-server         # Stops a Minecraft server.
+  aws_minecraft.rb terminate-instance  # Terminates an EC2 instance.
+  aws_minecraft.rb upload-files        # Uploads everything from drop, not just the world.
+  aws_minecraft.rb upload-world        # Upload world.
+```
+
+* `attach_to_server` will attach you to a running Minecraft server which you than can control and run
+commands on.
+* `create-instance` this will create your bare bone EC2 instance with some installed packages.
+* `init-db` is explained above
+* `ssh` this will ssh into your instance. For this to work, you'll have to load your private key
+into the ssh agent which belongs to the public key in your instance. To do this, run ssh-add like this:
+`ssh-add ~/.ssh/minecraft_rsa`. **NOTE**: This is an important part. SSH needs to be able to work for
+uploading your files and the world as well.
+* `start-instance` will start a stopped EC2 instance.
+* `start-server NAME` this will start a Minecraft server. NAME here will be the jar you'll upload with
+`upload-files`. For example, if you upload `minecraft-server-1.9.jar` than this would be
+`aws_minecraft.rb start-server minecraft-server-1.9.jar`.
+* `stop-instance` stops your EC2 instance. This is recommended after a session ends, since it would
+generate more usage cost if you left it running. **WARNING**: Do NOT forget to stop your EC2 instance.
+I'm not responsible for you forgetting to do that. :P
+* `stop-server` this stops your running Minecraft server. There is no need for NAME here, since it's
+running in a tmux session for which the name is predefined.
+* `terminate-instance` this will kill off your EC2 instance. **WARNING**: If you do this, you will loose
+all data! There is a prompt before terminate which asks you if you are sure about that.
+* `upload-files` this uploads files from a designated location. You would configure this to be a
+folder in which your world, and minecraft.jar resides in. Once the upload completes, you can start
+your server.
+* `upload-world` in order to avoid re-uploading everything, in case you have a new world you'd like
+to use, you would only run this and point it at the worlds folder. *NOTE*: Incomplete feature.
+
+## Typical use case
+
+A typical use case would be to install this gem with `gem install aws_minecraft`. Than setup your
+AWS creds. Next, create your SSH key and copy the base64 encoded public key under cfg/minecraft.key
+(this file is ignored so it won't show up in your repository if you are doing a git clone). Proceed
+with creating the database by running `init-db` and than you are ready to create your first EC2 instance.
+Run `start-instance`. Once the instance is ready, run `upload-files`. The uploads progress is shown.
+When that is finished, you are ready to start your server with `start-server`. This will also give
+you the server's ip address which you will need to enter into Minecraft in order to log in. Play.
+When you are done playing, don't forget to issue a `stop-server` command.
+
+If you would like to resume playing on the same server, you would call `start-server` and again,
+enjoy a nice session of Minecraft.
+
+# Examples
+
+Created the instance
+
+![create](img/create.png)
+
+Creation in progress with a progress bar showing that it's working
+
+![create_in_progress](img/create_in_progress.png)
+
+Terminating an instance
+
+![terminate](img/terminate.png)
+
+Upload files
+
+![upload](img/upload.png)
+
+Attach to a running Minecraft server
+
+![attached_session](img/attached_session.png)
+
+Attach-Detach to a running session
+
+![attach_detach](img/attach-detach.png)
+
+Trying to attach to a not running session
+
+![invalid_attach](img/attach_no_session.png)
+
+Stopping a minecraft server
+
+![stop_server](img/stop_server.png)
+
+# Contribution
+
+Any contributions are very welcomed. Please don't hesitate to open an issue even if it is a question only.
+The Roadmap outlines things that are missing and would be nice to have.

data/ROADMAP.md

@@ -0,0 +1,46 @@
+Roadmap for aws_minecraft
+=========================
+
+0.2.0
+-----
+
+* Working on coverage is important. Adding unit tests for ssh, uploader and negative scenarios for
+aws_helper would be Next.
+* Some of the error cases are not handled really well at the moment. They just raise an error.
+* Upload world is not working yet.
+* Everything Minecraft related could be extracted.
+* Would be nice if it wouldn't re-upload.
+* start-server doesn't tell you if starting the tmux session was successful or not.
+
+0.1.0
+-----
+
+* This is an MVP at this stage, with everything working and the most important parts have unit tests.
+
+
+0.0.4
+-----
+
+* Stopping minecraft server
+* Attaching to PID to see output and to run commands
+* Investiage tmux to run minecraft and attach to later (This would save a lot of trouble)
+* Use tmux like this:
+```bash
+# runs a tmux session and detaches from it
+tmux new -d -s minecraft 'java -jar minecraft_server.jar nogui'
+# can attach to the running session so that we can control minecraft
+tmux attach -t minecraft
+```
+
+0.0.3
+-----
+
+* Ready the CLI for starting a minecraft server
+  * Includes uploading a minecraft jar
+  * Remote execution on the host
+  * Saving PID id of the minecraft process
+
+0.0.2
+-----
+
+* Ready the CLI for starting, stopping, terminating, creating ec2 instance

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError => le
+  puts "There was a problem loading RSpec. #{le}."
+end

data/aws_minecraft.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'lib', 'aws_minecraft', 'version')
+
+Gem::Specification.new do |s|
+  s.name = 'aws_minecraft'
+  s.version = AWSMine::AWSMine::VERSION
+  s.required_rubygems_version =
+    Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Gergely Brautigam']
+  s.summary = 'A minecraft server provisioner on an AWS EC2 instance.'
+  s.description = 'Provisions an EC2. Uploads a world, and deploys it.'
+  s.email = 'skarlso777@gmail.com'
+  s.extra_rdoc_files = ['README.md']
+  s.files = `git ls-files`.split("\n")
+  s.files << './cfg/minecraft.key'
+  s.homepage = 'https://github.com/Skarlso/aws_minecraft'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.rubygems_version = '2.6.6'
+  s.test_files = `git ls-files`.split("\n").select { |f| f =~ /^specs/ }
+  s.rubyforge_project = 'aws_minecraft'
+  s.executables = `git ls-files -- bin/*`.split("\n")
+                                         .map { |f| File.basename(f) }
+  s.licenses    = ['MIT']
+
+  # dependencies
+  s.add_development_dependency 'code_stats'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+end

data/bin/aws_minecraft.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'aws_minecraft'
+
+# Providing a binary for AWSMine.
+class AWSMineCli < Thor
+  def initialize(*args)
+    super
+    @aws_mine = AWSMine::AWSMine.new
+  end
+
+  desc 'create-instance', 'Creates an EC2 instance.'
+  def create_instance
+    @aws_mine.create_instance
+  end
+
+  desc 'start-instance', 'Starts an EC2 instance.'
+  def start_instance
+    @aws_mine.start_instance
+  end
+
+  desc 'stop-instance', 'Stops an EC2 instance.'
+  def stop_instance
+    @aws_mine.stop_instance
+  end
+
+  desc 'terminate-instance', 'Terminates an EC2 instance.'
+  def terminate_instance
+    @aws_mine.terminate_instance
+  end
+
+  desc 'ssh', 'SSH into a running EC2 instance.'
+  def ssh
+    # @aws_mine.remote_exec('ls -l')
+    @aws_mine.ssh
+  end
+
+  # Handle minecraft server version here.
+  desc 'start-server NAME', 'Starts a minecraft server.'
+  def start_server(name = 'minecraft_server.jar')
+    @aws_mine.start_server(name)
+  end
+
+  desc 'stop-server', 'Stops a minecraft server.'
+  def stop_server
+    @aws_mine.stop_server
+  end
+
+  desc 'attach-to-server', 'Attach to a minecraft server.'
+  def attach_to_server
+    @aws_mine.attach_to_server
+  end
+
+  desc 'upload-world', 'Upload world.'
+  def upload_world
+  end
+
+  desc 'upload-files', 'Uploads everything from drop, not just the world.'
+  def upload_files
+    @aws_mine.upload_files
+  end
+
+  desc 'init-db', 'Initialize the databse.'
+  def init_db
+    @aws_mine.init_db
+  end
+end
+
+AWSMineCli.start