farmstead 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1df587d3b56929d7653dce3390aa4f922b22ef
-  data.tar.gz: 8fb5e6d98a604de22b7a3c5c2875b21e285e4b22
+  metadata.gz: a48f6cae9255db1d2658632a100ca2b688fafc36
+  data.tar.gz: b23ff09549e56cc94d3765336d5cfd0ca5e02db9
 SHA512:
-  metadata.gz: 6035576a3faa7e02b27830876c5e099c63069cfd9c1d7a046642cd45613985aac0416ed0ad70b99d71ba5aa93bd74a0cb534d20a8e9815b935f2c464028ba2ab
-  data.tar.gz: 79603605c005d7d95641760b9ac8463a1d283915da71a73979d9c51a10c2bf7c196a664a6644f62f36cf5774ae3e4333b89afb5e6335d158161201aa5e6411c4
+  metadata.gz: 3700ca6b90332438f66eeacde37900b582aafa8259a2621422f34421575ac30a54acdf17a59e2797d527bef10b0bf3feb4360336d835b50278b7e08fd3c4f535
+  data.tar.gz: 2fdf27cfbd1c15833acc2f096f8e129326fca7795e6f7a0a9a760b6e29f5234346e9cc5f644147323404cb82cabd065c1143179eea7f4c26b1c989361be284e5

data/README.md

@@ -12,6 +12,7 @@ Farmstead is a modular data pipeline platform. Farmstead makes creating and depl
 
 - [Getting started](#getting-started)
     - [Configuration](#configuration)
+        + [Configuration Options](#config-options)
     - [Environment Variables](#env)
     - [Deployment Methods](#deployment)
 - [Architecture](#architecture)
@@ -57,6 +58,34 @@ farmstead new myproject -c myproject.yml
 
 An example configuration file is included.
 
+#### Configuration Options
+
+**Rails Authentication**
+
+There is optional Rails Authentication with AUTH0.
+
+**Rails Environment**
+
+The default environment is development but can be set to production (if you're ready).
+
+**Database**
+
+The default database is MySQL but can be set to anything that Rails can handle. 
+
+**Kafka**
+
+The default is to advertise the IP address assigned to the host. If you're behind a firewall or a load-balancer and want to change it you anything you want. Here's an example:
+
+```yaml
+kafka:
+    - advertise_from_local_ip: false
+    - advertised_ip: 192.168.1.2
+```
+
+You can use a custom Zookeeper cluster if you have one. Just set the zookeeper_address in the config.
+
+You can also create custom topics outside of the default Wood, Field, Forest, and Road. 
+
 ### Environment Variables
 
 Farmstead builds projects on Docker. In order to keep secrets out of the Rails code we use environment varibles. These are read from the .env file at the root of the project. This is IGNORED in Git, so be sure to keep these safe in a deployment/build system (i.e. Jenkins).

data/examples/myproject.yml

@@ -1,23 +1,26 @@
 - name: My Project
-  hosts: 127.0.0.1
-  connection: local
-  gather_facts: False
-  remote_user: root
-  roles:
-    - create
-
-AUTH0_CLIENT_ID={CLIENT_ID}
-AUTH0_CLIENT_SECRET={CLIENT_SECRET}
-AUTH0_DOMAIN={DOMAIN}
-AUTH0_CALLBACK_URL=http://localhost:3000/auth/auth0/callback
-AUTH0_AUDIENCE=
-MYSQL_ROOT_PASSWORD=Rc2$NE99p5%^
-MYSQL_DATABASE=farmstead
-MYSQL_USER=farmstead
-MYSQL_PASSWORD=farmstead
-MYSQL_HOST=mysql
-RAILS_ENV=development
-KAFKA_ADVERTISED_HOST_NAME=192.168.1.13
-KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181
-KAFKA_CREATE_TOPICS=Wood:1:1,Field:1:1,Forest:1:1,Road:1:1
-
+  rails:
+    - authentication:
+      - enable: true
+      - AUTH0_CLIENT_ID: myclientid
+      - AUTH0_CLIENT_SECRET: myclientsecret
+      - AUTH0_DOMAIN: myauth0domain
+      - AUTH0_DOMAIN: http://localhost:3000/auth/auth0/callback
+      - AUTH0_AUDIENCE: 
+    - environment: development
+  database:
+    - type: mysql
+    - MYSQL_ROOT_PASSWORD: Rc2$NE99p5%^
+    - MYSQL_DATABASE: farmstead
+    - MYSQL_USER: farmstead
+    - MYSQL_PASSWORD: farmstead
+    - MYSQL_HOST: mysql
+  kafka:
+    - advertise_from_local_ip: false
+    - advertised_ip: 192.168.1.2
+    - zookeeper_address: "zookeeper:2181"
+    - topics
+      - "Wood:1:1"
+      - "Field:1:1"
+      - "Forest:1:1"
+      - "Road:1:1"

data/lib/farmstead/project.rb

@@ -1,4 +1,5 @@
 require "erb"
+require "net/http"
 
 module Farmstead
   # creates a Farmstead Project
@@ -16,6 +17,7 @@ module Farmstead
 
     def start_deploy
       Dir.chdir @name
+      File.chmod(0755, "exec.sh")
       system ("bash exec.sh")
     end
 
@@ -27,30 +29,36 @@ module Farmstead
 
     # Generate from templates in scaffold
     def generate_files
-      erbfiles = File.join("**", "*.erb")
-      scaffold = Dir.glob(erbfiles, File::FNM_DOTMATCH)
+      ip = get_ip_address_from_locals
+      scaffold_path = "#{File.dirname __FILE__}/scaffold"
+      scaffold = Dir.glob("#{scaffold_path}/**/*.erb", File::FNM_DOTMATCH)
       scaffold.each do |file|
-        filename = file.match('lib\/farmstead\/scaffold\/(.*)')[1]
-        foldername = File.dirname(filename)
-        # Create folder structure of subdirectories
-        if foldername != "."
-          create_recursive(foldername)
+        basename = File.basename(file)
+        folderstruct = file.match("#{scaffold_path}/(.*)")[1]
+        if basename != folderstruct
+          foldername = File.dirname(folderstruct)
+          create_recursive("#{@name}/#{foldername}")
         end
-        projectpath = "#{@name}/#{filename}".chomp(".erb")
-        scaffoldpath = "lib/farmstead/scaffold/#{filename}"
-        template = File.read(scaffoldpath)
+        projectpath = "#{@name}/#{folderstruct}".chomp(".erb")
+        template = File.read(file)
         results = ERB.new(template).result(binding)
         copy_to_directory(results, projectpath)
       end
     end
 
+    def get_ip_address_from_local
+      response = Net::HTTP.get(URI("http://v4.ifconfig.co/json"))
+      json = eval(response)
+      json[:ip]
+    end
+
     # Recursive Create
     def create_recursive(path)
       recursive = path.split("/")
       directory = ""
       recursive.each do |sub_directory|
         directory += sub_directory + "/"
-        Dir.mkdir("#{@name}/#{directory}") unless (File.directory? directory)
+        Dir.mkdir("#{directory}") unless (File.directory? directory)
       end
     end
 

data/lib/farmstead/scaffold/.env.erb

@@ -4,6 +4,6 @@ MYSQL_USER=farmstead
 MYSQL_PASSWORD=farmstead
 MYSQL_HOST=mysql
 RAILS_ENV=development
-KAFKA_ADVERTISED_HOST_NAME=192.168.1.139
+KAFKA_ADVERTISED_HOST_NAME={%= ip %}
 KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181
 KAFKA_CREATE_TOPICS=Wood:1:1,Field:1:1,Forest:1:1,Road:1:1

data/lib/farmstead/scaffold/Gemfile.erb

@@ -4,8 +4,6 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gemspec
-
 gem "coffee-rails", "~> 4.2"
 gem "httparty", "~> 0.15.6"
 gem "jbuilder", "~> 2.5"

data/lib/farmstead/scaffold/exec.sh.erb

@@ -8,6 +8,12 @@ docker-compose rm -f > /dev/null 2>&1
 
 echo "Building new environment"
 docker-compose build > /dev/null 2>&1
+if [ $? -eq 0 ]; then
+  printf "\tBuild successsful"
+else
+  printf "\tBuild failed"
+  exit 1
+fi
 
 echo "Starting MySQL and Zookeeper"
 docker-compose up -d mysql zookeeper > /dev/null 2>&1

data/lib/farmstead/version.rb

@@ -1,3 +1,3 @@
 module Farmstead
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farmstead
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ken Jenney
@@ -105,7 +105,6 @@ files:
 - lib/farmstead/scaffold/app/controllers/application_controller.rb.erb
 - lib/farmstead/scaffold/docker-compose.yml.erb
 - lib/farmstead/scaffold/exec.sh.erb
-- lib/farmstead/scaffold/exec.sh.erb.old
 - lib/farmstead/scaffold/supervisord.conf.erb
 - lib/farmstead/scarecrow.rb
 - lib/farmstead/service.rb

data/lib/farmstead/scaffold/exec.sh.erb.old

@@ -1,57 +0,0 @@
-#!/usr/bin/env bash
-
-# Script to start Farmstead on Docker
-
-trap mytrap ERR #0 #EXIT 0 HUP INT QUIT PIPE TERM
-
-mytrap() {
-	excode=$?
-	if [ $excode -ne 0 ]; then
-		printf "\tFailed!\n"
-    	exit 1
-    fi
-}
-
-success() {
-	printf "\tSucceeded\n"
-}
-
-# Counts down a number of seconds
-countdown() {
-	secs=$1
-	while [ $secs -gt 0 ]; do
-  	echo -ne "$secs\033[0K\r"
-   	sleep 1
-   	: $((secs--))
-	done
-}
-
-echo "Cleaning up old environment"
-docker-compose stop > /dev/null 2>&1
-docker-compose rm -f > /dev/null 2>&1
-#docker stop $(docker ps -a -q) > /dev/null 2>&1
-#docker rm $(docker ps -a -q) > /dev/null 2>&1
-success
-
-echo "Building new environment"
-docker-compose build > /dev/null 2>&1
-success
-
-echo "Starting MySQL and Zookeeper"
-docker-compose up -d mysql zookeeper > /dev/null 2>&1
-success
-
-echo "Sleeping"
-countdown 10
-
-echo "Starting dorothy"
-docker-compose up -d dorothy > /dev/null 2>&1
-success
-
-echo "Create and Seed MySQL DB"
-docker-compose exec dorothy rails db:setup > /dev/null 2>&1
-success
-
-echo "Starting everything else"
-docker-compose up -d > /dev/null 2>&1
-success