Skip to content
Open
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
24 changes: 13 additions & 11 deletions core/src/main/java/io/temporal/samples/nexusstandalone/README.MD
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
## Standalone Nexus Operations

> [!WARNING]
> Standalone Nexus operations are experimental and may be subject to backwards-incompatible
> changes. They require a Temporal server that implements and enables them via the dynamic configs
> shown below. Use the dev server build at
> https://github.com/temporalio/cli/releases/tag/v1.7.4-standalone-nexus-operations.
>
# Standalone Nexus Operations

> [!NOTE]
> ✨ **Standalone Nexus Operations are now in [Public Preview](https://docs.temporal.io/evaluate/development-production-features/release-stages#public-preview).**
> We aim to preserve backward compatibility and avoid breaking changes.

This sample shows how to invoke and manage **standalone Nexus operations** — Nexus operations
started directly by a client rather than from within a caller workflow. The long-running operation
(`startGreeting`) is backed by a `GreetingWorkflow` that blocks until it is cancelled; the quick
Expand All @@ -26,18 +24,22 @@ from the environment (and optionally a profile from `temporal.toml`).

### Run locally against a dev server

1. Start the [Temporal dev server build that supports standalone Nexus operations](https://docs.temporal.io/standalone-nexus-operation#temporal-cli-support) with the required namespaces pre-created:
> [!NOTE]
> Standalone Nexus Operations require a server that supports this feature. For local development, use a Temporal CLI
> release that enables SANO in its dev server.

1. Start a [Temporal dev server](https://docs.temporal.io/cli/setup-cli) with the required namespaces pre-created:

```bash
./temporal server start-dev \
temporal server start-dev \
--namespace my-caller-namespace \
--namespace my-handler-namespace
```

2. Create a Nexus endpoint that routes to the handler namespace and the worker's task queue:

```bash
./temporal operator nexus endpoint create \
temporal operator nexus endpoint create \
--name my-nexus-endpoint \
--target-namespace my-handler-namespace \
--target-task-queue nexus-handler-queue
Expand Down
Loading