Skip to content

Commit

Permalink
docs: add examples for kubernetes secret
Browse files Browse the repository at this point in the history
chore: explicitly set fields to field_behavior optional

PiperOrigin-RevId: 703589766
  • Loading branch information
Google APIs authored and copybara-github committed Dec 6, 2024
1 parent 5934869 commit 22dffa8
Showing 1 changed file with 32 additions and 16 deletions.
48 changes: 32 additions & 16 deletions google/cloud/orchestration/airflow/service/v1/environments.proto
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,13 @@ message UserWorkloadsSecret {
// pairs, which can contain sensitive values such as a password, a token, or a
// key. The values for all keys have to be base64-encoded strings. For details
// see: https://kubernetes.io/docs/concepts/configuration/secret/
//
// Example:
//
// {
// "example": "ZXhhbXBsZV92YWx1ZQ==",
// "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl"
// }
map<string, string> data = 2 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down Expand Up @@ -798,6 +805,13 @@ message UserWorkloadsConfigMap {
// Optional. The "data" field of Kubernetes ConfigMap, organized in key-value
// pairs. For details see:
// https://kubernetes.io/docs/concepts/configuration/configmap/
//
// Example:
//
// {
// "example_key": "example_value",
// "another_key": "another_value"
// }
map<string, string> data = 2 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down Expand Up @@ -1064,14 +1078,16 @@ message EnvironmentConfig {
// composer-1.*.*-airflow-*.*.*.
int32 node_count = 3;

// The configuration settings for software inside the environment.
SoftwareConfig software_config = 4;
// Optional. The configuration settings for software inside the environment.
SoftwareConfig software_config = 4 [(google.api.field_behavior) = OPTIONAL];

// The configuration used for the Kubernetes Engine cluster.
NodeConfig node_config = 5;
// Optional. The configuration used for the Kubernetes Engine cluster.
NodeConfig node_config = 5 [(google.api.field_behavior) = OPTIONAL];

// The configuration used for the Private IP Cloud Composer environment.
PrivateEnvironmentConfig private_environment_config = 7;
// Optional. The configuration used for the Private IP Cloud Composer
// environment.
PrivateEnvironmentConfig private_environment_config = 7
[(google.api.field_behavior) = OPTIONAL];

// Optional. The network-level access control policy for the Airflow web
// server. If unspecified, no network-level access restrictions will be
Expand Down Expand Up @@ -1274,7 +1290,7 @@ message SoftwareConfig {
PLUGINS_ENABLED = 2;
}

// The version of the software running in the environment.
// Optional. 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]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`.
Expand All @@ -1298,7 +1314,7 @@ message SoftwareConfig {
// See also [version
// list](/composer/docs/concepts/versioning/composer-versions) and [versioning
// overview](/composer/docs/concepts/versioning/composer-versioning-overview).
string image_version = 1;
string image_version = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. Apache Airflow configuration properties to override.
//
Expand Down Expand Up @@ -1511,7 +1527,7 @@ message NodeConfig {
// is provided, `nodeConfig.subnetwork` must also be provided. For
// [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
// `nodeConfig.subnetwork`.
string network = 3;
string network = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. The Compute Engine subnetwork to be used for machine
// communications, specified as a
Expand All @@ -1522,7 +1538,7 @@ message NodeConfig {
// If a subnetwork is provided, `nodeConfig.network` must also be provided,
// and the subnetwork must belong to the enclosing environment's project and
// location.
string subnetwork = 4;
string subnetwork = 4 [(google.api.field_behavior) = OPTIONAL];

// Optional. The disk size in GB used for node VMs. Minimum size is 30GB.
// If unspecified, defaults to 100GB. Cannot be updated.
Expand All @@ -1542,7 +1558,7 @@ message NodeConfig {
// 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.
string service_account = 7;
string service_account = 7 [(google.api.field_behavior) = OPTIONAL];

// 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
Expand Down Expand Up @@ -1911,15 +1927,15 @@ message Environment {
ERROR = 5;
}

// The resource name of the environment, in the form:
// Identifier. 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.
string name = 1;
string name = 1 [(google.api.field_behavior) = IDENTIFIER];

// Configuration parameters for this environment.
EnvironmentConfig config = 2;
// Optional. Configuration parameters for this environment.
EnvironmentConfig config = 2 [(google.api.field_behavior) = OPTIONAL];

// Output only. The UUID (Universally Unique IDentifier) associated with this
// environment. This value is generated when the environment is created.
Expand All @@ -1942,7 +1958,7 @@ message Environment {
// * 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.
map<string, string> labels = 7;
map<string, string> labels = 7 [(google.api.field_behavior) = OPTIONAL];

// Output only. Reserved for future use.
bool satisfies_pzs = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
Expand Down

0 comments on commit 22dffa8

Please sign in to comment.