README.md in dev-lxc-3.0.0 vs README.md in dev-lxc-3.1.0

- old
+ new

@@ -38,11 +38,11 @@ The easiest way to build a dev-lxc-platform system is to download the dev-lxc-platform repository 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 Login to the dev-lxc-platform instance and switch to the root user to use the dev-lxc tool. @@ -52,33 +52,12 @@ sudo -i ``` When you are logged in as the root user you should automatically enter a [byobu session](http://byobu.co/). -## Byobu keybindings +See [byobu keybindings](docs/byobu_keybindings.md) to learn some byobu basics. -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. - ## Update dev-lxc gem Run the following command as the instance's root user if you ever need to upgrade the dev-lxc gem inside the dev-lxc-platform instance. ``` @@ -90,13 +69,13 @@ ## dl Command and Subcommands `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: ``` dl help @@ -138,11 +117,11 @@ 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 ``` @@ -167,12 +146,14 @@ 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 chef-client exit ``` @@ -189,34 +170,34 @@ ``` 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. +For example, browse to https://automate.lxc and login with the credentials provided by `dl print-automate-credentials`. + ### Manage the Cluster -The right pane of the "cluster" window should show `dl status` output. This shows the status of each server including any existing snapshots. +Let's stop the servers before restoring and creating snapshots. -It is recommended that you stop the servers before restoring or 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. +You can restore the most recent snapshot of all the servers. -For example, you could restore the Chef Automate server to the state right after its package was installed but before it was configured. - ``` -dl snapshot automate -r snap0 +dl snapshot -r ``` You can create snapshots with or without a comment. ``` @@ -236,9 +217,13 @@ ``` ## More Documentation 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 2. Create your feature branch (`git checkout -b my-new-feature`)