Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add support for custom tags and GOBLET_ARTIFACT_TAG env var #443

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

Merged
anovis merged 5 commits into from
Oct 12, 2023
Merged

Add support for custom tags and GOBLET_ARTIFACT_TAG env var #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eb85d45
Add support for custom tags and GOBLET_ARTIFACT_TAG environment varia…
Oct 10, 2023
254c5c9
Lint
Oct 10, 2023
69b0a74
Fix KeyErrors when retrieving artifact tag from environment
Oct 11, 2023
fffe21a
Adding test cases
Oct 11, 2023
f16b4cc
Lint
Oct 11, 2023
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
11 changes: 10 additions & 1 deletion docs/source/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,22 @@ This can be done by running:

Here the service account from `project_b` is granted permissions to read from artifact registry en `project_a`

For adding custom tags to be created in cloud build and pushed to artifact registry, use the `GOBLET_BUILD_TAGS` environment variable with a comma-sepparated list of tags to be created:
.. code:: bash

To use a previously built artifact, use the `artifact_tag` configuration in the `deploy` configuration key. When using `artifact_tag`, source code will not be uploaded and cloudbuild will not be called. `artifact_tag` can be any existing tag or digest in the default registry or the configured `artifact_registry`.
GOBLET_BUILD_TAGS=tag1,tag2,tag3

To use a previously built artifact, use the `artifact_tag` configuration in the `deploy` configuration key or use the `GOBLET_ARTIFACT_TAG` environment variable. When using `artifact_tag`, source code will not be uploaded and cloudbuild will not be called. `artifact_tag` can be any existing tag or digest in the default registry or the configured `artifact_registry`.
.. code:: json

{
"deploy":{
"artifact_tag": "latest",
}
}

.. code:: bash

GOBLET_ARTIFACT_TAG=tag1
# or
GOBLET_ARTIFACT_TAG=sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
19 changes: 13 additions & 6 deletions goblet/backends/cloudrun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ def deploy(self, force=False):
write_dockerfile()

try:
artifact_tag = self.config.deploy.get("artifact_tag")
except AttributeError:
artifact_tag = None
artifact_tag = os.environ["GOBLET_ARTIFACT_TAG"]
except KeyError:
artifact_tag = self.config.deploy.get("artifact_tag", None)

if artifact_tag:
source, changes = None, False
Expand Down Expand Up @@ -174,6 +174,12 @@ def create_build(self, client, source=None, name="goblet"):
"service account given but no logging bucket so defaulting to cloud logging only"
)

images = [f"{registry}:latest"]
# Add environment variable tags
build_tags = os.environ.get("GOBLET_BUILD_TAGS", None)
if build_tags:
images += list(map(lambda tag: f"{registry}:{tag}", build_tags.split(",")))

req_body = {
"source": {"storageSource": source["storageSource"]},
"steps": [
Expand All @@ -182,15 +188,16 @@ def create_build(self, client, source=None, name="goblet"):
"args": [
"build",
"--network=cloudbuild",
"-t",
registry,
]
+ list(map(lambda image: ["-t", image], images))
+ [
"--cache-from",
registry,
".",
],
}
],
"images": [registry],
"images": images,
**build_configs,
}

Expand Down
7 changes: 4 additions & 3 deletions goblet/revision.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,11 @@ def deployRevision(self):
region = get_default_location()
project = get_default_project_number()

# Get artifact tag from env variable or config
try:
artifact_tag = self.config.deploy.get("artifact_tag")
except AttributeError:
artifact_tag = None
artifact_tag = os.environ["GOBLET_ARTIFACT_TAG"]
except KeyError:
artifact_tag = self.config.deploy.get("artifact_tag", None)

if artifact_tag:
artifact_registry = self.config.deploy.get(
Expand Down
287 changes: 287 additions & 0 deletions ...gs/get-v1-operations-build-goblet-OTRjYzMxYzEtYTkyNC00ZWIxLWI5OWUtOTg3MjMxNWQyOTFj_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
{
"headers": {},
"body": {
"name": "operations/build/goblet/OTRjYzMxYzEtYTkyNC00ZWIxLWI5OWUtOTg3MjMxNWQyOTFj",
"metadata": {
"@type": "type.googleapis.com/google.devtools.cloudbuild.v1.BuildOperationMetadata",
"build": {
"id": "94cc31c1-a924-4eb1-b99e-9872315d291c",
"status": "SUCCESS",
"source": {
"storageSource": {
"bucket": "gcf-v2-uploads-98058317567-us-central1",
"object": "9381e8ca-ee19-4613-beb2-83105d34a50d.zip"
}
},
"createTime": "2023-10-11T21:28:24.479596087Z",
"startTime": "2023-10-11T21:28:25.131273379Z",
"finishTime": "2023-10-11T21:29:17.623497Z",
"results": {
"images": [
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
}
],
"buildStepImages": [
"sha256:041c465bfac9004d829722456bee1af1eba3df67d661b1c38ca8256c9dbb512b"
],
"buildStepOutputs": [
""
]
},
"steps": [
{
"name": "gcr.io/cloud-builders/docker",
"args": [
"build",
"--network=cloudbuild",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev",
"--cache-from",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet",
"."
],
"timing": {
"startTime": "2023-10-11T21:28:36.036182341Z",
"endTime": "2023-10-11T21:29:03.530999003Z"
},
"status": "SUCCESS",
"pullTiming": {
"startTime": "2023-10-11T21:28:36.036182341Z",
"endTime": "2023-10-11T21:28:36.040186826Z"
}
}
],
"timeout": "3600s",
"images": [
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev"
],
"projectId": "goblet",
"logsBucket": "gs://98058317567.cloudbuild-logs.googleusercontent.com",
"sourceProvenance": {
"resolvedStorageSource": {
"bucket": "gcf-v2-uploads-98058317567-us-central1",
"object": "9381e8ca-ee19-4613-beb2-83105d34a50d.zip",
"generation": "1697059697191745"
},
"fileHashes": {
"gs://gcf-v2-uploads-98058317567-us-central1/9381e8ca-ee19-4613-beb2-83105d34a50d.zip#1697059697191745": {
"fileHash": [
{
"type": "MD5",
"value": "q6+6+jX03ippcigUuBc/Kw=="
}
]
}
}
},
"options": {
"logging": "LEGACY",
"pool": {}
},
"logUrl": "https://console.cloud.google.com/cloud-build/builds/94cc31c1-a924-4eb1-b99e-9872315d291c?project=98058317567",
"tags": [
"goblet-build-goblet"
],
"timing": {
"FETCHSOURCE": {
"startTime": "2023-10-11T21:28:25.664952808Z",
"endTime": "2023-10-11T21:28:34.704216954Z"
},
"BUILD": {
"startTime": "2023-10-11T21:28:34.704443807Z",
"endTime": "2023-10-11T21:29:03.640418434Z"
},
"PUSH": {
"startTime": "2023-10-11T21:29:03.640739381Z",
"endTime": "2023-10-11T21:29:16.885520005Z"
}
},
"artifacts": {
"images": [
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev"
]
},
"queueTtl": "3600s",
"name": "projects/goblet/locations/global/builds/94cc31c1-a924-4eb1-b99e-9872315d291c"
}
},
"done": true,
"response": {
"@type": "type.googleapis.com/google.devtools.cloudbuild.v1.Build",
"id": "94cc31c1-a924-4eb1-b99e-9872315d291c",
"status": "SUCCESS",
"source": {
"storageSource": {
"bucket": "gcf-v2-uploads-98058317567-us-central1",
"object": "9381e8ca-ee19-4613-beb2-83105d34a50d.zip"
}
},
"createTime": "2023-10-11T21:28:24.479596087Z",
"startTime": "2023-10-11T21:28:25.131273379Z",
"finishTime": "2023-10-11T21:29:17.623497Z",
"results": {
"images": [
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
},
{
"name": "us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev",
"digest": "sha256:7f234bbe8e4ed430d6dcb345361dbadf408edb2d82a24a416fea6fcd0f876efa",
"pushTiming": {
"startTime": "2023-10-11T21:29:03.640740551Z",
"endTime": "2023-10-11T21:29:13.323032568Z"
}
}
],
"buildStepImages": [
"sha256:041c465bfac9004d829722456bee1af1eba3df67d661b1c38ca8256c9dbb512b"
],
"buildStepOutputs": [
""
]
},
"steps": [
{
"name": "gcr.io/cloud-builders/docker",
"args": [
"build",
"--network=cloudbuild",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"-t",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev",
"--cache-from",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet",
"."
],
"timing": {
"startTime": "2023-10-11T21:28:36.036182341Z",
"endTime": "2023-10-11T21:29:03.530999003Z"
},
"status": "SUCCESS",
"pullTiming": {
"startTime": "2023-10-11T21:28:36.036182341Z",
"endTime": "2023-10-11T21:28:36.040186826Z"
}
}
],
"timeout": "3600s",
"images": [
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev"
],
"projectId": "goblet",
"logsBucket": "gs://98058317567.cloudbuild-logs.googleusercontent.com",
"sourceProvenance": {
"resolvedStorageSource": {
"bucket": "gcf-v2-uploads-98058317567-us-central1",
"object": "9381e8ca-ee19-4613-beb2-83105d34a50d.zip",
"generation": "1697059697191745"
},
"fileHashes": {
"gs://gcf-v2-uploads-98058317567-us-central1/9381e8ca-ee19-4613-beb2-83105d34a50d.zip#1697059697191745": {
"fileHash": [
{
"type": "MD5",
"value": "q6+6+jX03ippcigUuBc/Kw=="
}
]
}
}
},
"options": {
"logging": "LEGACY",
"pool": {}
},
"logUrl": "https://console.cloud.google.com/cloud-build/builds/94cc31c1-a924-4eb1-b99e-9872315d291c?project=98058317567",
"tags": [
"goblet-build-goblet"
],
"timing": {
"FETCHSOURCE": {
"startTime": "2023-10-11T21:28:25.664952808Z",
"endTime": "2023-10-11T21:28:34.704216954Z"
},
"BUILD": {
"startTime": "2023-10-11T21:28:34.704443807Z",
"endTime": "2023-10-11T21:29:03.640418434Z"
},
"PUSH": {
"startTime": "2023-10-11T21:29:03.640739381Z",
"endTime": "2023-10-11T21:29:16.885520005Z"
}
},
"artifacts": {
"images": [
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:latest",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:test",
"us-central1-docker.pkg.dev/goblet/cloud-run-source-deploy/goblet:dev"
]
},
"queueTtl": "3600s",
"name": "projects/goblet/locations/global/builds/94cc31c1-a924-4eb1-b99e-9872315d291c"
}
}
}
Loading