chake 0.19 → 0.80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c3f3bf3aef3d51ac77731ec0fe1440b22aa77200b43d0b240af7793e40f557
-  data.tar.gz: 9b7e3bd34cc14c6809e67b14d17e538a6efd5c5de06f8ffe710f8a78ac94a6d9
+  metadata.gz: e0276e69503885ac871f9c3b73025598fe4401dd361e78e90d5921a873395a9b
+  data.tar.gz: 5e132b6715fb2f087ecfd72a411c8ab371f1bb0da63f7bf74def69e1c028fd15
 SHA512:
-  metadata.gz: 8d1e3b0eaf456c9cb8464761de7af27957f0439d1320a04591d2d3447836ccfac11c64682cf31a8ac207f62f40fa944ab7a3f2075caf8683b7d5a5dc28cf8596
-  data.tar.gz: f24ef87eed5d203bf19ad1ba47a71e2566152a0076593f16ab6b6b164fd896589a2d54b68b7a349bf18cb68b9432093e962bdcd699067c45ae097e5dad4d14ef
+  metadata.gz: '0914e13f840deaaba8a80eb7052006659e023ba8ea0c53aad08416cd56bedd2b66807f939352a7e57f53dad28cdcba5241884db461252dd909b4b09902d5d45f'
+  data.tar.gz: a0de67988cecfde1355cf0ebe21b778cb0fa51db7c6d572965ab34a2bb6eed43c88db7a8ef4eddf4f595344fc5685a2f11e67691ec82e90a81de314b15e39e90

data/.ackrc

@@ -0,0 +1 @@
+--ignore-dir=coverage

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 /examples/test/nodes.yaml
 /examples/test/.tmp
 .*.html
+*.1
+*.7

data/.gitlab-ci.yml

@@ -1,12 +1,24 @@
-before_script:
-  - pwd
-  - echo $USER
-  - bundle install --path .bundle
+image: debian:testing
+
+.install: &install
+  - apt-get update && apt-get install -qy ruby asciidoctor ruby-bundler ruby-rspec rubocop ruby-simplecov codespell
 
 tests:
+  before_script: *install
+  script:
+    - rake test
+
+manpages:
+  before_script: *install
+  script:
+    - rake man
+
+style:
+  before_script: *install
+  script:
+    - rake style
+
+codespell:
+  before_script: *install
   script:
-    - bundle exec rake
-    - bundle exec rake -f man/Rakefile
-  cache:
-    paths:
-      - .bundle
+    - rake codespell

data/.manifest

@@ -0,0 +1,63 @@
+.ackrc
+.gitignore
+.gitlab-ci.yml
+.manifest
+.rubocop.yml
+.rubocop_todo.yml
+ChangeLog.md
+Gemfile
+LICENSE.txt
+README.chef.md
+README.itamae.md
+README.md
+README.shell.md
+Rakefile
+bin/chake
+chake.gemspec
+chake.spec.erb
+examples/test/.ssh_config
+examples/test/Rakefile
+examples/test/Vagrantfile
+examples/test/config.rb
+examples/test/cookbooks/basics/recipes/default.rb
+examples/test/cookbooks/example/files/default/test
+examples/test/cookbooks/example/files/host-lemur/test.asc
+examples/test/cookbooks/example/recipes/default.rb
+lib/chake.rb
+lib/chake/bootstrap/00_set_hostname.sh
+lib/chake/bootstrap/chef/01_debian.sh
+lib/chake/bootstrap/chef/99_unsupported.sh
+lib/chake/config.rb
+lib/chake/config_manager.rb
+lib/chake/config_manager/chef.rb
+lib/chake/config_manager/itamae.rb
+lib/chake/config_manager/shell.rb
+lib/chake/config_manager/skel/chef/Rakefile
+lib/chake/config_manager/skel/chef/config.rb
+lib/chake/config_manager/skel/chef/cookbooks/basics/recipes/default.rb
+lib/chake/config_manager/skel/chef/nodes.yaml
+lib/chake/config_manager/skel/itamae/Rakefile
+lib/chake/config_manager/skel/itamae/cookbooks/basics/default.rb
+lib/chake/config_manager/skel/itamae/nodes.yaml
+lib/chake/config_manager/skel/itamae/roles/basic.rb
+lib/chake/config_manager/skel/shell/Rakefile
+lib/chake/config_manager/skel/shell/nodes.yaml
+lib/chake/connection.rb
+lib/chake/connection/local.rb
+lib/chake/connection/ssh.rb
+lib/chake/node.rb
+lib/chake/readline.rb
+lib/chake/tmpdir.rb
+lib/chake/version.rb
+man/.gitignore
+man/Rakefile
+man/readme2man.sed
+spec/chake/backend/local_spec.rb
+spec/chake/backend/ssh_spec.rb
+spec/chake/backend_spec.rb
+spec/chake/config_manager/chef_spec.rb
+spec/chake/config_manager/itamae_spec.rb
+spec/chake/config_manager/shell_spec.rb
+spec/chake/config_manager_spec.rb
+spec/chake/node_spec.rb
+spec/spec_helper.rb

data/.rubocop.yml

@@ -0,0 +1,53 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+    - lib/chake.rb
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-03-25 17:43:43 -0300 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/HeredocIndentation:
+  Exclude:
+    - 'lib/chake.rb'
+
+# Offense count: 3
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/chake.rb'
+
+# Offense count: 1
+Lint/InterpolationCheck:
+  Exclude:
+    - 'lib/chake.rb'
+
+# Offense count: 1
+# Configuration parameters: Blacklist.
+# Blacklist: END, (?-mix:EO[A-Z]{1})
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'lib/chake.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'bin/chake'

data/ChangeLog.md

@@ -1,3 +1,39 @@
+# 0.80
+
+This release adds support for multiple configuration managers. Chef is now only
+one of the options. There is also now support for configuration management with
+itamae, and lightweight configuration management tool inspired by Chef, and via
+shell commands. This should be mostly transparent to current Chef users, but
+new repositories initiatied by chake will use itamae by default.
+
+Other notable changes:
+
+* rake nodes: list configuration manager and format as table
+* Chake::Connection: fix handling of stderr
+* Rebootstrap nodes when changing config managers
+* bootstrap, upload: skip when config manager does not need them
+
+# 0.21.2
+
+* Chake::Backend#run: don't strip leading whitespace
+
+# 0.21.1
+
+* Fix converge when the connection is not already made as root. This bug was
+  introduced by the change in the previous release.
+
+# 0.21
+
+* converge, apply: allow removing data from the node JSON attributes
+
+# 0.20
+
+* check: give some feedback by running `sudo echo OK` instead of `sudo true`
+* Get rid of global variables
+* bin/chake: make rake run one thread for each node
+* Chake::Backend: run commands by opening a shell and writing to it
+* Document Chake.nodes
+
 # 0.19
 
 * Protect node JSON files from other users

data/README.chef.md

@@ -0,0 +1,70 @@
+chake-chef(7) -- configure chake nodes with chef-solo
+=====================================================
+
+## Description
+
+This configuration manager will allow you to manage nodes by running
+**chef-solo(1)** on each remote node.
+
+When `chake init` runs, the following chef-specific files will be created:
+
+A brief explanation of the created files that are specific to **chef**:
+
+* `config.rb`: contains the chef-solo configuration. You can modify it, but
+  usually you won't need to.
+* `config/roles`: directory is where you can put your role definitions.
+* `cookbooks`: directory where you will store your cookbooks. A sample cookbook
+  called "basics" is created, but feel free to remove it and add actual
+  cookbooks.
+
+## Configuration
+
+Nodes can be configured to be managed with chef by having a `run_list` key in
+their configuration:
+
+```yaml
+host1.mycompany.com:
+  run_list:
+    - role[server]
+    - recipe[service1]
+  service1:
+    option1: "here we go"
+```
+
+Any extra configuration under `host1.mycompany.com` will be saved to a JSON file
+and given to the chef-solo --node-json option in the command line. For example,
+the above configuration will produce a JSON file that looks like this:
+
+```json
+{
+  "run_list": [
+    "role[server]",
+    "recipe[service1]"
+  ]
+  ,
+  "service1": {
+    "option1": "here we go"
+  }
+}
+```
+
+Inside Chef recipes, you can access those values by using the `node` object.
+For example:
+
+```ruby
+template "/etc/service1.conf.d/option1.conf" do
+  variables option1: node["option1"]
+end
+```
+
+## Bootstrapping
+
+The bootstrap process for _chef_ involves getting chef-solo installed. The
+node hostname will also be set based on the hostname informed in the
+configuration file.
+
+## See also
+
+* **chake(1)**
+* <https://docs.chef.io/>
+* <https://docs.chef.io/chef_solo.html>

data/README.itamae.md

@@ -0,0 +1,58 @@
+chake-itamae(7) -- configure chake nodes with itamae
+====================================================
+
+## Description
+
+This configuration manager will run **itamae(1)** against your nodes.
+
+## Configuration
+
+The _itamae_ configuration manager requires one key called `itamae`, and the
+value must be a list of strings representing the list of recipes to apply to
+the node when converging.
+
+```yaml
+host1.mycompany.com:
+  itamae:
+    - cookbooks/basic/default.rb
+    - roles/server.rb
+  service1:
+    option1: "here we go"
+```
+
+Any extra configuration under `host1.mycompany.com` will be saved to a JSON file
+and given to the itamae --node-json option in the command line. For example,
+the above configuration will produce a JSON file that looks like this:
+
+```json
+{
+  "itamae": [
+    "cookbooks/basic.rb",
+    "roles/server.rb"
+  ]
+  ,
+  "service1": {
+    "option1": "here we go"
+  }
+}
+```
+
+Inside itamae recipes, you can access those values by using the `node` object.
+For example:
+
+```ruby
+template "/etc/service1.conf.d/option1.conf" do
+  variables option1: node["option1"]
+end
+```
+
+## Bootstrapping
+
+Very little bootstrapping is required for this configuration manager, as itamae
+requires no setup on the node site since the Ruby code in the recipes is
+interpreted locally and not on the nodes. During bootstrapping, only the node
+hostname will be set according to your chake configuration.
+
+## See also
+
+* **chake(1)**

data/README.md

@@ -1,42 +1,58 @@
-# chake(1)
+chake(1) -- serverless configuration management tool
+========================================
 
-## NAME
+## SYNOPSIS
 
-chake - serverless configuration with chef
+`chake` init
 
-## Introduction
+`chake` [rake arguments]
 
-chake is a tool that helps you manage multiple hosts with, without the need for
-a chef server. Configuration is managed in a local directory, which should
-probably be under version control with **git(1)** or anything else.
-Configuration is usually deployed via rsync over SSH, and applied by invoking
-**chef-solo(1)** over SSH on each host.
+## Description
 
-## Installation
+chake is a tool that helps you manage multiple hosts without the need for a
+central server. Configuration is managed in a local directory, which should
+(but doesn't need to ) be under version control with **git(1)** or any other
+version control system. áéíóú
 
-    $ gem install chake
+Configuration is deployed to managed hosts remotely, either by invoking a
+configuration management tool that will connect to them, or by first uploading
+the necessary configuration and them remotely running a tool on the hosts.
 
-## Creating the repository
+## Supported configuration managers.
 
-```
-$ chake init
-[create] nodes.yaml
-[ mkdir] nodes.d/
-[create] config.rb
-[ mkdir] config/roles
-[ mkdir] cookbooks/basics/recipes/
-[create] cookbooks/basics/recipes/default.rb
-[create] Rakefile
-```
+chake supports the following configuration management tools:
+
+* **itamae**: configuration is applied by running the itamae command line tool
+  on the management host; no configuration needs to be uploaded to the managed
+  hosts. See chake-itamae(7) for details.
+* **shell**: the local repository is copied to the host, and the shell commands
+  specified in the node configuration is executed from the directory where that
+  copy is. See chake-shell(7) for details.
+* **chef**: the local repository is copied to the host, and **chef-solo** is
+  executed remotely on the managed host. See chake-chef(7) for details.
+
+Beyond applying configuration management recipes on the hosts, chake also
+provides useful tools to manage multiple hosts, such as listing nodes, running
+commands against all of them simultaneously, logging in to interactive
+shells, and others.
+
+## creating the repository
+
+    $ chake init[:configmanager]
 
-A brief explanation of the created files:
+This will create an initial directory structure. Some of the files are specific
+to your your chosen **configmanager**, which can be one of [SUPPORTED
+CONFIGURATION MANAGERS]. The following files, though, will be common to any
+usage of chake:
 
-* `nodes.yaml`: where you will list the hosts you will be managing, and what recipes to apply to each of them.
-* `nodes.d`: a directory with multiple files in the same format as nodes.yaml. All files matching `*.yaml` in it will be added to the list of nodes.
-* `config.rb`: contains the chef-solo configuration. You can modify it, but usually you won't need to.
-* `config/roles`: directory is where you can put your role definitions.
-* `cookbooks`: directory where you will store your cookbooks. A sample cookbook called "basics" is created, but feel free to remove it and add actual cookbooks.
-* `Rakefile`: Contains just the `require 'chake'` line. You can augment it with other tasks specific to your intrastructure.
+* `nodes.yaml`: where you will list the hosts you will be managing, and what
+  recipes to apply to each of them.
+* `nodes.d`: a directory with multiple files in the same format as nodes.yaml.
+  All files matching `*.yaml` in it will be added to the list of nodes.
+* `Rakefile`: Contains just the `require 'chake'` line. You can augment it with
+  other tasks specific to your intrastructure.
+
+If you omit _configmanager_, `itamae` will be used by default.
 
 After the repository is created, you can call either `chake` or `rake`, as they
 are completely equivalent.
@@ -48,10 +64,12 @@ following:
 
 ```yaml
 host1.mycompany.com:
-  run_list:
-    - recipe[basics]
+  itamae:
+    - roles/basic.rb
 ```
 
+The exact contents depends on the chosen configuration management tool.
+
 You can list your hosts with `rake nodes`:
 
 ```
@@ -63,11 +81,11 @@ To add more nodes, just append to `nodes.yaml`:
 
 ```yaml
 host1.mycompany.com:
-  run_list:
-    - recipe[basics]
+  itamae:
+    - roles/basic.rb
 host2.mycompany.com:
-  run_list:
-    - recipes[basics]
+  itamae:
+    - roles/basic.rb
 ```
 
 And chake now knows about your new node:
@@ -100,55 +118,53 @@ password prompts, you can:
 
 ## Checking connectivity and initial host setup
 
-To check whether hosts are correcly configured, you can use the `check` task:
+To check whether hosts are correctly configured, you can use the `check` task:
 
-```bash
+```
 $ rake check
 ```
 
 That will run the the `sudo true` command on each host. If that pass without
-you having to passwords, you are sure that
+you having to type any passwords, it means that:
 
 * you have SSH access to each host; and
 * the user you are connecting as has password-less sudo correctly setup.
 
-```bash
-$ rake check
-```
-
-## Applying cookbooks
+## Applying configuration
 
 Note that by default all tasks that apply to all hosts will run in parallel,
 using rake's support for multitasks. If for some reason you need to prevent
 that, you can pass `-j1` (or --jobs=1`) in the rake invocation. Note that by
 default rake will only run N+4 tasks in parallel, where N is the number of
 cores on the machine you are running it. If you have more than N+4 hosts and
-want all of them to be handled in parallel, you might want o pass `-j` (or
+want all of them to be handled in parallel, you might want to pass `-j` (or
 `--jobs`), without any number, as the last argument; with that rake will have
 no limit on the number of tasks to perform in parallel.
 
-
 To apply the configuration to all nodes, run
 
-```bash
+```
 $ rake converge
 ```
 
 To apply the configuration to a single node, run
 
-```bash
+```
 $ rake converge:$NODE
 ```
 
 To apply a single recipe on all nodes, run
 
-```bash
+```
 $ rake apply[myrecipe]
 ```
 
+What `recipe` is depends on the configuration manager.
+
+
 To apply a single recipe on a specific node, run
 
-```bash
+```
 $ rake apply:$NODE[myrecipe]
 ```
 
@@ -156,12 +172,24 @@ If you don't inform a recipe in the command line, you will be prompted for one.
 
 To run a shell command on all nodes, run
 
+```
+$ rake run
+```
+The above will prompt you for a command, then execute it on all nodes.
+
+To pass the command to run in the command line, use the following syntax:
+
 ```
 $ rake run[command]
 ```
 
 If the `command` you want to run contains spaces, or other characters that are
-special do the shell, you have to quote them.
+special do the shell, you have to quote them, for example:
+
+```
+$ rake run["cat /etc/hostname"]
+```
+
 
 To run a shell command on a specific node, run
 
@@ -169,28 +197,29 @@ To run a shell command on a specific node, run
 $ rake run:$NODE[command]
 ```
 
-If you don't inform a command in the command line, you will be prompted for
-one.
+As before, if you run just `rake run:$NODE`, you will be prompted for the
+command.
 
-To check the existing tasks, run
+To list all existing tasks, run:
 
-```bash
+```
 $ rake -T
 ```
 
-## Writing cookbooks
+## Writing configuration management code
 
-Since chake is actually a wrapper for Chef Solo, you should read the [chef
-documentation](https://docs.chef.io/). In special, look at the [Chef Solo
-Documentation](https://docs.chef.io/chef_solo.html).
+As chake supports different configuration management tools, the specifics of
+configuration management code depends on the the tool you choose. See the
+corresponding documentation.
 
 ## The node bootstrapping process
 
-When chake acts on a node for the first time, it has to bootstrap it. The
-bootstrapping process includes doing the following:
+Some of the configuration management tools require some software to be
+installed on the managed hosts. When that's the case, chake acts on a node for
+the first time, it has to bootstrap it. The bootstrapping process includes
+doing the following:
 
-- installing chef and rsync
-- disabling the chef client daemon
+- installing and configuring the needed software
 - setting up the hostname
 
 ## Node URLs
@@ -201,10 +230,10 @@ is the simplest form of specifying your nodes. Here are all the components of
 the node URLs:
 
 ```
-[backend://][username@]hostname[:port][/path]
+[connection://][username@]hostname[:port][/path]
 ```
 
-* `backend`: backend to use to connect to the host. `ssh` or `local` (default: `ssh`)
+* `connection`: what to use to connect to the host. `ssh` or `local` (default: `ssh`)
 * `username`: user name to connect with (default: the username on your local workstation)
 * `hostname`: the hostname to connect to (default: _none_)
 * `port`: port number to connect to (default: 22)
@@ -228,7 +257,7 @@ converging. To do this, you just need to enhance the corresponding tasks:
 
 Example:
 
-```
+```ruby
 task :bootstrap_common do
   sh './scripts/pre-bootstrap-checks'
 end
@@ -237,7 +266,8 @@ end
 ### Encrypted files
 
 Any files ending matching `*.gpg` and `*.asc` will be decrypted with GnuPG
-before being sent to the node. You can use them to store passwords and other
+before being sent to the node (for the configuration management tools that
+required files to be sent). You can use them to store passwords and other
 sensitive information (SSL keys, etc) in the repository together with the rest
 of the configuration.
 
@@ -260,7 +290,7 @@ Some times, you will also want or need to prefix your SSH invocations with some
 prefix command in order to e.g. tunnel it through some central exit node. You
 can do this by setting `$CHAKE_SSH_PREFIX` on your environment. Example:
 
-```
+```bash
 CHAKE_SSH_PREFIX=tsocks rake converge
 ```
 
@@ -269,33 +299,48 @@ The above will make all SSH invocations to all hosts be called as `tsocks ssh
 
 ### Converging local host
 
-If you want to manage your local workstation with chake, you can declare a local node like this in `nodes.yaml`:
+If you want to manage your local workstation with chake, you can declare a
+local node using the "local" connection type, like this (in `nodes.yaml`):
 
 ```yaml
 local://thunderbolt:
-  run_list:
-    - role[workstation]
+  itamae:
+    - role/workstation.rb
 ```
 
 To apply the configuration to the local host, you can use the conventional
 `rake converge:thunderbolt`, or the special target `rake local`.
 
 When converging all nodes, `chake` will skip nodes that are declared with the
-`local://` backend and whose hostname does not match the hostname  in the
+`local://` connection and whose hostname does not match the hostname  in the
 declaration. For example:
 
 ```yaml
 local://desktop:
-  run_list:
-    - role[workstation]
+  itamae:
+    - role/workstation.rb
 local://laptop:
-  run_list:
-    - role[workstation]
+  itamae:
+    - role/workstation.rb
 ```
 
 When you run `rake converge` on `desktop`, `laptop` will be skipped, and
 vice-versa.
 
+### Accessing node data from your own tasks
+
+It's often useful to be able to run arbitrary commands against the data you
+have about nodes. You can use the `Chake.nodes` for that. For example, if you
+want to geolocate each of yours hosts:
+
+```ruby
+task :geolocate do
+  Chake.nodes.each do |node|
+    puts "#{node.hostname}: %s" % `geoiplookup #{node.hostname}`.strip
+  end
+end
+```
+
 ## Environment variables
 
 * `$CHAKE_SSH_CONFIG`:
@@ -316,13 +361,7 @@ vice-versa.
 
 ## See also
 
-* **rake(1)**, **chef-solo(1)**
-* Chef documentation: https://docs.chef.io/
-
-## Contributing
-
-1. Fork it ( http://github.com/terceiro/chake/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* **rake(1)**
+* **chake-itamae(7)**, https://itamae.kitchen/
+* **chake-shell(7)**
+* **chake-chef(7)**, **chef-solo(1)**, https://docs.chef.io/