Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Whether you’re using core components or experimenting with new ones, this guid
- [Using Components in MDX Source Files](#using-components-in-mdx-source-files)
- [Using CaptionedImage](#using-captionedimage)
- [Using DiscoverableDisclosure](#using-discoverabledisclosure)
- [Using ReleaseStage](#using-releasestage)
- [Using DocsTable](#using-docstable)
- [Using PhotoCarousel](#using-photocarousel)
- [Using RelatedRead](#using-relatedread)
Expand Down Expand Up @@ -170,6 +171,59 @@ Usage:
An additional `prompt` prop enables you to specify the leading text.
Normally it defaults to `prompt = "Dive deeper — "`.

## Using ReleaseStage

Role: Standardized callout for features in Pre-release or Public Preview.

General Availability features do not need a callout - GA is the default/assumed state.

Usage:

```
<ReleaseStage stage="public-preview" feature="Provisioned Capacity" />
```

This renders a `:::tip Support, stability, and dependency info` callout with the text:
"Provisioned Capacity is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview)."

### Props

- **`stage`** (optional): `"pre-release"` | `"public-preview"`. Determines the release stage link and label.
- **`feature`** (optional): The feature name. Used to generate the callout text (e.g. "Feature X is in Public Preview.").
- **`verb`** (optional): Defaults to `"is"`. Set to `"are"` for plural feature names.
- **`children`** (optional): Additional content shown below the auto-generated text, or the entire callout body for custom callouts.

If you use the auto-generated text, pass a `feature`. There is no generic no-feature mode.

### With additional context

```
<ReleaseStage stage="pre-release" feature="Temporal .NET SDK support for Nexus">
All APIs are experimental and may be subject to backwards-incompatible changes.
</ReleaseStage>
```

### Plural feature names

```
<ReleaseStage
stage="public-preview"
feature="Connectivity rules"
verb="are"
/>
```

### Children-only mode

For complex cases where the auto-generated text doesn't fit:

```
<ReleaseStage>
Same-region Replication and Multi-cloud Replication are in
[Public Preview](/evaluate/development-production-features/release-stages#public-preview).
</ReleaseStage>
```

## Using DocsTable

In certain rare instances, standard Markdown tables won't work for our needs.
Expand Down
11 changes: 3 additions & 8 deletions docs/cloud/capacity-modes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ tags:
- TRUs
---

import { ReleaseStage } from '@site/src/components';

Each Namespace in Temporal has a rate limit, which is measured in [Actions](/cloud/pricing#action) per second.
Temporal offers two different modes for adjusting capacity: On-Demand Capacity or Provisioned Capacity.
With On-Demand Capacity, Namespace capacity is increased automatically along with usage.
Expand Down Expand Up @@ -101,12 +103,10 @@ Actions that are external to the core Temporal service do not contribute to your

Using On-Demand Capacity, your rate limit grows automatically along with your usage.


| | Actions Per Second | Requests Per Second | Operations Per Second|
|---------------|--------------------|---------------------|----------------------|
| Default Limit | 500 | 2000 | 4000 |


Scaling automatically adjusts based on the lesser of 4 * APS Average or 2 * APS P90 over the past 7 days.

If you experience usage spikes, you may hit a throughput limit.
Expand All @@ -133,11 +133,7 @@ This means that your default limit would be 800 APS.

## Provisioned Capacity {#provisioned-capacity}

:::tip Support, stability, and dependency info

Provisioned Capacity is currently in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Provisioned Capacity" />

Provisioned Capacity provides an alternative to On-Demand Capacity by allowing you to control the limits on your Namespace based on your specific need.

Expand Down Expand Up @@ -166,7 +162,6 @@ The amount of capacity available within a region may vary.
Temporal will check available capacity at the time of your request and aims to provision requested capacity within two minutes.
If you need capacity beyond what is self-serviceable or available in a region, please [file a support ticket](https://docs.temporal.io/cloud/support#ticketing) indicating the limit, region, and timeframe that the capacity is needed.


### When should I use Provisioned Capacity?

Provisioned Capacity works well when you’re aware of specific increases in load on your Namespace. For example:
Expand Down
9 changes: 2 additions & 7 deletions docs/cloud/connectivity/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:
- term
---

import { ToolTipTerm, DiscoverableDisclosure, CaptionedImage, SdkTabs } from '@site/src/components';
import { CaptionedImage, DiscoverableDisclosure, ReleaseStage, SdkTabs, ToolTipTerm } from '@site/src/components';
import { LANGUAGE_TAB_GROUP, getLanguageLabel } from '@site/src/constants/languageTabs';

## Private network connectivity for namespaces
Expand Down Expand Up @@ -57,11 +57,7 @@ For step 3, keep reading for details on [connectivity rules](/cloud/connectivity

## Connectivity rules

:::tip Support, stability, and dependency info

Connectivity rules are currently in [public preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Connectivity rules" verb="are" />

:::info Web UI Connectivity

Expand Down Expand Up @@ -177,7 +173,6 @@ tcld namespace set-connectivity-rules --namespace "my-namespace.abc123" --remove

[Example in the Terraform repo](https://github.com/temporalio/terraform-provider-temporalcloud/tree/main/examples/resources/temporalcloud_namespace/resource.tf#L113-L128)


## View the connectivity rules for a namespace

You have two ways to view the connectivity rules attached to a particular namespace.
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/high-availability/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:
- temporal-cloud
---

import { ToolTipTerm, DiscoverableDisclosure, CaptionedImage } from '@site/src/components';
import { CaptionedImage, DiscoverableDisclosure, ToolTipTerm } from '@site/src/components';

Temporal Cloud's High Availability features use asynchronous <ToolTipTerm term="replication"/> across multiple <ToolTipTerm term="isolation domains" /> to provide enhanced resilience and a 99.99% [SLA](/cloud/sla).
When you enable High Availability features, Temporal deploys your primary and its <ToolTipTerm term="replica"/> in separate isolation domains, giving you control over the location of both. This redundancy, combined with <ToolTipTerm term="failover"/> capability, enhances availability during outages.
Expand Down
2 changes: 0 additions & 2 deletions docs/cloud/metrics/openmetrics/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import { CaptionedImage } from '@site/src/components';

The Temporal Cloud OpenMetrics API provides actionable operational metrics about your Temporal Cloud deployment. This is a scrapable HTTP API that returns metrics in OpenMetrics format, suitable for ingestion by Prometheus-compatible monitoring systems.


## Available Metrics Reference

Metrics descriptions are also available programmatically via the `/v1/descriptors` endpoint. You can see the Metrics Reference for a list of available metrics.
Expand Down Expand Up @@ -309,7 +308,6 @@ scrape_configs:

:::


### Label Management

#### Prometheus
Expand Down
1 change: 0 additions & 1 deletion docs/cloud/metrics/openmetrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ tags:
- Temporal Cloud
---


:::tip PRICING

Future pricing may apply to high-volume usage that exceeds standard [limits](/cloud/metrics/openmetrics/api-reference#api-limits).
Expand Down
1 change: 0 additions & 1 deletion docs/cloud/metrics/openmetrics/metrics-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Metrics can be exported from Temporal Cloud using the OpenMetrics endpoint. This
This document is for basic configuration only. For advanced concepts such as label management and high cardinality scenarios see the
[general API reference](/cloud/metrics/openmetrics/api-reference).


## Integrations

### Datadog
Expand Down
1 change: 0 additions & 1 deletion docs/cloud/metrics/openmetrics/metrics-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ tags:

This document describes all metrics available from the Temporal Cloud OpenMetrics endpoint.


## Metric Conventions

### Metric Types
Expand Down
3 changes: 1 addition & 2 deletions docs/cloud/metrics/openmetrics/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ tags:
- Temporal Cloud
---

import { RelatedReadContainer, RelatedReadItem } from '@site/src/components';
import { CaptionedImage } from '@site/src/components';
import { CaptionedImage, RelatedReadContainer, RelatedReadItem, ReleaseStage } from '@site/src/components';

Temporal Cloud is transitioning from our Prometheus query endpoint to an industry-standard OpenMetrics
(Prometheus-compatible) endpoint for metrics collection. This migration represents a significant improvement in how you
Expand Down
7 changes: 2 additions & 5 deletions docs/cloud/migrate/automated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ tags:
- Production
---

:::tip Support, stability, and dependency info
import { ReleaseStage } from '@site/src/components';

Automated migration is currently in [Pre-release](/evaluate/development-production-features/release-stages#pre-release).
Please contact your Temporal account executive prior to planning your migration project.

:::
<ReleaseStage stage="pre-release" feature="Please contact your Temporal account executive prior to planning your migration project. Automated migration" />

## Process Overview

Expand Down
7 changes: 0 additions & 7 deletions docs/cloud/nexus/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ tags:

import { CaptionedImage } from '@site/src/components';

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).
Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Temporal Cloud builds on the [core Nexus experience](/nexus) with:

- **Global [Nexus Registry](/nexus/registry)** - Scoped to your entire Account across all Namespaces. Workers in any Namespace can host Nexus Services for others to use.
Expand Down
7 changes: 0 additions & 7 deletions docs/cloud/nexus/latency-availability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,6 @@ keywords:
- service level agreement
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).
Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Nexus latency and availability in Temporal Cloud:

- **SLOs and SLAs** - Nexus operations (for example, `RespondWorkflowTaskCompleted`, `PollNexusTaskQueue`, `RespondNexusTaskCompleted`, and `RespondNexusTaskFailed`) have the same [latency SLOs](/cloud/service-availability#latency) and [availability SLAs](/cloud/sla) as other Worker requests in both caller and handler Namespaces.
Expand Down
7 changes: 0 additions & 7 deletions docs/cloud/nexus/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ keywords:
- max operation duration
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).
Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Nexus limits are documented in [Temporal Cloud limits](/cloud/limits):

- [Nexus rate limits](/cloud/limits#nexus-rate-limits) - Nexus requests count toward the Namespace RPS limit.
Expand Down
8 changes: 0 additions & 8 deletions docs/cloud/nexus/observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,6 @@ keywords:
- audit log streaming
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now
[Generally Available](/evaluate/development-production-features/release-stages#general-availability). Learn why you
should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Nexus observability in Temporal Cloud:

- **[Nexus metrics](/nexus/metrics)** - [SDK metrics](/nexus/metrics#sdk-metrics) emitted by Workers and [Cloud metrics](/nexus/metrics#cloud-metrics) emitted by Temporal Cloud.
Expand Down
7 changes: 0 additions & 7 deletions docs/cloud/nexus/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@ keywords:
- Temporal Cloud pricing
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).
Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Nexus pricing:

- **One Action to start or cancel a Nexus Operation** in the caller Namespace.
Expand Down
7 changes: 0 additions & 7 deletions docs/cloud/nexus/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ keywords:
- access control
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).
Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus).

:::

Nexus security in Temporal Cloud:

- **[Runtime access controls](/nexus/security#runtime-access-controls)** - Endpoint allowlists restrict which caller Namespaces can use an Endpoint. See [configuring access controls](/nexus/registry#configure-runtime-access-controls).
Expand Down
6 changes: 2 additions & 4 deletions docs/cloud/operation-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@ tags:
- Temporal Cloud
---

:::tip Support, stability, and dependency info
import { ReleaseStage } from '@site/src/components';

The Temporal Cloud Operations API is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="The Temporal Cloud Operations API" />

The Temporal Cloud Operations API, or the Cloud Ops API, is an open source, public [HTTP API](https://saas-api.tmprl.cloud/docs/httpapi.html#description/introduction) and [gRPC API](https://github.com/temporalio/cloud-api/tree/main) for programmatically managing Temporal Cloud control plane resources, including [Namespaces](/cloud/namespaces), [Users](/cloud/users), [Service Accounts](/cloud/service-accounts), [API keys](/cloud/api-keys), and others. The Temporal Cloud [Terraform Provider](/cloud/terraform-provider), [tcld CLI](/cloud/tcld), and Web UI all use the Cloud Ops API.

Expand Down
9 changes: 4 additions & 5 deletions docs/cloud/worker-health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ keywords:
- workflow task execution size
- temporal worker resources
---

import { ReleaseStage } from '@site/src/components';

import { LANGUAGE_TAB_GROUP, getLanguageLabel } from '@site/src/constants/languageTabs';
import SdkTabs from '@site/src/components';
import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -367,11 +370,7 @@ rate(temporal_sticky_cache_total_forced_eviction_total{namespace="$namespace"}[5

## Manage Worker Heartbeating {#manage-worker-heartbeating}

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

This feature is currently in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Worker heartbeating" />

Workers send a heartbeat to Temporal Server every 60 seconds by default. This heartbeat serves to provide liveness and configuration data from the Worker to the Server.
Specific data sent can be found in the [API](https://github.com/temporalio/api/blob/master/temporal/api/worker/v1/message.proto). By providing a consistent heartbeat from
Expand Down
10 changes: 2 additions & 8 deletions docs/develop/dotnet/nexus/feature-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,9 @@ tags:
- .NET SDK
---

import { CaptionedImage } from '@site/src/components';
import { CaptionedImage, ReleaseStage } from '@site/src/components';

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal .NET SDK support for Nexus is at [Pre-release](/evaluate/development-production-features/release-stages#pre-release).

All APIs are experimental and may be subject to backwards-incompatible changes.

:::
<ReleaseStage stage="pre-release" feature="Temporal .NET SDK support for Nexus" />

Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations.

Expand Down
6 changes: 0 additions & 6 deletions docs/develop/go/nexus/feature-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ tags:

import { CaptionedImage } from '@site/src/components';

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Go SDK support for Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability).

:::

Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations.

This page shows how to do the following:
Expand Down
7 changes: 0 additions & 7 deletions docs/develop/java/nexus/feature-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,6 @@ tags:

import { CaptionedImage } from '@site/src/components';

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Java SDK support for Nexus is now
[Generally Available](/evaluate/development-production-features/release-stages#general-availability).

:::

Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus
Endpoint, a Nexus Service contract, and Nexus Operations.

Expand Down
Loading
Loading