├── action.yml ├── main.js ├── chaos-test.yaml ├── main.sh ├── .github └── workflows │ └── chaos.yml ├── README.md └── LICENSE /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Chaos Mesh' 2 | description: 'Orchestrate chaos on Kubernetes environments' 3 | runs: 4 | using: "node12" 5 | main: "main.js" 6 | branding: 7 | icon: 'terminal' 8 | color: 'blue' 9 | -------------------------------------------------------------------------------- /main.js: -------------------------------------------------------------------------------- 1 | const spawnSync = require('child_process').spawnSync; 2 | const path = require("path"); 3 | 4 | const proc = spawnSync('bash', [path.join(__dirname, 'main.sh')], {stdio: 'inherit'}); 5 | process.exit(proc.status) 6 | -------------------------------------------------------------------------------- /chaos-test.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: chaos-mesh.org/v1alpha1 2 | kind: NetworkChaos 3 | metadata: 4 | name: network-delay 5 | namespace: busybox 6 | spec: 7 | action: delay # the specific chaos action to inject 8 | mode: all 9 | selector: 10 | pods: 11 | busybox: 12 | - busybox-0 13 | delay: 14 | latency: "10ms" 15 | duration: "5s" 16 | scheduler: 17 | cron: "@every 10s" 18 | direction: to 19 | target: 20 | selector: 21 | pods: 22 | busybox: 23 | - busybox-1 24 | mode: all -------------------------------------------------------------------------------- /main.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | CFG_BASE64=${CFG_BASE64:="NULL"} 6 | CFG_FILE=${CFG_FILE:="NULL"} 7 | CHAOS_MESH_VERSION=${CHAOS_MESH_VERSION:="LATEST"} 8 | CFG_FILE_PATH="" 9 | 10 | git clone https://github.com/chaos-mesh/chaos-mesh.git 11 | cd chaos-mesh 12 | if [ "$CHAOS_MESH_VERSION" != "LATEST" ]; then 13 | echo "use version $CHAOS_MESH_VERSION" 14 | git checkout $CHAOS_MESH_VERSION 15 | fi 16 | 17 | if [ "$CFG_BASE64" != "NULL" ]; then 18 | echo "$CFG_BASE64" | base64 --decode > chaos.yaml 19 | CFG_FILE_PATH="./chaos.yaml" 20 | echo "**** chaos configuration ****" 21 | cat chaos.yaml 22 | echo "*****************************" 23 | elif [ "$CFG_FILE" != "NULL" ]; then 24 | CFG_FILE_PATH="${CFG_FILE}" 25 | else 26 | echo "CFG_BASE64 and CFG_FILE is empty, can not get chaos configuration" 27 | exit 1 28 | fi 29 | 30 | echo "CFG_FILE_PATH is $CFG_FILE_PATH" 31 | 32 | echo "install chaos mesh" 33 | helm version 34 | kubectl version 35 | kubectl create -f ./manifests/crd.yaml 36 | kubectl create ns chaos-testing 37 | helm install chaos-mesh helm/chaos-mesh --namespace=chaos-testing --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock 38 | 39 | echo "wait pod status to running" 40 | for ((k=0; k<120; k++)); do 41 | kubectl get pods --namespace chaos-testing -l app.kubernetes.io/instance=chaos-mesh > pods.status 42 | cat pods.status 43 | 44 | run_num=`grep Running pods.status | wc -l` 45 | pod_num=$((`cat pods.status | wc -l` - 1)) 46 | if [ $run_num == $pod_num ]; then 47 | break 48 | fi 49 | 50 | sleep 1 51 | done 52 | 53 | kubectl apply -f $CFG_FILE_PATH 54 | -------------------------------------------------------------------------------- /.github/workflows/chaos.yml: -------------------------------------------------------------------------------- 1 | name: Chaos 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | steps: 15 | 16 | - name: Creating kind cluster 17 | uses: helm/kind-action@v1.0.0-rc.1 18 | 19 | - name: Print cluster information 20 | run: | 21 | kubectl config view 22 | kubectl cluster-info 23 | kubectl get nodes 24 | kubectl get pods -n kube-system 25 | helm version 26 | kubectl version 27 | 28 | - uses: actions/checkout@v2 29 | 30 | - name: Deploy an application 31 | run: | 32 | kubectl apply -f https://raw.githubusercontent.com/chaos-mesh/apps/master/ping/busybox-statefulset.yaml 33 | 34 | - name: Check pods 35 | run: | 36 | kubectl get pods -n chaos-testing 37 | sleep 5 38 | kubectl get pods -n busybox 39 | 40 | - name: Run chaos mesh action 41 | uses: chaos-mesh/chaos-mesh-action@master 42 | env: 43 | CFG_BASE64: YXBpVmVyc2lvbjogY2hhb3MtbWVzaC5vcmcvdjFhbHBoYTEKa2luZDogTmV0d29ya0NoYW9zCm1ldGFkYXRhOgogIG5hbWU6IG5ldHdvcmstZGVsYXkKICBuYW1lc3BhY2U6IGJ1c3lib3gKc3BlYzoKICBhY3Rpb246IGRlbGF5ICMgdGhlIHNwZWNpZmljIGNoYW9zIGFjdGlvbiB0byBpbmplY3QKICBtb2RlOiBhbGwKICBzZWxlY3RvcjoKICAgIHBvZHM6CiAgICAgIGJ1c3lib3g6CiAgICAgICAgLSBidXN5Ym94LTAKICBkZWxheToKICAgIGxhdGVuY3k6ICIxMG1zIgogIGR1cmF0aW9uOiAiNXMiCiAgc2NoZWR1bGVyOgogICAgY3JvbjogIkBldmVyeSAxMHMiCiAgZGlyZWN0aW9uOiB0bwogIHRhcmdldDoKICAgIHNlbGVjdG9yOgogICAgICBwb2RzOgogICAgICAgIGJ1c3lib3g6CiAgICAgICAgICAtIGJ1c3lib3gtMQogICAgbW9kZTogYWxsCg== 44 | CHAOS_MESH_VERSION: v1.0.0 45 | #CFG_FILE: https://raw.githubusercontent.com/chaos-mesh/chaos-mesh-action/master/chaos-test.yaml 46 | 47 | - name: Verification 48 | run: | 49 | echo "do some verification" 50 | kubectl exec busybox-0 -it -n busybox -- ping -c 30 busybox-1.busybox.busybox.svc 51 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # chaos-mesh-action ![Chaos](https://github.com/chaos-mesh/chaos-mesh-action/workflows/Chaos/badge.svg) 2 | 3 | `chaos-mesh-action` is a GitHub action that applies chaos engineering to your development workflow using Chaos Mesh. It automatically deploys the Chaos Mesh environment and injects the specified chaos experiment. 4 | 5 | For more details on Chaos Mesh, refer to [https://chaos-mesh.org/](https://chaos-mesh.org/). 6 | 7 | ## Usage 8 | 9 | ### Step 1. Prepare chaos configuration file 10 | 11 | Prepare the configuration file (YAML) of the failures which you expect to inject into the system, for example: 12 | 13 | ```yaml 14 | apiVersion: chaos-mesh.org/v1alpha1 15 | kind: NetworkChaos 16 | metadata: 17 | name: network-delay 18 | namespace: busybox 19 | spec: 20 | action: delay # the specific chaos action to inject 21 | mode: all 22 | selector: 23 | pods: 24 | busybox: 25 | - busybox-0 26 | delay: 27 | latency: "10ms" 28 | duration: "5s" 29 | scheduler: 30 | cron: "@every 10s" 31 | direction: to 32 | target: 33 | selector: 34 | pods: 35 | busybox: 36 | - busybox-1 37 | mode: all 38 | ``` 39 | 40 | ### Step 2. Encode the chaos configuration file with base64 (optional) 41 | 42 | Obtain the base64 value of the chaos configuration file using the following command: 43 | 44 | ```shell 45 | CFG_BASE64=`base64 chaos.yaml` 46 | ``` 47 | 48 | ### Step 3. Create the workflow 49 | 50 | 1. Deploy the Kubernetes cluster 51 | 52 | A Kubernetes cluster is required for the workflow. You can use [Kind Cluster](https://github.com/marketplace/actions/kind-cluster) or [Kind Action](https://github.com/marketplace/actions/kind-kubernetes-in-docker-action) to deploy. 53 | 54 | 2. Use `chaos-mesh-action`. 55 | 56 | To create the workflow in GitHub action, use `chaos-mesh/chaos-mesh-action` in the yaml configuration file and configure the base64 value of the chaos configuration file, and set the version of Chaos Mesh. The chaos-mesh related configuration is as follows: 57 | 58 | ```yaml 59 | - name: Run chaos mesh action 60 | uses: chaos-mesh/chaos-mesh-action@master 61 | env: 62 | CFG_BASE64: ${CFG_BASE64} 63 | CHAOS_MESH_VERSION: v1.0.0 64 | ``` 65 | 66 | If the chaos configuration file is committed to GitHub, you can set `CFG_FILE` as the path to the file: 67 | 68 | ```yaml 69 | - name: Run chaos mesh action 70 | uses: chaos-mesh/chaos-mesh-action@master 71 | env: 72 | CFG_FILE: https://raw.githubusercontent.com/chaos-mesh/chaos-mesh-action/master/chaos-test.yaml 73 | CHAOS_MESH_VERSION: v1.0.0 74 | ``` 75 | 76 | 77 | For the complete configuration file, see [sample](https://github.com/chaos-mesh/chaos-mesh-action/blob/master/.github/workflows/chaos.yml). 78 | 79 | ## Limitation 80 | 81 | - Link to private K8s clusters is not supported for now. 82 | - Only helm 3.x is supported for now. 83 | -------------------------------------------------------------------------------- /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 {} 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 | 203 | --------------------------------------------------------------------------------