> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# duksis/gcp-gke

Google Kubernetes Engine (GKE) Orb

## Commands

### install

Install `gcloud` and `kubectl` if not already installed.

### init

Initialize the `gcloud` CLI.

### rollout-image

Update a deployment's Docker image.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `cluster` | string |  | The Kubernetes cluster name. |
| `deployment` | string |  | The Kubernetes deployment name. |
| `container` | string |  | The Kubernetes container name. |
| `image` | string |  | A name for your docker image |
| `namespace` | string | default | The Kubernetes namespace name. |

### notify-datadog

Send a deploy event to DataDog

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | env_var_name | DATADOG_API_KEY | Datadog API Key |
| `image` | string |  | Deployed image |

### notify-sentry

Send a deploy event to Sentry

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | env_var_name | SENTRY_API_KEY | Sentry API Key |
| `version` | string |  | Release version |
| `organization` | string | titelmedia-gmbh | Sentry organization slug |

### notify-slack

Send a deploy event to Slack

| Parameter | Type | Default | Description |
|---|---|---|---|
| `web_hook` | env_var_name | SLACK_WEBHOOK_URL | Slack Webhook URL |
| `text` | string | Oh boy! | Message to post to slack |
| `channel` | string | #deployments | Slack channel to post message |
| `username` | string | webhookbot | Slack username to send message as |

## Jobs

### publish-and-rollout-image

Update cluster with new Docker image.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `cluster` | string |  | The Kubernetes cluster name. |
| `deployment` | string |  | The Kubernetes deployment name. |
| `namespace` | string | default | The Kubernetes namespace name. |
| `container` | string |  | The Kubernetes container name. |
| `gcloud-service-key` | env_var_name | GCLOUD_SERVICE_KEY | The gcloud service key |
| `google-project-id` | env_var_name | GOOGLE_PROJECT_ID | The Google project ID to connect with via the gcloud CLI |
| `google-compute-zone` | env_var_name | GOOGLE_COMPUTE_ZONE | The Google compute zone to connect with via the gcloud CLI |
| `registry-url` | string | gcr.io | The GCR registry URL from ['', us, eu, asia].gcr.io |
| `image` | string |  | A name for your docker image |
| `tag` | string | latest | A docker image tag |
| `path-to-dockerfile` | string | . | The relative path to the Dockerfile to use when building image |