dev-lxc 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e0e276b0a71f81db3d3e2c9ce69f30f248273e
-  data.tar.gz: dc862739ae2bc74fbf31cebcfabec2e908320c76
+  metadata.gz: 27e29d239c3a0ace8d73c26432ca4b4aeff00575
+  data.tar.gz: baa644c15104f2b374710b300ba387e35e83391e
 SHA512:
-  metadata.gz: 71f30ee18b6f27a0e6d1dde77024e110e6fc91f37509ae5b6f7b938472b1d1a19eef5bb72d58051313bbd99e7dfb7d15292d07ecf258d467aeba34b1ccc76871
-  data.tar.gz: ae7596695df5c5a63b876c5ccdcef354205564118aba80a3e7ae54d6754675230902b2f17dd77f4c21a63db7a85124d8e6677a6d4e97bc7d4b0ce460c7bc9f62
+  metadata.gz: 307edb219ff3d8c6553632c0fac42e8a5a86e7a4aeb717a67fb072c646102a61ab4951b53add995b307df4efa1a4572630f13afd6727fb24bd9f0e4e150dec6c
+  data.tar.gz: 5c3017b50b7757c9ea6c5809c983ff652e1d96d41bfed38cd04c667dfb1872c242ad7ffe69fb72a9013ed94ca6b8aae762b1ec8a07d7d8131ff83972599792e4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # dev-lxc Change Log
 
+## 3.0.0 (2017-03-06)
+
+* Rename `dev-lxc` binary to `dl`
+* Comment out the "reporting" product in generated config files since it is a legacy product.
+* Change default automate license_path in generated config files to something more readily usable.
+* Change default mounts and ssh-keys paths in generated config files
+* Overhaul documentation
+
 ## 2.7.0 (2017-03-03)
 
 * Make chef-repo command only create .chef directory

data/README.md

@@ -88,158 +88,114 @@ sudo -i
 chef gem update dev-lxc
 ```
 
-## Demo: Build Chef Automate Cluster
+## dl Command and Subcommands
 
-### Display dev-lxc help
+`dl` is the dev-lxc command line tool.
 
-```
-dev-lxc help
+`dev-lxc` subcommands and some options can be auto-completed by pressing the `Tab` key.
 
-dev-lxc help <subcommand>
-```
+You only have to type enough of a `dev-lxc` subcommand to make it unique.
 
-### Create Base Container
+For example, the following commands are equivalent:
+
+```
+dl help
+dl he
+```
 
-The [base container](docs/base_containers.md) used for the cluster's containers must be created first. Let's use Ubuntu 14.04 for the base container.
+## Display dev-lxc help
 
 ```
-dev-lxc create b-ubuntu-1404
+dl help
+
+dl help <subcommand>
 ```
 
-### Create Config File
+## Demo: Build Chef Automate Cluster
 
-Create the [dev-lxc.yml config file](docs/configuration.md) for the cluster.
+### Create Base Container
 
-First, create an arbitrary directory to hold the dev-lxc.yml file.
+Create an Ubuntu 14.04 base container for the cluster's containers.
 
 ```
-mkdir -p /root/work/clusters/automate
+dl create b-ubuntu-1404
 ```
 
-Then use the `init` subcommand to generate a sample configuration using the available options. Run `dl help init` to see what options are available.
+### Create Config File
 
-The following command configures a standalone Chef Server, Supermarket server, Compliance server,
-Chef Automate server, and a job dispatch runner.
+Create a directory to hold the dev-lxc.yml file.
 
 ```
-dev-lxc init --chef --compliance --supermarket --automate --runners -f /root/work/clusters/automate/dev-lxc.yml
+mkdir -p /root/clusters/automate
 ```
 
-We can easily append additional configurations to this file. For example, the following command appends an infrastructure node.
+The following command creates a dev-lxc.yml file that defines a standalone Chef Server, Supermarket server, Compliance server,
+Chef Automate server a Job Dispatch Runner and an infrastructure node.
 
 ```
-dev-lxc init --nodes -a -f /root/work/clusters/automate/dev-lxc.yml
+dl init --chef --compliance --supermarket --automate --runners --nodes > /root/clusters/automate/dev-lxc.yml
 ```
 
-Edit the dev-lxc.yml file:
-
-* Delete the `reporting` product from the Chef Server config since we will be using Chef Automate's Visibility.
-* Set the Automate server's `license_path` value to the location of your license file.
-* (Optionally) If you built other clusters then you can modify the server names (including the nodes' `chef_server_url`) in this cluster to
-  make them [unique from the other clusters](docs/manage_multiple_clusters.md).
+Copy your delivery.license file to the `/root/clusters` directory.
 
 ### cluster-view
 
-Run the `cluster-view` command to create a Byobu session specifically for this cluster.
+Run the `cluster-view` command to create a Byobu (tmux) session specifically for this cluster.
+
+```
+cluster-view /root/clusters/automate
+```
 
 The session's first window is named "cluster".
 
 The left pane is useful for running dev-lxc commands.
 
-The right pane updates every 0.5 seconds with the cluster's status provided by `dev-lxc status`.
+The right pane updates every 0.5 seconds with the cluster's status provided by `dl status`.
 
 The session's second window is named "shell". It opens in the same directory as the
 cluster's `dev-lxc.yml` file and is useful for attaching to a server to perform system administration tasks.
 
 See the [usage docs](docs/usage.md) for more information about how to close/kill Byobu sessions.
 
-```
-cluster-view /root/work/clusters/automate
-```
-
-### dev-lxc Alias and Subcommands
-
-The dev-lxc command has a `dl` alias for ease of use.
-
-Also, you only have to type enough of a `dev-lxc` subcommand to make it unique.
-
-For example, the following commands are equivalent:
-
-```
-dev-lxc status
-dl st
-```
-
-```
-dev-lxc snapshot
-dl sn
-```
-
-### Specifying a Subset of Servers
-
-Many dev-lxc subcommands can act on a subset of the cluster's servers by specifying a regular expression that matches the desired server names.
-
-For example, the following command will show the status of the infrastructure node.
-
-```
-dl status node
-```
-
 ### Build the Cluster
 
-dev-lxc knows to build the servers in an appropriate order.
-
-It downloads the product packages to a cache location and installs the packages in each server.
-
-It configures each product and creates necessary things such as Chef organizations and users as needed.
-
 ```
 dl up
 ```
 
-Note: You also have the option of running the `prepare-product-cache` subcommand which downloads required product packages to the cache.  
-This can be helpful when you don't want to start building the cluster yet but you want the package cache ready when you build the cluster later.
-
 ### Use the Servers
 
 At this point all of the cluster's servers should be running.
 
-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 dev-lxc server that has a web interface using its FQDN.
+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.
 
-Since the cluster has a Chef Server you can use the `chef-repo` subcommand to create a `.chef` directory in the host instance that contains a knife.rb and all of the keys for the users and org validator clients that are defined in dev-lxc.yml. This makes it very easy to use tools such as knife or berkshelf.
+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.
 
 ```
-dl chef
-knife client list
+dl attach node
+chef-client
+exit
 ```
 
-Since the cluster has a Chef Automate server you can use the `print-automate-credentials` subcommand to see what the login credentials.
+Since the cluster has a Chef Server you can use the `chef-repo` subcommand to create a `.chef` directory in the host instance that contains a knife.rb and all of the keys for the users and org validator clients that are defined in dev-lxc.yml. This makes it very easy to use tools such as knife or berkshelf.
 
 ```
-dl print
+dl chef-repo
+# set `username` to `mary-admin` and `orgname` to `demo` in `.chef/knife.rb`
+knife client list
 ```
 
-You can use the `attach` subcommand to login to the root user of a server.
-
-For example, the following command should attach to the Chef Server.
+Since the cluster has a Chef Automate server you can use the `print-automate-credentials` subcommand to see the login credentials.
 
 ```
-dl attach chef
+dl print
 ```
 
-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.
-
-### Use mitmproxy to view HTTP traffic
-
-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 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.
 
 ### Manage the Cluster
 
-The right pane of the "cluster" window should show `dev-lxc status` output. This shows the status of each server including any existing snapshots.
+The right pane of the "cluster" window should show `dl status` output. This shows the status of each server including any existing snapshots.
 
 It is recommended that you stop the servers before restoring or creating snapshots.
 
@@ -250,7 +206,7 @@ dl halt
 You can restore the most recent snapshot of all the servers.
 
 ```
-dl sn -r
+dl snapshot -r
 ```
 
 You could also restore a specific snapshot by name if you desire.
@@ -258,27 +214,31 @@ 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.
 
 ```
-dl sn automate -r snap0
+dl snapshot automate -r snap0
 ```
 
 You can create snapshots with or without a comment.
 
 ```
-dl sn -c 'Demo snapshot'
+dl snapshot -c 'Demo snapshot'
 ```
 
 You can destroy snapshots.
 
 ```
-dl sn -d snap2
+dl snapshot -d snap2
 ```
 
-And finally you can destroy the servers and there snapshots.
+Generally speaking, a cluster can be reused for a long time especially since snapshots easily allow you to restore the cluster to its initial build state. However, if you really want to destroy the servers and their snapshots you can use the `destroy` subcommand.
 
 ```
-dl d
+dl destroy
 ```
 
+## More Documentation
+
+For more in-depth documentation please see the pages in the [docs folder](docs).
+
 ## Contributing
 
 1. Fork it

data/docs/adhoc_clusters.md

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

data/docs/base_containers.md

@@ -26,19 +26,19 @@ dev-lxc base containers have a "dev-lxc" user with "dev-lxc" password and passwo
 You can see a menu of base containers that `dev-lxc` can create by using the following command.
 
 ```
-dev-lxc create-base-container
+dl create-base-container
 ```
 
 The initial creation of base containers can take awhile so let's go ahead and start creating
 an Ubuntu 14.04 container now.
 
 ```
-dev-lxc create-base-container b-ubuntu-1404
+dl create-base-container b-ubuntu-1404
 ```
 
 Note: It is possible to pass additional arguments to the underlying LXC create command.
 For example:
 
 ```
-dev-lxc create-base-container b-ubuntu-1404 -o -- '--no-validate --keyserver http://my.key.server.com'
+dl create-base-container b-ubuntu-1404 -o -- '--no-validate --keyserver http://my.key.server.com'
 ```

data/docs/configuration.md

@@ -5,10 +5,16 @@ dev-lxc uses a YAML configuration file named `dev-lxc.yml` to define a cluster.
 The `init` command generates sample config files for various server types.
 
 Let's generate a config for a cluster with a standalone Chef Server, Supermarket server,
-Compliance server, Chef Automate server, job dispatch runner and an infrastructure node.
+Compliance server, Chef Automate server and a Job Dispatch Runner.
 
 ```
-dev-lxc init --chef --compliance --supermarket --automate --runners --nodes > dev-lxc.yml
+dl init --chef --compliance --supermarket --automate --runners > dev-lxc.yml
+```
+
+We can easily append additional configurations to this file. For example, the following command appends an infrastructure node.
+
+```
+dl init --nodes -a >> /root/work/clusters/automate/dev-lxc.yml
 ```
 
 The contents of `dev-lxc.yml` should look like this.
@@ -30,11 +36,11 @@ base_container: b-ubuntu-1404
 
 # list any host directories you want mounted into the servers
 #mounts:
-#  - /root/work root/work
+#  - /root/clusters root/clusters
 
 # list any SSH public keys you want added to /home/dev-lxc/.ssh/authorized_keys
 #ssh-keys:
-#  - /root/work/clusters/id_rsa.pub
+#  - /root/clusters/id_rsa.pub
 
 # DHCP reserved (static) IPs must be selected from the IP range 10.0.3.150 - 254
 
@@ -55,7 +61,7 @@ chef-server:
         chef-server:
         manage:
         push-jobs-server:
-        reporting:
+#        reporting:
 
 compliance:
   admin_user: admin         # the password will be the same as the username

data/docs/mitmproxy.md

@@ -0,0 +1,7 @@
+### Use mitmproxy to view HTTP traffic
+
+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.

data/docs/usage.md

@@ -1,42 +1,31 @@
 ## Usage
 
-### Show Calculated Configuration
+### dl Command and Subcommands
 
-Mostly for debugging purposes you have the ability to print the calculated cluster configuration.
+`dl` is the dev-lxc command line tool.
 
-```
-dev-lxc show-config
-```
+`dev-lxc` subcommands and some options can be auto-completed by pressing the `Tab` key.
 
-### Cluster status
+You only have to type enough of a `dev-lxc` subcommand to make it unique.
 
-Run the following command to see the status of the cluster.
+For example, the following commands are equivalent:
 
 ```
-dev-lxc status
+dl help
+dl he
 ```
 
-This is an example of the output.
+### Display dev-lxc help
 
 ```
-chef.lxc            NOT_CREATED
-
-analytics.lxc       NOT_CREATED
+dl help
 
-supermarket.lxc     NOT_CREATED
-
-node-1.lxc          NOT_CREATED
+dl help <subcommand>
 ```
 
-### Specifying a Subset of Servers
-
-Many dev-lxc subcommands can act on a subset of the cluster's servers by specifying a regular expression that matches the desired server names.
+### Configure a cluster
 
-For example, the following command will show the status of the Chef Server.
-
-```
-dev-lxc status chef
-```
+See the [configuration docs](docs/configuration.md) to learn how to use the `dl init` command to create and configure a `dev-lxc.yml` file.
 
 ### cluster-view, tks, tls commands
 
@@ -54,7 +43,7 @@ The session's first window is named "cluster".
 
 The left side is for running dev-lxc commands.
 
-The right side updates every 0.5 seconds with the cluster's status provided by `dev-lxc status`.
+The right side updates every 0.5 seconds with the cluster's status provided by `dl status`.
 
 The session's second window is named "shell". It opens in the same directory as the
 cluster's `dev-lxc.yml` file.
@@ -72,12 +61,42 @@ I recommend switching to a different running tmux/byobu session before killing t
 tmux/byobu session. Otherwise you will need to reattach to the remaining tmux/byobu session.
 Use the keyboard shortcuts Alt-Up/Down to easily switch between tmux/byobu sessions.
 
+### Cluster status
+
+Run the following command to see the status of the cluster.
+
+```
+dl status
+```
+
+This is an example of the output.
+
+```
+chef.lxc            NOT_CREATED
+
+analytics.lxc       NOT_CREATED
+
+supermarket.lxc     NOT_CREATED
+
+node-1.lxc          NOT_CREATED
+```
+
+### Specifying a Subset of Servers
+
+Many dev-lxc subcommands can act on a subset of the cluster's servers by specifying a regular expression that matches the desired server names.
+
+For example, the following command will show the status of the Chef Server.
+
+```
+dl status chef
+```
+
 ### Start cluster
 
 Starting the cluster the first time takes awhile since it has a lot to download and build.
 
 ```
-dev-lxc up
+dl up
 ```
 
 A test org, users, knife.rb and keys are automatically created in
@@ -91,7 +110,7 @@ Note: You also have the option of running the `prepare-product-cache` subcommand
 This can be helpful when you don't want to start building the cluster yet but you want the package cache ready when you build the cluster later.
 
 ```
-dev-lxc prepare-product-cache
+dl prepare-product-cache
 ```
 
 ### Print Chef Automate Credentials
@@ -99,7 +118,7 @@ dev-lxc prepare-product-cache
 If the cluster has a Chef Automate server you can use the `print-automate-credentials` subcommand to see what the login credentials.
 
 ```
-dev-lxc print-automate-credentials
+dl print-automate-credentials
 ```
 
 ### Create chef-repo
@@ -111,7 +130,7 @@ Use the `-p` option to also get pivotal.pem and pivotal.rb files.
 Use the `-f` option to overwrite existing knife.rb and pivotal.rb files.
 
 ```
-dev-lxc chef-repo
+dl chef-repo
 ```
 
 Now you can easily use knife to access the cluster.
@@ -123,14 +142,14 @@ knife client list
 ### Stop and start the cluster
 
 ```
-dev-lxc halt
-dev-lxc up
+dl halt
+dl up
 ```
 
 ### Run arbitrary commands in each server
 
 ```
-dev-lxc run-command chef 'uptime'
+dl run-command chef 'uptime'
 ```
 
 ### Attach the terminal to a server
@@ -138,7 +157,7 @@ dev-lxc run-command chef 'uptime'
 Attach the terminal to a server in the cluster that matches the REGEX pattern given.
 
 ```
-dev-lxc attach chef
+dl attach chef
 ```
 
 ### Create a snapshot of the servers
@@ -146,14 +165,14 @@ dev-lxc attach chef
 Save the changes in the servers to snapshots with a comment.
 
 ```
-dev-lxc halt
-dev-lxc snapshot -c 'this is a snapshot comment'
+dl halt
+dl snapshot -c 'this is a snapshot comment'
 ```
 
 ### List snapshots
 
 ```
-dev-lxc snapshot -l
+dl snapshot -l
 ```
 
 ### Restore snapshots
@@ -163,8 +182,8 @@ Restore snapshots by name.
 Leave out the snapshot name or specify `LAST` to restore the most recent snapshot.
 
 ```
-dev-lxc snapshot -r
-dev-lxc up
+dl snapshot -r
+dl up
 ```
 
 ### Destroy snapshots
@@ -174,7 +193,7 @@ Destroy snapshots by name or destroy all snapshots by specifying `ALL`.
 Leave out the snapshot name or specify `LAST` to destroy the most recent snapshots.
 
 ```
-dev-lxc snapshot -d
+dl snapshot -d
 ```
 
 ### Destroy cluster
@@ -182,5 +201,13 @@ dev-lxc snapshot -d
 Use the following command to destroy the cluster's servers.
 
 ```
-dev-lxc destroy
+dl destroy
+```
+
+### Show Calculated Configuration
+
+Mostly for debugging purposes you have the ability to print the calculated cluster configuration.
+
+```
+dl show-config
 ```

data/lib/dev-lxc/cli.rb

@@ -76,11 +76,11 @@ base_container: b-ubuntu-1404
 
 # list any host directories you want mounted into the servers
 #mounts:
-#  - /root/work root/work
+#  - /root/clusters root/clusters
 
 # list any SSH public keys you want added to /home/dev-lxc/.ssh/authorized_keys
 #ssh-keys:
-#  - /root/work/clusters/id_rsa.pub
+#  - /root/clusters/id_rsa.pub
 
 # DHCP reserved (static) IPs must be selected from the IP range 10.0.3.150 - 254
 )
@@ -105,7 +105,7 @@ chef-server:
       products:
         chef-server:
         push-jobs-server:
-        reporting:
+#        reporting:
     chef-fe1.lxc:
       ipaddress: 10.0.3.202
       role: frontend
@@ -113,7 +113,7 @@ chef-server:
         chef-server:
         manage:
         push-jobs-server:
-        reporting:
+#        reporting:
 )
       chef_config = %Q(
 chef-server:
@@ -133,7 +133,7 @@ chef-server:
         chef-server:
         manage:
         push-jobs-server:
-        reporting:
+#        reporting:
 )
       automate_config = %Q(
 automate:
@@ -142,7 +142,7 @@ automate:
       ipaddress: 10.0.3.200
       products:
         delivery:
-      license_path: /path/for/automate.license
+      license_path: ../delivery.license
       chef_org: delivery
       enterprise_name: demo-ent
 )

data/lib/dev-lxc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev-lxc
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremiah Snapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,7 +84,7 @@ description: A tool for building Chef server clusters using LXC containers
 email:
 - jeremiah@getchef.com
 executables:
-- dev-lxc
+- dl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,13 +94,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/dev-lxc
+- bin/dl
 - dev-lxc.gemspec
 - docs/adhoc_clusters.md
 - docs/base_containers.md
 - docs/configuration.md
 - docs/dev-lxc_version_2.md
 - docs/manage_multiple_clusters.md
+- docs/mitmproxy.md
 - docs/usage.md
 - lib/dev-lxc.rb
 - lib/dev-lxc/cli.rb