Merge pull request #11179 from c2thorn/sync-main-FEATURE-BRANCH-6.0.0

Sync main feature branch 6.0.0 - 7/16

Author: c2thorn

.ci/magician/github/membership.go

@@ -69,8 +69,8 @@ var (
 		},
 		{
 			id:        "SarahFrench",
-			startDate: newDate(2024, 5, 17, bstLoc),
-			endDate:   newDate(2024, 5, 19, bstLoc),
+			startDate: newDate(2024, 7, 10, bstLoc),
+			endDate:   newDate(2024, 7, 28, bstLoc),
 		},
 		{
 			id:        "shuyama1",
@@ -87,6 +87,16 @@ var (
 			startDate: newDate(2024, 7, 5, pdtLoc),
 			endDate:   newDate(2024, 7, 16, pdtLoc),
 		},
+		{
+			id:        "c2thorn",
+			startDate: newDate(2024, 7, 10, pdtLoc),
+			endDate:   newDate(2024, 7, 16, pdtLoc),
+		},
+		{
+			id:        "rileykarson",
+			startDate: newDate(2024, 7, 18, pdtLoc),
+			endDate:   newDate(2024, 8, 10, pdtLoc),
+		},
 	}
 )
 

docs/content/best-practices/_index.md

@@ -190,27 +190,3 @@ if err := tpgresource.SetDataSourceAnnotations(d); err != nil {
 7. In the handwritten acceptance tests, add `annotations` to `ImportStateVerifyIgnore`.
 8. In the corresponding data source, after the resource read method, call the function `tpgresource.SetDataSourceAnnotations(d)` to make `annotations` have all of the labels on the resource.
 9. Add the documentation for these annotation-related fields.
-
-## Update `go.mod`
-
-The Magic Modules repository does not contain a complete Go module, preventing the use of automated tooling like `go get` from that repository. To add or update provider dependencies, use standard Go tooling to update an individual provider and copy the results to the upstream files in Magic Modules. The providers share the same go.mod and go.sum contents so either can be used to generate the changes.
-
-Below are the steps you can follow to make the change:
-
-1. Navigate to the local `google` provider directory:
-```bash
-cd $GOPATH/src/github.com/hashicorp/terraform-provider-google
-``` 
-2. Open the [`go.mod`](https://github.com/hashicorp/terraform-provider-google/blob/main/go.mod) file and add the new entries or modify the versions of existing entries as needed
-3. Update dependencies using either of the following methods
-   * run the following commands to update all dependencies: 
-   ```bash
-   go get
-   go mod tidy
-   ```
-   * Alternatively, update a specific package to a desired version:
-   ```bash
-   go get google.golang.org/[email protected] 
-   go mod tidy
-   ```
-4. Copy the contents of the updated `go.mod` and `go.sum` file into [`mmv1/third_party/terraform/go.mod.erb`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/go.mod.erb) and [`mmv1/third_party/terraform/go.sum`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/go.sum) in the `magic-modules` respectively. Ensure `<% autogen_exception -%>` is still at the top of the file afterwards

docs/content/contribute/review-pr.md

@@ -11,7 +11,7 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR).
    * is linked to a GitHub issue or an internal bug
       * if not, check the [issue tracker](https://github.com/hashicorp/terraform-provider-google/issues) to see whether the feature has already been requested and add the issues in the description, if any.
    * establishes clear context itself via title or description.
-2. If the PR adds any new resource, ensure that the resource does not already exists in the [GA provider](https://github.com/hashicorp/terraform-provider-google) or [beta provider](https://github.com/hashicorp/terraform-provider-google-beta)
+2. If the PR adds any new resource, ensure that the resource does not already exist in the [GA provider](https://github.com/hashicorp/terraform-provider-google) or [beta provider](https://github.com/hashicorp/terraform-provider-google-beta)
 1. Read through all the changes in the PR, generated code in the downstreams and the API documentation to ensure that:
    1. the resource schema added in the PR matches the API structure.
    1. the features are added in the correct version
@@ -46,4 +46,4 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR).
 1. Check documentation to ensure
    1. resouce-level and field-level documentation are generated correctly for MMv1-based resource
    1. documentation is added manually for handwritten resources.   
-1. Check if release notes capture all changes in the PR, and are correctly formatted following the guidance in [write release notes]({{< ref "release-notes" >}}) before merge the PR.
+1. Check if release notes capture all changes in the PR, and are correctly formatted following the guidance in [write release notes]({{< ref "release-notes" >}}) before merging the PR.

docs/content/develop/update-dependencies.md

@@ -0,0 +1,30 @@
+---
+title: "Update dependencies"
+weight: 300
+aliases:
+  - /docs/update-dependencies
+---
+
+# Update `go.mod`
+
+The Magic Modules repository does not contain a complete Go module, preventing the use of automated tooling like `go get` from that repository. To add or update provider dependencies, use standard Go tooling to update an individual provider and copy the results to the upstream files in Magic Modules. The providers share the same go.mod and go.sum contents so either can be used to generate the changes.
+
+Below are the steps you can follow to make the change:
+
+1. Navigate to the local `google` provider directory:
+```bash
+cd $GOPATH/src/github.com/hashicorp/terraform-provider-google
+``` 
+2. Open the [`go.mod`](https://github.com/hashicorp/terraform-provider-google/blob/main/go.mod) file and add the new entries or modify the versions of existing entries as needed
+3. Update dependencies using either of the following methods
+   * run the following commands to update all dependencies: 
+   ```bash
+   go get
+   go mod tidy
+   ```
+   * Alternatively, update a specific package to a desired version:
+   ```bash
+   go get google.golang.org/[email protected] 
+   go mod tidy
+   ```
+4. Copy the contents of the updated `go.mod` and `go.sum` file into [`mmv1/third_party/terraform/go.mod.erb`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/go.mod.erb) and [`mmv1/third_party/terraform/go.sum`](https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/terraform/go.sum) in the `magic-modules` respectively. Ensure `<% autogen_exception -%>` is still at the top of the file afterwards

mmv1/api/resource/examples.go

@@ -172,7 +172,9 @@ func (e *Examples) UnmarshalYAML(n *yaml.Node) error {
 		return err
 	}
 
-	e.ConfigPath = fmt.Sprintf("templates/terraform/examples/go/%s.tf.tmpl", e.Name)
+	if e.ConfigPath == "" {
+		e.ConfigPath = fmt.Sprintf("templates/terraform/examples/go/%s.tf.tmpl", e.Name)
+	}
 	e.SetHCLText()
 
 	return nil

mmv1/products/alloydb/Instance.yaml

@@ -236,6 +236,36 @@ properties:
       - !ruby/object:Api::Type::Integer
         name: 'queryPlansPerMinute'
         description: 'Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.'
+  - !ruby/object:Api::Type::NestedObject
+    name: 'observabilityConfig'
+    description: 'Configuration for enhanced query insights.'
+    default_from_api: true
+    min_version: beta
+    properties:
+      - !ruby/object:Api::Type::Boolean
+        name: 'enabled'
+        description: 'Observability feature status for an instance.'
+      - !ruby/object:Api::Type::Boolean
+        name: 'preserveComments'
+        description: 'Preserve comments in the query string.'
+      - !ruby/object:Api::Type::Boolean
+        name: 'trackWaitEvents'
+        description: 'Record wait events during query execution for an instance.'
+      - !ruby/object:Api::Type::Boolean
+        name: 'trackWaitEventTypes'
+        description: 'Record wait event types during query execution for an instance.'
+      - !ruby/object:Api::Type::Integer
+        name: 'maxQueryStringLength'
+        description: 'Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.'
+      - !ruby/object:Api::Type::Boolean
+        name: 'recordApplicationTags'
+        description: 'Record application tags for an instance. This flag is turned "on" by default.'
+      - !ruby/object:Api::Type::Integer
+        name: 'queryPlansPerMinute'
+        description: 'Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 200 is considered valid.'
+      - !ruby/object:Api::Type::Boolean
+        name: 'trackActiveQueries'
+        description: 'Track actively running queries. If not set, default value is "off".'
   - !ruby/object:Api::Type::NestedObject
     name: 'readPoolConfig'
     description: 'Read pool specific config. If the instance type is READ_POOL, this configuration must be provided.'

mmv1/products/alloydb/go_Backup.yaml

@@ -33,6 +33,7 @@ timeouts:
   delete_minutes: 10
 autogen_async: true
 async:
+  actions: ['create', 'delete', 'update']
   type: 'OpAsync'
   operation:
     base_url: '{{op_id}}'

mmv1/products/alloydb/go_Cluster.yaml

@@ -24,6 +24,13 @@ docs:
     Users can promote a secondary cluster to a primary cluster with the help of `cluster_type`.
     To promote, users have to set the `cluster_type` property as `PRIMARY` and remove the `secondary_config` field from cluster configuration.
     [See Example](https://github.com/hashicorp/terraform-provider-google/pull/16413).
+
+    Switchover is supported in terraform by refreshing the state of the terraform configurations.
+    The switchover operation still needs to be called outside of terraform.
+    After the switchover operation is completed successfully:
+      1. Refresh the state of the AlloyDB resources by running `terraform apply -refresh-only --auto-approve` .
+      2. Manually update the terraform configuration file(s) to match the actual state of the resources by modifying the `cluster_type` and `secondary_config` fields.
+      3. Verify the sync of terraform state by running `terraform plan` and ensure that the infrastructure matches the configuration and no changes are required.
 base_url: 'projects/{{project}}/locations/{{location}}/clusters'
 self_link: 'projects/{{project}}/locations/{{location}}/clusters/{{cluster_id}}'
 create_url: 'projects/{{project}}/locations/{{location}}/clusters?clusterId={{cluster_id}}'
@@ -38,6 +45,7 @@ timeouts:
   delete_minutes: 30
 autogen_async: true
 async:
+  actions: ['create', 'delete', 'update']
   type: 'OpAsync'
   operation:
     base_url: '{{op_id}}'

mmv1/products/alloydb/go_Instance.yaml

@@ -36,6 +36,7 @@ timeouts:
   delete_minutes: 120
 autogen_async: true
 async:
+  actions: ['create', 'delete', 'update']
   type: 'OpAsync'
   operation:
     base_url: '{{op_id}}'
@@ -234,6 +235,36 @@ properties:
       - name: 'queryPlansPerMinute'
         type: Integer
         description: 'Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.'
+  - name: 'observabilityConfig'
+    type: NestedObject
+    description: 'Configuration for enhanced query insights.'
+    default_from_api: true
+    min_version: beta
+    properties:
+      - name: 'enabled'
+        type: Boolean
+        description: 'Observability feature status for an instance.'
+      - name: 'preserveComments'
+        type: Boolean
+        description: 'Preserve comments in the query string.'
+      - name: 'trackWaitEvents'
+        type: Boolean
+        description: 'Record wait events during query execution for an instance.'
+      - name: 'trackWaitEventTypes'
+        type: Boolean
+        description: 'Record wait event types during query execution for an instance.'
+      - name: 'maxQueryStringLength'
+        type: Integer
+        description: 'Query string length. The default value is 10240. Any integer between 1024 and 100000 is considered valid.'
+      - name: 'recordApplicationTags'
+        type: Boolean
+        description: 'Record application tags for an instance. This flag is turned "on" by default.'
+      - name: 'queryPlansPerMinute'
+        type: Integer
+        description: 'Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 200 is considered valid.'
+      - name: 'trackActiveQueries'
+        type: Boolean
+        description: 'Track actively running queries. If not set, default value is "off".'
   - name: 'readPoolConfig'
     type: NestedObject
     description: 'Read pool specific config. If the instance type is READ_POOL, this configuration must be provided.'

mmv1/products/apigee/EnvironmentKeyvaluemap.yaml

@@ -0,0 +1,76 @@
+# Copyright 2023 Google Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+--- !ruby/object:Api::Resource
+name: 'EnvironmentKeyvaluemaps'
+description: |
+  Collection of key/value string pairs.
+references: !ruby/object:Api::Resource::ReferenceLinks
+  guides:
+    'Using key value maps': 'https://cloud.google.com/apigee/docs/api-platform/cache/key-value-maps'
+  api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.keyvaluemaps/create'
+
+base_url: '{{env_id}}/keyvaluemaps'
+create_url: '{{env_id}}/keyvaluemaps'
+delete_url: '{{env_id}}/keyvaluemaps/{{name}}'
+self_link: '{{env_id}}/keyvaluemaps/{{name}}/entries'
+import_format: ['{{env_id}}/keyvaluemaps/{{name}}', '{{env_id}}/{{name}}']
+skip_sweeper: true
+examples:
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_basic'
+    primary_resource_id: 'apigee_environment_keyvaluemaps'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_test: true
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_test'
+    primary_resource_id: 'apigee_environment_keyvaluemaps'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_docs: true
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_beta_test'
+    primary_resource_id: 'apigee_environment_keyvaluemaps'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_docs: true
+    min_version: beta
+immutable: true
+timeouts: !ruby/object:Api::Timeouts
+  insert_minutes: 1
+  delete_minutes: 1
+autogen_async: true
+custom_code: !ruby/object:Provider::Terraform::CustomCode
+  custom_import: templates/terraform/custom_import/apigee_environment_keyvaluemaps.go.erb
+  custom_create: 'templates/terraform/custom_create/apigee_environment_keyvaluemaps.go'
+  decoder: templates/terraform/decoders/apigee_environment_keyvaluemaps.go.erb
+parameters:
+  - !ruby/object:Api::Type::String
+    name: 'envId'
+    description: |
+      The Apigee environment group associated with the Apigee environment,
+      in the format `organizations/{{org_name}}/environments/{{env_name}}`.
+    required: true
+    immutable: true
+    url_param_only: true
+properties:
+  - !ruby/object:Api::Type::String
+    name: 'name'
+    description: |
+      Required. ID of the key value map.
+    required: true
+    immutable: true

mmv1/products/apigee/EnvironmentKeyvaluemapEntry.yaml

@@ -0,0 +1,81 @@
+# Copyright 2023 Google Inc.
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+--- !ruby/object:Api::Resource
+name: 'EnvironmentKeyvaluemapsEntries'
+description: |
+  Creates key value entries in a key value map scoped to an environment.
+references: !ruby/object:Api::Resource::ReferenceLinks
+  guides:
+    'Using key value maps': 'https://cloud.google.com/apigee/docs/api-platform/cache/key-value-maps'
+  api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.keyvaluemaps.entries/create'
+
+base_url: '{{env_keyvaluemap_id}}/entries'
+create_url: '{{env_keyvaluemap_id}}/entries'
+delete_url: '{{env_keyvaluemap_id}}/entries/{{name}}'
+self_link: '{{env_keyvaluemap_id}}/entries/{{name}}'
+import_format:
+  ['{{env_keyvaluemap_id}}/entries/{{name}}', '{{env_keyvaluemap_id}}/{{name}}']
+skip_sweeper: true
+examples:
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_entries_basic'
+    primary_resource_id: 'apigee_environment_keyvaluemaps_entries'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_test: true
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_entries_test'
+    primary_resource_id: 'apigee_environment_keyvaluemaps_entries'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_docs: true
+  - !ruby/object:Provider::Terraform::Examples
+    name: 'apigee_environment_keyvaluemaps_entries_beta_test'
+    primary_resource_id: 'apigee_environment_keyvaluemaps_entries'
+    test_env_vars:
+      org_id: :ORG_ID
+      billing_account: :BILLING_ACCT
+    skip_docs: true
+    min_version: beta
+timeouts: !ruby/object:Api::Timeouts
+  insert_minutes: 1
+  delete_minutes: 1
+immutable: true
+autogen_async: true
+custom_code: !ruby/object:Provider::Terraform::CustomCode
+  custom_import: templates/terraform/custom_import/apigee_environment_keyvaluemaps_entries.go.erb
+parameters:
+  - !ruby/object:Api::Type::String
+    name: 'env_keyvaluemap_id'
+    description: |
+      The Apigee environment keyvalumaps Id associated with the Apigee environment,
+      in the format `organizations/{{org_name}}/environments/{{env_name}}/keyvaluemaps/{{keyvaluemap_name}}`.
+    required: true
+    immutable: true
+    url_param_only: true
+properties:
+  - !ruby/object:Api::Type::String
+    name: 'name'
+    description: |
+      Required. Resource URI that can be used to identify the scope of the key value map entries.
+    required: true
+    immutable: true
+  - !ruby/object:Api::Type::String
+    name: 'value'
+    description: |
+      Required. Data or payload that is being retrieved and associated with the unique key.
+    required: true
+    immutable: true