diff --git a/docs/cli/command-reference/cloud/account.mdx b/docs/cli/command-reference/cloud/account.mdx index 7ff75574fa..1824d5fc26 100644 --- a/docs/cli/command-reference/cloud/account.mdx +++ b/docs/cli/command-reference/cloud/account.mdx @@ -11,9 +11,13 @@ tags: - account --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Manage the Temporal Cloud account. This page provides a reference for the `temporal cloud account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/apikey.mdx b/docs/cli/command-reference/cloud/apikey.mdx index 5f568c99cd..89e2de48d2 100644 --- a/docs/cli/command-reference/cloud/apikey.mdx +++ b/docs/cli/command-reference/cloud/apikey.mdx @@ -12,9 +12,13 @@ tags: - apikeys --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for creating, listing, and managing Temporal Cloud API keys. API keys authenticate requests to the Temporal Cloud API. diff --git a/docs/cli/command-reference/cloud/async-operation.mdx b/docs/cli/command-reference/cloud/async-operation.mdx index 998c565ae8..3d10e8506c 100644 --- a/docs/cli/command-reference/cloud/async-operation.mdx +++ b/docs/cli/command-reference/cloud/async-operation.mdx @@ -12,9 +12,13 @@ tags: - async-operations --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for working with Temporal Cloud async operations. This page provides a reference for the `temporal cloud async-operation` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/connectivity.mdx b/docs/cli/command-reference/cloud/connectivity.mdx index 5c1289b6d3..a7dc22085e 100644 --- a/docs/cli/command-reference/cloud/connectivity.mdx +++ b/docs/cli/command-reference/cloud/connectivity.mdx @@ -11,9 +11,13 @@ tags: - connectivity --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing connectivity rules for Temporal Cloud. This page provides a reference for the `temporal cloud connectivity` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. @@ -108,7 +112,7 @@ Use the following options to change the behavior of this command. You can also u | `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | `--async` | No | **bool** Return immediately after initiating the operation instead of waiting for completion. Use the returned operation ID to check status later. | | `--async-operation-id` | No | **string** Custom identifier for tracking this async operation. If not provided, a unique ID is generated automatically. | -| `--azure-pe-resource-id` | No | **string** The ARM resource ID of the Azure Private Endpoint (only for Azure private connectivity). Example: `/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name}`. | +| `--azure-pe-resource-id` | No | **string** The ARM resource ID of the Azure Private Endpoint (only for Azure private connectivity). Example: /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Network/privateEndpoints/{name}. | | `--connection-id` | No | **string** The connection ID for private connectivity (AWS VPC endpoint ID or GCP PSC connection ID). | | `--gcp-project-id` | No | **string** The GCP project ID (only for GCP private connectivity). | | `--idempotent` | No | **bool** Succeed silently if the resource already exists or matches the specification. Without this flag, the command errors when no changes are needed. | diff --git a/docs/cli/command-reference/cloud/custom-role.mdx b/docs/cli/command-reference/cloud/custom-role.mdx index 3f6263033a..2011b54332 100644 --- a/docs/cli/command-reference/cloud/custom-role.mdx +++ b/docs/cli/command-reference/cloud/custom-role.mdx @@ -12,9 +12,13 @@ tags: - custom-roles --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing Temporal Cloud custom roles. Custom roles enable fine-grained authorization by binding sets of diff --git a/docs/cli/command-reference/cloud/login.mdx b/docs/cli/command-reference/cloud/login.mdx index 94fc20976c..0493eee88a 100644 --- a/docs/cli/command-reference/cloud/login.mdx +++ b/docs/cli/command-reference/cloud/login.mdx @@ -12,9 +12,13 @@ tags: - login --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Authenticate with Temporal Cloud using browser-based OAuth login. This command opens your default browser to complete authentication. Once diff --git a/docs/cli/command-reference/cloud/logout.mdx b/docs/cli/command-reference/cloud/logout.mdx index 01526838b3..f54091a3c0 100644 --- a/docs/cli/command-reference/cloud/logout.mdx +++ b/docs/cli/command-reference/cloud/logout.mdx @@ -12,9 +12,13 @@ tags: - login --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Log out from Temporal Cloud by clearing stored authentication tokens and credentials from the local configuration. diff --git a/docs/cli/command-reference/cloud/namespace.mdx b/docs/cli/command-reference/cloud/namespace.mdx index 0c1d597f2d..5dd8ae9ac2 100644 --- a/docs/cli/command-reference/cloud/namespace.mdx +++ b/docs/cli/command-reference/cloud/namespace.mdx @@ -11,9 +11,13 @@ tags: - namespaces --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for creating, updating, and managing Temporal Cloud namespaces. Namespaces provide isolation for workflows and activities. Each namespace diff --git a/docs/cli/command-reference/cloud/nexus.mdx b/docs/cli/command-reference/cloud/nexus.mdx index aa52495a5a..a9021288e0 100644 --- a/docs/cli/command-reference/cloud/nexus.mdx +++ b/docs/cli/command-reference/cloud/nexus.mdx @@ -10,9 +10,13 @@ tags: - nexus --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing Nexus Operations in Temporal Cloud. This page provides a reference for the `temporal cloud nexus` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/region.mdx b/docs/cli/command-reference/cloud/region.mdx index 2880bb8ad6..0714f20148 100644 --- a/docs/cli/command-reference/cloud/region.mdx +++ b/docs/cli/command-reference/cloud/region.mdx @@ -11,9 +11,13 @@ tags: - region --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for listing Temporal Cloud regions. This page provides a reference for the `temporal cloud region` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/service-account.mdx b/docs/cli/command-reference/cloud/service-account.mdx index 488dee2b30..5df6e1d861 100644 --- a/docs/cli/command-reference/cloud/service-account.mdx +++ b/docs/cli/command-reference/cloud/service-account.mdx @@ -11,9 +11,13 @@ tags: - service-accounts --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing Temporal Cloud service accounts. This page provides a reference for the `temporal cloud service-account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/user-group.mdx b/docs/cli/command-reference/cloud/user-group.mdx index 58a8af4af9..3edf0dfd88 100644 --- a/docs/cli/command-reference/cloud/user-group.mdx +++ b/docs/cli/command-reference/cloud/user-group.mdx @@ -11,9 +11,13 @@ tags: - user-groups --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing Temporal Cloud user groups. This page provides a reference for the `temporal cloud user-group` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/user.mdx b/docs/cli/command-reference/cloud/user.mdx index d824b3c9b0..450a3f95b0 100644 --- a/docs/cli/command-reference/cloud/user.mdx +++ b/docs/cli/command-reference/cloud/user.mdx @@ -11,9 +11,13 @@ tags: - users --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Commands for managing Temporal Cloud users. This page provides a reference for the `temporal cloud user` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/whoami.mdx b/docs/cli/command-reference/cloud/whoami.mdx index 6b8ef72cc0..35f4e425cd 100644 --- a/docs/cli/command-reference/cloud/whoami.mdx +++ b/docs/cli/command-reference/cloud/whoami.mdx @@ -12,9 +12,13 @@ tags: - authentication --- +import { ReleaseNoteHeader } from '@site/src/components'; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from the CLI command definitions via cmd/gen-docs. */} + + Display information about the currently authenticated identity. Shows whether you are authenticated as a user or service account, along diff --git a/docs/cli/command-reference/index.mdx b/docs/cli/command-reference/index.mdx index ea9c2f6625..1355888c96 100644 --- a/docs/cli/command-reference/index.mdx +++ b/docs/cli/command-reference/index.mdx @@ -19,6 +19,7 @@ This section includes the complete command reference for the `temporal` CLI, inc - [cloud](/cli/command-reference/cloud) - [config](/cli/command-reference/config) - [env](/cli/command-reference/env) +- [nexus](/cli/command-reference/nexus) - [operator](/cli/command-reference/operator) - [schedule](/cli/command-reference/schedule) - [server](/cli/command-reference/server) diff --git a/docs/cli/command-reference/nexus.mdx b/docs/cli/command-reference/nexus.mdx new file mode 100644 index 0000000000..75d15f5f56 --- /dev/null +++ b/docs/cli/command-reference/nexus.mdx @@ -0,0 +1,261 @@ +--- +id: nexus +title: Temporal CLI nexus command reference +sidebar_label: nexus +description: Learn how to use Temporal Nexus commands for starting, listing, and managing Nexus Operation Executions. +toc_max_heading_level: 4 +keywords: + - nexus + - nexus operation + - nexus operation start + - nexus operation execute + - nexus operation describe + - nexus operation cancel + - nexus operation terminate + - nexus operation list + - nexus operation count + - cli reference + - cli-feature + - command-line-interface-cli + - temporal cli +tags: + - Nexus + - Temporal CLI +--- + +{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. +This file is generated from the CLI command definitions via cmd/gen-docs. */} + +This page provides a reference for the `temporal` CLI `nexus` command. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. + +## operation + +These commands manage Nexus Operation Executions. + +Nexus Operation commands follow this syntax: + +``` +temporal nexus operation [command] [options] +``` + +### cancel + +Request cancellation of a Nexus Operation. + +``` +temporal nexus operation cancel \ + --operation-id YourOperationId +``` + +The Operation handler determines how to handle the +cancellation request. + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--reason` | No | **string** Reason for cancellation. | +| `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | + +### count + +Return a count of Nexus Operations. Use `--query` +to filter the operations to be counted. + +``` +temporal nexus operation count \ + --query 'Endpoint="YourEndpoint"' +``` + +Visit https://docs.temporal.io/visibility to read more about +Search Attributes and queries. + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--query`, `-q` | No | **string** Query to filter Nexus Operation Executions to count. | + +### describe + +Display detailed information about a specific Nexus +Operation Execution. + +``` +temporal nexus operation describe \ + --operation-id YourOperationId +``` + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--raw` | No | **bool** Print properties without changing their format. | +| `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | + +### execute + +Start a new Nexus Operation Execution and block until +it completes. The result is output to stdout. + +``` +temporal nexus operation execute \ + --endpoint YourEndpoint \ + --service YourService \ + --operation YourOperation \ + --operation-id YourOperationId \ + --input '{"some-key": "some-value"}' +``` + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--endpoint` | Yes | **string** Nexus Endpoint name. | +| `--id-conflict-policy` | No | **string-enum** Policy for handling an Operation ID conflict with a running operation. Accepted values: Fail, UseExisting, TerminateExisting. | +| `--id-reuse-policy` | No | **string-enum** Policy for re-using an Operation ID from a previously closed operation. Accepted values: AllowDuplicate, RejectDuplicate. | +| `--input`, `-i` | No | **string[]** Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. | +| `--input-base64` | No | **bool** Assume inputs are base64-encoded and attempt to decode them. | +| `--input-file` | No | **string[]** A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. | +| `--input-meta` | No | **string[]** Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. | +| `--operation` | Yes | **string** Nexus Operation name. | +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--schedule-to-close-timeout` | No | **duration** Total time the operation is allowed to run. | +| `--schedule-to-start-timeout` | No | **duration** Maximum time to wait for an operation to be started (or completed synchronously) by a handler. | +| `--search-attribute` | No | **string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | +| `--service` | Yes | **string** Nexus Service name. | +| `--start-to-close-timeout` | No | **duration** Maximum time to wait for an asynchronous operation to complete after it has been started. | +| `--static-summary` | No | **string** Static summary for the Nexus Operation for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. _(Experimental)_ | + +### list + +List Nexus Operations. Use `--query` to filter results. + +``` +temporal nexus operation list \ + --query 'Endpoint="YourEndpoint"' +``` + +Visit https://docs.temporal.io/visibility to read more about +Search Attributes and queries. + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--limit` | No | **int** Maximum number of Nexus Operation Executions to display. | +| `--page-size` | No | **int** Maximum number of Nexus Operation Executions to fetch at a time from the server. | +| `--query`, `-q` | No | **string** Query to filter the Nexus Operation Executions to list. | + +### result + +Wait for a Nexus Operation to complete and output +the result. + +``` +temporal nexus operation result \ + --operation-id YourOperationId +``` + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | + +### start + +Start a new Nexus Operation. Outputs the +Operation ID and Run ID. + +``` +temporal nexus operation start \ + --endpoint YourEndpoint \ + --service YourService \ + --operation YourOperation \ + --operation-id YourOperationId \ + --input '{"some-key": "some-value"}' +``` + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--endpoint` | Yes | **string** Nexus Endpoint name. | +| `--id-conflict-policy` | No | **string-enum** Policy for handling an Operation ID conflict with a running operation. Accepted values: Fail, UseExisting, TerminateExisting. | +| `--id-reuse-policy` | No | **string-enum** Policy for re-using an Operation ID from a previously closed operation. Accepted values: AllowDuplicate, RejectDuplicate. | +| `--input`, `-i` | No | **string[]** Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. | +| `--input-base64` | No | **bool** Assume inputs are base64-encoded and attempt to decode them. | +| `--input-file` | No | **string[]** A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. | +| `--input-meta` | No | **string[]** Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. | +| `--operation` | Yes | **string** Nexus Operation name. | +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--schedule-to-close-timeout` | No | **duration** Total time the operation is allowed to run. | +| `--schedule-to-start-timeout` | No | **duration** Maximum time to wait for an operation to be started (or completed synchronously) by a handler. | +| `--search-attribute` | No | **string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | +| `--service` | Yes | **string** Nexus Service name. | +| `--start-to-close-timeout` | No | **duration** Maximum time to wait for an asynchronous operation to complete after it has been started. | +| `--static-summary` | No | **string** Static summary for the Nexus Operation for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. _(Experimental)_ | + +### terminate + +Terminate a Nexus Operation. + +``` +temporal nexus operation terminate \ + --operation-id YourOperationId \ + --reason YourReason +``` + +Operation handlers cannot see or respond to terminations. + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--operation-id` | Yes | **string** Nexus Operation ID. | +| `--reason` | No | **string** Reason for termination. Defaults to a message with the current user's name. | +| `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | + +## Global Flags + +The following options can be used with any command. + +| Flag | Required | Description | Default | +|------|----------|-------------|--------| +| `--address` | No | **string** Temporal Service gRPC endpoint. | `localhost:7233` | +| `--api-key` | No | **string** API key for request. | | +| `--client-authority` | No | **string** Temporal gRPC client :authority pseudoheader. | | +| `--client-connect-timeout` | No | **duration** The client connection timeout. 0s means no timeout. | | +| `--codec-auth` | No | **string** Authorization header for Codec Server requests. | | +| `--codec-endpoint` | No | **string** Remote Codec Server endpoint. | | +| `--codec-header` | No | **string[]** HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. | | +| `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` | +| `--command-timeout` | No | **duration** The command execution timeout. 0s means no timeout. | | +| `--config-file` | No | **string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. | | +| `--disable-config-env` | No | **bool** If set, disables loading environment config from environment variables. | | +| `--disable-config-file` | No | **bool** If set, disables loading environment config from config file. | | +| `--env` | No | **string** Active environment name (`ENV`). | `default` | +| `--env-file` | No | **string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. | | +| `--grpc-meta` | No | **string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. | | +| `--identity` | No | **string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". | | +| `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | +| `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` | +| `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | +| `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | +| `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | +| `--profile` | No | **string** Profile to use for config file. | | +| `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` | +| `--tls` | No | **bool** Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. | | +| `--tls-ca-data` | No | **string** Data for server CA certificate. Can't be used with --tls-ca-path. | | +| `--tls-ca-path` | No | **string** Path to server CA certificate. Can't be used with --tls-ca-data. | | +| `--tls-cert-data` | No | **string** Data for x509 certificate. Can't be used with --tls-cert-path. | | +| `--tls-cert-path` | No | **string** Path to x509 certificate. Can't be used with --tls-cert-data. | | +| `--tls-disable-host-verification` | No | **bool** Disable TLS host-name verification. | | +| `--tls-key-data` | No | **string** Private certificate key data. Can't be used with --tls-key-path. | | +| `--tls-key-path` | No | **string** Path to x509 private key. Can't be used with --tls-key-data. | | +| `--tls-server-name` | No | **string** Override target TLS server name. | | + diff --git a/docs/cli/command-reference/worker.mdx b/docs/cli/command-reference/worker.mdx index daefb0fb9f..6ed0f868df 100644 --- a/docs/cli/command-reference/worker.mdx +++ b/docs/cli/command-reference/worker.mdx @@ -100,6 +100,8 @@ temporal worker deployment create-version \ If a Worker Deployment Version with the supplied BuildID already exists, this command will return an error. +Returns an error if all compute configuration fields are empty. + Note: This is an experimental feature and may change in the future. Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. @@ -442,6 +444,54 @@ Use the following options to change the behavior of this command. You can also u | `--unversioned` | No | **bool** Set unversioned workers as the target version. Cannot be used with --build-id. | | `--yes`, `-y` | No | **bool** Don't prompt to confirm set Ramping Version. | +### update-version-compute-config + +Update compute configuration associated with a Worker Deployment +Version. + +For example, to update the AWS Lambda function ARN associated with an +existing Worker Deployment Version: + +``` + temporal worker deployment update-version-compute-config \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --aws-lambda-function-arn UpdatedLambdaFunctionARN +``` + +To update the AWS IAM role ARN that is assumed by the serverless worker +manager associated with an existing Worker Deployment Version: + +``` + temporal worker deployment update-version-compute-config \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --aws-lambda-assume-role-arn UpdatedRoleARN +``` + +If --remove is specified, the compute configuration for the Worker +Deployment Version will be removed: + +``` + temporal worker deployment update-version-compute-config \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --remove +``` + +If a Worker Deployment Version with the supplied BuildID does not exist, +this command will return an error. + +Note: This is an experimental feature and may change in the future. + +Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. + +| Flag | Required | Description | +|------|----------|-------------| +| `--aws-lambda-assume-role-arn` | No | **string** AWS IAM role ARN that the Temporal server will assume when invoking the Lambda function that spawns a new Worker in this Worker Deployment Version. Required when --aws-lambda-function-arn is specified. | +| `--aws-lambda-assume-role-external-id` | No | **string** Temporal server will enforce that the AWS IAM trust policy associated with the AWS IAM role specified in --aws-lambda-assume-role-arn has an aws:ExternalId condition that matches the supplied value. Required when --aws-lambda-function-arn is specified. | +| `--aws-lambda-function-arn` | No | **string** Qualified (contains version suffix) or unqualified AWS Lambda function ARN to invoke when there are no active pollers for task queue targets in the Worker Deployment. | +| `--build-id` | Yes | **string** Build ID of the Worker Deployment Version. | +| `--deployment-name` | Yes | **string** Name of the Worker Deployment. | +| `--remove` | No | **bool** Removes any compute configuration associated with this Worker Deployment Version. | + ### update-version-metadata Update metadata associated with a Worker Deployment Version. diff --git a/docs/cli/command-reference/workflow.mdx b/docs/cli/command-reference/workflow.mdx index 4bc69d3e4a..37523b6942 100644 --- a/docs/cli/command-reference/workflow.mdx +++ b/docs/cli/command-reference/workflow.mdx @@ -403,9 +403,9 @@ Use the following options to change the behavior of this command. You can also u | Flag | Required | Description | |------|----------|-------------| -| `--versioning-override-behavior` | Yes | **string-enum** Override the versioning behavior of a Workflow. Accepted values: pinned, auto_upgrade. | -| `--versioning-override-build-id` | No | **string** When overriding to a `pinned` behavior, specifies the Build ID of the version to target. | -| `--versioning-override-deployment-name` | No | **string** When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. | +| `--versioning-override-behavior` | Yes | **string-enum** Override the versioning behavior of a Workflow. Accepted values: pinned, one_time, auto_upgrade. | +| `--versioning-override-build-id` | No | **string** When overriding to a `pinned` or `one_time` behavior, specifies the Build ID of the version to target. | +| `--versioning-override-deployment-name` | No | **string** When overriding to a `pinned` or `one_time` behavior, specifies the Deployment Name of the version to target. | ## result @@ -848,6 +848,17 @@ temporal workflow update-options \ --versioning-override-build-id YourDeploymentBuildId ``` +or to move the workflow execution to a Worker Deployment Version until +the next Workflow Task completes there, set behavior to `one_time`: + +``` +temporal workflow update-options \ + --workflow-id YourWorkflowId \ + --versioning-override-behavior one_time \ + --versioning-override-deployment-name YourDeploymentName \ + --versioning-override-build-id YourDeploymentBuildId +``` + To remove any previous overrides, set the behavior to `unspecified`: @@ -868,9 +879,9 @@ Use the following options to change the behavior of this command. You can also u | `--reason` | No | **string** Reason for batch operation. Only use with --query. Defaults to user name. | | `--rps` | No | **float** Limit batch's requests per second. Only allowed if query is present. | | `--run-id`, `-r` | No | **string** Run ID. Only use with --workflow-id. Cannot use with --query. | -| `--versioning-override-behavior` | Yes | **string-enum** Override the versioning behavior of a Workflow. Accepted values: unspecified, pinned, auto_upgrade. | -| `--versioning-override-build-id` | No | **string** When overriding to a `pinned` behavior, specifies the Build ID of the version to target. | -| `--versioning-override-deployment-name` | No | **string** When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. | +| `--versioning-override-behavior` | Yes | **string-enum** Override the versioning behavior of a Workflow. Accepted values: unspecified, pinned, one_time, auto_upgrade. | +| `--versioning-override-build-id` | No | **string** When overriding to a `pinned` or `one_time` behavior, specifies the Build ID of the version to target. | +| `--versioning-override-deployment-name` | No | **string** When overriding to a `pinned` or `one_time` behavior, specifies the Deployment Name of the version to target. | | `--workflow-id`, `-w` | No | **string** Workflow ID. You must set either --workflow-id or --query. | | `--yes`, `-y` | No | **bool** Don't prompt to confirm signaling. Only allowed when --query is present. |