Enable the IP Masquerade agent in Cloud Composer environments

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

This page describes how to enable the IP Masquerade agent for your environment.

About the IP Masquerade agent in Cloud Composer

Cloud Composer supports the IP Masquerade agent for your environments.

IP masquerading is a form of network address translation (NAT) used to perform many-to-one IP address translations. This allows multiple clients to access a destination from a single IP address.

Cloud Composer runs your workloads on GKE. For correct function, it requires IP ranges for nodes (VMs) as well as GKE Pods and Services. When Airflow DAGs and tasks communicate with other services, they use Pod IPs and these Pod IP ranges need to be routable to and from any destinations that the tasks interact with.

With the IP Masquerade agent, you have the option to translate Pod IP addresses to node IP addresses, so that destinations and services targeted from Airflow DAGs and tasks only receive packets from node IP addresses instead of Pod IP addresses. This is useful in environments that expect to only receive packets from node IP addresses or where Pod IP ranges are not routable outside of the cluster.

In addition, you can use the IP Masquerade agent to save network ranges in your networking configuration. For example, you can use a separate network range for Pods inside your environment's cluster and masquerade this traffic as coming from the node IP address range. In this way, you save IP address space in one range by using IP addresses from a different range for Pods in your environment's cluster.

For example:

  1. You use the 10.0.0.0/8 range for VMs and only this range is allowed by your firewall rules.

  2. To save network ranges, you use a different range (for example, 192.168.0.0/16) for Pods in your environment's cluster.

  3. To be able to connect to any service from a Pod (Airflow worker), IP masquerading is needed; otherwise the service receives traffic from 192.168.0.0/16 and drops it because of a firewall rule. With the IP Masquerade agent enabled and configured, the service gets requests from 10.0.0.0/8, which are accepted.

Before you begin

  • It is not possible to enable the IP Masquerade agent in Google Cloud console.

  • To use this feature, you must create an environment with GKE 1.22.7 or later version.

  • The IP Masquerade agent is not available for environments that were created in earlier GKE versions, even if GKE was upgraded to 1.22.7 and later versions.

Enable the IP Masquerade agent for an existing environment

It is not possible to enable the IP Masquerade agent for an existing environment.

Enable the IP Masquerade agent when creating an environment

You can enable the IP Masquerade agent when you create an environment.

For more information about creating Cloud Composer environments, see Create environment.

Console

It is not possible to enable the IP Masquerade agent in Google Cloud console.

gcloud

When you create an environment, the --enable-ip-masq-agent argument enables the IP Masqerade agent. 

gcloud composer environments create ENVIRONMENT_NAME \
    --location LOCATION \
    --image-version composer-2.10.1-airflow-2.10.2 \
    --enable-ip-masq-agent

Replace:

  • ENVIRONMENT_NAME with the name of the environment.
  • LOCATION with the region where the environment is located.

Example:

gcloud composer environments create example-environment \
    --location us-central1 \
    --image-version composer-2.10.1-airflow-2.10.2 \
    --enable-ip-masq-agent

API

Construct an environments.create API request. Specify the configuration in the Environment resource.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/environments/ENVIRONMENT_NAME",
  "config": {
    "softwareConfig": {
      "imageVersion": "composer-2.10.1-airflow-2.10.2"
    },
    "nodeConfig": {
      "enableIpMasqAgent": true
    }
  }
}

Replace:

  • PROJECT_ID with the Project ID.
  • LOCATION with the region where the environment is located.
  • ENVIRONMENT_NAME with the environment name.

Example:

  // POST https://composer.googleapis.com/v1/{parent=projects/*/locations/*}/environments

  {
    "name": "projects/example-project/locations/us-central1/environments/example-environment",
    "config": {
      "softwareConfig": {
        "imageVersion": "composer-2.10.1-airflow-2.10.2"
      },
      "nodeConfig": {
        "enableIpMasqAgent": true
      }
    }
  }

Terraform

When you create an environment, the enable_ip_masq_agent field in the node_config block enables the IP Masqerade agent. 

resource "google_composer_environment" "example_environment" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {
    software_config {
      image_version = "composer-2.10.1-airflow-2.10.2"
    }
    node_config {
      enable_ip_masq_agent = true
    }
  }

Replace:

  • ENVIRONMENT_NAME with the name of the environment.
  • LOCATION with the region where the environment is located.

Example:

resource "google_composer_environment" "example_environment" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {
    software_config {
      image_version = "composer-2.10.1-airflow-2.10.2"
    }
    node_config {
      enable_ip_masq_agent = true
    }
  }
}

Configure the IP Masquerade agent

For more information about using and configuring the IP Masquerade agent in Cloud Composer 2, see Use Egress NAT Policy to configure IP masquerade in Autopilot clusters.

What's next