dev-lxc 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27e29d239c3a0ace8d73c26432ca4b4aeff00575
-  data.tar.gz: baa644c15104f2b374710b300ba387e35e83391e
+  metadata.gz: 418e5d84f4cd828da09f766360fb63e68ff52fc6
+  data.tar.gz: eb420a6d8a3fcc30a9ec84e1a43ae63f7b8ea063
 SHA512:
-  metadata.gz: 307edb219ff3d8c6553632c0fac42e8a5a86e7a4aeb717a67fb072c646102a61ab4951b53add995b307df4efa1a4572630f13afd6727fb24bd9f0e4e150dec6c
-  data.tar.gz: 5c3017b50b7757c9ea6c5809c983ff652e1d96d41bfed38cd04c667dfb1872c242ad7ffe69fb72a9013ed94ca6b8aae762b1ec8a07d7d8131ff83972599792e4
+  metadata.gz: 71955db99c7af24fdf4ee602e61d5bb669a95500a58baa95d36a8be2a4fd2ebd51894a95bcc315349f0e7308cfe401df8713c85270b49c0d9cd2caba4120a3ed
+  data.tar.gz: 1a3114175737f4e9396d82cd7ce9924e88705ad42a59d9b05a4741e26c1015a2b29f848885853e9b42b023941c4f35c8e985d2950e6589a4bfd49a4721843e2e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # dev-lxc Change Log
 
+## 3.1.0 (2017-03-08)
+
+* Add example dev-lxc.yml files
+* Change product name from 'delivery' to 'automate'
+* Minor cleanup in adhoc_clusters docs
+* Move byobu keybindings docs to its own file
+* Minor improvements to README
+* Minor updates about how to use tinyproxy or mitmproxy
+
 ## 3.0.0 (2017-03-06)
 
 * Rename `dev-lxc` binary to `dl`

data/README.md

@@ -40,7 +40,7 @@ The easiest way to build a dev-lxc-platform system is to download the dev-lxc-pl
 and use Test Kitchen to build an AWS EC2 instance or a VirtualBox Vagrant instance.
 
 Follow the instructions in the [dev-lxc-platform README](https://github.com/jeremiahsnapp/dev-lxc-platform) to build
-a dev-lxc-platform instance.
+a dev-lxc-platform instance. It takes about 7 minutes to build the dev-lxc-platform instance.
 
 ## Login to the dev-lxc-platform instance
 
@@ -54,28 +54,7 @@ sudo -i
 
 When you are logged in as the root user you should automatically enter a [byobu session](http://byobu.co/).
 
-## Byobu keybindings
-
-Byobu makes it easy to manage multiple terminal windows and panes. You can press `F1` to get help which includes a [list of keybindings](http://manpages.ubuntu.com/manpages/wily/en/man1/byobu.1.html#contenttoc8).
-
-`C-` refers to the keyboard's `Control` key.
-`M-` refers to the keyboard's `Meta` key which is the `Alt` key on a PC keyboard and the `Option` key on an Apple keyboard.
-
-The prefix key is set to `C-o`
-
-Some of the keyboard shortcuts that will be most useful to you are:
-
-* `M-Up`, `M-Down` - switch between Byobu sessions
-* `M-Left`, `M-Right` - switch between windows in a session
-* `shift-Left`, `shift-Right`, `shift-Up`, `shift-Down` - switch between panes in a window
-  * Windows users using Conemu must first disable "Start selection with Shift+Arrow" in "Mark/Copy" under the "Keys & Macro" settings
-* `C-o C-s` - synchronize panes
-* `C-o z` - zoom into and out of a pane
-* `C-o M-1` - evenly split panes horizontally
-* `C-o M-2` - evenly split panes vertically
-* `M-pageup`, `M-pagedown` - page up/down in scrollback
-
-Note: `Shift-F2` does not create horizontal splits for Windows users. Use the `C-o |` key binding instead.
+See [byobu keybindings](docs/byobu_keybindings.md) to learn some byobu basics.
 
 ## Update dev-lxc gem
 
@@ -92,9 +71,9 @@ chef gem update dev-lxc
 
 `dl` is the dev-lxc command line tool.
 
-`dev-lxc` subcommands and some options can be auto-completed by pressing the `Tab` key.
+`dl` subcommands and some options can be auto-completed by pressing the `Tab` key.
 
-You only have to type enough of a `dev-lxc` subcommand to make it unique.
+You only have to type enough of a `dl` subcommand to make it unique.
 
 For example, the following commands are equivalent:
 
@@ -140,7 +119,7 @@ Copy your delivery.license file to the `/root/clusters` directory.
 
 ### cluster-view
 
-Run the `cluster-view` command to create a Byobu (tmux) session specifically for this cluster.
+Run the `cluster-view` command to create a Byobu session specifically for this cluster.
 
 ```
 cluster-view /root/clusters/automate
@@ -169,7 +148,9 @@ At this point all of the cluster's servers should be running.
 
 Since the cluster has a Chef Server and an infrastructure node dev-lxc made sure it configured the node's chef-client for the Chef Server so it is easy to converge the node.
 
-You can use the `attach` subcommand to login to the root user of a server. For example, the following commands should attach to node-1.lxc, start a chef-client run and exit the node.
+You can use the `attach` subcommand to login to a server as the root user.
+
+For example, the following commands should attach to node-1.lxc, start a chef-client run and exit the node.
 
 ```
 dl attach node
@@ -191,30 +172,30 @@ Since the cluster has a Chef Automate server you can use the `print-automate-cre
 dl print
 ```
 
-If you enabled dynamic forwarding (SOCKS v5) in your workstation's SSH config file and configured a web browser to use the SOCKS v5 proxy as described in the dev-lxc-platform README.md then you should be able to browse from your workstation to any server that has a web interface using its FQDN. For example, browse to https://automate.lxc and login with the credentials that you just displayed in the previous step.
+If you enabled local port forwarding for port 8888 in your workstation's SSH config file and configured your web browser to use `127.0.0.1:8888` for HTTP and HTTPS proxies as described in the [dev-lxc-platform README.md](https://github.com/jeremiahsnapp/dev-lxc-platform) then you should be able to browse from your workstation to any server that has a web interface using its FQDN.
 
-### Manage the Cluster
+For example, browse to https://automate.lxc and login with the credentials provided by `dl print-automate-credentials`.
 
-The right pane of the "cluster" window should show `dl status` output. This shows the status of each server including any existing snapshots.
+### Manage the Cluster
 
-It is recommended that you stop the servers before restoring or creating snapshots.
+Let's stop the servers before restoring and creating snapshots.
 
 ```
 dl halt
 ```
 
-You can restore the most recent snapshot of all the servers.
+You can restore a specific snapshot by name if you desire.
+
+For example, the following command restores the Chef Automate server to the state right after its package was installed but before it was configured.
 
 ```
-dl snapshot -r
+dl snapshot automate -r snap0
 ```
 
-You could also restore a specific snapshot by name if you desire.
-
-For example, you could restore the Chef Automate server to the state right after its package was installed but before it was configured.
+You can restore the most recent snapshot of all the servers.
 
 ```
-dl snapshot automate -r snap0
+dl snapshot -r
 ```
 
 You can create snapshots with or without a comment.
@@ -239,6 +220,10 @@ dl destroy
 
 For more in-depth documentation please see the pages in the [docs folder](docs).
 
+## Example dev-lxc.yml files
+
+See the files in [example-clusters](example-clusters).
+
 ## Contributing
 
 1. Fork it

data/docs/adhoc_clusters.md

@@ -13,8 +13,8 @@ The number of servers, their names and their IP addresses can be changed to fit
 particular requirements.
 
 ```
-mkdir -p /root/clusters/delivery
-dl init --adhoc > /root/clusters/delivery/dev-lxc.yml
-cluster-view /root/clusters/delivery
+mkdir -p /root/clusters/adhoc
+dl init --adhoc > /root/clusters/adhoc/dev-lxc.yml
+cluster-view /root/clusters/adhoc
 dl up
 ```

data/docs/byobu_keybindings.md

@@ -0,0 +1,22 @@
+## byobu keybindings
+
+byobu makes it easy to manage multiple terminal windows and panes. You can press `F1` to get help which includes a [list of keybindings](http://manpages.ubuntu.com/manpages/wily/en/man1/byobu.1.html#contenttoc8).
+
+`C-` refers to the keyboard's `Control` key.
+`M-` refers to the keyboard's `Meta` key which is the `Alt` key on a PC keyboard and the `Option` key on an Apple keyboard.
+
+The prefix key is set to `C-o`
+
+Some of the keyboard shortcuts that will be most useful to you are:
+
+* `M-Up`, `M-Down` - switch between byobu sessions
+* `M-Left`, `M-Right` - switch between windows in a session
+* `shift-Left`, `shift-Right`, `shift-Up`, `shift-Down` - switch between panes in a window
+  * Windows users using Conemu must first disable "Start selection with Shift+Arrow" in "Mark/Copy" under the "Keys & Macro" settings
+* `C-o C-s` - synchronize panes
+* `C-o z` - zoom into and out of a pane
+* `C-o M-1` - evenly split panes horizontally
+* `C-o M-2` - evenly split panes vertically
+* `M-pageup`, `M-pagedown` - page up/down in scrollback
+
+Note: `Shift-F2` does not create horizontal splits for Windows users. Use the `C-o |` key binding instead.

data/docs/configuration.md

@@ -83,7 +83,7 @@ automate:
     automate.lxc:
       ipaddress: 10.0.3.200
       products:
-        delivery:
+        automate:
       license_path: /path/for/automate.lxc
       chef_org: delivery
       enterprise_name: demo-ent

data/docs/mitmproxy.md

@@ -4,4 +4,4 @@ Run `mitmproxy` in a terminal on the host instance.
 
 Uncomment the `https_proxy` line in the chef-repo's `.chef/knife.rb` or in a node's `/etc/chef/client.rb` so traffic from knife commands or chef-client runs will be proxied through mitmproxy making the HTTP requests visible in the mitmproxy console.
 
-If you configured your workstation's SSH config file with LocalForward as described in dev-lxc-platform's README then you should be able to configure the web browser to use "127.0.0.1 8080" for HTTP and HTTPS proxies and watch the HTTP requests appear in the mitmproxy console.
+If you enabled local port forwarding for port 8080 in your workstation's SSH config file and configured your web browser to use `127.0.0.1:8080` for HTTP and HTTPS proxies as described in the [dev-lxc-platform README.md](https://github.com/jeremiahsnapp/dev-lxc-platform) then you should be able to see the HTTP requests appear in the mitmproxy console.

data/example-clusters/README.md

@@ -0,0 +1,37 @@
+The files in this directory are working examples of cluster dev-lxc.yml files. You can upload them to separate directories in your dev-lxc-platform instance, rename each file to `dev-lxc.yml` and run `dl up` to build each cluster.
+
+### automate
+
+The [automate_dev-lxc.yml](example-clusters/automate_dev-lxc.yml) file was created using the following command.
+
+```
+dl init --chef --compliance --supermarket --automate --runners --nodes
+```
+
+Cluster build time: 19 minutes
+
+### chef-backend
+
+The [chef-backend_dev-lxc.yml](example-clusters/chef-backend_dev-lxc.yml) file was created using the following command.
+
+The nodes' `chef_server_url` hostname was changed to `chef-ha.lxc` and the node's hostname was changed to `node-1-ha.lxc`.
+
+```
+dl init --chef-backend --nodes
+```
+
+Cluster build time: 12 minutes
+
+### tier
+
+The [tier_dev-lxc.yml](example-clusters/tier_dev-lxc.yml) file was created using the following command.
+
+The `reporting` product was uncommented for `chef-be.lxc` and `chef-fe1.lxc`.
+
+The nodes' `chef_server_url` hostname was changed to `chef-tier.lxc` and the node's hostname was changed to `node-1-tier.lxc`.
+
+```
+dl init --chef-tier --analytics --nodes
+```
+
+Cluster build time: 14 minutes

data/example-clusters/automate_dev-lxc.yml

@@ -0,0 +1,83 @@
+# enable_build_snapshots automatically makes container snapshots at key times during the build process
+# default value is `true`
+#enable_build_snapshots: true
+
+# base_container must be the name of an existing container
+base_container: b-ubuntu-1404
+
+# memory_per_server sets the maximum amount of user memory (including file cache) for each server.
+# dev-lxc will set the `memory.limit_in_bytes` cgroup for each server to apply this limit.
+# If no units are specified, the value is interpreted as bytes.
+# You can use suffixes to represent larger units - k or K for kilobytes, m or M for megabytes, and g or G for gigabytes.
+# The default behavior is that no limit is set.
+#memory_per_server: 4G
+
+# list any host directories you want mounted into the servers
+#mounts:
+#  - /root/clusters root/clusters
+
+# list any SSH public keys you want added to /home/dev-lxc/.ssh/authorized_keys
+#ssh-keys:
+#  - /root/clusters/id_rsa.pub
+
+# DHCP reserved (static) IPs must be selected from the IP range 10.0.3.150 - 254
+
+chef-server:
+  users:          # a user's password will be the same as its username
+    - mary-admin
+    - joe-user
+  orgs:
+    demo:
+      admins:
+        - mary-admin
+      non-admins:
+        - joe-user
+  servers:
+    chef.lxc:
+      ipaddress: 10.0.3.203
+      products:
+        chef-server:
+        manage:
+        push-jobs-server:
+#        reporting:
+
+compliance:
+  admin_user: admin         # the password will be the same as the username
+  servers:
+    compliance.lxc:
+      ipaddress: 10.0.3.205
+      products:
+        compliance:
+
+supermarket:
+  servers:
+    supermarket.lxc:
+      ipaddress: 10.0.3.206
+      products:
+        supermarket:
+
+automate:
+  servers:
+    automate.lxc:
+      ipaddress: 10.0.3.200
+      products:
+        automate:
+      license_path: ../delivery.license
+      chef_org: delivery
+      enterprise_name: demo-ent
+
+runners:
+  servers:
+    runner-1.lxc:
+      products:
+        chefdk:     # downloaded only
+
+nodes:
+  chef_server_url: https://chef.lxc/organizations/demo
+  validation_client_name: demo-validator
+  # comment out or remove the validation_key path to use chef-server keys generated by dev-lxc
+  validation_key: # /path/for/ORG-validator.pem
+  servers:
+    node-1.lxc:
+      products:
+        chef:

data/example-clusters/chef-backend_dev-lxc.yml

@@ -0,0 +1,69 @@
+# enable_build_snapshots automatically makes container snapshots at key times during the build process
+# default value is `true`
+#enable_build_snapshots: true
+
+# base_container must be the name of an existing container
+base_container: b-ubuntu-1404
+
+# memory_per_server sets the maximum amount of user memory (including file cache) for each server.
+# dev-lxc will set the `memory.limit_in_bytes` cgroup for each server to apply this limit.
+# If no units are specified, the value is interpreted as bytes.
+# You can use suffixes to represent larger units - k or K for kilobytes, m or M for megabytes, and g or G for gigabytes.
+# The default behavior is that no limit is set.
+#memory_per_server: 4G
+
+# list any host directories you want mounted into the servers
+#mounts:
+#  - /root/clusters root/clusters
+
+# list any SSH public keys you want added to /home/dev-lxc/.ssh/authorized_keys
+#ssh-keys:
+#  - /root/clusters/id_rsa.pub
+
+# DHCP reserved (static) IPs must be selected from the IP range 10.0.3.150 - 254
+
+chef-backend:
+  api_fqdn: chef-ha.lxc
+  users:          # a user's password will be the same as its username
+    - mary-admin
+    - joe-user
+  orgs:
+    demo:
+      admins:
+        - mary-admin
+      non-admins:
+        - joe-user
+  servers:
+    chef-backend1.lxc:
+      ipaddress: 10.0.3.208
+      role: backend
+      leader: true
+      products:
+        chef-backend:
+    chef-backend2.lxc:
+      ipaddress: 10.0.3.209
+      role: backend
+      products:
+        chef-backend:
+    chef-backend3.lxc:
+      ipaddress: 10.0.3.210
+      role: backend
+      products:
+        chef-backend:
+    chef-frontend1.lxc:
+      ipaddress: 10.0.3.211
+      role: frontend
+      bootstrap: true
+      products:
+        chef-server:
+        manage:
+
+nodes:
+  chef_server_url: https://chef-ha.lxc/organizations/demo
+  validation_client_name: demo-validator
+  # comment out or remove the validation_key path to use chef-server keys generated by dev-lxc
+  validation_key: # /path/for/ORG-validator.pem
+  servers:
+    node-1-ha.lxc:
+      products:
+        chef:

data/example-clusters/tier_dev-lxc.yml

@@ -0,0 +1,70 @@
+# enable_build_snapshots automatically makes container snapshots at key times during the build process
+# default value is `true`
+#enable_build_snapshots: true
+
+# base_container must be the name of an existing container
+base_container: b-ubuntu-1404
+
+# memory_per_server sets the maximum amount of user memory (including file cache) for each server.
+# dev-lxc will set the `memory.limit_in_bytes` cgroup for each server to apply this limit.
+# If no units are specified, the value is interpreted as bytes.
+# You can use suffixes to represent larger units - k or K for kilobytes, m or M for megabytes, and g or G for gigabytes.
+# The default behavior is that no limit is set.
+#memory_per_server: 4G
+
+# list any host directories you want mounted into the servers
+#mounts:
+#  - /root/clusters root/clusters
+
+# list any SSH public keys you want added to /home/dev-lxc/.ssh/authorized_keys
+#ssh-keys:
+#  - /root/clusters/id_rsa.pub
+
+# DHCP reserved (static) IPs must be selected from the IP range 10.0.3.150 - 254
+
+chef-server:
+  topology: tier
+  api_fqdn: chef-tier.lxc
+  users:          # a user's password will be the same as its username
+    - mary-admin
+    - joe-user
+  orgs:
+    demo:
+      admins:
+        - mary-admin
+      non-admins:
+        - joe-user
+  servers:
+    chef-be.lxc:
+      ipaddress: 10.0.3.201
+      role: backend
+      bootstrap: true
+      products:
+        chef-server:
+        push-jobs-server:
+#        reporting:
+    chef-fe1.lxc:
+      ipaddress: 10.0.3.202
+      role: frontend
+      products:
+        chef-server:
+        manage:
+        push-jobs-server:
+#        reporting:
+
+analytics:
+  servers:
+    analytics.lxc:
+      ipaddress: 10.0.3.204
+      products:
+        analytics:
+
+nodes:
+  chef_server_url: https://chef-tier.lxc/organizations/demo
+  validation_client_name: demo-validator
+  # comment out or remove the validation_key path to use chef-server keys generated by dev-lxc
+  validation_key: # /path/for/ORG-validator.pem
+  servers:
+    node-1-tier.lxc:
+      products:
+        chef:

data/lib/dev-lxc/cli.rb

@@ -141,7 +141,7 @@ automate:
     automate.lxc:
       ipaddress: 10.0.3.200
       products:
-        delivery:
+        automate:
       license_path: ../delivery.license
       chef_org: delivery
       enterprise_name: demo-ent

data/lib/dev-lxc/cluster.rb

@@ -695,7 +695,7 @@ module DevLXC
       when 'compliance'
         configure_compliance(server) if installed_products.include?('compliance')
       when 'automate'
-        configure_automate(server) if installed_products.include?('delivery')
+        configure_automate(server) if installed_products.include?('automate') || installed_products.include?('delivery')
       when 'nodes'
         # Allow servers time to generate SSH Server Host Keys
         sleep 5
@@ -803,7 +803,8 @@ module DevLXC
         FileUtils.cp(validation_key, "#{server.container.config_item('lxc.rootfs')}/etc/chef/") if File.exists?(validation_key)
       end
 
-      client_rb = %Q(#http_proxy 'http://10.0.3.1:8080'
+      client_rb = %Q(# uncomment the following proxy lines to send traffic through mitmproxy
+#http_proxy 'http://10.0.3.1:8080'
 #https_proxy 'http://10.0.3.1:8080'
 
 chef_server_url '#{chef_server_url}'
@@ -1030,7 +1031,10 @@ ssl_verify_mode :verify_none
     end
 
     def create_knife_config(fqdn, dot_chef_path)
-      knife_rb = %Q(#http_proxy 'http://127.0.0.1:8080'
+      knife_rb = %Q(# uncomment the following proxy lines to send traffic through a proxy
+# mitmproxy uses port 8080
+# tinyproxy uses port 8888
+#http_proxy 'http://127.0.0.1:8080'
 #https_proxy 'http://127.0.0.1:8080'
 
 username = "CHANGEME"

data/lib/dev-lxc/version.rb

@@ -1,3 +1,3 @@
 module DevLXC
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev-lxc
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jeremiah Snapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,11 +98,16 @@ files:
 - dev-lxc.gemspec
 - docs/adhoc_clusters.md
 - docs/base_containers.md
+- docs/byobu_keybindings.md
 - docs/configuration.md
 - docs/dev-lxc_version_2.md
 - docs/manage_multiple_clusters.md
 - docs/mitmproxy.md
 - docs/usage.md
+- example-clusters/README.md
+- example-clusters/automate_dev-lxc.yml
+- example-clusters/chef-backend_dev-lxc.yml
+- example-clusters/tier_dev-lxc.yml
 - lib/dev-lxc.rb
 - lib/dev-lxc/cli.rb
 - lib/dev-lxc/cluster.rb