From 0cd08c7a0127b36d382a5f8f1cbe03bfb9377c51 Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Thu, 10 Oct 2024 17:25:07 -0700 Subject: [PATCH 01/10] add temporal cli docs for nexus endpoints Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 38 +++- docs/cli/operator.mdx | 385 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 421 insertions(+), 2 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index cffd52b5b7..89a5b44de9 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -32,6 +32,8 @@ keywords: - cron - cross-cluster-connection - data converters + - description + - description file - endpoint - environment - event @@ -55,6 +57,7 @@ keywords: - logging and metrics - memo - metrics + - name - namespace - namespace description - namespace id @@ -88,6 +91,9 @@ keywords: - server options and configurations - sqlite - start-to-close + - target namespace + - target task queue + - target url - task queue - task queue type - temporal cli @@ -98,6 +104,7 @@ keywords: - timeouts and heartbeats - tls - tls server + - unset description - uri - verification - visibility @@ -140,6 +147,8 @@ tags: - cron - cross-cluster-connection - data-converters + - description + - description-file - endpoint - environment - event @@ -163,6 +172,7 @@ tags: - logging-and-metrics - memo - metrics + - name - namespace - namespace-description - namespace-id @@ -196,6 +206,9 @@ tags: - server-options-and-configurations - sqlite - start-to-close + - target-namespace + - target-task-queue + - target-url - task-queue - task-queue-type - temporal-cli @@ -206,6 +219,7 @@ tags: - timeouts-and-heartbeats - tls - tls-server + - unset-description - uri - verification - visibility @@ -313,7 +327,11 @@ Use `-1` to fetch Child Workflows at any depth. ## description -Namespace description. +Namespace description or Endpoint description in markdown format (encoded using the configured codec server). + +## description-file + +Endpoint description file in markdown format (encoded using the configured codec server). ## detail @@ -503,7 +521,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 @@ -656,6 +674,18 @@ Specify a delay before the workflow starts. Backfill start time. +## target-namespace + +Namespace in which a handler worker will be polling for Nexus tasks on. + +## target-task-queue + +Task Queue in which a handler worker will be polling for Nexus tasks on. + +## target-url + +URL to direct Nexus requests to. + ## task-queue-type Task Queue type, which can be either workflow or activity. @@ -727,6 +757,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..ca20ddb9fd 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 @@ -40,6 +47,13 @@ tags: - 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 +578,377 @@ Use the options listed below to change the command's behavior. - [--visibility-uri](/cli/cmd-options#visibility-uri) +## nexus + +Nexus commands enable managing Nexus resources. + +Nexus commands follow this syntax: + +``` +temporal operator nexus [command] [command] [command options] +``` + +### endpoint + +Endpoint commands enable managing Nexus Endpoints. + +Endpoint commands follow this syntax: + +``` +temporal operator nexus endpoint [command] [command options] +``` + +#### create + +Create a new Nexus Endpoint on the Server. + +An 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) + +- [--command-timeout](/cli/cmd-options#command-timeout) + +- [--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 configuration 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) + +- [--command-timeout](/cli/cmd-options#command-timeout) + +- [--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 configuration 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) + +- [--command-timeout](/cli/cmd-options#command-timeout) + +- [--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 Endpoint configurations 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) + +- [--command-timeout](/cli/cmd-options#command-timeout) + +- [--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. + +An 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) + +- [--command-timeout](/cli/cmd-options#command-timeout) + +- [--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). From ade7de97b5fe026796c9d242bf0279aca5a46de2 Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Fri, 11 Oct 2024 09:41:22 -0700 Subject: [PATCH 02/10] adjust front matter Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 14 -------------- docs/cli/operator.mdx | 7 ------- 2 files changed, 21 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index 89a5b44de9..25e7f809d4 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -32,8 +32,6 @@ keywords: - cron - cross-cluster-connection - data converters - - description - - description file - endpoint - environment - event @@ -57,7 +55,6 @@ keywords: - logging and metrics - memo - metrics - - name - namespace - namespace description - namespace id @@ -91,9 +88,6 @@ keywords: - server options and configurations - sqlite - start-to-close - - target namespace - - target task queue - - target url - task queue - task queue type - temporal cli @@ -104,7 +98,6 @@ keywords: - timeouts and heartbeats - tls - tls server - - unset description - uri - verification - visibility @@ -147,8 +140,6 @@ tags: - cron - cross-cluster-connection - data-converters - - description - - description-file - endpoint - environment - event @@ -172,7 +163,6 @@ tags: - logging-and-metrics - memo - metrics - - name - namespace - namespace-description - namespace-id @@ -206,9 +196,6 @@ tags: - server-options-and-configurations - sqlite - start-to-close - - target-namespace - - target-task-queue - - target-url - task-queue - task-queue-type - temporal-cli @@ -219,7 +206,6 @@ tags: - timeouts-and-heartbeats - tls - tls-server - - unset-description - uri - verification - visibility diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index ca20ddb9fd..46f344bf7c 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -47,13 +47,6 @@ tags: - 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 From 44bdcb0db8f79c9d477f1c3e6216a2afb9b2305c Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Fri, 11 Oct 2024 09:56:47 -0700 Subject: [PATCH 03/10] add missing command options Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 24 ++++++++++++++++++++++++ docs/cli/operator.mdx | 10 ---------- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index 25e7f809d4..b7fe1a243c 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -234,6 +234,10 @@ 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. @@ -348,6 +352,10 @@ 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). @@ -522,6 +530,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 they are JSON. + ## no-pager Disables the interactive pager. @@ -693,10 +705,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. @@ -705,6 +725,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. diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 46f344bf7c..5008768d9e 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -622,8 +622,6 @@ Use the following options to change the behavior of this command. - [--color](/cli/cmd-options#color) -- [--command-timeout](/cli/cmd-options#command-timeout) - - [--description](/cli/cmd-options#description) - [--description-file](/cli/cmd-options#description-file) @@ -692,8 +690,6 @@ Use the following options to change the behavior of this command. - [--color](/cli/cmd-options#color) -- [--command-timeout](/cli/cmd-options#command-timeout) - - [--env](/cli/cmd-options#env) - [--env-file](/cli/cmd-options#env-file) @@ -752,8 +748,6 @@ Use the following options to change the behavior of this command. - [--color](/cli/cmd-options#color) -- [--command-timeout](/cli/cmd-options#command-timeout) - - [--env](/cli/cmd-options#env) - [--env-file](/cli/cmd-options#env-file) @@ -812,8 +806,6 @@ Use the following options to change the behavior of this command. - [--color](/cli/cmd-options#color) -- [--command-timeout](/cli/cmd-options#command-timeout) - - [--env](/cli/cmd-options#env) - [--env-file](/cli/cmd-options#env-file) @@ -890,8 +882,6 @@ Use the following options to change the behavior of this command. - [--color](/cli/cmd-options#color) -- [--command-timeout](/cli/cmd-options#command-timeout) - - [--description](/cli/cmd-options#description) - [--description-file](/cli/cmd-options#description-file) From 2ed35e47a66454d467cb7f806767934825701e69 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Fri, 11 Oct 2024 12:41:40 -0500 Subject: [PATCH 04/10] running yarn format on file --- docs/cli/operator.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 5008768d9e..0be703b20f 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -595,7 +595,7 @@ temporal operator nexus endpoint [command] [command options] Create a new Nexus Endpoint on the Server. -An endpoint name is used in workflow code to invoke Nexus operations. The +An 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. @@ -846,7 +846,7 @@ Use the following options to change the behavior of this command. Update an existing Nexus Endpoint on the Server. -An endpoint name is used in workflow code to invoke Nexus operations. The +An 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. From 1261902b2be533779ea3ff0eba179a47dd59f077 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Fri, 11 Oct 2024 12:48:24 -0500 Subject: [PATCH 05/10] putting one sentence on one line and capitalizing Temporal terms --- docs/cli/operator.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 0be703b20f..2405f82639 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -595,8 +595,8 @@ temporal operator nexus endpoint [command] [command options] Create a new Nexus Endpoint on the Server. -An 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 +An 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. @@ -846,8 +846,8 @@ Use the following options to change the behavior of this command. Update an existing Nexus Endpoint on the Server. -An 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 +An 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. From ad55e91afbe67be683a0ba9daca767f3c52686f4 Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Fri, 11 Oct 2024 12:58:16 -0700 Subject: [PATCH 06/10] capitalize Temporal terms Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 4 ++-- docs/cli/operator.mdx | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index b7fe1a243c..becaa4b4a7 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -317,11 +317,11 @@ Use `-1` to fetch Child Workflows at any depth. ## description -Namespace description or Endpoint description in markdown format (encoded using the configured codec server). +Namespace description or Endpoint description in markdown format (encoded using the configured Codec Server). ## description-file -Endpoint description file in markdown format (encoded using the configured codec server). +Endpoint description file in markdown format (encoded using the configured Codec Server). ## detail diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 2405f82639..1817bbf4db 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -595,8 +595,8 @@ temporal operator nexus endpoint [command] [command options] Create a new Nexus Endpoint on the Server. -An 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 +An 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. @@ -846,7 +846,7 @@ Use the following options to change the behavior of this command. Update an existing Nexus Endpoint on the Server. -An endpoint name is used in Workflow code to invoke Nexus operations. +An 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. From 5a317ff516edc8305d512c9ca763adc8df7d831e Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Mon, 14 Oct 2024 13:08:24 -0700 Subject: [PATCH 07/10] mark `nexus endpoint create --target-url` flag experimental Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index becaa4b4a7..0983e3cabc 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -684,6 +684,12 @@ Task Queue in which a handler worker will be polling for Nexus tasks on. URL to direct Nexus requests to. +:::note + +Currently an experimental feature. + +::: + ## task-queue-type Task Queue type, which can be either workflow or activity. From a9aa1ebaa8620f2d2e4f4bd06800d9d4a548427f Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Tue, 15 Oct 2024 14:06:49 -0700 Subject: [PATCH 08/10] address feedback Signed-off-by: Phil Prasek --- docs/cli/cmd-options.mdx | 27 +++++++++++++++++++-------- docs/cli/operator.mdx | 28 ++++++++++++++-------------- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index 0983e3cabc..1446f22bab 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -244,7 +244,7 @@ List archived Workflow Executions. :::note -Currently an experimental feature. +Caution: `--archived` is experimental. ::: @@ -317,11 +317,13 @@ Use `-1` to fetch Child Workflows at any depth. ## description -Namespace description or Endpoint description in markdown format (encoded using the configured Codec Server). +Namespace description or Nexus Endpoint description. +You may use Markdown formatting in the Nexus Endpoint description. ## description-file -Endpoint description file in markdown format (encoded using the configured Codec Server). +Path to the Nexus Endpoint description file. +The contents of the description file may use Markdown formatting. ## detail @@ -354,7 +356,8 @@ Name of the environment to read environmental variables from. ## env-file -Path to environment settings file. (defaults to `$HOME/.config/temporalio/temporal.yaml`). +Path to environment settings file. +Defaults to `$HOME/.config/temporalio/temporal.yaml`. ## event-id @@ -532,7 +535,7 @@ All Child Workflows within the set depth will be fetched and displayed. ## no-json-shorthand-payloads -Raw payload output, even if they are JSON. +Raw payload output, even if the JSON option was used. ## no-pager @@ -674,15 +677,23 @@ Backfill start time. ## target-namespace -Namespace in which a handler worker will be polling for Nexus tasks on. +Namespace in which a handler Worker will poll for Nexus tasks. ## target-task-queue -Task Queue in which a handler worker will be polling for Nexus tasks on. +Task Queue in which a handler Worker will poll for Nexus tasks. ## target-url -URL to direct Nexus requests to. +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. + +::: + :::note diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 1817bbf4db..49281342e4 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -573,30 +573,30 @@ Use the options listed below to change the command's behavior. ## nexus -Nexus commands enable managing Nexus resources. +These commands manage Nexus resources. -Nexus commands follow this syntax: +nexus commands follow this syntax: ``` -temporal operator nexus [command] [command] [command options] +temporal operator nexus [command] [subcommand] [options] ``` ### endpoint -Endpoint commands enable managing Nexus Endpoints. +These commands manage Nexus Endpoints. -Endpoint commands follow this syntax: +Nexus Endpoint commands follow this syntax: ``` -temporal operator nexus endpoint [command] [command options] +temporal operator nexus endpoint [command] [options] ``` #### create -Create a new Nexus Endpoint on the Server. +Create a Nexus Endpoint on the Server. -An 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 +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. @@ -672,7 +672,7 @@ Use the following options to change the behavior of this command. #### delete -Delete a Nexus Endpoint configuration from the Server. +Delete a Nexus Endpoint from the Server. ``` temporal operator nexus endpoint delete --name your-endpoint @@ -730,7 +730,7 @@ Use the following options to change the behavior of this command. #### get -Get a Nexus Endpoint configuration by name from the Server. +Get a Nexus Endpoint by name from the Server. ``` temporal operator nexus endpoint get --name your-endpoint @@ -788,7 +788,7 @@ Use the following options to change the behavior of this command. #### list -List all Nexus Endpoint configurations on the Server. +List all Nexus Endpoints on the Server. ``` temporal operator nexus endpoint list @@ -846,8 +846,8 @@ Use the following options to change the behavior of this command. Update an existing Nexus Endpoint on the Server. -An 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 +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. From 7da3ca1fcb907a16088afee1c1f432047e6997a2 Mon Sep 17 00:00:00 2001 From: Phil Prasek Date: Wed, 16 Oct 2024 10:00:24 -0700 Subject: [PATCH 09/10] copy edit changes Signed-off-by: Phil Prasek --- docs/cli/operator.mdx | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/cli/operator.mdx b/docs/cli/operator.mdx index 49281342e4..e6f78a933d 100644 --- a/docs/cli/operator.mdx +++ b/docs/cli/operator.mdx @@ -575,7 +575,7 @@ Use the options listed below to change the command's behavior. These commands manage Nexus resources. -nexus commands follow this syntax: +Nexus commands follow this syntax: ``` temporal operator nexus [command] [subcommand] [options] @@ -595,10 +595,8 @@ temporal operator nexus endpoint [command] [options] 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. +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. @@ -846,10 +844,8 @@ Use the following options to change the behavior of this command. 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. +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. From 14978fde85b3f88ca2f7ca10f35bf00645515fa6 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Wed, 16 Oct 2024 13:04:39 -0500 Subject: [PATCH 10/10] running yarn format and removing duplicate note under target-url --- docs/cli/cmd-options.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx index 1446f22bab..ee859721f7 100644 --- a/docs/cli/cmd-options.mdx +++ b/docs/cli/cmd-options.mdx @@ -694,13 +694,6 @@ Caution: `--target-url` is experimental. ::: - -:::note - -Currently an experimental feature. - -::: - ## task-queue-type Task Queue type, which can be either workflow or activity.