-
Notifications
You must be signed in to change notification settings - Fork 323
Replace Latin abbreviations in hand-written docs #5100
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,7 @@ Strong identity management in Temporal Cloud is crucial for ensuring secure acce | |
|
|
||
| #### 1. Enable [SAML Single Sign-on](/cloud/manage-access/saml) (SSO) for User Access | ||
|
|
||
| Integrate Temporal Cloud with your organization's identity provider via SAML 2.0 for centralized authentication. SSO allows you to enforce your corporate login policies (MFA, password complexity, etc.). When you configure SAML with Temporal Cloud, you can disable social logins (i.e. Microsoft, Google) by opening a support ticket. | ||
| Integrate Temporal Cloud with your organization's identity provider via SAML 2.0 for centralized authentication. SSO allows you to enforce your corporate login policies (such as MFA and password complexity). When you configure SAML with Temporal Cloud, you can disable social logins (that is, Microsoft, Google) by opening a support ticket. | ||
|
|
||
| #### 2. Use Least-Privilege Roles for Temporal Cloud Users | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
@@ -49,7 +49,7 @@ When applicable, use [SCIM](/cloud/manage-access/scim) or the Temporal Cloud use | |
|
|
||
| #### Use Service Accounts for Automation | ||
|
|
||
| For non-human access (CI/CD pipelines, backend services), use [Temporal Cloud Service Accounts](/cloud/manage-access/service-accounts) instead of shared user logins. Service Accounts are machine identities that can be granted specific permissions without ties to an individual. Create separate Service Accounts with unique API keys for different applications or microservices, and apply least privilege to each (e.g. a service account that only has access to one Namespace). | ||
| For non-human access (CI/CD pipelines, backend services), use [Temporal Cloud Service Accounts](/cloud/manage-access/service-accounts) instead of shared user logins. Service Accounts are machine identities that can be granted specific permissions without ties to an individual. Create separate Service Accounts with unique API keys for different applications or microservices, and apply least privilege to each (for example, a service account that only has access to one Namespace). | ||
|
|
||
| ## Secure Application Authentication and API Access | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
@@ -67,7 +67,7 @@ We recommend you enable mTLS for strong identity assurance of clients; it ensure | |
|
|
||
| #### 2. Proactively manage and rotate certificates | ||
|
|
||
| Track the expiration dates of your client and [Certificate Authority certificates](/cloud/certificates). Temporal Cloud trusts the uploaded CA; if it expires, all client authorizations will fail. Establish and automate a certificate rotation schedule (e.g. rotate client certificates quarterly and CA certificates annually, well before expiry). Temporal supports uploading a new CA certificate alongside the old one to allow seamless rollover. Always test new certificates in a staging environment if possible. | ||
| Track the expiration dates of your client and [Certificate Authority certificates](/cloud/certificates). Temporal Cloud trusts the uploaded CA; if it expires, all client authorizations will fail. Establish and automate a certificate rotation schedule (for example, rotate client certificates quarterly and CA certificates annually, well before expiry). Temporal supports uploading a new CA certificate alongside the old one to allow seamless rollover. Always test new certificates in a staging environment if possible. | ||
|
|
||
| #### 3. If you’re using API Keys, handle them with strict care | ||
|
|
||
|
|
@@ -90,9 +90,9 @@ Temporal Cloud supports private connectivity options such as [AWS PrivateLink](/ | |
|
|
||
| #### 2. Separate environments by Namespace | ||
|
|
||
| Use [Temporal Namespaces](/best-practices/managing-namespace#naming-conventions) to isolate workflows for different environments or teams (e.g. development, staging, production). Each Namespace is logically segregated and cannot interact with others by default, providing a security boundary. | ||
| Use [Temporal Namespaces](/best-practices/managing-namespace#naming-conventions) to isolate workflows for different environments or teams (for example, development, staging, production). Each Namespace is logically segregated and cannot interact with others by default, providing a security boundary. | ||
|
|
||
| Ensure that your production Namespace uses stricter network controls (e.g. only accessible from the prod network) and that credentials for it are separate from non-prod Namespaces. This limits the impact of any compromise in a lower environment, and as workflow data is only visible to users with access to that Namespace, separating environments by Namespace also enforces data-visibility boundaries. | ||
| Ensure that your production Namespace uses stricter network controls (for example, only accessible from the prod network) and that credentials for it are separate from non-prod Namespaces. This limits the impact of any compromise in a lower environment, and as workflow data is only visible to users with access to that Namespace, separating environments by Namespace also enforces data-visibility boundaries. | ||
|
|
||
| ## Data Protection and Encryption | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
@@ -125,7 +125,7 @@ Temporal Cloud’s platform is engineered for fault-tolerance out of the box, bu | |
| | **Single-Region** | **If your application is built for one region and does not have stringent high-availability or disaster recovery requirements.** | 99.9% | ≤ 8 hours | ≤ 8 hours | | ||
| | **Same-Region Replication** | **If you want higher availability but your application is designed for a single region or if cross region latency doesn’t meet SLAs for application** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
| | **Multi-Region Replication** | **If a disruption of your workflow will cause loss of revenue, poor end-user experience, or issues with regulatory compliance.** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
| | **Multi-Cloud Replication** | **If you need the highest level of disaster tolerance, protecting against outages of an entire cloud provider (e.g., AWS or GCP)** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
| | **Multi-Cloud Replication** | **If you need the highest level of disaster tolerance, protecting against outages of an entire cloud provider (for example, AWS or GCP)** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
|
|
||
| ### Best Practices: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -94,8 +94,8 @@ The next step is to [configure private DNS](#configuring-private-dns-for-aws-pri | |
|
|
||
| When you connect to Temporal Cloud through AWS PrivateLink you normally must: | ||
|
|
||
| 1. **Point your SDKs/Workers at the PrivateLink DNS name** for the VPC Endpoint (e.g., `vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com`), **and** | ||
| 2. **Override the Server Name Indicator (SNI)** so that the TLS handshake still presents the public Temporal Cloud hostname (e.g., `my-namespace.my-account.tmprl.cloud`). | ||
| 1. **Point your SDKs/Workers at the PrivateLink DNS name** for the VPC Endpoint (for example, `vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com`), **and** | ||
| 2. **Override the Server Name Indicator (SNI)** so that the TLS handshake still presents the public Temporal Cloud hostname (for example, `my-namespace.my-account.tmprl.cloud`). | ||
|
|
||
| By creating a Route 53 **private hosted zone (PHZ)** that maps the public Temporal Cloud hostname (or region hostname) to your VPC Endpoint, you can: | ||
|
|
||
|
|
@@ -154,7 +154,7 @@ Save the **`vpce-*.amazonaws.com`** value — you will target it in the CNAME re | |
| #### 2. Create a Route 53 Private Hosted Zone (do not yet attach Worker VPCs) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| a. Open _Route 53 → Hosted zones → Create hosted zone_. | ||
| b. Enter the domain chosen from the table above, e.g., `payments.abcde.tmprl.cloud`. | ||
| b. Enter the domain chosen from the table above, for example, `payments.abcde.tmprl.cloud`. | ||
| c. Type: _Private hosted zone for Temporal Cloud_. | ||
| d. Leave VPC associations empty for now (you'll add them in step 4). | ||
| e. Create the hosted zone. | ||
|
|
@@ -165,7 +165,7 @@ Inside the new PHZ: | |
|
|
||
| | Field | Value | | ||
| | --------------- | ------------------------------------------------------------------------------------- | | ||
| | **Record name** | the Namespace Endpoint (e.g., `payments.abcde.tmprl.cloud`). | | ||
| | **Record name** | the Namespace Endpoint (for example, `payments.abcde.tmprl.cloud`). | | ||
| | **Record type** | `CNAME` | | ||
| | **Value** | Your VPC Endpoint DNS name (`vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com`) | | ||
| | **TTL** | 60s is typical; 15s for Namespaces with High Availability (to minimize recovery time after failover). | | ||
|
|
@@ -214,8 +214,8 @@ You can avoid creating DNS records for each Namespace by pointing Workers direct | |
|
|
||
| 1. Create the PrivateLink VPC Endpoint (one per region — all Namespaces in that region share it). | ||
| 2. Configure each Worker with: | ||
| - **Endpoint**: the DNS name of the VPC Endpoint in the region where the Worker runs (e.g., `vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com:7233`) | ||
| - **Server name** (SNI override): the Namespace Endpoint value (e.g., `my-namespace.my-account.tmprl.cloud`) | ||
| - **Endpoint**: the DNS name of the VPC Endpoint in the region where the Worker runs (for example, `vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com:7233`) | ||
| - **Server name** (SNI override): the Namespace Endpoint value (for example, `my-namespace.my-account.tmprl.cloud`) | ||
|
|
||
| With this approach, new Namespaces do not require new DNS records. Workers set their **Endpoint** to the VPC Endpoint DNS name and their **Server name** to the Namespace Endpoint, so the client SDK accepts the TLS handshake from Temporal Cloud. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -424,7 +424,7 @@ track, and manage namespaces more easily. | |
| ### Tag Structure and Limits | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| - Each namespace can have a maximum of 10 tags | ||
| - Each key must be unique for a given namespace (e.g., a namespace cannot have both `team:foo` and `team:bar` tags) | ||
| - Each key must be unique for a given namespace (for example, a namespace cannot have both `team:foo` and `team:bar` tags) | ||
| - Keys and values must be 1-63 characters in length | ||
| - Allowed characters: lowercase letters (`a-z`), numbers (`0-9`), periods (`.`), underscores (`_`), hyphens (`-`), and | ||
| at signs (`@`) | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Organizational Patterns' should use sentence-style capitalization.