kaiser 0.0.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fca5130b0e2499829e856a1c50d3456620ae5d30
-  data.tar.gz: 454dcd8b92a260abc2071dadcb82446ff3515d04
+SHA256:
+  metadata.gz: b038487b21d1842c497c567c1b7f5bfcd15113f4099106f3de2d59fbbd1151c9
+  data.tar.gz: 7177b78736ccef59a0b4f4c0d2cfd0902cb4db1f5c235e9ed9eb8e6424ff6039
 SHA512:
-  metadata.gz: 6a8015dbe99d1184d4c75aa4599e1334288c40622bb7ad3e973244e387c9c52480cc9a97d80f1398f276fc49145a94b2352b0c8026a0488dd53dec5424f43f03
-  data.tar.gz: bafeacb6d191595108857bbc33b519e3af18e359e7dfc3df52c2c942a952892ef6cbaa8fd8a5c5261c5486b6d23bf8681c6a6e8d2e8e31c91dba911613d4c87d
+  metadata.gz: deeb309b718a0bc5a53c108da2e561096deaa05fbf49433c6253c38b40435283e8dc53ac6bd122fe6726176f94e2f5823476805ddc50ba37a6c1b46ef9b3d8fb
+  data.tar.gz: b9b5a6bd7ee1e163bbb1ff1ea00fb7112efa47bf8ddb7f5ba1a5c4f9a456cfb5b7475da68bfcbc15889774392b1b7b1c6044ca7ca6f48430b30a2dfe863e0f95

data/README.md

@@ -0,0 +1,281 @@
+# Kaiser
+
+Welcome to Kaiser! Kaiser will mind-control all your monsters and make them even more effective.
+
+Kaiser lets you define how an application starts, so trying out a web application simply reduces to a `kaiser up`
+
+## Installation (Traditional)
+
+1. Download and setup [Docker](https://www.docker.com/get-started)
+
+2. Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaiser', git: "https://github.com/degica/kaiser"
+```
+
+3. Execute:
+
+    ```$ bundle```
+
+    Or install it yourself as:
+
+        $ gem install specific_install
+        $ gem specific_install -l https://github.com/degica/kaiser
+
+## Installation (Docker)
+
+You can install Kaiser as a docker image on your machine too!
+
+Simply clone the repo and run 
+
+```
+cd kaiser
+docker build -t degica/kaiser . 
+```
+
+And then add the following line to your `.bashrc` or `.bash_profile`
+
+```
+alias kaiser='docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v `pwd`:`pwd` -e CONTEXT_DIR="`pwd`" degica/kaiser'
+```
+
+Or if you use fish
+
+```
+function kaiser
+  docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock -v $HOME/.kaiser:/root/.kaiser -v (pwd):(pwd) -e CONTEXT_DIR=(pwd) degica/kaiser $argv
+end
+```
+
+## Usage
+
+You'll need a Dockerfile and a Kaiserfile. The Kaiserfile should be placed in the project root directory, with contents like this:
+
+```ruby
+# Example Kaiserfile for a Rails app
+
+dockerfile "Dockerfile.kaiser"
+
+db "mysql:5.6",
+  port: 3306,
+  data_dir: "/var/lib/mysql",
+  params: "-e MYSQL_ROOT_PASSWORD=test123",
+  commands: ""
+
+app_params "-e DATABASE_URL=mysql2://root:test123@<%= db_container_name %>"
+
+expose "9000"
+db_reset_command "bin/rails db:reset"
+```
+
+```dockerfile
+FROM ruby:alpine
+
+COPY . /app
+RUN apk update && apk add build-base
+RUN gem install bundler
+RUN bundle install
+
+EXPOSE "3000"
+
+CMD ["sh", "-c", "rails -b 0.0.0.0 -p 3000"]
+```
+
+Then go to your repo's root folder and go
+
+```sh
+bundle exec kaiser init myapp
+bundle exec kaiser up
+```
+
+Once its done, simply
+
+```sh
+open http://myapp.lvh.me
+```
+
+And enjoy previewing your app!
+
+### Alternative Kaiserfile
+
+If you want change your dev environment for a project, but don't want to overwrite the project's Kaiserfile/Dockerfile,
+you can use an alternative Kaiserfile.
+
+An alternative Kaiserfile is located at `~/kaiserfiles/Kaiserfile.<app name>`,
+where `<app name>` is replaced with the name you provided when calling `kaiser init`.
+
+If Kaiser detects an alternative Kaiserfile, it will use it instead of the Project root one. Some things to watch out for:
+
+- Of course, your app may behave differently if you change your environment from the project's default.
+- The `dockerfile` declaration is still relative to the project root. If you want to use a custom Dockerfile as well, you need to specify the its full path in the Kaiserfile.
+- If the project's Kaiserfile or Dockerfile changes, you'll have to update your custom ones manually.
+
+### Debugging
+
+You can also debug by going
+
+```sh
+bundle exec kaiser attach
+```
+
+### Run stuff in the container
+
+You can also run stuff inside by going
+
+```sh
+bundle exec kaiser login sh
+```
+
+And you can do anything inside the container
+
+### Attach to the container
+
+If you want to run with the container in the foreground simply go
+
+```sh
+bundle exec kaiser attach
+```
+
+This is similar to `kaiser login` but it terminates the running container, whereas `kaiser login` will simply run you in the same container as the running container.
+
+```sh
+bundle exec kaiser attach nano /etc/hosts
+```
+
+### Save database state
+
+```sh
+bundle exec kaiser db_save customer_setup
+```
+
+You can also save your database state to a file in your current dir:
+
+```sh
+bundle exec kaiser db_save ./my_setup.dbimage
+```
+
+### Load database state
+
+```sh
+bundle exec kaiser db_load customer_setup
+```
+
+You can load a previously saved database file that you have
+
+```sh
+bundle exec kaiser db_load ./my_setup.dbimage
+```
+
+### Get ports
+
+Kaiser decides what ports to use on the host. To know them simply go
+
+```sh
+bundle exec kaiser show ports
+```
+
+### Curious?
+
+You can see what Kaiser is doing under the hood with the `-v` flag:
+
+```sh
+bundle exec kaiser -v db_reset 
+```
+
+## Reverse proxy
+
+Why does it magically work?
+
+By default kaiser sets up a reverse proxy that puts all your apps on a subdomain of (lvh.me)[lvh.me]. This means all your environments can be accessed like so: `envname.lvh.me`. Easy.
+
+[Read more about lvh.me](https://nickjanetakis.com/blog/ngrok-lvhme-nipio-a-trilogy-for-local-development-and-testing#lvh-me)
+
+#### HTTPS
+
+If you want to you can create a self-signed HTTPS certificate for lvh.me, trust it and use it to access your dev sites with HTTPS! (Cool! Now you can debug your websites in HTTPS!)
+
+It is easy to do this: Simply run
+
+```sh
+kaiser set cert-folder /home/me/my-certificate-folder
+```
+
+As preparation you need to generate [HTTPS certificates](https://gist.github.com/dagjaneiro/dc1e26d87e745b47c4e2596f6b54022c). You should have the following files:
+
+```
+/home/me/my-certificate-folder/lvh.me.crt
+/home/me/my-certificate-folder/lvh.me.key
+/home/me/my-certificate-folder/lvh.me.chain.pem
+```
+
+Hint: you can create the `.chain.pem` file by going
+
+```
+cat lvh.me.crt >> lvh.me.key
+cat lvh.me.crt >> lvh.me.crt
+```
+
+Remember to trust your certificates! Otherwise your browser will give you an error (if it isn't dodgy).
+
+If you and your colleagues all want to sign using the same certificates, simply put the certificates on a webserver and go:
+
+```sh
+kaiser set cert-url https://internal-site.com/dev-certificates
+```
+
+and Kaiser will look for certificates at:
+
+```
+https://internal-site.com/dev-certificates/lvh.me.crt
+https://internal-site.com/dev-certificates/lvh.me.key
+https://internal-site.com/dev-certificates/lvh.me.chain.pem
+```
+
+#### HTTP/HTTPS Your own domain
+
+If you have a fancy setup where you have your own localhost domain (like local.aweso.me) and you can generate your own SSL certificates (yes, very fancy) then you can set the suffix of your domain like this:
+
+```sh
+kaiser set http-suffix local.aweso.me
+```
+
+And your apps will be all `envname.local.aweso.me`
+
+#### If you change these settings
+
+You will need to run
+
+```sh
+kaiser shutdown
+```
+
+And run
+
+```sh
+kaiser up
+```
+
+Again for changes to take effect.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/degica/kaiser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kaiser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/degica/kaiser/blob/master/CODE_OF_CONDUCT.md).
+
+## Contributors
+
+- Guga Katsiashvili (provided the rubygem)

data/exe/kaiser

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optimist'
+require 'fileutils'
+require 'yaml'
+require 'json'
+require 'pty'
+require 'erb'
+
+require 'kaiser'
+
+sub_command_strings = Kaiser::SUB_COMMANDS.keys.map(&:to_s)
+
+Kaiser::SUB_COMMANDS.each { |k, v| Kaiser::Cli.register(k, v) }
+
+# It was difficult to allow global arguments like -v and -q to be typed both before and after cmds
+# and still support `kaiser -h` for full help messages and `kaiser subcmd -h` for focused messages.
+# Putting the global options in an array, using an Optimist::Parser and basically everything up to
+# the 'end parser hacks' comment are all hacks to marry the above two behaviours.
+
+global_opts = [
+  [:verbose, "Show Kaiser's debug output", short: '-v'],
+  [:quiet, 'Suppress all output', short: '-q']
+]
+
+parser = Optimist::Parser.new do
+  version "Kaiser v#{Kaiser::VERSION}"
+
+  banner <<~BANNER
+    #{version}
+
+    Kaiser is a tool to make development a lot easier by defining how an application starts using a \`Kaiserfile\` in the source code's root directory.
+
+    Prerequisites
+    =============
+
+    Install docker on your system and make sure the current user has all the rights required to spin up docker containers.
+
+    Usage
+    =====
+
+    For typical usage you'll want to do the following three commands.
+
+    \`\`\`
+    kaiser init ENV_NAME
+    kaiser up
+    kaiser attach
+    \`\`\`
+
+    This will boot up your application in docker and bind mount your local source directory so you can start doing development. Happy coding!
+
+    If any of these commands are giving you trouble, please run them with the \`-v\` flag set. They will show you what exactly is happening so you can debug.
+
+    Subcommands
+    ===========
+
+    - #{Kaiser::SUB_COMMANDS.keys.join("\n- ")}
+
+    Type \`SUB_COMMAND -h\` for help with specific subcommands.
+
+    Global Parameters
+    =================
+  BANNER
+
+  global_opts.each { |o| opt(*o) }
+end
+
+commands = sub_command_strings & ARGV
+
+if commands.empty?
+  Optimist.with_standard_exception_handling parser do
+    raise Optimist::HelpNeeded
+  end
+end
+
+cmd = commands.first
+## end parser hacks ##
+
+begin
+  Kaiser::Cli.run_command(:"#{cmd}", global_opts)
+rescue Kaiser::Error => e
+  puts ''
+  puts e.message
+end
+
+puts ''

data/lib/kaiser/after_dotter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kaiser
+  # Prints properly after a dotter prints
+  class AfterDotter
+    def initialize(channel: $stderr, dotter:)
+      @channel = channel
+      @dotter = dotter
+    end
+
+    def puts(value)
+      if @dotter.dotted
+        @dotter.dotted = false
+        @channel.puts ''
+      end
+      @channel.puts(value)
+    end
+
+    def flush
+      @channel.flush
+    end
+  end
+end