Package: aws-az-failure-chaostoolkit
Chaos Toolkit AZ Failure Extension for AWSWarning: You are strongly advised to only utilize this extension in environments with non-production workloads, as the actions may cause unwanted downtime to your users. Be sure to check if there are any production workloads running in the target AWS account before running Chaos Toolkit experiments with this extension.This project is a collection ofactions, gathered as an
extension to theChaos Toolkitto simulate an Availability Zone (AZ) failure across multiple AWS services for you to test the resiliency of your hosted applications. This project is purposefully built for simulating AZ failures. If you wish to utilize other fault injection actions with Chaos Toolkit, you might want to consider looking at theChaos Toolkit Extension for AWSfor your experiments.InstallThis package requires Python 3.7 or newer.To be used from your experiment, this package must be installed in the Python
environment wherechaostoolkitalready lives.Install via pippip install -U aws-az-failure-chaostoolkitUsageTo use the actions from this package, add the blocks of code below to your Chaos Toolkit experiment file. ReplaceTagKey1andTagValue1with the appropriate key-value pair you tagged your resources with. Replace the value ofazargument with an availability zone of your choice.Failure ActionsAuto Scaling Group (ASG)This action removes subnets belonging to the target AZ in all tagged ASGs and suspends the AZRebalance process if its running. If the ASG is only configured for a single AZ, it updates the min, max and desired capacity to 0:-type:actionname:Simulate AZ Failure for ASGprovider:type:pythonmodule:azchaosaws.asg.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"Elastic Compute Cloud (EC2)This action withfailure_typeset tonetworkwill affect tagged/filtered subnets in the target AZ by replacing the current NACL associations with a newly created blackhole NACL:-type:actionname:Simulate AZ Failure for EC2provider:type:pythonmodule:azchaosaws.ec2.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truefailure_type:"network"filters:-Name:tag:TagKey1Values:-"TagValue1"This action withfailure_typeset toinstancewill affect tagged/filtered normal/spot instances in the target AZ that are in pending/running state by stopping/terminating them depending on the instance lifecycle:-type:actionname:Simulate AZ Failure for EC2provider:type:pythonmodule:azchaosaws.ec2.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truefailure_type:"instance"filters:-Name:tag:TagKey1Values:-"TagValue1"Application Load Balancer (ALB)This action removes target AZ subnets in application load balancers:-type:actionname:Simulate AZ Failure for ALBprovider:type:pythonmodule:azchaosaws.elbv2.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"Classic Load Balancer (CLB)This action detaches classic load balancers from subnets belonging to target AZ if they are in a non-default VPC and disables the target AZ from classic load balancers if they are in a default VPC:-type:actionname:Simulate AZ Failure for CLBprovider:type:pythonmodule:azchaosaws.elb.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"Relational Database Service (RDS)This action forces RDS to reboot and failover to another AZ, and/or promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (cluster writer):-type:actionname:Simulate AZ Failure for RDSprovider:type:pythonmodule:azchaosaws.rds.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"ElastiCacheThis action forces ElastiCache (cluster mode disabled) to failover primary nodes if exists in the target AZ:-type:actionname:Simulate AZ Failure for ElastiCache (cluster mode disabled)provider:type:pythonmodule:azchaosaws.elasticache.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"This action forces ElastiCache (cluster mode enabled) to failover the shards provided as cache cluster ids (sequential if multiple shards of same cluster) (replace ReplicationGroup1, CacheClusterId1 and CacheClusterId2 as required):-type:actionname:Simulate AZ Failure for ElastiCache (cluster mode enabled)provider:type:pythonmodule:azchaosaws.elasticache.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-Key:"TagKey1"Value:"TagValue1"replication_groups:-replication_group_id:ReplicationGroup1cache_cluster_ids:-CacheClusterId1-CacheClusterId2Elastic Kubernetes Service (EKS)This action removes subnets belonging to the target AZ in all nodegroup ASGs that are part of the tagged EKS clusters and suspends the AZRebalance process if its running.failure_typeset tonetworkwill affect target AZ subnets of the nodegroups by associating them with a newly created blackhole NACL. All its previous NACL associations will be replaced with the blackhole NACL:-type:actionname:Simulate AZ Failure for EKS Clustersprovider:type:pythonmodule:azchaosaws.eks.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truefailure_type:"network"tags:-TagKey1:"TagValue1"This action removes subnets belonging to the target AZ in all nodegroup ASGs that are part of the tagged EKS clusters and suspends the AZRebalance process if its running.failure_typeset toinstancewill affect worker nodes that are part of the managed node groups and are in a pending/running state in the target AZ by stopping/terminating normal/spot instances:-type:actionname:Simulate AZ Failure for EKS Clustersprovider:type:pythonmodule:azchaosaws.eks.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truefailure_type:"instance"tags:-TagKey1:"TagValue1"Managed Message Broker Service (MQ)This action reboots ActiveMQ brokers that have an active-standby setup:-type:actionname:Simulate AZ Failure for Amazon MQ (ActiveMQ)provider:type:pythonmodule:azchaosaws.mq.actionsfunc:fail_azarguments:az:"ap-southeast-1a"dry_run:Truetags:-TagKey1:"TagValue1"TipsTo 'rollback' the changes made by thefail_azaction, you can userecover_azin your experiment template. Therecover_azaction will read the state file generated and rollback if it's a service that's supported.Do also note that by default, thedry_runargument for eachfail_azaction is required. Setting it toTruewill only run read-only operations and not impact the target resources. Set it toFalseif you want the actions to make changes your resources. It is best practice to set it on an experiment level under the configuration block and then reference it for every action.To have granular filtering of resources, you can also provide a list of tags as part of the argument for thefail_azaction.Please explore the code to see existing actions and supported arguments. Alternatively, you can runchaos discover aws-az-failure-chaostoolkitto view the list of supported actions along with their required and optional arguments for each service in the generateddiscovery.jsonfile.ConfigurationDevelopIf you wish to develop on this project, make sure to install the development
dependencies. But first,create a virtual environmentand then install
those dependencies.make install-devNow, you can edit the files and they will be automatically be seen by your
environment, even when running from thechaoscommand locally.FormatTo format your code execute the following:make fmtLintTo check your code with a linter execute the following:make lintTestTo run the tests for the project execute the following:make testSecuritySeeCONTRIBUTINGfor more information.LicenseThis project is licensed under the Apache-2.0 License.