docs(temporal-proxy): add Temporal Proxy configuration page#4954
docs(temporal-proxy): add Temporal Proxy configuration page#4954pseudomuto wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| Credentials require TLS to the upstream. If you set `credentials` without a `tls` block, the configuration fails to | ||
| load. | ||
|
|
||
| ### Configure TLS |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Configure TLS' should use sentence-style capitalization.
There was a problem hiding this comment.
I don't think this applies here since TLS is an acronym
📖 Docs PR preview links
|
eec71b6 to
02a7493
Compare
|
@flippedcoder should we remove that slug, following our new guidance? And should this use the release note header to communicate the pre-release status? |
Add a deploy to production page for the Temporal Proxy, the gRPC proxy that routes SDK Client and Worker traffic to one or more upstream Temporal Services (local, self-hosted, or Temporal Cloud) while handling Namespace translation, TLS, and credentials. The proxy is pre-release, so the page leads with that caveat and links to the repository, the Cloud example, and the Helm chart for the definitive, still-evolving schema. Lives under production-deployment as a directory (index.mdx) to leave room for future pages; the slug is pinned so the URL is stable regardless of file location.
89f1a69 to
64878a2
Compare
| host. Grant that identity only the permission to encrypt and decrypt with the specific key, as shown for each provider | ||
| below. | ||
|
|
||
| #### AWS KMS |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'AWS KMS' should use sentence-style capitalization.
There was a problem hiding this comment.
KMS is an acronym, and how AWS refers to the product
| renewBefore: 15m | ||
| ``` | ||
|
|
||
| #### Azure Key Vault |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Azure Key Vault' should use sentence-style capitalization.
There was a problem hiding this comment.
maybe 😄 Azure docs also use sentence-style titles, but refer to Key Vault (likely because it's a product). ref
| renewBefore: 15m | ||
| ``` | ||
|
|
||
| #### Google Cloud KMS |
| ServiceAccount by name, so set `serviceAccount.name` in your values to keep it stable and matching what you bind on the | ||
| cloud side. | ||
|
|
||
| ### AWS IRSA and Pod Identity |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'AWS IRSA and Pod Identity' should use sentence-style capitalization.
There was a problem hiding this comment.
Same comment as Azure Key Vault. IRSA is an acronym, and Pod Identity is a product/feature name ref
| an association between the role and the ServiceAccount with `aws eks create-pod-identity-association`, and no annotation | ||
| is required. | ||
|
|
||
| ### Azure Workload Identity |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Azure Workload Identity' should use sentence-style capitalization.
| azure.workload.identity/use: 'true' | ||
| ``` | ||
|
|
||
| ### GCP Workload Identity |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'GCP Workload Identity' should use sentence-style capitalization.
2 participants
Add a deploy-to-production page for the Temporal Proxy, the gRPC proxy that routes SDK Client and Worker traffic to one or more upstream Temporal Services (local, self-hosted, or Temporal Cloud) while handling Namespace translation, TLS, and credentials.
The proxy is pre-release, so the page leads with that caveat and links to the repository, the Cloud example, and the Helm chart for the definitive, still-evolving schema. Lives under production-deployment as a directory (index.mdx) to leave room for future pages; the slug is pinned so the URL is stable regardless of file location.
┆Attachments: EDU-6796 docs(temporal-proxy): add Temporal Proxy configuration page