|
|
|
|
@@ -5,7 +5,7 @@
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
|
|
|
|
<title>Locations Environments Create - Cloud Composer v2.0.4+20210319</title>
|
|
|
|
|
<title>Locations Environments Create - Cloud Composer v3.0.0+20220224</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -34,7 +34,7 @@
|
|
|
|
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
|
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
<a href=".." class="icon icon-home"> Cloud Composer v2.0.4+20210319</a>
|
|
|
|
|
<a href=".." class="icon icon-home"> Cloud Composer v3.0.0+20220224</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
@@ -170,7 +170,12 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
|
|
|
|
machine-type: string
|
|
|
|
|
encryption-config:
|
|
|
|
|
kms-key-name: string
|
|
|
|
|
environment-size: string
|
|
|
|
|
gke-cluster: string
|
|
|
|
|
maintenance-window:
|
|
|
|
|
end-time: string
|
|
|
|
|
recurrence: string
|
|
|
|
|
start-time: string
|
|
|
|
|
node-config:
|
|
|
|
|
disk-size-gb: integer
|
|
|
|
|
ip-allocation-policy:
|
|
|
|
|
@@ -188,6 +193,9 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
|
|
|
|
tags: [string]
|
|
|
|
|
node-count: integer
|
|
|
|
|
private-environment-config:
|
|
|
|
|
cloud-composer-connection-subnetwork: string
|
|
|
|
|
cloud-composer-network-ipv4-cidr-block: string
|
|
|
|
|
cloud-composer-network-ipv4-reserved-range: string
|
|
|
|
|
cloud-sql-ipv4-cidr-block: string
|
|
|
|
|
enable-private-environment: boolean
|
|
|
|
|
private-cluster-config:
|
|
|
|
|
@@ -202,8 +210,25 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
|
|
|
|
image-version: string
|
|
|
|
|
pypi-packages: { string: string }
|
|
|
|
|
python-version: string
|
|
|
|
|
scheduler-count: integer
|
|
|
|
|
web-server-config:
|
|
|
|
|
machine-type: string
|
|
|
|
|
workloads-config:
|
|
|
|
|
scheduler:
|
|
|
|
|
count: integer
|
|
|
|
|
cpu: number
|
|
|
|
|
memory-gb: number
|
|
|
|
|
storage-gb: number
|
|
|
|
|
web-server:
|
|
|
|
|
cpu: number
|
|
|
|
|
memory-gb: number
|
|
|
|
|
storage-gb: number
|
|
|
|
|
worker:
|
|
|
|
|
cpu: number
|
|
|
|
|
max-count: integer
|
|
|
|
|
memory-gb: number
|
|
|
|
|
min-count: integer
|
|
|
|
|
storage-gb: number
|
|
|
|
|
create-time: string
|
|
|
|
|
labels: { string: string }
|
|
|
|
|
name: string
|
|
|
|
|
@@ -236,168 +261,264 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>.. gke-cluster=voluptua.</code></p>
|
|
|
|
|
<p><code>.. environment-size=voluptua.</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>gke-cluster=at</code><ul>
|
|
|
|
|
<li>Output only. The Kubernetes Engine cluster used to run this environment.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>node-config disk-size-gb=74</code><ul>
|
|
|
|
|
<li>Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.</li>
|
|
|
|
|
<li><code>maintenance-window end-time=sanctus</code><ul>
|
|
|
|
|
<li>Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to <code>start_time</code>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>ip-allocation-policy cluster-ipv4-cidr-block=sanctus</code><ul>
|
|
|
|
|
<li>Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. This field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
|
|
|
<li><code>recurrence=sed</code><ul>
|
|
|
|
|
<li>Required. Maintenance window recurrence. Format is a subset of <a href="https://tools.ietf.org/html/rfc5545">RFC-5545</a> <code>RRULE</code>. The only allowed values for <code>FREQ</code> field are <code>FREQ=DAILY</code> and <code>FREQ=WEEKLY;BYDAY=...</code> Example values: <code>FREQ=WEEKLY;BYDAY=TU,WE</code>, <code>FREQ=DAILY</code>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cluster-secondary-range-name=sed</code><ul>
|
|
|
|
|
<li>Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. This field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>start-time=amet.</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Required. Start time of the first recurrence of the maintenance window.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>services-ipv4-cidr-block=amet.</code><ul>
|
|
|
|
|
<li>Optional. The IP address range of the services IP addresses in this GKE cluster. This field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..node-config disk-size-gb=42</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>services-secondary-range-name=takimata</code><ul>
|
|
|
|
|
<li>Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. This field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
|
|
|
<li><code>ip-allocation-policy cluster-ipv4-cidr-block=amet.</code><ul>
|
|
|
|
|
<li>Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cluster-secondary-range-name=duo</code><ul>
|
|
|
|
|
<li>Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>services-ipv4-cidr-block=ipsum</code><ul>
|
|
|
|
|
<li>Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>services-secondary-range-name=gubergren</code><ul>
|
|
|
|
|
<li>Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>use-ip-aliases=true</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. Whether or not to enable Alias IPs in the GKE cluster. If <code>true</code>, a VPC-native cluster is created.</li>
|
|
|
|
|
<li>Optional. Whether or not to enable Alias IPs in the GKE cluster. If <code>true</code>, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*. Environments in newer versions always use VPC-native GKE clusters.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>.. location=duo</code></p>
|
|
|
|
|
<p><code>.. location=gubergren</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The Compute Engine <a href="..//compute/docs/regions-zones">zone</a> in which to deploy the VMs used to run the Apache Airflow software, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}". This <code>location</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.machineType</code> are specified, <code>nodeConfig.machineType</code> must belong to this <code>location</code>; 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 (<code>location</code> or <code>nodeConfig.machineType</code>) is specified, the location information from the specified field will be propagated to the unspecified field.</li>
|
|
|
|
|
<li>Optional. The Compute Engine <a href="..//compute/docs/regions-zones">zone</a> in which to deploy the VMs used to run the Apache Airflow software, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}". This <code>location</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.machineType</code> are specified, <code>nodeConfig.machineType</code> must belong to this <code>location</code>; 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 (<code>location</code> or <code>nodeConfig.machineType</code>) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>machine-type=ipsum</code><ul>
|
|
|
|
|
<li>Optional. The Compute Engine <a href="..//compute/docs/machine-types">machine type</a> used for cluster instances, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The <code>machineType</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.location</code> are specified, this <code>machineType</code> must belong to the <code>nodeConfig.location</code>; 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 <code>nodeConfig.location</code> is specified, the location information from the specified field will be propagated to the unspecified field. The <code>machineTypeId</code> must not be a <a href="..//compute/docs/machine-types#sharedcore">shared-core machine type</a>. If this field is unspecified, the <code>machineTypeId</code> defaults to "n1-standard-1".</li>
|
|
|
|
|
<li><code>machine-type=eos</code><ul>
|
|
|
|
|
<li>Optional. The Compute Engine <a href="..//compute/docs/machine-types">machine type</a> used for cluster instances, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The <code>machineType</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.location</code> are specified, this <code>machineType</code> must belong to the <code>nodeConfig.location</code>; 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 <code>nodeConfig.location</code> is specified, the location information from the specified field will be propagated to the unspecified field. The <code>machineTypeId</code> must not be a <a href="..//compute/docs/machine-types#sharedcore">shared-core machine type</a>. If this field is unspecified, the <code>machineTypeId</code> defaults to "n1-standard-1". This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>network=gubergren</code><ul>
|
|
|
|
|
<li><code>network=dolor</code><ul>
|
|
|
|
|
<li>Optional. The Compute Engine network to be used for machine communications, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a <a href="..//vpc/docs/vpc#vpc_networks_and_subnets">Custom Subnet Network</a> is provided, <code>nodeConfig.subnetwork</code> must also be provided. For <a href="..//vpc/docs/shared-vpc">Shared VPC</a> subnetwork requirements, see <code>nodeConfig.subnetwork</code>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>oauth-scopes=lorem</code><ul>
|
|
|
|
|
<li>Optional. The set of Google API scopes to be made available on all node VMs. If <code>oauth_scopes</code> is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.</li>
|
|
|
|
|
<li><code>oauth-scopes=ea</code><ul>
|
|
|
|
|
<li>Optional. The set of Google API scopes to be made available on all node VMs. If <code>oauth_scopes</code> is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>service-account=gubergren</code><ul>
|
|
|
|
|
<li><code>service-account=ipsum</code><ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>subnetwork=eos</code><ul>
|
|
|
|
|
<li><code>subnetwork=invidunt</code><ul>
|
|
|
|
|
<li>Optional. The Compute Engine subnetwork to be used for machine communications, specified as a <a href="..//apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, <code>nodeConfig.network</code> must also be provided, and the subnetwork must belong to the enclosing environment's project and location.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>tags=dolor</code></p>
|
|
|
|
|
<p><code>tags=amet</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>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 <a href="https://www.ietf.org/rfc/rfc1035.txt">RFC1035</a>. Cannot be updated.</li>
|
|
|
|
|
<li>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 <a href="https://www.ietf.org/rfc/rfc1035.txt">RFC1035</a>. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>.. node-count=84</code></p>
|
|
|
|
|
<p><code>.. node-count=81</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.</li>
|
|
|
|
|
<li>The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>private-environment-config cloud-sql-ipv4-cidr-block=ipsum</code><ul>
|
|
|
|
|
<li><code>private-environment-config cloud-composer-connection-subnetwork=ipsum</code><ul>
|
|
|
|
|
<li>Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cloud-composer-network-ipv4-cidr-block=sed</code><ul>
|
|
|
|
|
<li>Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cloud-composer-network-ipv4-reserved-range=ut</code><ul>
|
|
|
|
|
<li>Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cloud-sql-ipv4-cidr-block=gubergren</code><ul>
|
|
|
|
|
<li>Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from <code>web_server_ipv4_cidr_block</code>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>enable-private-environment=false</code><ul>
|
|
|
|
|
<li>Optional. If <code>true</code>, a Private IP Cloud Composer environment is created. If this field is set to true, <code>IPAllocationPolicy.use_ip_aliases</code> must be set to true.</li>
|
|
|
|
|
<li><code>enable-private-environment=true</code><ul>
|
|
|
|
|
<li>Optional. If <code>true</code>, a Private IP Cloud Composer environment is created. If this field is set to true, <code>IPAllocationPolicy.use_ip_aliases</code> must be set to true for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>private-cluster-config enable-private-endpoint=true</code><ul>
|
|
|
|
|
<li>Optional. If <code>true</code>, access to the public endpoint of the GKE cluster is denied.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>master-ipv4-cidr-block=duo</code><ul>
|
|
|
|
|
<li><code>master-ipv4-cidr-block=ipsum</code><ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>master-ipv4-reserved-range=ipsum</code></p>
|
|
|
|
|
<p><code>master-ipv4-reserved-range=est</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>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 GKE 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.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>.. web-server-ipv4-cidr-block=sed</code></p>
|
|
|
|
|
<p><code>.. web-server-ipv4-cidr-block=gubergren</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from <code>private_cluster_config.master_ipv4_cidr_block</code> and <code>cloud_sql_ipv4_cidr_block</code>.</li>
|
|
|
|
|
<li>Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from <code>private_cluster_config.master_ipv4_cidr_block</code> and <code>cloud_sql_ipv4_cidr_block</code>. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>web-server-ipv4-reserved-range=ut</code></p>
|
|
|
|
|
<p><code>web-server-ipv4-reserved-range=ea</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Output only. The IP range reserved for the tenant project's App Engine VMs.</li>
|
|
|
|
|
<li>Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..software-config airflow-config-overrides=key=gubergren</code></p>
|
|
|
|
|
<p><code>..software-config airflow-config-overrides=key=dolor</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>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 <a href="https://en.wikipedia.org/wiki/Snake_case">snake_case</a>. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are <a href="..//composer/docs/concepts/airflow-configurations">blocked</a>, and cannot be overridden.</li>
|
|
|
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>env-variables=key=rebum.</code><ul>
|
|
|
|
|
<li><code>env-variables=key=lorem</code><ul>
|
|
|
|
|
<li>Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression <code>a-zA-Z_*</code>. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression <code>AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+</code>), and they cannot match any of the following reserved names: * <code>AIRFLOW_HOME</code> * <code>C_FORCE_ROOT</code> * <code>CONTAINER_NAME</code> * <code>DAGS_FOLDER</code> * <code>GCP_PROJECT</code> * <code>GCS_BUCKET</code> * <code>GKE_CLUSTER_NAME</code> * <code>SQL_DATABASE</code> * <code>SQL_INSTANCE</code> * <code>SQL_PASSWORD</code> * <code>SQL_PROJECT</code> * <code>SQL_REGION</code> * <code>SQL_USER</code></li>
|
|
|
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>image-version=est</code><ul>
|
|
|
|
|
<li><code>image-version=eos</code><ul>
|
|
|
|
|
<li>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 <code>composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?</code>. 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 <a href="https://semver.org">semantic version</a> or <code>latest</code>. When the patch version is omitted, the current Cloud Composer patch version is selected. When <code>latest</code> is provided instead of an explicit version number, the server replaces <code>latest</code> with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows <em>airflow-</em> is an official Apache Airflow repository <a href="https://github.com/apache/incubator-airflow/releases">release name</a>. See also <a href="..//composer/docs/concepts/versioning/composer-versions">Version List</a>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>pypi-packages=key=ipsum</code><ul>
|
|
|
|
|
<li><code>pypi-packages=key=labore</code><ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>python-version=ipsum</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
<li><code>python-version=sed</code><ul>
|
|
|
|
|
<li>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. This field is only supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*. Environments in newer versions always use Python major version 3.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..web-server-config machine-type=est</code></p>
|
|
|
|
|
<p><code>scheduler-count=31</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-2.<em>.</em>.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..web-server-config machine-type=sed</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>... create-time=gubergren</code></p>
|
|
|
|
|
<p><code>..workloads-config.scheduler count=40</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. The number of schedulers.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>cpu=0.6792626134346527</code><ul>
|
|
|
|
|
<li>Optional. CPU request and limit for a single Airflow scheduler replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>memory-gb=0.9217746474973857</code><ul>
|
|
|
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow scheduler replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>storage-gb=0.6045921553459583</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. Storage (GB) request and limit for a single Airflow scheduler replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..web-server cpu=0.6034145300452126</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. CPU request and limit for Airflow web server.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>memory-gb=0.8039909988714865</code><ul>
|
|
|
|
|
<li>Optional. Memory (GB) request and limit for Airflow web server.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>storage-gb=0.5477575441248734</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. Storage (GB) request and limit for Airflow web server.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>..worker cpu=0.6383502522516505</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. CPU request and limit for a single Airflow worker replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>max-count=79</code><ul>
|
|
|
|
|
<li>Optional. Maximum number of workers for autoscaling.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>memory-gb=0.9697780726648698</code><ul>
|
|
|
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow worker replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>min-count=99</code><ul>
|
|
|
|
|
<li>Optional. Minimum number of workers for autoscaling.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>storage-gb=0.04388040358005296</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Optional. Storage (GB) request and limit for a single Airflow worker replica.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<p><code>.... create-time=dolor</code></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Output only. The time at which this environment was created.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>labels=key=ea</code><ul>
|
|
|
|
|
<li><code>labels=key=et</code><ul>
|
|
|
|
|
<li>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}{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.</li>
|
|
|
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>name=dolor</code><ul>
|
|
|
|
|
<li><code>name=et</code><ul>
|
|
|
|
|
<li>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.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>state=lorem</code><ul>
|
|
|
|
|
<li><code>state=sadipscing</code><ul>
|
|
|
|
|
<li>The current state of the environment.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>update-time=eos</code><ul>
|
|
|
|
|
<li><code>update-time=stet</code><ul>
|
|
|
|
|
<li>Output only. The time at which this environment was last modified.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li><code>uuid=labore</code><ul>
|
|
|
|
|
<li><code>uuid=dolor</code><ul>
|
|
|
|
|
<li>Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
Sebastian Thiel