- Resource: Environment
- EnvironmentConfig
- SoftwareConfig
- NodeConfig
- IPAllocationPolicy
- PrivateEnvironmentConfig
- PrivateClusterConfig
- WebServerNetworkAccessControl
- AllowedIpRange
- DatabaseConfig
- WebServerConfig
- EncryptionConfig
- State
- Methods
Resource: Environment
An environment for running orchestration tasks.
JSON representation | |
---|---|
{ "name": string, "config": { object ( |
Fields | |
---|---|
name |
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 |
Configuration parameters for this environment. |
uuid |
Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. |
state |
The current state of the environment. |
createTime |
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: |
updateTime |
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: |
labels |
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:
An object containing a list of |
EnvironmentConfig
Configuration information for an environment.
JSON representation | |
---|---|
{ "gkeCluster": string, "dagGcsPrefix": string, "nodeCount": integer, "softwareConfig": { object ( |
Fields | |
---|---|
gkeCluster |
Output only. The Kubernetes Engine cluster used to run this environment. |
dagGcsPrefix |
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 |
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. |
softwareConfig |
The configuration settings for software inside the environment. |
nodeConfig |
The configuration used for the Kubernetes Engine cluster. |
privateEnvironmentConfig |
The configuration used for the Private IP Cloud Composer environment. |
webServerNetworkAccessControl |
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. |
databaseConfig |
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. |
webServerConfig |
Optional. The configuration settings for the Airflow web server App Engine instance. |
airflowUri |
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface). |
encryptionConfig |
Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated. |
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 |
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 The Cloud Composer portion of the version is a semantic version or The portion of the image version that follows airflow- is an official Apache Airflow repository release name. See also Version List. |
airflowConfigOverrides |
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 |
pypiPackages |
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 |
envVariables |
Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression
An object containing a list of |
pythonVersion |
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 '2'. 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 ( |
Fields | |
---|---|
location |
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 |
machineType |
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 The If this field is unspecified, the |
network |
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, |
subnetwork |
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, |
diskSizeGb |
Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. |
oauthScopes[] |
Optional. The set of Google API scopes to be made available on all node VMs. If |
serviceAccount |
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[] |
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 |
Optional. The IPAllocationPolicy fields for the GKE cluster. |
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 |
Optional. Whether or not to enable Alias IPs in the GKE cluster. If |
clusterSecondaryRangeName |
Optional. The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either This field is applicable only when |
servicesSecondaryRangeName |
Optional. The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either This field is applicable only when |
clusterIpv4CidrBlock |
Optional. The IP address range used to allocate IP addresses to pods in the cluster. This field is applicable only when Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
servicesIpv4CidrBlock |
Optional. The IP address range of the services IP addresses in this cluster. This field is applicable only when Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
PrivateEnvironmentConfig
The configuration information for configuring a Private IP Cloud Composer environment.
JSON representation | |
---|---|
{
"enablePrivateEnvironment": boolean,
"privateClusterConfig": {
object ( |
Fields | |
---|---|
enablePrivateEnvironment |
Optional. If |
privateClusterConfig |
Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. |
webServerIpv4CidrBlock |
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 |
Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from webServerIpv4CidrBlock |
webServerIpv4ReservedRange |
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 |
Optional. If |
masterIpv4CidrBlock |
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 |
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 ( |
Fields | |
---|---|
allowedIpRanges[] |
A collection of allowed IP ranges with descriptions. |
AllowedIpRange
Allowed IP range with user-provided description.
JSON representation | |
---|---|
{ "value": string, "description": string } |
Fields | |
---|---|
value |
IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: IP range prefixes should be properly truncated. For example, |
description |
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 |
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 |
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 |
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used. |
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 a new environment. |
|
Delete an environment. |
|
Get an existing environment. |
|
List environments. |
|
Update an environment. |
|
Restart Airflow web server. |