Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Cloud Deploy resources #5710

Merged
merged 5 commits into from
Apr 14, 2022
Merged

Add support for Cloud Deploy resources #5710

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b34526
add cloud deploy resources
upodroid Feb 14, 2022
617daea
add new test
upodroid Apr 13, 2022
c67424c
apply suggestions from sam
upodroid Apr 13, 2022
f53e541
remove custom flattener
upodroid Apr 13, 2022
d8e431f
fix import id, add new tests and fix bad rebase
upodroid Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 218 additions & 0 deletions mmv1/products/clouddeploy/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
# Copyright 2022 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::Product
name: CloudDeploy
display_name: Cloud Deploy
versions:
- !ruby/object:Api::Product::Version
name: ga
base_url: https://clouddeploy.googleapis.com/v1/
scopes:
- https://www.googleapis.com/auth/cloud-platform
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
objects:
- !ruby/object:Api::Resource
name: 'DeliveryPipeline'
base_url: projects/{{project}}/locations/{{region}}/deliveryPipelines
self_link: 'projects/{{project}}/locations/{{region}}/deliveryPipelines/{{name}}'
create_url: projects/{{project}}/locations/{{region}}/deliveryPipelines?deliveryPipelineId={{name}}
input: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Official Documentation':
'https://cloud.google.com/deploy/docs'
api: 'https://cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.deliveryPipelines'
description: |-
A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.
parameters:
- !ruby/object:Api::Type::String
name: region
description: The region of the DeliveryPipeline Store. eg us-central1
url_param_only: true
input: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: The name of the DeliveryPipeline. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
input: true
url_param_only: true
pattern: projects/{{project}}/locations/{{region}}/deliveryPipelines/{{name}}
- !ruby/object:Api::Type::String
name: 'description'
description: Description of the DeliveryPipeline.
input: true
- !ruby/object:Api::Type::KeyValuePairs
name: 'labels'
description: |
Resource labels to represent user-provided metadata.
- !ruby/object:Api::Type::KeyValuePairs
name: 'annotations'
description: |
User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.
- !ruby/object:Api::Type::NestedObject
name: 'serialPipeline'
slevenick marked this conversation as resolved.
Show resolved Hide resolved
required: true
description: |
SerialPipeline defines a sequential set of stages for a DeliveryPipeline.
properties:
- !ruby/object:Api::Type::Array
required: true
name: 'stages'
description: |
Stage specifies a location to which to deploy.
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::String
name: 'targetId'
required: true
input: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are unnecessary as the whole resource is input: true

description: |
The targetId to which this stage points. This field refers exclusively to the last segment of a target name.
For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target).
The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.
- !ruby/object:Api::Type::Array
name: 'profiles'
item_type: Api::Type::String
input: true
description: |
Skaffold profiles to use when rendering the manifest for this stage's Target.
- !ruby/object:Api::Resource
name: 'Target'
base_url: projects/{{project}}/locations/{{region}}/targets
self_link: 'projects/{{project}}/locations/{{region}}/targets/{{name}}'
create_url: projects/{{project}}/locations/{{region}}/targets?targetId={{name}}
update_verb: :PATCH
update_mask: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Official Documentation':
'https://cloud.google.com/deploy/docs'
api: 'https://cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.targets'
description: |-
A Target defines a location to which a Skaffold configuration can be deployed.
parameters:
- !ruby/object:Api::Type::String
name: region
description: The region of the Target Store. eg us-central1
url_param_only: true
input: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: The name of the Target. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
input: true
url_param_only: true
pattern: projects/{{project}}/locations/{{region}}/targets/{{name}}
- !ruby/object:Api::Type::String
name: 'description'
description: Description of the Target.
- !ruby/object:Api::Type::String
name: 'createTime'
output: true
description: |
The timestamp of when the Target was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
- !ruby/object:Api::Type::String
name: 'updateTime'
output: true
description: |
The timestamp of when the Target was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
- !ruby/object:Api::Type::String
name: 'etag'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this needed for any particular reason? We tend to avoid adding etag and some of these other output-only fields if they aren't needed for other resources that depend on this. Similarly, updateTime & createTime can be removed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were these needed?

output: true
description: |
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
- !ruby/object:Api::Type::KeyValuePairs
name: 'labels'
description: |
Resource labels to represent user-provided metadata.
- !ruby/object:Api::Type::KeyValuePairs
name: 'annotations'
description: |
User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.
- !ruby/object:Api::Type::Boolean
name: 'requireApproval'
description: |
Whether or not the Target requires approval.
- !ruby/object:Api::Type::NestedObject
name: 'gke'
upodroid marked this conversation as resolved.
Show resolved Hide resolved
description: |
Information specifying a GKE Cluster.
properties:
- !ruby/object:Api::Type::String
name: 'cluster'
exactly_one_of:
- gke.0.cluster
- anthos_cluster.0.membership
description: |
Information specifying a GKE Cluster. Format is `projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.
- !ruby/object:Api::Type::Boolean
name: 'internalIp'
description: |
If true, cluster is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used.
The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise.
- !ruby/object:Api::Type::NestedObject
name: 'anthosCluster'
description: |
Information specifying a GKE Cluster.
properties:
- !ruby/object:Api::Type::String
name: 'membership'
exactly_one_of:
- gke.0.cluster
- anthos_cluster.0.membership
description: |
Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is projects/{project}/locations/{location}/memberships/{membership_name}.
- !ruby/object:Api::Type::Array
name: 'executionConfigs'
description: |
Configurations for all execution that relates to this Target. Each ExecutionEnvironmentUsage value may only be used in a single configuration;
using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER and DEPLOY ExecutionEnvironmentUsage values.
When no configurations are specified, execution will use the default specified in DefaultPool.
upodroid marked this conversation as resolved.
Show resolved Hide resolved
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::Array
name: 'usages'
required: true
item_type: Api::Type::String
description: |
Possible usages of this configuration.
- !ruby/object:Api::Type::String
name: 'serviceAccount'
description: |
Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
- !ruby/object:Api::Type::String
name: 'artifactStorage'
description: |
Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir").
If unspecified, a default bucket located in the same region will be used.
- !ruby/object:Api::Type::String
name: 'workerPool'
description: |
Resource name of the Cloud Build worker pool to use. The format is projects/{project}/locations/{location}/workerPools/{pool}.
48 changes: 48 additions & 0 deletions mmv1/products/clouddeploy/terraform.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Copyright 2022 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:Provider::Terraform::Config
overrides: !ruby/object:Overrides::ResourceOverrides
DeliveryPipeline: !ruby/object:Overrides::Terraform::ResourceOverride
autogen_async: true
id_format: '{{name}}'
examples:
- !ruby/object:Provider::Terraform::Examples
name: "cloud_deploy_delivery_pipeline"
primary_resource_id: "pipeline"
vars:
name: "dev"
properties:
region: !ruby/object:Overrides::Terraform::PropertyOverride
default_from_api: true
Target: !ruby/object:Overrides::Terraform::ResourceOverride
autogen_async: true
id_format: '{{name}}'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is name the right format? This is the short-form, so won't be able to identify the full resource during import?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

https://github.com/modular-magician/terraform-provider-google/compare/auto-pr-5710-old..auto-pr-5710#diff-e36b98e511d7d496a126e50204560eea400fe43213204672a22acece89f3f4ebR409

Copy link
Contributor Author

@upodroid upodroid Apr 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a side note, I'm not a fan of something_Id as name is the consistent resource name in most resources. The API uses name as selflink but an identical value can be read with the id attribute.

Precedent: #4951

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, having this id_format ends up with the following code to set the ID of the resource:

	// Store the ID now
	id, err := replaceVars(d, config, "{{name}}")
	if err != nil {
		return fmt.Errorf("Error constructing id: %s", err)
	}
	d.SetId(id)

I don't believe this is right, because it doesn't represent the full resource. The ID format should be projects/{{project}}/locations/{{region}}/deliveryPipelines/{{name}} so that we can reference this value from other resources within a config (if needed)

examples:
- !ruby/object:Provider::Terraform::Examples
name: "cloud_deploy_target"
primary_resource_id: "pipeline"
vars:
name: "tf-test"
test_env_vars:
project: :PROJECT_NAME
properties:
region: !ruby/object:Overrides::Terraform::PropertyOverride
upodroid marked this conversation as resolved.
Show resolved Hide resolved
default_from_api: true

# This is for copying files over
files: !ruby/object:Provider::Config::Files
# These files have templating (ERB) code that will be run.
# This is usually to add licensing info, autogeneration notices, etc.
compile:
<%= lines(indent(compile('provider/terraform/product~compile.yaml'), 4)) -%>
16 changes: 16 additions & 0 deletions mmv1/templates/terraform/examples/cloud_deploy_delivery_pipeline.tf.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
resource "google_cloud_deploy_delivery_pipeline" "<%= ctx[:primary_resource_id] %>" {
name = "<%= ctx[:vars]['name'] %>"
description = "Dev Pipeline"
serial_pipeline {
stages {
target_id = "dev"
}
}
annotations = {
generated-by = "magic-modules"
}
labels = {
env = "dev"
}
region = "us-central1"
}
19 changes: 19 additions & 0 deletions mmv1/templates/terraform/examples/cloud_deploy_target.tf.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
resource "google_cloud_deploy_target" "<%= ctx[:primary_resource_id] %>" {
name = "<%= ctx[:vars]['name'] %>"
description = "Target Cluster"
annotations = {
generated-by = "magic-modules"
}

require_approval = true
labels = {
env = "dev"
}
gke {
cluster = "projects/<%= ctx[:test_env_vars]['project'] %>/locations/us-central1/clusters/dev"
}
execution_configs {
usages = ["RENDER", "DEPLOY"]
service_account = "<%= ctx[:test_env_vars]['project'] %>@appspot.gserviceaccount.com"
}
}
74 changes: 74 additions & 0 deletions mmv1/third_party/terraform/tests/resource_cloud_deploy_target_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
package google

import (
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
)

func TestAccCloudDeployTarget_update(t *testing.T) {
t.Parallel()

context := map[string]interface{}{
"project": getTestProjectFromEnv(),
"random_suffix": randString(t, 10),
}

vcrTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
CheckDestroy: testAccCheckDataCatalogEntryGroupDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testAccCloudDeployTarget_cloudDeployTargetExample(context),
},
{
ResourceName: "google_cloud_deploy_target.pipeline",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"name", "region"},
},
{
Config: testAccCloudDeployTarget_cloudDeployTargetExample_update(context),
},
{
ResourceName: "google_cloud_deploy_target.pipeline",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"name", "region"},
},
},
})
}

func testAccCloudDeployTarget_cloudDeployTargetExample_update(context map[string]interface{}) string {
return Nprintf(`
resource "google_cloud_deploy_target" "pipeline" {
name = "tf-test-tf-test%{random_suffix}"
description = "Target Prod Cluster"
annotations = {
generated-by = "magic-modules"
another = "one"
}
labels = {
env = "prod"
}
gke {
cluster = "projects/%{project}/locations/us-central1/clusters/prod"
}
execution_configs {
usages = ["RENDER"]
service_account = data.google_compute_default_service_account.default.email
}

execution_configs {
usages = ["DEPLOY"]
service_account = "%{project}@appspot.gserviceaccount.com"
}

}

data "google_compute_default_service_account" "default" {
}
`, context)
}