Skip to content

Document gke-deploy timeout overrides #1109

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

Open
Haihan-Jiang wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document gke-deploy timeout overrides #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions gke-deploy/doc/app/cloudbuild-no-configs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ steps:
- '--namespace=$_K8S_NAMESPACE'
- '--cluster=$_GKE_CLUSTER'
- '--location=$_GKE_LOCATION'
- '--timeout=$_GKE_DEPLOY_TIMEOUT'
images:
- '$_IMAGE_NAME:$_IMAGE_VERSION'
substitutions:
Expand All @@ -35,6 +36,7 @@ substitutions:
_K8S_APP_NAME:
_K8S_NAMESPACE:
_OUTPUT_PATH:
_GKE_DEPLOY_TIMEOUT: 5m0s
options:
substitution_option: 'ALLOW_LOOSE'
tags: ['$_K8S_APP_NAME']
2 changes: 2 additions & 0 deletions gke-deploy/doc/app/cloudbuild-with-configs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ steps:
- '--namespace=$_K8S_NAMESPACE'
- '--cluster=$_GKE_CLUSTER'
- '--location=$_GKE_LOCATION'
- '--timeout=$_GKE_DEPLOY_TIMEOUT'
images:
- '$_IMAGE_NAME:$_IMAGE_VERSION'
substitutions:
Expand All @@ -36,6 +37,7 @@ substitutions:
_K8S_APP_NAME:
_K8S_NAMESPACE:
_OUTPUT_BUCKET_PATH:
_GKE_DEPLOY_TIMEOUT: 5m0s
options:
substitution_option: 'ALLOW_LOOSE'
tags: [$_K8S_APP_NAME]
25 changes: 24 additions & 1 deletion gke-deploy/doc/deploying-with-cloud-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,35 @@ sed -i "s#@IMAGE_NAME@#$IMAGE_NAME#g" config/deployment.yaml
sed -i "s#@NAMESPACE@#$NAMESPACE#g" config/namespace.yaml

# Run build, replacing substitution variables accordingly.
gcloud builds submit . --project=$PROJECT --config cloudbuild-with-configs.yaml --substitutions=_IMAGE_NAME=gcr.io/$PROJECT/$APP,_IMAGE_VERSION=$VERSION,_GKE_CLUSTER=$CLUSTER,_GKE_LOCATION=$LOCATION,_K8S_YAML_PATH=config,_K8S_APP_NAME=$APP,_K8S_NAMESPACE=$NAMESPACE,_OUTPUT_PATH=$BUCKET_PATH
gcloud builds submit . --project=$PROJECT --config cloudbuild-with-configs.yaml --substitutions=_IMAGE_NAME=gcr.io/$PROJECT/$APP,_IMAGE_VERSION=$VERSION,_GKE_CLUSTER=$CLUSTER,_GKE_LOCATION=$LOCATION,_K8S_YAML_PATH=config,_K8S_APP_NAME=$APP,_K8S_NAMESPACE=$NAMESPACE,_OUTPUT_BUCKET_PATH=$BUCKET_PATH
```

You can replace the GCS url with a UNIX file path if you do not
want to store configs to a bucket.

### Increase the deploy wait timeout

`gke-deploy apply` waits up to five minutes for applied Kubernetes objects to
be ready. If your rollout needs more time, pass a larger `--timeout` value to
the `gke-deploy` step:

```yaml
- name: 'gcr.io/cloud-builders/gke-deploy'
id: 'Apply deploy'
args:
- 'apply'
- '--filename=$_K8S_YAML_PATH'
- '--cluster=$_GKE_CLUSTER'
- '--location=$_GKE_LOCATION'
- '--timeout=20m0s'
timeout: 1260s
```

The `--timeout` flag controls how long `gke-deploy` waits for Kubernetes
objects to become ready. The Cloud Build step `timeout` controls how long Cloud
Build lets the entire build step run, so it should be slightly longer than the
`gke-deploy` timeout.

Builds can use `$SHORT_SHA` instead of an explicit `$_IMAGE_VERSION` for the
image and app versions if executed via a trigger. Follow [these
instructions](automated-deployments.md) to set up a trigger.