REST Resource: projects.locations.environments

Resource: Environment

An environment for running orchestration tasks.

JSON representation 
{
  "name": string,
  "config": {
    object (EnvironmentConfig)
  },
  "uuid": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
config

object (EnvironmentConfig)

Configuration parameters for this environment.
uuid

string

Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.
state

enum (State)

The current state of the environment.
createTime

string (Timestamp format)

Output only. The time at which this environment was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time at which this environment was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

EnvironmentConfig

Configuration information for an environment.

JSON representation 
{
  "gkeCluster": string,
  "dagGcsPrefix": string,
  "nodeCount": integer,
  "softwareConfig": {
    object (SoftwareConfig)
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "privateEnvironmentConfig": {
    object (PrivateEnvironmentConfig)
  },
  "webServerNetworkAccessControl": {
    object (WebServerNetworkAccessControl)
  },
  "databaseConfig": {
    object (DatabaseConfig)
  },
  "webServerConfig": {
    object (WebServerConfig)
  },
  "airflowUri": string,
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "maintenanceWindow": {
    object (MaintenanceWindow)
  }
}
Fields
gkeCluster

string

Output only. The Kubernetes Engine cluster used to run this environment.
dagGcsPrefix

string

Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
nodeCount

integer

The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
softwareConfig

object (SoftwareConfig)

The configuration settings for software inside the environment.
nodeConfig

object (NodeConfig)

The configuration used for the Kubernetes Engine cluster.
privateEnvironmentConfig

object (PrivateEnvironmentConfig)

The configuration used for the Private IP Cloud Composer environment.
webServerNetworkAccessControl

object (WebServerNetworkAccessControl)

Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
databaseConfig

object (DatabaseConfig)

Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
webServerConfig

object (WebServerConfig)

Optional. The configuration settings for the Airflow web server App Engine instance.
airflowUri

string

Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
encryptionConfig

object (EncryptionConfig)

Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated.
maintenanceWindow

object (MaintenanceWindow)

Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods.

The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window.

The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours.

If this value is omitted, Cloud Composer components may be subject to maintenance at any time.

SoftwareConfig

Specifies the selection and configuration of software inside the environment.

JSON representation 
{
  "imageVersion": string,
  "airflowConfigOverrides": {
    string: string,
    ...
  },
  "pypiPackages": {
    string: string,
    ...
  },
  "envVariables": {
    string: string,
    ...
  },
  "pythonVersion": string
}
Fields
imageVersion

string

The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version.

The Cloud Composer portion of the version is a semantic version or latest. When the patch version is omitted, the current Cloud Composer patch version is selected. When latest is provided instead of an explicit version number, the server replaces latest with the current Cloud Composer version and stores that version number in the same field.

The portion of the image version that follows airflow- is an official Apache Airflow repository release name.

See also Version List.
airflowConfigOverrides

map (key: string, value: string)

Optional. Apache Airflow configuration properties to override.

Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format.

Certain Apache Airflow configuration property values are blocked, and cannot be overridden.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pypiPackages

map (key: string, value: string)

Optional. Custom Python Package Index (PyPI) packages to be installed in the environment.

Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
envVariables

map (key: string, value: string)

Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes.

Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names:

  • AIRFLOW_HOME
  • C_FORCE_ROOT
  • CONTAINER_NAME
  • DAGS_FOLDER
  • GCP_PROJECT
  • GCS_BUCKET
  • GKE_CLUSTER_NAME
  • SQL_DATABASE
  • SQL_INSTANCE
  • SQL_PASSWORD
  • SQL_PROJECT
  • SQL_REGION
  • SQL_USER

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonVersion

string

Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes.

Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be updated.

NodeConfig

The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.

JSON representation 
{
  "location": string,
  "machineType": string,
  "network": string,
  "subnetwork": string,
  "diskSizeGb": integer,
  "oauthScopes": [
    string
  ],
  "serviceAccount": string,
  "tags": [
    string
  ],
  "ipAllocationPolicy": {
    object (IPAllocationPolicy)
  },
  "maxPodsPerNode": integer
}
Fields
location

string

Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}".

This location must belong to the enclosing environment's project and location. If both this field and nodeConfig.machineType are specified, nodeConfig.machineType must belong to this location; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (location or nodeConfig.machineType) is specified, the location information from the specified field will be propagated to the unspecified field.
machineType

string

Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".

The machineType must belong to the enclosing environment's project and location. If both this field and nodeConfig.location are specified, this machineType must belong to the nodeConfig.location; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and nodeConfig.location is specified, the location information from the specified field will be propagated to the unspecified field.

The machineTypeId must not be a shared-core machine type.

If this field is unspecified, the machineTypeId defaults to "n1-standard-1".
network

string

Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/global/networks/{networkId}".

If unspecified, the default network in the environment's project is used. If a Custom Subnet Network is provided, nodeConfig.subnetwork must also be provided. For Shared VPC subnetwork requirements, see nodeConfig.subnetwork.
subnetwork

string

Optional. The Compute Engine subnetwork to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"

If a subnetwork is provided, nodeConfig.network must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
diskSizeGb

integer

Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
oauthScopes[]

string

Optional. The set of Google API scopes to be made available on all node VMs. If oauthScopes is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
serviceAccount

string

Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
tags[]

string

Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
ipAllocationPolicy

object (IPAllocationPolicy)

Optional. The IPAllocationPolicy fields for the GKE cluster.
maxPodsPerNode

integer

Optional. The maximum number of pods per node in the Cloud Composer GKE cluster. The value must be between 8 and 110 and it can be set only if the environment is VPC-native. The default value is 32. Values of this field will be propagated both to the default-pool node pool of the newly created GKE cluster, and to the default "Maximum Pods per Node" value which is used for newly created node pools if their value is not explicitly set during node pool creation. For more information, see Optimizing IP address allocation. Cannot be updated.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the GKE cluster.

JSON representation 
{
  "useIpAliases": boolean,
  "clusterSecondaryRangeName": string,
  "servicesSecondaryRangeName": string,
  "clusterIpv4CidrBlock": string,
  "servicesIpv4CidrBlock": string
}
Fields
useIpAliases

boolean

Optional. Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created.
clusterSecondaryRangeName

string

Optional. The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either clusterSecondaryRangeName or clusterIpv4CidrBlock but not both.

This field is applicable only when useIpAliases is true.
servicesSecondaryRangeName

string

Optional. The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either servicesSecondaryRangeName or servicesIpv4CidrBlock but not both.

This field is applicable only when useIpAliases is true.
clusterIpv4CidrBlock

string

Optional. The IP address range used to allocate IP addresses to pods in the cluster.

This field is applicable only when useIpAliases is true.

Set to blank to have GKE choose a range with the default size.

Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify clusterSecondaryRangeName or clusterIpv4CidrBlock but not both.
servicesIpv4CidrBlock

string

Optional. The IP address range of the services IP addresses in this cluster.

This field is applicable only when useIpAliases is true.

Set to blank to have GKE choose a range with the default size.

Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify servicesSecondaryRangeName or servicesIpv4CidrBlock but not both.

PrivateEnvironmentConfig

The configuration information for configuring a Private IP Cloud Composer environment.

JSON representation 
{
  "enablePrivateEnvironment": boolean,
  "privateClusterConfig": {
    object (PrivateClusterConfig)
  },
  "webServerIpv4CidrBlock": string,
  "cloudSqlIpv4CidrBlock": string,
  "webServerIpv4ReservedRange": string
}
Fields
enablePrivateEnvironment

boolean

Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true.
privateClusterConfig

object (PrivateClusterConfig)

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
webServerIpv4CidrBlock

string

Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from privateClusterConfig.master_ipv4_cidr_block and cloudSqlIpv4CidrBlock.
cloudSqlIpv4CidrBlock

string

Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from webServerIpv4CidrBlock
webServerIpv4ReservedRange

string

Output only. The IP range reserved for the tenant project's App Engine VMs.

PrivateClusterConfig

Configuration options for the private GKE cluster in a Cloud Composer environment.

JSON representation 
{
  "enablePrivateEndpoint": boolean,
  "masterIpv4CidrBlock": string,
  "masterIpv4ReservedRange": string
}
Fields
enablePrivateEndpoint

boolean

Optional. If true, access to the public endpoint of the GKE cluster is denied.
masterIpv4CidrBlock

string

Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
masterIpv4ReservedRange

string

Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network.

WebServerNetworkAccessControl

Network-level access control policy for the Airflow web server.

JSON representation 
{
  "allowedIpRanges": [
    {
      object (AllowedIpRange)
    }
  ]
}
Fields
allowedIpRanges[]

object (AllowedIpRange)

A collection of allowed IP ranges with descriptions.

AllowedIpRange

Allowed IP range with user-provided description.

JSON representation 
{
  "value": string,
  "description": string
}
Fields
value

string

IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.

IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
description

string

Optional. User-provided description. It must contain at most 300 characters.

DatabaseConfig

The configuration of Cloud SQL instance that is used by the Apache Airflow software.

JSON representation 
{
  "machineType": string
}
Fields
machineType

string

Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.

WebServerConfig

The configuration settings for the Airflow web server App Engine instance.

JSON representation 
{
  "machineType": string
}
Fields
machineType

string

Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

EncryptionConfig

The encryption options for the Composer environment and its dependencies.

JSON representation 
{
  "kmsKeyName": string
}
Fields
kmsKeyName

string

Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.

MaintenanceWindow

The configuration settings for Cloud Composer maintenance window.

The following example:

{ "startTime":"2019-08-01T01:00:00Z" "endTime":"2019-08-01T07:00:00Z" "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE" }

would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.

JSON representation 
{
  "startTime": string,
  "endTime": string,
  "recurrence": string
}
Fields
startTime

string (Timestamp format)

Required. Start time of the first recurrence of the maintenance window.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for endTime must be in the future, relative to startTime.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
recurrence

string

Required. Maintenance window recurrence. Format is a subset of RFC-5545 RRULE. The only allowed values for FREQ field are FREQ=DAILY and FREQ=WEEKLY;BYDAY=... Example values: FREQ=WEEKLY;BYDAY=TU,WE, FREQ=DAILY.

State

State of the environment.

Enums
STATE_UNSPECIFIED The state of the environment is unknown.
CREATING The environment is in the process of being created.
RUNNING The environment is currently running and healthy. It is ready for use.
UPDATING The environment is being updated. It remains usable but cannot receive additional update requests or be deleted at this time.
DELETING The environment is undergoing deletion. It cannot be used.
ERROR The environment has encountered an error and cannot be used.

Methods

create

 Create a new environment.

delete

 Delete an environment.

get

 Get an existing environment.

list

 List environments.

patch

 Update an environment.

restartWebServer

 Restart Airflow web server.