Extension chaosgcp¶

Google Cloud Platform Extension for the Chaos Toolkit

Community • ChangeLog

Welcome to the Google Cloud Platform (GCP) extension for Chaos Toolkit. The package aggregates activities to target your GCP projects and explore your resilience via Chaos Engineering experiments.

Install¶

This package requires Python 3.8+

To be used from your experiment, this package must be installed in the Python environment where Chaos Toolkit already lives.

$ pip install -U chaostoolkit-google-cloud-platform

Usage¶

To use the probes and actions from this package, add the following to your experiment file:

{
  "version": "1.0.0",
  "title": "Our users should not be impacted by increased latency from our services",
  "description": "Use traffic shaping from the load Balancer to explore the impact of latency on our users",
  "method": [
    {
      "name": "add-delay-to-traffic",
      "type": "action",
      "provider": {
        "type": "python",
        "module": "chaosgcp.lb.actions",
        "func": "inject_traffic_delay",
        "arguments": {
          "url_map": "my-service",
          "target_name": "all-paths",
          "target_path": "/*",
          "delay_in_seconds": 1,
          "impacted_percentage": 80
        }
      },
      "pauses": {
        "after": 180
      }
    }
  ],
  "rollbacks": [
    {
      "name": "remove-traffic-delay",
      "type": "action",
      "provider": {
        "type": "python",
        "module": "chaosgcp.lb.actions",
        "func": "remove_fault_injection_traffic_policy",
        "arguments": {
          "url_map": "my-service",
          "target_name": "all-paths",
          "target_path": "/*"
        }
      }
    }
  ]
}

That’s it! You can now run it as chaos run experiment.json

Please explore the code to see existing probes and actions.

The extension picks up the credentials found on the machine running the experiment as describe in the official Python GCP client.

Contribute¶

If you wish to contribute more functions to this package, you are more than welcome to do so. Please, fork this project, make your changes following the usual PEP 8 code style, sprinkling with tests and submit a PR for review.

The Chaos Toolkit projects require all contributors must sign a Developer Certificate of Origin on each commit they would like to merge into the master branch of the repository. Please, make sure you can abide by the rules of the DCO before submitting a PR.

Develop¶

If you wish to develop on this project, make sure to install the development dependencies. You will need to install PDM.

$ pdm install --dev

Whenever you need to make contribution, ensure to run the linter as follows:

$ pdm run format
$ pdm run lint

Now, you can edit the files and they will be automatically be seen by your environment, even when running from the chaos command locally.

Test¶

To run the tests for the project execute the following:

$ pdm run test

Exported Controls¶

journal¶

This module exports controls covering the following phases of the execution of an experiment:

In addition, the controls may define the followings:

To use this control module, please add the following section to your experiment:

{
  "controls": [
    {
      "name": "chaosgcp",
      "provider": {
        "type": "python",
        "module": "chaosgcp.cloudlogging.controls.journal"
      }
    }
  ]
}

controls:
- name: chaosgcp
  provider:
    module: chaosgcp.cloudlogging.controls.journal
    type: python

This block may also be enabled at any other level (steady-state hypothesis or activity) to focus only on that level.

When enabled at the experiment level, by default, all sub-levels are also applied unless you set the automatic properties to false.

policy¶

This module exports controls covering the following phases of the execution of an experiment:

In addition, the controls may define the followings:

To use this control module, please add the following section to your experiment:

{
  "controls": [
    {
      "name": "chaosgcp",
      "provider": {
        "type": "python",
        "module": "chaosgcp.iam.controls.policy"
      }
    }
  ]
}

controls:
- name: chaosgcp
  provider:
    module: chaosgcp.iam.controls.policy
    type: python

This block may also be enabled at any other level (steady-state hypothesis or activity) to focus only on that level.

When enabled at the experiment level, by default, all sub-levels are also applied unless you set the automatic properties to false.

Exported Activities¶

apphub¶

inject_fault_if_url_map_exists_app_hub¶

Processes a URL map if it exists within the specified AppHub application.

Args: application_name (str): The name of the AppHub application. url_map (str): The URL map value to check for. project_id (str): The Google Cloud project ID. region (str): The region of the AppHub application. target_name (str): the the name of a path matcher in the URL map. target_path (str): default “/*”, impacted_percentage: float default 50.0, http_status (int) default 400, regional: (bool) default True, configuration: (Configuration) default None, secrets: (Secrets) default None,

Signature:

def inject_fault_if_url_map_exists_app_hub(
        application_name: str,
        host_project_id: str,
        url_map: str,
        project_id: str,
        region: str,
        target_name: str,
        target_path: str = '/*',
        impacted_percentage: float = 50.0,
        http_status: int = 400,
        regional: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> None:
    pass

Arguments:

Usage:

{
  "name": "inject-fault-if-url-map-exists-app-hub",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.apphub.actions",
    "func": "inject_fault_if_url_map_exists_app_hub",
    "arguments": {
      "application_name": "",
      "host_project_id": "",
      "url_map": "",
      "project_id": "",
      "region": "",
      "target_name": ""
    }
  }
}

name: inject-fault-if-url-map-exists-app-hub
provider:
  arguments:
    application_name: ''
    host_project_id: ''
    project_id: ''
    region: ''
    target_name: ''
    url_map: ''
  func: inject_fault_if_url_map_exists_app_hub
  module: chaosgcp.apphub.actions
  type: python
type: action

remove_fault_if_url_map_exists_app_hub¶

Processes a URL map if it exists within the specified AppHub application.

Args: application_name (str): The name of the AppHub application. host_project_id (str): The ID of the Host Apphub project. url_map (str): The URL map value to check for. project_id (str): The Google Cloud project ID. region (str): The region of the AppHub application. target_name (str): the the name of a path matcher in the URL map. target_path (str): default “/*”, regional: (bool) default True, configuration: (Configuration) default None, secrets: (Secrets) default None,

Signature:

def remove_fault_if_url_map_exists_app_hub(
        application_name: str,
        host_project_id: str,
        url_map: str,
        project_id: str,
        region: str,
        target_name: str,
        target_path: str = '/*',
        regional: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> None:
    pass

Arguments:

Usage:

{
  "name": "remove-fault-if-url-map-exists-app-hub",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.apphub.actions",
    "func": "remove_fault_if_url_map_exists_app_hub",
    "arguments": {
      "application_name": "",
      "host_project_id": "",
      "url_map": "",
      "project_id": "",
      "region": "",
      "target_name": ""
    }
  }
}

name: remove-fault-if-url-map-exists-app-hub
provider:
  arguments:
    application_name: ''
    host_project_id: ''
    project_id: ''
    region: ''
    target_name: ''
    url_map: ''
  func: remove_fault_if_url_map_exists_app_hub
  module: chaosgcp.apphub.actions
  type: python
type: action

artifact¶

get_container_most_recent_image_vulnerabilities_occurences¶

List all occurrences for a given container image tag.

Signature:

def get_container_most_recent_image_vulnerabilities_occurences(
        repository: str,
        package_name: str,
        kind: str = 'VULNERABILITY',
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "get-container-most-recent-image-vulnerabilities-occurences",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "get_container_most_recent_image_vulnerabilities_occurences",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: get-container-most-recent-image-vulnerabilities-occurences
provider:
  arguments:
    package_name: ''
    repository: ''
  func: get_container_most_recent_image_vulnerabilities_occurences
  module: chaosgcp.artifact.probes
  type: python
type: probe

get_docker_image_version_from_tag¶

Get image version (sha256) for most recent tag.

Signature:

def get_docker_image_version_from_tag(
        repository: str,
        package_name: str,
        tag: str = 'latest',
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "get-docker-image-version-from-tag",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "get_docker_image_version_from_tag",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: get-docker-image-version-from-tag
provider:
  arguments:
    package_name: ''
    repository: ''
  func: get_docker_image_version_from_tag
  module: chaosgcp.artifact.probes
  type: python
type: probe

get_most_recent_docker_image¶

Get most recent tag for a package in repository.

Signature:

def get_most_recent_docker_image(
        repository: str,
        package_name: str,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "get-most-recent-docker-image",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "get_most_recent_docker_image",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: get-most-recent-docker-image
provider:
  arguments:
    package_name: ''
    repository: ''
  func: get_most_recent_docker_image
  module: chaosgcp.artifact.probes
  type: python
type: probe

has_most_recent_image_any_severe_or_critical_vulnerabilities¶

Has the most recent tag any severe or critical vulnerabilities.

Signature:

def has_most_recent_image_any_severe_or_critical_vulnerabilities(
        repository: str,
        package_name: str,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> bool:
    pass

Arguments:

Usage:

{
  "name": "has-most-recent-image-any-severe-or-critical-vulnerabilities",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "has_most_recent_image_any_severe_or_critical_vulnerabilities",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: has-most-recent-image-any-severe-or-critical-vulnerabilities
provider:
  arguments:
    package_name: ''
    repository: ''
  func: has_most_recent_image_any_severe_or_critical_vulnerabilities
  module: chaosgcp.artifact.probes
  type: python
type: probe

list_docker_image_tags¶

List docker image tags of a package in the given repository.

Signature:

def list_docker_image_tags(
        repository: str,
        package_name: str,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass

Arguments:

Usage:

{
  "name": "list-docker-image-tags",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "list_docker_image_tags",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: list-docker-image-tags
provider:
  arguments:
    package_name: ''
    repository: ''
  func: list_docker_image_tags
  module: chaosgcp.artifact.probes
  type: python
type: probe

list_severe_or_critical_vulnerabilities_in_most_recent_image¶

List all severe and critical vulnerabilities for the most recent tag.

Signature:

def list_severe_or_critical_vulnerabilities_in_most_recent_image(
        repository: str,
        package_name: str,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass

Arguments:

Usage:

{
  "name": "list-severe-or-critical-vulnerabilities-in-most-recent-image",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.artifact.probes",
    "func": "list_severe_or_critical_vulnerabilities_in_most_recent_image",
    "arguments": {
      "repository": "",
      "package_name": ""
    }
  }
}

name: list-severe-or-critical-vulnerabilities-in-most-recent-image
provider:
  arguments:
    package_name: ''
    repository: ''
  func: list_severe_or_critical_vulnerabilities_in_most_recent_image
  module: chaosgcp.artifact.probes
  type: python
type: probe

cloudbuild¶

get_trigger¶

Returns information about a BuildTrigger.

See: https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers/get

:param name: name of the trigger :param configuration: :param secrets: :return:

Signature:

def get_trigger(name: str,
                project_id: str = None,
                region: str = None,
                configuration: Dict[str, Dict[str, str]] = None,
                secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "get-trigger",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudbuild.probes",
    "func": "get_trigger",
    "arguments": {
      "name": ""
    }
  }
}

name: get-trigger
provider:
  arguments:
    name: ''
  func: get_trigger
  module: chaosgcp.cloudbuild.probes
  type: python
type: probe

list_trigger_names¶

List only the trigger names of a project

:param configuration: :param secrets:

:return:

Signature:

def list_trigger_names(project_id: str = None,
                       region: str = None,
                       configuration: Dict[str, Dict[str, str]] = None,
                       secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "list-trigger-names",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudbuild.probes",
    "func": "list_trigger_names"
  }
}

name: list-trigger-names
provider:
  func: list_trigger_names
  module: chaosgcp.cloudbuild.probes
  type: python
type: probe

list_triggers¶

Lists existing BuildTriggers.

See: https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers/list

:param configuration: :param secrets:

:return:

Signature:

def list_triggers(project_id: str = None,
                  region: str = None,
                  configuration: Dict[str, Dict[str, str]] = None,
                  secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "list-triggers",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudbuild.probes",
    "func": "list_triggers"
  }
}

name: list-triggers
provider:
  func: list_triggers
  module: chaosgcp.cloudbuild.probes
  type: python
type: probe

run_trigger¶

Runs a BuildTrigger at a particular source revision.

NB: The trigger must exist in the targeted project.

See: https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers/run

:param name: name of the trigger :param source: location of the source in a Google Cloud Source Repository :param configuration: :param secrets:

:return:

Signature:

def run_trigger(name: str,
                source: Dict[Any, Any],
                project_id: str = None,
                region: str = None,
                configuration: Dict[str, Dict[str, str]] = None,
                secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "run-trigger",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudbuild.actions",
    "func": "run_trigger",
    "arguments": {
      "name": "",
      "source": {}
    }
  }
}

name: run-trigger
provider:
  arguments:
    name: ''
    source: {}
  func: run_trigger
  module: chaosgcp.cloudbuild.actions
  type: python
type: action

controls¶

cloudrun¶

create_service¶

Deletes a Cloud Run service and all its revisions. Cannot be undone.

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.services.ServicesClient#google_cloud_run_v2_services_services_ServicesClient_delete_service

:param parent: the path to the location in the project ‘projects/PROJECT_ID/locations/LOC. Otherwise set the project_id and region fields :param project_id: the project identifier where to create the service when parent is not set :param region: the region where to create the service when parent is not set :param service_id: unique identifier for the service :param container: definition of the container as per https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.types.Container :param description: optional text description of the service :param max_instance_request_concurrency: optional maximum number of requests that each serving instance can receive :param labels: optional labels to set on the service :param annotations: optional annotations to set on the service :param configuration: :param secrets:

:return:

Signature:

def create_service(service_id: str,
                   container: Dict[str, Any],
                   parent: str = None,
                   project_id: str = None,
                   region: str = None,
                   description: str = None,
                   max_instance_request_concurrency: int = 0,
                   service_account: str = None,
                   encryption_key: str = None,
                   traffic: List[Dict[str, Any]] = None,
                   labels: Dict[str, str] = None,
                   annotations: Dict[str, str] = None,
                   configuration: Dict[str, Dict[str, str]] = None,
                   secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "create-service",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.actions",
    "func": "create_service",
    "arguments": {
      "service_id": "",
      "container": {}
    }
  }
}

name: create-service
provider:
  arguments:
    container: {}
    service_id: ''
  func: create_service
  module: chaosgcp.cloudrun.actions
  type: python
type: action

delete_service¶

Deletes a Cloud Run service and all its revisions. Cannot be undone.

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.services.ServicesClient#google_cloud_run_v2_services_services_ServicesClient_delete_service

:param parent: the path to the service ‘projects/PROJECT_ID/locations/LOC/services/SVC :param project_id: the project identifier where to delete the service when parent is not set :param region: the region where to delete the service when parent is not set :param name: the name of the service when parent is not set :param configuration: :param secrets:

:return:

Signature:

def delete_service(parent: str = None,
                   project_id: str = None,
                   region: str = None,
                   name: str = None,
                   configuration: Dict[str, Dict[str, str]] = None,
                   secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "delete-service",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.actions",
    "func": "delete_service"
  }
}

name: delete-service
provider:
  func: delete_service
  module: chaosgcp.cloudrun.actions
  type: python
type: action

get_service¶

Retrieve a single cloud run service

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.services.ServicesClient#google_cloud_run_v2_services_services_ServicesClient_get_service

:param parent: the path to the service ‘projects/PROJECT_ID/locations/LOC/services/SVC :param project_id: the project identifier where to delete the service when parent is not set :param region: the region where to delete the service when parent is not set :param name: the name of the service when parent is not set :param configuration: :param secrets:

:return:

Signature:

def get_service(parent: str = None,
                project_id: str = None,
                region: str = None,
                name: str = None,
                configuration: Dict[str, Dict[str, str]] = None,
                secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "get-service",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.probes",
    "func": "get_service"
  }
}

name: get-service
provider:
  func: get_service
  module: chaosgcp.cloudrun.probes
  type: python
type: probe

list_service_revisions¶

List all Cloud Run service revisions for a specific service.

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.revisions.RevisionsClient#google_cloud_run_v2_services_revisions_RevisionsClient_list_revisions

:param parent: the path to the service ‘projects/PROJECT_ID/locations/LOC/services/SVC :param project_id: the project identifier where to delete the service when parent is not set :param region: the region where to delete the service when parent is not set :param name: the name of the service when parent is not set :param configuration: :param secrets:

:return:

Signature:

def list_service_revisions(
        parent: str,
        project_id: str = None,
        region: str = None,
        name: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass

Arguments:

Usage:

{
  "name": "list-service-revisions",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.probes",
    "func": "list_service_revisions",
    "arguments": {
      "parent": ""
    }
  }
}

name: list-service-revisions
provider:
  arguments:
    parent: ''
  func: list_service_revisions
  module: chaosgcp.cloudrun.probes
  type: python
type: probe

list_services¶

List all Cloud Run services

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.services.ServicesClient#google_cloud_run_v2_services_services_ServicesClient_list_services

:param parent: the path to the location in the project ‘projects/PROJECT_ID/locations/LOC. Otherwise set the project_id and region fields :param project_id: the project identifier where to create the service when parent is not set :param region: the region where to create the service when parent is not set :param configuration: :param secrets:

:return:

Signature:

def list_services(
        parent: str = None,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass

Arguments:

Usage:

{
  "name": "list-services",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.probes",
    "func": "list_services"
  }
}

name: list-services
provider:
  func: list_services
  module: chaosgcp.cloudrun.probes
  type: python
type: probe

update_service¶

Updates a Cloud Run service.

For example:

{
    "name": "route-traffic-two-latest-and-older-revision",
    "type": "action",
    "provider": {
   "type": "python",
   "module": chaosgcp.cloudrun.actions",
   "func": "update_service",
   "arguments": {
  "parent": "projects/${gcp_project_id}/locations/${gcp_location}/services/${service_name}",
  "container": {
 "image": "eu.gcr.io/${gcp_project_id}/demo"
  },
  "traffic": [{
 "type_": 1,
 "percent": 50
  }, {
 "type_": 2,
 "revision": "whatever-w788x",
 "percent": 50
  }],
   }
    }
}

See: https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.services.services.ServicesClient#google_cloud_run_v2_services_services_ServicesClient_delete_service

:param parent: the path to the service ‘projects/PROJECT_ID/locations/LOC/services/SVC :param project_id: the project identifier where to delete the service when parent is not set :param region: the region where to delete the service when parent is not set :param name: the name of the service when parent is not set :param container: definition of the container as per https://cloud.google.com/python/docs/reference/run/latest/google.cloud.run_v2.types.Container :param labels: optional labels to set on the service :param annotations: optional annotations to set on the service :param configuration: :param secrets: :param vpc_access_config: optional value for vpc_connect

:return:

Signature:

def update_service(parent: str = None,
                   project_id: str = None,
                   region: str = None,
                   name: str = None,
                   container: Dict[str, Any] = None,
                   max_instance_request_concurrency: int = 100,
                   service_account: str = None,
                   encryption_key: str = None,
                   traffic: List[Dict[str, Any]] = None,
                   labels: Dict[str, str] = None,
                   annotations: Dict[str, str] = None,
                   vpc_access_config: Dict[str, str] = None,
                   configuration: Dict[str, Dict[str, str]] = None,
                   secrets: Dict[str, Dict[str, str]] = None):
    pass

Arguments:

Usage:

{
  "name": "update-service",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.cloudrun.actions",
    "func": "update_service"
  }
}

name: update-service
provider:
  func: update_service
  module: chaosgcp.cloudrun.actions
  type: python
type: action

compute¶

set_instance_tags¶

Set a Network Tags to a GCE VM instance

:param project_id : the project ID in which the DNS record is present :param ip_address: the IP address for the A record that needs to be changed :param zone: the name of the zone where the GCE VM is provisioned :param tags_list : list of network tags to be set to the GCE VM instance :return nothing

Signature:

def set_instance_tags(project_id: str,
                      zone: str,
                      instance_name: str,
                      tags_list: list,
                      configuration: Dict[str, Dict[str, str]] = None,
                      secrets: Dict[str, Dict[str, str]] = None) -> None:
    pass

Arguments:

Usage:

{
  "name": "set-instance-tags",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.compute.actions",
    "func": "set_instance_tags",
    "arguments": {
      "project_id": "",
      "zone": "",
      "instance_name": "",
      "tags_list": []
    }
  }
}

name: set-instance-tags
provider:
  arguments:
    instance_name: ''
    project_id: ''
    tags_list: []
    zone: ''
  func: set_instance_tags
  module: chaosgcp.compute.actions
  type: python
type: action

dns¶

update_dns_record¶

Updates the DNS A record entry, It cannot be undone.

Args: project_id : the project ID in which the DNS record is present ip_address: the IP address for the A record that needs to be changed name: the name of the dns record entry zone_name: the name of the dns zone name which needs to be changed kind : the type of dns record set ttl: time to live for dns record change record_type: the record type for the name existing_type: the existing type of record secrets: authorization token Returns: JSON Response which is in form of dictionary

Signature:

def update_dns_record(
        project_id: str,
        ip_address: str,
        name: str,
        zone_name: str,
        kind: str = 'dns#resourceRecordSet',
        ttl: int = 5,
        record_type: str = 'A',
        existing_type: str = 'A',
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "update-dns-record",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.dns.actions",
    "func": "update_dns_record",
    "arguments": {
      "project_id": "",
      "ip_address": "",
      "name": "",
      "zone_name": ""
    }
  }
}

name: update-dns-record
provider:
  arguments:
    ip_address: ''
    name: ''
    project_id: ''
    zone_name: ''
  func: update_dns_record
  module: chaosgcp.dns.actions
  type: python
type: action

nodepool¶

create_new_nodepool¶

Create a new node pool in the given cluster/zone of the provided project.

The node pool config must be passed a mapping to the body parameter and respect the REST API.

If wait_until_complete is set to True (the default), the function will block until the node pool is ready. Otherwise, will return immediatly with the operation information.

See: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools/create

Signature:

def create_new_nodepool(
        body: Dict[str, Any],
        parent: str = None,
        project_id: str = None,
        region: str = None,
        wait_until_complete: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "create-new-nodepool",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.actions",
    "func": "create_new_nodepool",
    "arguments": {
      "body": {}
    }
  }
}

name: create-new-nodepool
provider:
  arguments:
    body: {}
  func: create_new_nodepool
  module: chaosgcp.gke.nodepool.actions
  type: python
type: action

delete_nodepool¶

Delete node pool from the given cluster/zone of the provided project.

If wait_until_complete is set to True (the default), the function will block until the node pool is deleted. Otherwise, will return immediatly with the operation information.

See: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools/create

Signature:

def delete_nodepool(
        parent: str = None,
        node_pool_id: str = None,
        project_id: str = None,
        region: str = None,
        wait_until_complete: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "delete-nodepool",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.actions",
    "func": "delete_nodepool"
  }
}

name: delete-nodepool
provider:
  func: delete_nodepool
  module: chaosgcp.gke.nodepool.actions
  type: python
type: action

get_nodepool¶

Get a specific nodepool of a cluster.

The parent is following the form projects/*/locations/*/clusters/*/nodePools/* and will override any settings in the configuration block.

{
    "name": "retrieve-our-nodepool",
    "type": "probe",
    "provider": {
   "type": "python",
   "module": "chaosgcp.gke.nodepool.probes",
   "func": "get_nodepool",
   "secrets": ["gcp"],
   "arguments": {
  "parent": "projects/my-project-89/locations/us-east1/clusters/cluster-1/nodePools/default-pool"
   }
    }
}

If not provided this action uses the configuration settings. In that case, make sure to also pass the node_pool_id value.

{
    "name": "retrieve-our-nodepool",
    "type": "probe",
    "provider": {
   "type": "python",
   "module": "chaosgcp.gke.nodepool.probes",
   "func": "get_nodepool",
   "secrets": ["gcp"],
   "arguments": {
  "node_pool_id": "default-pool"
   }
    }
}

See: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools/get

Signature:

def get_nodepool(node_pool_id: str = None,
                 parent: str = None,
                 project_id: str = None,
                 region: str = None,
                 configuration: Dict[str, Dict[str, str]] = None,
                 secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "get-nodepool",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.probes",
    "func": "get_nodepool"
  }
}

name: get-nodepool
provider:
  func: get_nodepool
  module: chaosgcp.gke.nodepool.probes
  type: python
type: probe

list_nodepools¶

List nodepools of a cluster.

The parent is following the form projects/*/locations/*/clusters/* and will override any settings in the configuration block. If not provided this action uses the configuration settings.

See: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools/list

Signature:

def list_nodepools(
        parent: str = None,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "list-nodepools",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.probes",
    "func": "list_nodepools"
  }
}

name: list-nodepools
provider:
  func: list_nodepools
  module: chaosgcp.gke.nodepool.probes
  type: python
type: probe

resize_nodepool¶

Resize a cluster nodepool.

Specify the nodepool through the parent argument as follows projects/*/locations/*/clusters/*/nodePools/* or set node_pool_id and optionally the project_id and region. If not passed, these two will be loaded from the configuration.

If wait_until_complete is set to True (the default), the function will block until the node pool is ready. Otherwise, will return immediatly with the operation information.

See: https://cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1.services.cluster_manager.ClusterManagerClient#google_cloud_container_v1_services_cluster_manager_ClusterManagerClient_set_node_pool_size

Signature:

def resize_nodepool(
        pool_size: int = 1,
        node_pool_id: str = None,
        parent: str = None,
        wait_until_complete: bool = True,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "resize-nodepool",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.actions",
    "func": "resize_nodepool"
  }
}

name: resize-nodepool
provider:
  func: resize_nodepool
  module: chaosgcp.gke.nodepool.actions
  type: python
type: action

rollback_nodepool¶

Rollback a previously Aborted or Failed NodePool upgrade.

If wait_until_complete is set to True (the default), the function will block until the node pool is ready. Otherwise, will return immediatly with the operation information.

See: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools/create

Signature:

def rollback_nodepool(
        node_pool_id: str,
        parent: str = None,
        wait_until_complete: bool = True,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "rollback-nodepool",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.actions",
    "func": "rollback_nodepool",
    "arguments": {
      "node_pool_id": ""
    }
  }
}

name: rollback-nodepool
provider:
  arguments:
    node_pool_id: ''
  func: rollback_nodepool
  module: chaosgcp.gke.nodepool.actions
  type: python
type: action

swap_nodepool¶

Create a new nodepool, drain the old one so pods can be rescheduled on the new pool. Delete the old nodepool only delete_old_node_pool is set to True, which is not the default. Otherwise, leave the old node pool cordonned so it cannot be scheduled any longer.

Please ensure to provide the Kubernetes secrets as well when calling this action. See https://github.com/chaostoolkit/chaostoolkit-kubernetes#configuration

Signature:

def swap_nodepool(old_node_pool_id: str,
                  new_nodepool_body: Dict[str, Any],
                  parent: str = None,
                  wait_until_complete: bool = True,
                  delete_old_node_pool: bool = False,
                  drain_timeout: int = 120,
                  project_id: str = None,
                  region: str = None,
                  configuration: Dict[str, Dict[str, str]] = None,
                  secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "swap-nodepool",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.gke.nodepool.actions",
    "func": "swap_nodepool",
    "arguments": {
      "old_node_pool_id": "",
      "new_nodepool_body": {}
    }
  }
}

name: swap-nodepool
provider:
  arguments:
    new_nodepool_body: {}
    old_node_pool_id: ''
  func: swap_nodepool
  module: chaosgcp.gke.nodepool.actions
  type: python
type: action

lb¶

add_latency_to_endpoint¶

Add latency to a particular URL.

This is a high level shortcut to the inject_traffic_delay which infers all the appropriate parameters from the URL itself. It does this by querying the GCP project for all LB information and matches the correct target from there.

This might no work on all combinaison of Load Balancer and backend services that GCP support but should work well with LB + Cloud Run.

The latency is expressed in seconds with a default set to 0.3 seconds.

Signature:

def add_latency_to_endpoint(
        url: str,
        latency: float = 0.3,
        percentage: float = 90.0,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "add-latency-to-endpoint",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosgcp.lb.actions",
    "func": "add_latency_to_endpoint",
    "arguments": {
      "url": ""
    }
  }
}

name: add-latency-to-endpoint
provider:
  arguments:
    url: ''
  func: add_latency_to_endpoint
  module: chaosgcp.lb.actions
  type: python
type: action

get_backend_service_health¶

Fetch the latest health check result of the given backend service.

See also: https://cloud.google.com/python/docs/reference/compute/latest/google.cloud.compute_v1.services.backend_services.BackendServicesClient#google_cloud_compute_v1_services_backend_services_BackendServicesClient_get_health

Signature:

def get_backend_service_health(
        backend_service: str,
        project_id: str = None,
        region: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass