├── CODEOWNERS ├── LICENSE ├── README.md ├── bolt-project.yaml ├── plans ├── dynamic_inventory.pp └── remove_apache.yaml ├── spec └── tasks │ └── ruby_task_helper_spec.rb └── tasks ├── python_task_helper.json ├── python_task_helper.py ├── ruby_task_helper.json └── ruby_task_helper.rb /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @puppetlabs/bolt 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bolt Example Library 2 | 3 | This repo contains a variety of examples demonstrating common patterns used when writing Bolt plans 4 | and tasks. To see what plans and tasks are available, run: 5 | 6 | ``` 7 | bolt plan show 8 | ``` 9 | or 10 | ``` 11 | bolt task show 12 | ``` 13 | 14 | ## The Examples 15 | 16 | ### Tasks 17 | 18 | * **examples::python_task_helper** and **examples::ruby_task_helper**: These tasks simply print a 19 | message with the provided name. 20 | 21 | * Using the ruby and python task helpers 22 | * Returning structured output 23 | 24 | ### Plans 25 | 26 | * **examples::remove_apache**: This is a short YAML plan that stops the Apache service on RHEL 27 | targets using the service task, a command, and the package task. It demonstrates: 28 | 29 | * A YAML plan running tasks and commands 30 | * **examples::dynamic_inventory**: This Puppet plan attempts to install python on the provided 31 | targets, then adds the 'python' feature to the targets that succeeded and runs a task that has 32 | python, bash, and powershell implementations. This demonstrates: 33 | 34 | * Catching and handling errors 35 | * Printing messages for the user 36 | * Iterating over an array 37 | * Modifying targets during a plan run 38 | -------------------------------------------------------------------------------- /bolt-project.yaml: -------------------------------------------------------------------------------- 1 | name: examples 2 | -------------------------------------------------------------------------------- /plans/dynamic_inventory.pp: -------------------------------------------------------------------------------- 1 | # @summary 2 | # Attempt to install python on targets, then run a task using python if it 3 | # installed successfully and falling back to bash or powershell. 4 | # This plan demonstrates editing targets during a plan run, as well as simple 5 | # plan constructs like iterating over an array and conditionals. 6 | # 7 | # @param targets 8 | # The targets to run on. 9 | # @param task 10 | # The task to run after attempting python install 11 | # 12 | # @return ResultSet The result of running the task 13 | # 14 | # @example Run task 'examples::mytask' 15 | # run_plan(examples::dynamic_inventory, $targets, 'task' => 'examples::mytask') 16 | # 17 | plan examples::dynamic_inventory ( 18 | TargetSpec $targets, 19 | String $task, 20 | ) { 21 | # Install python 22 | $result = run_task('package', $targets, 23 | 'name' => 'python', 24 | 'action' => 'install', 25 | '_catch_errors' => true) 26 | 27 | # Let users know which targets failed python install 28 | # This is an example of a conditional 29 | unless $result.ok { 30 | out::message("Installing python failed on #{$result.error_set.targets}") 31 | } 32 | 33 | # Set the python feature on all targets that successfully had python 34 | # installed, allowing the task to use the python version instead of shell. 35 | # This is an example of iterating over an array 36 | $result.ok_set.targets.each |$target| { 37 | set_feature($target, 'python', true) 38 | } 39 | 40 | # Run a task on all targets. Targets with the python interpreter will use the 41 | # python version, while targets where install failed will use either the bash 42 | # or powershell version. 43 | # Return the output of the task 44 | return run_task($task, $targets) 45 | 46 | } 47 | 48 | -------------------------------------------------------------------------------- /plans/remove_apache.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | parameters: 3 | targets: 4 | type: TargetSpec 5 | description: "The RHEL targets to remove Apache on" 6 | 7 | steps: 8 | - task: service 9 | target: $targets 10 | description: "Shut down apache service" 11 | parameters: 12 | name: httpd 13 | action: stop 14 | - command: "cp /etc/httpd/logs/access_log /tmp/apache_access" 15 | target: $targets 16 | description: "Copy Apache access log" 17 | - task: package 18 | target: $targets 19 | description: "Remove Apache" 20 | parameters: 21 | action: uninstall 22 | name: httpd 23 | -------------------------------------------------------------------------------- /spec/tasks/ruby_task_helper_spec.rb: -------------------------------------------------------------------------------- 1 | # Make sure the ruby_task_helper module is in the same directory as your bolt 2 | # project. For example: 3 | # $ ls modules/ 4 | # ruby_task_helper/ 5 | # myproject/ 6 | 7 | require_relative '../../tasks/ruby_task_helper.rb' 8 | # An example of testing a task using the helper 9 | 10 | describe 'MyTask' do 11 | let(:params) { { name: "Robert'); DROP TABLE Students;--" } } 12 | let(:task) { MyTask.new() } 13 | 14 | it 'runs my task' do 15 | expect(task.task(params)).to eq({greeting: "Robert'); DROP TABLE Students;--"}) 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /tasks/python_task_helper.json: -------------------------------------------------------------------------------- 1 | { 2 | "description": "An example task that uses the Python helper library", 3 | "input_method": "stdin", 4 | "parameters": { 5 | "name": { 6 | "description": "Name of user you would like to greet.", 7 | "type": "String" 8 | } 9 | }, 10 | "files": ["python_task_helper/files/task_helper.py"] 11 | } 12 | -------------------------------------------------------------------------------- /tasks/python_task_helper.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import os, sys 4 | import pathlib 5 | sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python_task_helper', 'files')) 6 | from task_helper import TaskHelper 7 | 8 | class MyTask(TaskHelper): 9 | def task(self, args): 10 | return {'result': 'Hi, my name is '+args['name']} 11 | 12 | if __name__ == '__main__': 13 | MyTask().run() 14 | 15 | -------------------------------------------------------------------------------- /tasks/ruby_task_helper.json: -------------------------------------------------------------------------------- 1 | { 2 | "description": "An example task that uses the Ruby helper library", 3 | "input_method": "stdin", 4 | "parameters": { 5 | "name": { 6 | "description": "Name of user you would like to greet.", 7 | "type": "String" 8 | } 9 | }, 10 | "files": ["ruby_task_helper/files/task_helper.rb"] 11 | } 12 | -------------------------------------------------------------------------------- /tasks/ruby_task_helper.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | installdir_path = "../../ruby_task_helper/files/task_helper.rb" 4 | local_path = "../files/task_helper.rb" 5 | 6 | # Task is being run with bolt and helper is at location relative to task 7 | if File.exist?(installdir_path) 8 | require_relative installdir_path 9 | # TODO MODULES-8605 reccomend efficient pattern for testing locally 10 | else 11 | require_relative local_path 12 | end 13 | 14 | class MyTask < TaskHelper 15 | def task(name: nil, **kwargs) 16 | { greeting: "Hi, my name is #{name}" } 17 | end 18 | end 19 | 20 | if __FILE__ == $0 21 | MyTask.run 22 | end 23 | --------------------------------------------------------------------------------