EC2 Terminate By ID
- It causes termination of an EC2 instance by instance ID or list of instance IDs before bringing it back to running state after the specified chaos duration.
- It helps to check the performance of the application/process running on the ec2 instance. When the MANAGED_NODEGROUP is enable then the experiment will not try to start the instance post chaos instead it will check of the addition of the new node instance to the cluster.
Scenario: Terminate EC2 Instance
View the uses of the experiment
Verify the prerequisites
- Ensure that Kubernetes Version > 1.16
- Ensure that the Litmus Chaos Operator is running by executing
kubectl get podsin operator namespace (typically,
litmus).If not, install from here
- Ensure that the
ec2-terminate-by-idexperiment resource is available in the cluster by executing
kubectl get chaosexperimentsin the desired namespace. If not, install from here
- Ensure that you have sufficient AWS access to stop and start an ec2 instance.
Ensure to create a Kubernetes secret having the AWS access configuration(key) in the
CHAOS_NAMESPACE. A sample secret file looks like:
apiVersion: v1 kind: Secret metadata: name: cloud-secret type: Opaque stringData: cloud_config.yml: |- # Add the cloud AWS credentials respectively [default] aws_access_key_id = XXXXXXXXXXXXXXXXXXX aws_secret_access_key = XXXXXXXXXXXXXXX
If you change the secret key name (from
cloud_config.yml) please also update the
AWS_SHARED_CREDENTIALS_FILEENV value on
experiment.yamlwith the same name.
If the target EC2 instance is a part of a self-managed nodegroup: Make sure to drain the target node if any application is running on it and also ensure to cordon the target node before running the experiment so that the experiment pods do not schedule on it.
View the default validations
- EC2 instance should be in healthy state.
Minimal RBAC configuration example (optional)¶
If you are using this experiment as part of a litmus workflow scheduled constructed & executed from chaos-center, then you may be making use of the litmus-admin RBAC, which is pre installed in the cluster as part of the agent setup.
View the Minimal RBAC permissions
--- apiVersion: v1 kind: ServiceAccount metadata: name: ec2-terminate-by-id-sa namespace: default labels: name: ec2-terminate-by-id-sa app.kubernetes.io/part-of: litmus --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: ec2-terminate-by-id-sa labels: name: ec2-terminate-by-id-sa app.kubernetes.io/part-of: litmus rules: # Create and monitor the experiment & helper pods - apiGroups: [""] resources: ["pods"] verbs: ["create","delete","get","list","patch","update", "deletecollection"] # Performs CRUD operations on the events inside chaosengine and chaosresult - apiGroups: [""] resources: ["events"] verbs: ["create","get","list","patch","update"] # Fetch configmaps & secrets details and mount it to the experiment pod (if specified) - apiGroups: [""] resources: ["secrets","configmaps"] verbs: ["get","list",] # Track and get the runner, experiment, and helper pods log - apiGroups: [""] resources: ["pods/log"] verbs: ["get","list","watch"] # for creating and managing to execute comands inside target container - apiGroups: [""] resources: ["pods/exec"] verbs: ["get","list","create"] # for configuring and monitor the experiment job by the chaos-runner pod - apiGroups: ["batch"] resources: ["jobs"] verbs: ["create","list","get","delete","deletecollection"] # for creation, status polling and deletion of litmus chaos resources used within a chaos workflow - apiGroups: ["litmuschaos.io"] resources: ["chaosengines","chaosexperiments","chaosresults"] verbs: ["create","list","get","patch","update","delete"] # for experiment to perform node status checks - apiGroups: [""] resources: ["nodes"] verbs: ["get","list"] --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: ec2-terminate-by-id-sa labels: name: ec2-terminate-by-id-sa app.kubernetes.io/part-of: litmus roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: ec2-terminate-by-id-sa subjects: - kind: ServiceAccount name: ec2-terminate-by-id-sa namespace: default
Use this sample RBAC manifest to create a chaosServiceAccount in the desired (app) namespace. This example consists of the minimum necessary role permissions to execute the experiment.
check the experiment tunables
|EC2_INSTANCE_ID||Instance ID of the target ec2 instance. Multiple IDs can also be provided as a comma(,) separated values|| Multiple IDs can be provided as
|REGION||The region name of the target instace|
|TOTAL_CHAOS_DURATION||The total time duration for chaos insertion (sec)||Defaults to 30s|
|CHAOS_INTERVAL||The interval (in sec) between successive instance termination.||Defaults to 30s|
|MANAGED_NODEGROUP|| Set to
|| Defaults to
|SEQUENCE||It defines sequence of chaos execution for multiple instance||Default value: parallel. Supported: serial, parallel|
|RAMP_TIME||Period to wait before and after injection of chaos in sec|
Common and AWS specific tunables¶
Stop Instances By ID¶
It contains comma separated list of instances IDs subjected to ec2 stop chaos. It can be tuned via
Use the following example to tune this:
# contains the instance id, to be terminated/stopped apiVersion: litmuschaos.io/v1alpha1 kind: ChaosEngine metadata: name: engine-nginx spec: engineState: "active" annotationCheck: "false" chaosServiceAccount: ec2-terminate-by-id-sa experiments: - name: ec2-terminate-by-id spec: components: env: # id of the ec2 instance - name: EC2_INSTANCE_ID value: 'instance-1' # region for the ec2 instance - name: REGION value: '<region for EC2_INSTANCE_ID>' - name: TOTAL_CHAOS_DURATION VALUE: '60'