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 @@ -97,12 +99,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 @@ -129,11 +129,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 @@ -162,7 +158,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
14 changes: 5 additions & 9 deletions docs/cloud/high-availability/enable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,13 @@ slug: /cloud/high-availability/enable
description: Get started with HA features
---

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

:::tip Support, stability, and dependency info
<ReleaseStage>
Same-region Replication and Multi-cloud Replication are in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

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

Multi-region Replication is in
[General Availability](/evaluate/development-production-features/release-stages#general-availability)

:::
Multi-region Replication is in [General Availability](/evaluate/development-production-features/release-stages#general-availability).
</ReleaseStage>

You can enable High Availability features
([Single-region Replication](/cloud/high-availability#same-region-replication),
Expand Down
10 changes: 4 additions & 6 deletions 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, ReleaseStage, 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 All @@ -37,13 +37,11 @@ This provides the basis of our 99.9% service level.

## High Availability features {#high-availability-features}

:::tip Support, stability, and dependency info

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

Multi-region Replication is in [General Availability](/evaluate/development-production-features/release-stages#general-availability)

:::
Multi-region Replication is in [General Availability](/evaluate/development-production-features/release-stages#general-availability).
</ReleaseStage>

High Availability features provide three types of replication:

Expand Down
9 changes: 2 additions & 7 deletions docs/cloud/metrics/openmetrics/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,11 @@ tags:
- Temporal Cloud
---

import { CaptionedImage } from '@site/src/components';
import { CaptionedImage, ReleaseStage } 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.

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Temporal Cloud OpenMetrics support" />

## Available Metrics Reference

Expand Down Expand Up @@ -314,7 +310,6 @@ scrape_configs:

:::


### Label Management

#### Prometheus
Expand Down
6 changes: 2 additions & 4 deletions docs/cloud/metrics/openmetrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ tags:
- Temporal Cloud
---

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
import { ReleaseStage } from '@site/src/components';

Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Temporal Cloud OpenMetrics support" />

:::tip PRICING

Expand Down
8 changes: 2 additions & 6 deletions docs/cloud/metrics/openmetrics/metrics-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,13 @@ tags:
- Temporal Cloud
---

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

Metrics can be exported from Temporal Cloud using the OpenMetrics endpoint. This document describes configuring integrations that have third party support or are based on open standards.
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).

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).

:::
<ReleaseStage stage="public-preview" feature="Temporal Cloud OpenMetrics support" />

## Integrations

Expand Down
8 changes: 3 additions & 5 deletions docs/cloud/metrics/openmetrics/metrics-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,11 @@ tags:
- Temporal Cloud
---

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

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
import { ReleaseStage } from '@site/src/components';

Temporal Cloud OpenMetrics support is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview).
This document describes all metrics available from the Temporal Cloud OpenMetrics endpoint.

:::
<ReleaseStage stage="public-preview" feature="Temporal Cloud OpenMetrics support" />

## Metric Conventions

Expand Down
8 changes: 3 additions & 5 deletions docs/cloud/metrics/openmetrics/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,19 @@ tags:
- Temporal Cloud
---

import { RelatedReadContainer, RelatedReadItem } from '@site/src/components';
import { RelatedReadContainer, RelatedReadItem, ReleaseStage } from '@site/src/components';
import { CaptionedImage } 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
can monitor your Temporal Cloud workloads, bringing enhanced capabilities, better integration with observability tools,
and access to high-cardinality metrics that were previously unavailable.

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO
<ReleaseStage stage="public-preview" feature="The OpenMetrics endpoint">

The OpenMetrics endpoint is available in
[Public Preview](/evaluate/development-production-features/release-stages#public-preview) for testing and validation.
The existing Prometheus query endpoint remains fully operational and supported.

:::
</ReleaseStage>

## Why We're Making This Change

Expand Down
6 changes: 2 additions & 4 deletions docs/cloud/migrate/automated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +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).

:::
<ReleaseStage stage="pre-release" feature="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 Nexus](/nexus) allows you to connect Temporal Applications across (and within) isolated Namespaces.
This provides all the benefits of Durable Execution across team and application boundaries with improved modularity, security, debugging, and fault isolation.
Nexus supports cross-team, cross-domain, cross-namespace, multi-region, and multi-cloud use cases.
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 @@ -22,13 +22,6 @@ keywords:

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).

:::

Nexus requests (commands, polling) have the same latency SLOs and error rate SLAs as other Worker requests in both the caller and handler Namespaces.

## Latency metrics
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).

:::

Temporal Cloud has default limits for several aspects of Nexus.
Many of these defaults are configurable, so if you need them changed please open a support ticket.

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 provides metrics and audit log streaming, in addition to integrated
[execution debugging](/nexus/execution-debugging).

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).

:::

The pricing for [Temporal Nexus](/evaluate/nexus) is:

- **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 @@ -16,13 +16,6 @@ keywords:

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 has built-in Nexus security.
It provides secure Nexus connectivity across Namespaces with an mTLS secured Envoy mesh.
Workers authenticate to their Namespace with mTLS client certificates or API keys, as allowed by their Namespace.
Expand Down
Loading
Loading