diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index cffd52b5b7..ee859721f7 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -234,13 +234,17 @@ Identifies the Activity Execution. The host and port (formatted as host:port) for the Temporal Frontend Service. +## api-key + +API key for request. + ## archived List archived Workflow Executions. :::note -Currently an experimental feature. +Caution: `--archived` is experimental. ::: @@ -313,7 +317,13 @@ Use `-1` to fetch Child Workflows at any depth. ## description -Namespace description. +Namespace description or Nexus Endpoint description. +You may use Markdown formatting in the Nexus Endpoint description. + +## description-file + +Path to the Nexus Endpoint description file. +The contents of the description file may use Markdown formatting. ## detail @@ -344,6 +354,11 @@ Backfill end time. Name of the environment to read environmental variables from. +## env-file + +Path to environment settings file. +Defaults to `$HOME/.config/temporalio/temporal.yaml`. + ## event-id The Event Id for any Event after WorkflowTaskStarted you want to reset to (exclusive). @@ -503,7 +518,7 @@ Enabled by default with a randomly assigned port. ## name -Frontend address of the remote Cluster. +Frontend address of the remote Cluster or the Endpoint name. ## namespace @@ -518,6 +533,10 @@ Namespace Id. Disable folding. All Child Workflows within the set depth will be fetched and displayed. +## no-json-shorthand-payloads + +Raw payload output, even if the JSON option was used. + ## no-pager Disables the interactive pager. @@ -656,6 +675,25 @@ Specify a delay before the workflow starts. Backfill start time. +## target-namespace + +Namespace in which a handler Worker will poll for Nexus tasks. + +## target-task-queue + +Task Queue in which a handler Worker will poll for Nexus tasks. + +## target-url + +An external Nexus Endpoint where Nexus requests are forwarded to. +May be used as an alternative to `--target-namespace` and `--target-task-queue`. + +:::note + +Caution: `--target-url` is experimental. + +::: + ## task-queue-type Task Queue type, which can be either workflow or activity. @@ -677,10 +715,18 @@ Format time as: relative, iso, raw. Time zone (IANA name). +## tls-ca-data + +Data for server CA certificate. Can't be used with --tls-ca-path. + ## tls-ca-path Path to server CA certificate. +## tls-cert-data + +Data for x509 certificate. Can't be used with --tls-cert-path. + ## tls-cert-path Path to x509 certificate. @@ -689,6 +735,10 @@ Path to x509 certificate. Disables TLS host name verification. +## tls-key-data + +Private certificate key data. Can't be used with --tls-key-path. + ## tls-key-path Path to private certificate key. @@ -727,6 +777,10 @@ Default: `--port` + 1000 (for example, 4000). Unpauses the Schedule. +## unset-description + +Unset the description. + ## verbose Print applied Namespace changes. diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index e7060ba219..e6f78a933d 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -18,6 +18,13 @@ keywords: - namespace delete - namespace describe - namespace list + - nexus + - nexus endpoint + - nexus endpoint create + - nexus endpoint delete + - nexus endpoint get + - nexus endpoint list + - nexus endpoint update - operator - search attribute - search attribute create @@ -564,6 +571,363 @@ Use the options listed below to change the command's behavior. - [--visibility-uri](/cli/cmd-options#visibility-uri) +## nexus + +These commands manage Nexus resources. + +Nexus commands follow this syntax: + +``` +temporal operator nexus [command] [subcommand] [options] +``` + +### endpoint + +These commands manage Nexus Endpoints. + +Nexus Endpoint commands follow this syntax: + +``` +temporal operator nexus endpoint [command] [options] +``` + +#### create + +Create a Nexus Endpoint on the Server. + +A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. +The endpoint target may either be a Worker, in which case `--target-namespace` and `--target-task-queue` must both be provided, or an external URL, in which case `--target-url` must be provided. + +This command will fail if an endpoint with the same name is already registered. + +``` +temporal operator nexus endpoint create \ + --name your-endpoint \ + --target-namespace your-namespace \ + --target-task-queue your-task-queue \ + --description-file DESCRIPTION.md +``` + +Use the following options to change the behavior of this command. + +- [--address](/cli/cmd-options#address) + +- [--api-key](/cli/cmd-options#api-key) + +- [--codec-auth](/cli/cmd-options#codec-auth) + +- [--codec-endpoint](/cli/cmd-options#codec-endpoint) + +- [--color](/cli/cmd-options#color) + +- [--description](/cli/cmd-options#description) + +- [--description-file](/cli/cmd-options#description-file) + +- [--env](/cli/cmd-options#env) + +- [--env-file](/cli/cmd-options#env-file) + +- [--grpc-meta](/cli/cmd-options#grpc-meta) + +- [--log-format](/cli/cmd-options#log-format) + +- [--log-level](/cli/cmd-options#log-level) + +- [--name](/cli/cmd-options#name) + +- [--namespace](/cli/cmd-options#namespace) + +- [--no-json-shorthand-payloads](/cli/cmd-options#no-json-shorthand-payloads) + +- [--output](/cli/cmd-options#output) + +- [--target-namespace](/cli/cmd-options#target-namespace) + +- [--target-task-queue](/cli/cmd-options#target-task-queue) + +- [--target-url](/cli/cmd-options#target-url) + +- [--time-format](/cli/cmd-options#time-format) + +- [--tls](/cli/cmd-options#tls) + +- [--tls-ca-data](/cli/cmd-options#tls-ca-data) + +- [--tls-ca-path](/cli/cmd-options#tls-ca-path) + +- [--tls-cert-data](/cli/cmd-options#tls-cert-data) + +- [--tls-cert-path](/cli/cmd-options#tls-cert-path) + +- [--tls-disable-host-verification](/cli/cmd-options#tls-disable-host-verification) + +- [--tls-key-data](/cli/cmd-options#tls-key-data) + +- [--tls-key-path](/cli/cmd-options#tls-key-path) + +- [--tls-server-name](/cli/cmd-options#tls-server-name) + +#### delete + +Delete a Nexus Endpoint from the Server. + +``` +temporal operator nexus endpoint delete --name your-endpoint +``` + +Use the following options to change the behavior of this command. + +- [--address](/cli/cmd-options#address) + +- [--api-key](/cli/cmd-options#api-key) + +- [--codec-auth](/cli/cmd-options#codec-auth) + +- [--codec-endpoint](/cli/cmd-options#codec-endpoint) + +- [--color](/cli/cmd-options#color) + +- [--env](/cli/cmd-options#env) + +- [--env-file](/cli/cmd-options#env-file) + +- [--grpc-meta](/cli/cmd-options#grpc-meta) + +- [--log-format](/cli/cmd-options#log-format) + +- [--log-level](/cli/cmd-options#log-level) + +- [--name](/cli/cmd-options#name) + +- [--namespace](/cli/cmd-options#namespace) + +- [--no-json-shorthand-payloads](/cli/cmd-options#no-json-shorthand-payloads) + +- [--output](/cli/cmd-options#output) + +- [--time-format](/cli/cmd-options#time-format) + +- [--tls](/cli/cmd-options#tls) + +- [--tls-ca-data](/cli/cmd-options#tls-ca-data) + +- [--tls-ca-path](/cli/cmd-options#tls-ca-path) + +- [--tls-cert-data](/cli/cmd-options#tls-cert-data) + +- [--tls-cert-path](/cli/cmd-options#tls-cert-path) + +- [--tls-disable-host-verification](/cli/cmd-options#tls-disable-host-verification) + +- [--tls-key-data](/cli/cmd-options#tls-key-data) + +- [--tls-key-path](/cli/cmd-options#tls-key-path) + +- [--tls-server-name](/cli/cmd-options#tls-server-name) + +#### get + +Get a Nexus Endpoint by name from the Server. + +``` +temporal operator nexus endpoint get --name your-endpoint +``` + +Use the following options to change the behavior of this command. + +- [--address](/cli/cmd-options#address) + +- [--api-key](/cli/cmd-options#api-key) + +- [--codec-auth](/cli/cmd-options#codec-auth) + +- [--codec-endpoint](/cli/cmd-options#codec-endpoint) + +- [--color](/cli/cmd-options#color) + +- [--env](/cli/cmd-options#env) + +- [--env-file](/cli/cmd-options#env-file) + +- [--grpc-meta](/cli/cmd-options#grpc-meta) + +- [--log-format](/cli/cmd-options#log-format) + +- [--log-level](/cli/cmd-options#log-level) + +- [--name](/cli/cmd-options#name) + +- [--namespace](/cli/cmd-options#namespace) + +- [--no-json-shorthand-payloads](/cli/cmd-options#no-json-shorthand-payloads) + +- [--output](/cli/cmd-options#output) + +- [--time-format](/cli/cmd-options#time-format) + +- [--tls](/cli/cmd-options#tls) + +- [--tls-ca-data](/cli/cmd-options#tls-ca-data) + +- [--tls-ca-path](/cli/cmd-options#tls-ca-path) + +- [--tls-cert-data](/cli/cmd-options#tls-cert-data) + +- [--tls-cert-path](/cli/cmd-options#tls-cert-path) + +- [--tls-disable-host-verification](/cli/cmd-options#tls-disable-host-verification) + +- [--tls-key-data](/cli/cmd-options#tls-key-data) + +- [--tls-key-path](/cli/cmd-options#tls-key-path) + +- [--tls-server-name](/cli/cmd-options#tls-server-name) + +#### list + +List all Nexus Endpoints on the Server. + +``` +temporal operator nexus endpoint list +``` + +Use the following options to change the behavior of this command. + +- [--address](/cli/cmd-options#address) + +- [--api-key](/cli/cmd-options#api-key) + +- [--codec-auth](/cli/cmd-options#codec-auth) + +- [--codec-endpoint](/cli/cmd-options#codec-endpoint) + +- [--color](/cli/cmd-options#color) + +- [--env](/cli/cmd-options#env) + +- [--env-file](/cli/cmd-options#env-file) + +- [--grpc-meta](/cli/cmd-options#grpc-meta) + +- [--log-format](/cli/cmd-options#log-format) + +- [--log-level](/cli/cmd-options#log-level) + +- [--namespace](/cli/cmd-options#namespace) + +- [--no-json-shorthand-payloads](/cli/cmd-options#no-json-shorthand-payloads) + +- [--output](/cli/cmd-options#output) + +- [--time-format](/cli/cmd-options#time-format) + +- [--tls](/cli/cmd-options#tls) + +- [--tls-ca-data](/cli/cmd-options#tls-ca-data) + +- [--tls-ca-path](/cli/cmd-options#tls-ca-path) + +- [--tls-cert-data](/cli/cmd-options#tls-cert-data) + +- [--tls-cert-path](/cli/cmd-options#tls-cert-path) + +- [--tls-disable-host-verification](/cli/cmd-options#tls-disable-host-verification) + +- [--tls-key-data](/cli/cmd-options#tls-key-data) + +- [--tls-key-path](/cli/cmd-options#tls-key-path) + +- [--tls-server-name](/cli/cmd-options#tls-server-name) + +#### update + +Update an existing Nexus Endpoint on the Server. + +A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. +The endpoint target may either be a Worker, in which case `--target-namespace` and `--target-task-queue` must both be provided, or an external URL, in which case `--target-url` must be provided. + +The endpoint is patched; existing fields for which flags are not provided are +left as they were. + +Update only the target task queue: + +``` +temporal operator nexus endpoint update \ + --name your-endpoint \ + --target-task-queue your-other-queue +``` + +Update only the description: + +``` +temporal operator nexus endpoint update \ + --name your-endpoint \ + --description-file DESCRIPTION.md +``` + +Use the following options to change the behavior of this command. + +- [--address](/cli/cmd-options#address) + +- [--api-key](/cli/cmd-options#api-key) + +- [--codec-auth](/cli/cmd-options#codec-auth) + +- [--codec-endpoint](/cli/cmd-options#codec-endpoint) + +- [--color](/cli/cmd-options#color) + +- [--description](/cli/cmd-options#description) + +- [--description-file](/cli/cmd-options#description-file) + +- [--env](/cli/cmd-options#env) + +- [--env-file](/cli/cmd-options#env-file) + +- [--grpc-meta](/cli/cmd-options#grpc-meta) + +- [--log-format](/cli/cmd-options#log-format) + +- [--log-level](/cli/cmd-options#log-level) + +- [--name](/cli/cmd-options#name) + +- [--namespace](/cli/cmd-options#namespace) + +- [--no-json-shorthand-payloads](/cli/cmd-options#no-json-shorthand-payloads) + +- [--output](/cli/cmd-options#output) + +- [--target-namespace](/cli/cmd-options#target-namespace) + +- [--target-task-queue](/cli/cmd-options#target-task-queue) + +- [--target-url](/cli/cmd-options#target-url) + +- [--time-format](/cli/cmd-options#time-format) + +- [--tls](/cli/cmd-options#tls) + +- [--tls-ca-data](/cli/cmd-options#tls-ca-data) + +- [--tls-ca-path](/cli/cmd-options#tls-ca-path) + +- [--tls-cert-data](/cli/cmd-options#tls-cert-data) + +- [--tls-cert-path](/cli/cmd-options#tls-cert-path) + +- [--tls-disable-host-verification](/cli/cmd-options#tls-disable-host-verification) + +- [--tls-key-data](/cli/cmd-options#tls-key-data) + +- [--tls-key-path](/cli/cmd-options#tls-key-path) + +- [--tls-server-name](/cli/cmd-options#tls-server-name) + +- [--unset-description](/cli/cmd-options#unset-description) + ## search-attribute Search Attribute commands enable operations for the creation, listing, and removal of [Search Attributes](/visibility#search-attribute).