chef-apply 0.1.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# Chef Run
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chef_apply`.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chef-apply'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chef-apply
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write usage development here
+
+## Contributing
+
+TODO: Write usage contributing here
+
+## License
+
+The gem is available as open source under the terms of the [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
+
+## Code of Conduct
+
+TODO: Write usage code of conduct here

data/Rakefile

@@ -0,0 +1,32 @@
+#
+# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "bundler/gem_tasks"
+
+task :default => [:spec, :style]
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "chefstyle"
+require "rubocop/rake_task"
+desc "Run Chef Ruby style checks"
+RuboCop::RakeTask.new(:chefstyle) do |t|
+  t.options = %w{--display-cop-names}
+end
+
+task :style => :chefstyle

data/bin/chef-run

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+#
+# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require "chef_apply/startup"
+
+# Perform initialization tasks then hand off control to
+# CLI to run the command.
+ChefApply::Startup.new(ARGV).run

data/chef-apply.gemspec

@@ -0,0 +1,67 @@
+#
+# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chef_apply/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-apply"
+  spec.version       = ChefApply::VERSION
+  spec.authors       = ["Chef Software, Inc"]
+  spec.email         = ["beta@chef.io"]
+
+  spec.summary       = "The ad-hoc execution tool for the Chef ecosystem."
+  spec.description   = "Ad-hoc management of individual nodes and devices."
+  spec.homepage      = "https://github.com/chef/chef-apply"
+  spec.license       = "Apache-2.0"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.files = %w{Rakefile LICENSE README.md} +
+    Dir.glob("Gemfile*") + # Includes Gemfile and locks
+    Dir.glob("*.gemspec") +
+    Dir.glob("{lib,bin,vendor,i18n}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mixlib-cli"    # Provides argument handling DSL for CLI applications
+  spec.add_dependency "mixlib-config" # shared chef configuration library that
+                                      # simplifies managing a configuration file
+  spec.add_dependency "mixlib-log"    # Basis for our traditional logger
+  spec.add_dependency "mixlib-install" # URL resolver + install tool for chef products
+  spec.add_dependency "r18n-desktop" # easy path to message text management via
+                                     # localization gem...
+  spec.add_dependency "toml-rb" # This isn't ideal because mixlib-config uses 'tomlrb'
+                                # but that library does not support a dumper
+  spec.add_dependency "train" # remote connection management over ssh, winrm
+  spec.add_dependency "pastel" # A color library
+  spec.add_dependency "tty-spinner" # Pretty output for status updates in the CLI
+  spec.add_dependency "chef", ">= 14.0" # Needed to load cookbooks
+  spec.add_dependency "chef-dk", ">= 3.0"
+  spec.add_dependency "chef-telemetry"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry-stack_explorer"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "chefstyle"
+end

data/i18n/en.yml

@@ -0,0 +1,513 @@
+#
+# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+cli:
+  telemetry_enabled: |
+    Telemetry has been enabled by default for this beta release
+    of Chef Workstation. The anonymous data we gather is used to
+    determine how we can impove your Chef Workstation experience.
+
+    To disable it, add the following entry to
+    %1:
+
+    [telemetry]
+    enable=false
+
+    For more information about what we data gather and additional opt-out
+    options, please visit https://chef.sh/TODO.
+  description: |
+    Chef Run is a tool to execute ad-hoc tasks using Chef.
+  creating_config: "Creating config file in %1."
+  default_config_location: "Location of config file. Default: %1"
+  identity_file: "SSH identity file to use when connecting. Keys loaded into ssh-agent will also be used."
+  ssl:
+    desc: "Use SSL for WinRM. Current default: %1"
+    verify_desc: |
+      Verify peer certificate when using SSL for WinRM
+      Use --ssl-no-verify when using SSL for WinRM and
+      the remote host is using a self-signed certificate.
+      Current default: %1
+  cookbook_repo_paths: "Comma separated list of cookbook repository paths."
+  install_description: |
+    Install Chef client on the target host(s) if it is not installed.
+    This defaults to enabled - the installation will be performed
+    if there is no Chef client on the target(s).
+  user_description: |
+    Username to use for authentication to the target(s). The same
+    username will be used for all targets.
+  password_description: |
+    Password to use for authentication to the target(s). The same
+    password will be used for all targets.
+  protocol_description: |
+    The protocol to use for connecting to targets.
+    The default is '%2', and it can be changed in config.toml by
+    setting 'connection.default_protocol' to a supported option.
+  sudo:
+    flag_description:
+      sudo: "Whether to use root permissions on the target. Default: true"
+      command: "Command to use for administrative/root access. Defaults to 'sudo'."
+      options: |
+        Options to use with the sudo command. If there are multiple flags,
+        quote them. For example: --sudo-options '-H -P -s'
+      password: |
+        Password to use with the sudo command.  This must be provided if
+        password is required for sudo on the target(s). The same sudo password
+        will be used for all targets.
+  help:
+    description: Show help and usage for `chef-run`
+  usage: |
+    chef-run <TARGET[S]> <RESOURCE> <RESOURCE_NAME> [PROPERTIES] [FLAGS]
+    chef-run <TARGET[S]> <RECIPE> [FLAGS]
+
+  usage_full: |
+    chef-run <TARGET[S]> <RESOURCE> <RESOURCE_NAME> [PROPERTIES] [FLAGS]
+
+      Runs a single <RESOURCE> on the specified <TARGET[S]>.
+      [PROPERTIES] should be specified as key=value.
+
+      For example:
+
+        chef-run web01 service nginx action=restart
+        chef-run web01,web02 service nginx action=restart
+        chef-run web0[1:2] service nginx action=restart
+
+    chef-run <TARGET[S]> <RECIPE> [FLAGS]
+
+      Runs a single recipe located at <RECIPE> on the specified <TARGET[S]>.
+
+      For example:
+
+        chef-run web01 path/to/cookbook/recipe.rb
+        chef-run web01,web02 path/to/cookbook
+        chef-run web0[1:2] cookbook_name
+        chef-run web01 cookbook_name::recipe_name
+
+    ARGUMENTS:
+      <TARGET[S]>       The hosts or IPs to target. Can also be an SSH or WinRM URLs
+                        in the form:
+
+                        ssh://[USERNAME]@example.com[:PORT]
+      <RESOURCE>        A Chef resource, such as 'user' or 'package'
+      <RESOURCE_NAME>   The name, usually used to specify what 'thing' to set up with
+                        the resource. For example, given resource 'user', 'name' would be
+                        the name of the user you wanted to create.
+      <RECIPE>          The recipe to converge. This can be provided as one of:
+                        1. Full path to a recipe file
+                        2. Cookbook name. First we check the working directory for this
+                           cookbook, then we check in the chef repository path. If a
+                           cookbook is found we run the default recipe.
+                        3. This behaves similarly to 'cookbook name' above, but it also allows
+                           you to specify which recipe to use from the cookbook.
+  error:
+    bad_config_file: |
+
+      The path '%1' is not a valid file, or it cannot be read.
+
+      Please verify that the path is correct, and that permissions
+      on the file allow it to be read by your user account.
+
+    missing_config_path: |
+
+      Missing configuration file.
+
+      Please provide the path to a valid chef-run configuration file
+      as an argument to --config-path. For example:
+
+        --config-path /home/user1/.chef-workstation/config.toml
+
+    invalid_config_key: |
+
+      Invalid configuration entry.
+
+      When loading '%2',
+      the configuration entry '%1' was not recognized.
+
+      Please check the spelling and ensure that the value is correct.
+
+    unknown_config_error: |
+
+      Error in configuration file.
+
+      When loading '%2',
+      the following error occurred:
+        %1
+
+      Please verify that the configuration file is correct. If the
+      problem continues, contact beta@chef.io for further assistance.
+
+  version:
+    description: Show the current version of Chef Run.
+    show: "chef-run: %1"
+  status:
+    connecting: "Connecting as %1..."
+    connected: "Connected."
+    connection_failed: "Connection failed: %1"
+
+status:
+  generate_policyfile:
+    generating:  Generating local policyfile...
+    success: Generated local policyfile
+  install_chef:
+    installing: Installing Chef client version %1.
+    checking_for_client: Checking for Chef client.
+    upgrading: Upgrading Chef client from version %1 to %2.
+    downloading: Downloading Chef client installer into local cache.
+    uploading: Uploading Chef client installer to target.
+    verifying: Verifying Chef client installation.
+    already_present: Chef client version %1 already installed on target.
+    install_success: Successfully installed Chef client version %1
+    upgrade_success: Successfully upgraded Chef client from version %1 to %2.
+    failure: "An error occurred while installing Chef client: %1"
+  converge:
+    multi_header: "Converging targets:"
+    converging_recipe: Converging local recipe %1 on target...
+    converging_resource: Converging %1 on target...
+    creating_local_policy: Creating local policy...
+    creating_remote_policy: Pushing remote policy to target...
+    uploading_trusted_certs: Uploading local trusted certs to target...
+    running_chef: Running Chef on target...
+    success: "Successfully converged target!"
+    failure: "Failed to converge target."
+    reboot: "Reboot scheduled on target."
+
+# Error definitions, usage Text.e.ERR999
+# General format:
+# First Line: brief description of the error
+# Second line: blank
+# Third+ : detailed description, max 76 characters per line
+errors:
+  # Catch-all for the worst case
+  UNKNOWN: An unknown error has occurred.
+
+  # Installer action errors
+  CHEFINS002: |
+    The target does not have chef-client installed.
+
+    This command is powered by the Chef client.  In order to make use of it
+    on this node, the Chef client must be installed first.
+
+    Re-running this command without the '--no-install' flag will
+    automatically perform the installation.
+
+  CHEFINS003: |
+    The target has an older version of Chef client installed.
+
+    The target has version %1 installed, but this command
+    requires a minimum version of %2.
+
+    Please upgrade the Chef client on this node to version %2 or later.
+
+  # Local errors trying to create policy to send to target
+  CHEFPOLICY001: |
+    Could not create local Policyfile bundle.
+
+    The following error was reported:
+
+      %1
+
+  # Remote execution and file operation errors are prefixed CHEFRMT
+  CHEFRMT001: |
+    The command '%1' exited with return code '%2' on '%3'.
+
+    The following error was reported:
+
+      %4
+
+  # Remote chef client run failure start here.
+  CHEFCCR001: |
+    Could not determine reason for converge failure.
+
+    STDOUT (may be blank)
+
+      %1
+
+    STDERR (may be blank)
+
+      %2
+
+    An error occurred while converging the remote host.
+    I was unable to retrieve the log file which would allow
+    me to provide more information.  Above is the output
+    that occurred while trying to retrieve the remote log file.
+
+  CHEFCCR002: |
+    The converge of the remote host failed for the
+    following reason:
+
+      %1
+
+  CHEFCCR003: |
+    The action '%1' is not valid.
+
+    Valid actions are:
+
+      %2
+
+    For more information, please consult the documentation
+    for this resource:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR004: |
+    A property value you provided is not valid:
+
+      %1
+
+    Please consult the documentation for properties
+    supported by your resource and their valid values:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR005: |
+    '%1' is not a valid Chef resource.
+
+    Please consult the documentation for a list of valid resources:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR006: |
+    '%1' is not a property of '%2'.
+
+    Please consult the documentation for %2 for a list of
+    valid properties:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR099: |
+    The converge of the remote host failed.
+
+    Please examine the log file for a detailed cause of failure.
+
+  # Train-related errors (connectivy, auth failure, etc)
+  # are prefixed CHEFTRN. Non-specific descendants of Train::Error
+  # will resolve to CHEFTRN001, and we can add additional
+  # more specific text as we need it.
+  CHEFTRN001: |
+    An error has occurred on the %1 connection to %2:
+
+    %2.
+
+  CHEFTRN002: |
+    An remote error has occurred:
+
+      %1.
+
+  CHEFTRN003: |
+    Password required for sudo.
+
+    This target requires a password to perform sudo operations.  Please provide a
+    password using the --sudo-password option. For example if the sudo password is
+    in the environment variable $CHEF_RUN_SUDO_PASSWORD, you could use:
+
+    --sudo-password $CHEF_RUN_SUDO_PASSWORD
+
+  CHEFTRN004: |
+    Incorrect sudo password provided.
+
+    Please ensure that the password you provided with "--sudo-password" is correct.
+
+  CHEFTRN005: |
+    sudo command '%1' not found.
+
+    Please verify that the --sudo-command '%1' is valid
+    and installed on this node.
+
+  CHEFTRN006: |
+    sudo requires tty on this system
+
+    In order to continue, sudo must be configured to no longer require tty.
+    You can do this by modifying /etc/sudoers:
+
+    For all users:
+      Defaults !requiretty
+
+    Per-user:
+      Defaults:username !requiretty
+
+  CHEFTRN007: |
+    No authentication methods available.
+
+    Try...
+    - Provide a password with "--password PASSWORD"
+    - Provide a key with "-identity-file PATH/TO/FILE"
+    - Enable ssh-agent and add keys
+    - Add a host entry to your ssh configuration
+
+    Additional instructions can be found in the troubleshooting documentation:
+
+    https://www.chef.sh/docs/chef-workstation/troubleshooting/#error-code-cheftrn007
+
+  CHEFTRN999: |
+    Connection failed: %1
+
+    The following error occured while attempting to connect and authenticate to the target.
+
+    %1
+
+  # CLI argument validation errors
+  CHEFVAL002: |
+    You must supply <TARGET[S]> and either <RESOURCE> and <RESOURCE_NAME> or <RECIPE>
+
+  CHEFVAL003: |
+    Property '%1' did not match the 'key=value' syntax required
+
+  CHEFVAL004: |
+    Please provide a recipe in the form 'path/to/recipe/file.rb',
+    'path/to/cookbook', 'cookbook_name' or 'cookbook_name::recipe_name'.
+
+    You provided '%1'.
+
+  CHEFVAL005: |
+    The cookbook provided could not be loaded. Ensure it contains a valid
+    'metadata.rb'.
+
+    Cookbook path is '%1'.
+
+  CHEFVAL006: |
+    Cookbook '%1' could not be found in any of the following directories
+
+    %2
+
+  CHEFVAL007: |
+    There is no default recipe in cookbook '%2'. Please provide the name of the recipe to run, for example:
+      %2::some_recipe
+
+    Cookbook path is '%1'.
+
+  CHEFVAL008: |
+    There is no recipe named '%2' in the cookbook '%4', which I found at '%1'.
+
+    Please include the name of the recipe you wish to converge on the remote target.
+
+    These are the available recipes in '%4':
+    %3
+
+  CHEFVAL009: |
+    File extension '%1' is unsupported. Currently recipes must be specified with a `.rb` extension.
+
+  CHEFVAL010: |
+    The flag '%1' does not exist.
+
+      Available flags are:
+    %2
+
+  CHEFVAL011: |
+    The protocol '%1' is not supported.
+
+    Currently supported remote access protocols are:
+
+      %2
+
+  # General errors/unknown errors are handled with CHEFINT
+  CHEFINT001: |
+    An unexpected error has occurred:
+
+      %1
+
+  # Maps to: NameError
+  CHEFNET001: |
+    A network error occurred:
+
+      %1
+
+    Please verify the host name or address is correct and that the host is
+    reachable before trying again.
+
+  # Remote chef client run failure start here.
+  CHEFUPL003: |
+    Uploading config to target failed.
+
+  CHEFUPL004: |
+    Uploading handler to target failed.
+
+  CHEFUPL005: |
+    Uploading policy bundle to target failed.
+
+  # Maps to: SSL::SSLError with message text indicating verification failure
+  CHEFNET002: |
+    SSL host verification failed.
+
+    I could not verify the identity of the remote host.
+
+    If you are certain that you are connecting to the correct host,
+    you can specify the '--no-ssl-verify' option for this command, or
+    make it the default by setting the following in your configuration:
+
+      [connection.winrm]
+      ssl_verify=false
+
+  # Errors specifying target ranges
+  CHEFRANGE001: |
+    The target '%1' contains an invalid range.
+
+    The range '%2' mixes alphabetic and numeric values.
+    A range must be one or the other.
+
+  CHEFRANGE002:
+    The target '%1' contains too many ranges.
+
+    A single target name can contain up two ranges.
+
+  CHEFRANGE003: !!pl
+    1:
+      The target provided resolves to too many hosts.
+
+      At this time there is a limit of %2 hosts in a single operation.
+    n:
+      The targets provided resolve to too many hosts.
+
+      At this time there is a limit of %2 hosts in a single operation.
+
+  # Errors related to multi-target execution
+  CHEFMULTI001: |
+    One or more actions has failed.
+
+    A complete list of failures and possible resolutions can
+    be found in the file below:
+
+      %1
+
+  # Errors relating to target state:
+  CHEFTARG001: |
+    '%1' is not a supported target operating system at this time.
+
+    We plan to support a range of target operating systems,
+    but during this targeted beta we are constraining our efforts
+    to Windows and Linux.
+
+  footer:
+    both: |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the log file and stack trace from the
+      locations below:
+
+        %1
+        %2
+
+    log_only:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the log file from the location below:
+        %1
+
+    stack_only:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the stack trace from the location below:
+        %1
+
+    neither:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io