> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Temporal Cloud Namespace

> Provision a Temporal Cloud namespace (regions, retention, client auth) via the Temporal Cloud Terraform provider

Qovery creates it in your account with a third-party provider, using credentials you enter in the form, as a [Blueprint](https://www.qovery.com/docs/configuration/blueprints.md) service in one of your environments.

| | |
| - | - |
| Catalog name | `temporal-cloud-namespace` |
| Category | Compute & Runtime |
| Provider | EXTERNAL |
| Engine | terraform |
| Major versions (latest release) | `default` (1.0.7) |
| Source | [EXTERNAL/temporal-cloud/default](https://github.com/Qovery/service-catalog/tree/EXTERNAL/temporal-cloud/default/1.0.7/EXTERNAL/temporal-cloud/default) |

> [!TIP]
>
> **New to this?** You don't need to know Terraform or Kubernetes. Qovery sets up Temporal Cloud Namespace in your account with the provider: you fill in a form, or paste the prompt below into your coding agent. The values it publishes, listed under Outputs, reach your other services as environment variables. Qovery tells you when a newer version of the Blueprint is available. Check the requirements in the Reference section before you start, and try it first in a development environment.

## Create it

> [tab] Console
>
> 1. Open the environment, then **New service** › **Blueprint**.
> 2. Find **Temporal Cloud Namespace** in the catalog and pick the major version.
> 3. Fill in the variables. Required ones are marked; the others use their defaults.
> 4. Create the service, and deploy it now or later.

> [tab] CLI and API
>
> List the catalog to get the latest tag, then create the service from it. `qovery api` signs the requests with your CLI session.
>
> ```bash theme={null}
> ORG_ID="REPLACE_WITH_ORGANIZATION_ID"
> ENV_ID="REPLACE_WITH_ENVIRONMENT_ID"
>
> qovery api "organization/$ORG_ID/blueprint/catalog" | jq '.. | objects | select(.name? == "temporal-cloud-namespace")'
>
> cat > blueprint.json <<'EOF'
> {
>   "name": "temporal-cloud-namespace",
>   "tag": "EXTERNAL/temporal-cloud/default/1.0.7",
>   "icon": "app://qovery-console/temporal",
>   "variables": [
>     {
>       "name": "temporal_cloud_api_key",
>       "value": "REPLACE_WITH_TEMPORAL_CLOUD_API_KEY",
>       "is_secret": true
>     },
>     {
>       "name": "namespace_name",
>       "value": "REPLACE_WITH_NAMESPACE_NAME"
>     }
>   ],
>   "spec_overrides": {
>     "engine_version": "1.9.7"
>   }
> }
> EOF
> BLUEPRINT_ID=$(qovery api "environment/$ENV_ID/blueprint" --method POST --input - < blueprint.json | jq -r .id)
> rm blueprint.json   # it can hold secret values
> qovery api "blueprint/$BLUEPRINT_ID/deploy" --method POST
> qovery api "blueprint/$BLUEPRINT_ID"   # status of the latest deployment
> ```
>
> Replace each `REPLACE_WITH_` value. Add optional variables to `variables` the same way.

> [tab] Coding agent
>
> Paste this into Claude Code, Cursor, Codex or another coding agent with the [Qovery agent skills](https://www.qovery.com/docs/getting-started/quickstart/agent-skills.md) installed (`curl -fsSL https://skill.qovery.com/install.sh | bash`).
>
> ```text Prompt wrap theme={null}
> Add the Qovery Blueprint Temporal Cloud Namespace (temporal-cloud-namespace) to one of my Qovery environments and deploy it. Ask me for temporal_cloud_api_key and namespace_name.
> Ask me before deploying to a production environment.
> Docs: https://www.qovery.com/docs/configuration/blueprints/temporal-cloud-namespace.md
> ```

You don't add any file to your repository. Qovery creates the Blueprint from the Console or the API.

## Variables and outputs

Generated from `qbm.yml` at `EXTERNAL/temporal-cloud/default/1.0.7`, the manifest the Console form is built from.

> [accordion] All 5 variables
>
> | Name | Type | Required | Default | Secret | Description |
> | - | - | - | - | - | - |
> | `temporal_cloud_api_key` | string | Yes | | Yes | Temporal Cloud API key (used by the provider to manage namespaces) |
> | `namespace_name` | string | Yes | | | 2–64 lowercase letters, digits, hyphens. Temporal appends the account suffix. |
> | `regions` | string | | `aws-us-east-1` | | Comma-separated Temporal Cloud regions (1-2), e.g. aws-us-east-1 or gcp-us-central1 |
> | `retention_days` | number | | `30` | | Days to keep workflow execution history (1–90) |
> | `accepted_client_ca` | string | | | | Base64-encoded PEM CA bundle to additionally enable mTLS client auth. Empty = API-key auth only. |

Outputs become environment variables that other services in the environment can use. By default Qovery also creates an alias for each output, prefixed with the Blueprint's name; see [Aliases Qovery creates for outputs](https://www.qovery.com/docs/configuration/environment-variables.md#aliases-qovery-creates-for-outputs) for the naming rules and the cases where no alias is created.

> [accordion] All 4 outputs
>
> | Name | Secret | Description |
> | - | - | - |
> | `namespace_id` | | Full Temporal Cloud namespace id (name.accountId) |
> | `namespace_name` | | Namespace name |
> | `grpc_endpoint` | | gRPC endpoint for API-key clients |
> | `mtls_grpc_endpoint` | | gRPC endpoint for mTLS clients |

> [!WARNING]
>
> Secret variables and outputs are encrypted and masked in Qovery, but Terraform can also keep their values, and values derived from them, in its state. With the Qovery-managed state backend (the default), Qovery stores the state. If you use your own backend, protect it and keep state files out of version control.

## Reference

From the Blueprint's [README](https://github.com/Qovery/service-catalog/blob/EXTERNAL/temporal-cloud/default/1.0.7/EXTERNAL/temporal-cloud/default/README.md).

Provisions a [Temporal Cloud](https://temporal.io/cloud) namespace (`temporalcloud_namespace`) via the official `temporalio/temporalcloud` provider (`~> 1.0`).

> **Temporal Cloud only.** There is no official Terraform provider for self-hosted Temporal — deploy that via Helm/containers. This blueprint manages the SaaS offering.

### Credentials

A **Temporal Cloud API key** supplied as the sensitive `temporal_cloud_api_key` variable (`credentials.default: env`). Generate it in the Temporal Cloud UI / `tcld` with permission to manage namespaces.

### Variables

#### Required

| Name | Type | Sensitive | Description |
| - | - | - | - |
| `temporal_cloud_api_key` | string | yes | Temporal Cloud API key |
| `namespace_name` | string | | Namespace name (2-64 chars: lowercase letters, digits, hyphens). Temporal appends the account suffix. |

#### Optional

| Name | Type | Default | Description |
| - | - | - | - |
| `regions` | string | `aws-us-east-1` | Comma-separated regions (1-2), e.g. `aws-us-east-1` |
| `retention_days` | number | `30` | Workflow execution retention (1-90 days) |
| `accepted_client_ca` | string | | Base64 PEM CA bundle to additionally enable mTLS. Unset = api-key only. |

API-key client auth is always enabled; supplying `accepted_client_ca` additionally enables mTLS.

### Outputs

| Name | Description |
| - | - |
| `namespace_id` | Full namespace id (`name.accountId`) |
| `namespace_name` | Namespace name |
| `grpc_endpoint` | gRPC endpoint for API-key clients |
| `mtls_grpc_endpoint` | gRPC endpoint for mTLS clients |

### Notes

* The namespace's full id is `namespace_name` + your Temporal Cloud account suffix (see `namespace_id`).
* Clients connect at `grpc_endpoint` (with an API key) or `mtls_grpc_endpoint` (with a client cert chained to `accepted_client_ca`).


## Related topics

- [Blueprints](https://www.qovery.com/docs/configuration/blueprints.md)
- [Scaleway Container Registry](https://www.qovery.com/docs/configuration/integrations/container-registries/scaleway-cr.md)
- [Connect to Your Cluster](https://www.qovery.com/docs/configuration/connect-to-cluster.md)
- [Bring Your Own Kubernetes (BYOK)](https://www.qovery.com/docs/configuration/integrations/kubernetes/byok.md)
- [Install Qovery on other Kubernetes clusters with the CLI](https://www.qovery.com/docs/configuration/integrations/kubernetes/byok-legacy.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.