diff --git a/temporalcli/commands.gen.go b/temporalcli/commands.gen.go index 9e2a0296..2f400318 100644 --- a/temporalcli/commands.gen.go +++ b/temporalcli/commands.gen.go @@ -822,11 +822,11 @@ func NewTemporalOperatorNexusCommand(cctx *CommandContext, parent *TemporalOpera var s TemporalOperatorNexusCommand s.Parent = parent s.Command.Use = "nexus" - s.Command.Short = "Commands for managing Nexus resources (EXPERIMENTAL)." + s.Command.Short = "Commands for managing Nexus resources (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "Nexus commands enable managing Nexus resources.\n\nNexus commands follow this syntax: \x1b[1mtemporal operator nexus [command] [command] [command options]\x1b[0m" + s.Command.Long = "Nexus commands enable managing Nexus resources.\n\nNexus commands follow this syntax:\n\n\x1b[1mtemporal operator nexus [command] [command] [command options]\x1b[0m" } else { - s.Command.Long = "Nexus commands enable managing Nexus resources.\n\nNexus commands follow this syntax: `temporal operator nexus [command] [command] [command options]`" + s.Command.Long = "Nexus commands enable managing Nexus resources.\n\nNexus commands follow this syntax:\n\n```\ntemporal operator nexus [command] [command] [command options]\n```" } s.Command.Args = cobra.NoArgs s.Command.AddCommand(&NewTemporalOperatorNexusEndpointCommand(cctx, &s).Command) @@ -842,11 +842,11 @@ func NewTemporalOperatorNexusEndpointCommand(cctx *CommandContext, parent *Tempo var s TemporalOperatorNexusEndpointCommand s.Parent = parent s.Command.Use = "endpoint" - s.Command.Short = "Commands for managing Nexus Endpoints (EXPERIMENTAL)." + s.Command.Short = "Commands for managing Nexus Endpoints (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "Endpoint commands enable managing Nexus Endpoints.\n\nEndpoint commands follow this syntax: \x1b[1mtemporal operator nexus endpoint [command] [command options]\x1b[0m" + s.Command.Long = "Endpoint commands enable managing Nexus Endpoints.\n\nEndpoint commands follow this syntax:\n\n\x1b[1mtemporal operator nexus endpoint [command] [command options]\x1b[0m" } else { - s.Command.Long = "Endpoint commands enable managing Nexus Endpoints.\n\nEndpoint commands follow this syntax: `temporal operator nexus endpoint [command] [command options]`" + s.Command.Long = "Endpoint commands enable managing Nexus Endpoints.\n\nEndpoint commands follow this syntax:\n\n```\ntemporal operator nexus endpoint [command] [command options]\n```" } s.Command.Args = cobra.NoArgs s.Command.AddCommand(&NewTemporalOperatorNexusEndpointCreateCommand(cctx, &s).Command) @@ -873,11 +873,11 @@ func NewTemporalOperatorNexusEndpointCreateCommand(cctx *CommandContext, parent s.Parent = parent s.Command.DisableFlagsInUseLine = true s.Command.Use = "create [flags]" - s.Command.Short = "Create a new Nexus Endpoint (EXPERIMENTAL)." + s.Command.Short = "Create a new Nexus Endpoint (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "The temporal operator nexus endpoint create command creates a new Nexus Endpoint on the Server.\n\nAn endpoint name is used by in workflow code to invoke Nexus operations.\nThe endpoint target may either be a worker, in which case \x1b[1m--target-namespace\x1b[0m and \x1b[1m--target-task-queue\x1b[0m must both be\nprovided, or an external URL, in which case \x1b[1m--target-url\x1b[0m must be provided.\n\nThis will fail if an endpoint with the same name is already registered.\n\n\x1b[1mtemporal operator nexus endpoint create \\\n --name my-endpoint \\\n --target-namespace my-namespace \\\n --target-task-queue my-task-queue \\\n --description-file DESCRIPTION.md\x1b[0m" + s.Command.Long = "Create a new Nexus Endpoint on the Server.\n\nAn endpoint name is used in workflow code to invoke Nexus operations. The\nendpoint target may either be a worker, in which case \x1b[1m--target-namespace\x1b[0m and\n\x1b[1m--target-task-queue\x1b[0m must both be provided, or an external URL, in which case\n\x1b[1m--target-url\x1b[0m must be provided.\n\nThis command will fail if an endpoint with the same name is already registered.\n\n\x1b[1mtemporal operator nexus endpoint create \\\n --name your-endpoint \\\n --target-namespace your-namespace \\\n --target-task-queue your-task-queue \\\n --description-file DESCRIPTION.md\x1b[0m" } else { - s.Command.Long = "The temporal operator nexus endpoint create command creates a new Nexus Endpoint on the Server.\n\nAn endpoint name is used by in workflow code to invoke Nexus operations.\nThe endpoint target may either be a worker, in which case `--target-namespace` and `--target-task-queue` must both be\nprovided, or an external URL, in which case `--target-url` must be provided.\n\nThis will fail if an endpoint with the same name is already registered.\n\n```\ntemporal operator nexus endpoint create \\\n --name my-endpoint \\\n --target-namespace my-namespace \\\n --target-task-queue my-task-queue \\\n --description-file DESCRIPTION.md\n```" + s.Command.Long = "Create a new Nexus Endpoint on the Server.\n\nAn endpoint name is used in workflow code to invoke Nexus operations. The\nendpoint target may either be a worker, in which case `--target-namespace` and\n`--target-task-queue` must both be provided, or an external URL, in which case\n`--target-url` must be provided.\n\nThis command will fail if an endpoint with the same name is already registered.\n\n```\ntemporal operator nexus endpoint create \\\n --name your-endpoint \\\n --target-namespace your-namespace \\\n --target-task-queue your-task-queue \\\n --description-file DESCRIPTION.md\n```" } s.Command.Args = cobra.NoArgs s.Command.Flags().StringVar(&s.Name, "name", "", "Endpoint name. Required.") @@ -906,11 +906,11 @@ func NewTemporalOperatorNexusEndpointDeleteCommand(cctx *CommandContext, parent s.Parent = parent s.Command.DisableFlagsInUseLine = true s.Command.Use = "delete [flags]" - s.Command.Short = "Delete a Nexus Endpoint (EXPERIMENTAL)." + s.Command.Short = "Delete a Nexus Endpoint (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "The temporal operator nexus endpoint delete deletes a Nexus Endpoint configuration from the Server.\n\n\x1b[1mtemporal operator nexus endpoint delete --name my-endpoint\x1b[0m" + s.Command.Long = "Delete a Nexus Endpoint configuration from the Server.\n\n\x1b[1mtemporal operator nexus endpoint delete --name your-endpoint\x1b[0m" } else { - s.Command.Long = "The temporal operator nexus endpoint delete deletes a Nexus Endpoint configuration from the Server.\n\n```\ntemporal operator nexus endpoint delete --name my-endpoint\n```" + s.Command.Long = "Delete a Nexus Endpoint configuration from the Server.\n\n```\ntemporal operator nexus endpoint delete --name your-endpoint\n```" } s.Command.Args = cobra.NoArgs s.Command.Flags().StringVar(&s.Name, "name", "", "Endpoint name. Required.") @@ -934,11 +934,11 @@ func NewTemporalOperatorNexusEndpointGetCommand(cctx *CommandContext, parent *Te s.Parent = parent s.Command.DisableFlagsInUseLine = true s.Command.Use = "get [flags]" - s.Command.Short = "Get a Nexus Endpoint by name (EXPERIMENTAL)." + s.Command.Short = "Get a Nexus Endpoint by name (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "The temporal operator nexus endpoint get gets a Nexus Endpoint configuration by name from the Server.\n\n\x1b[1mtemporal operator nexus endpoint get --name my-endpoint\x1b[0m" + s.Command.Long = "Get a Nexus Endpoint configuration by name from the Server.\n\n\x1b[1mtemporal operator nexus endpoint get --name your-endpoint\x1b[0m" } else { - s.Command.Long = "The temporal operator nexus endpoint get gets a Nexus Endpoint configuration by name from the Server.\n\n```\ntemporal operator nexus endpoint get --name my-endpoint\n```" + s.Command.Long = "Get a Nexus Endpoint configuration by name from the Server.\n\n```\ntemporal operator nexus endpoint get --name your-endpoint\n```" } s.Command.Args = cobra.NoArgs s.Command.Flags().StringVar(&s.Name, "name", "", "Endpoint name. Required.") @@ -961,11 +961,11 @@ func NewTemporalOperatorNexusEndpointListCommand(cctx *CommandContext, parent *T s.Parent = parent s.Command.DisableFlagsInUseLine = true s.Command.Use = "list [flags]" - s.Command.Short = "List Nexus Endpoints (EXPERIMENTAL)." + s.Command.Short = "List Nexus Endpoints (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "The temporal operator nexus endpoint list lists all Nexus Endpoint configurations on the Server.\n\n\x1b[1mtemporal operator nexus endpoint list\x1b[0m" + s.Command.Long = "List all Nexus Endpoint configurations on the Server.\n\n\x1b[1mtemporal operator nexus endpoint list\x1b[0m" } else { - s.Command.Long = "The temporal operator nexus endpoint list lists all Nexus Endpoint configurations on the Server.\n\n```\ntemporal operator nexus endpoint list\n```" + s.Command.Long = "List all Nexus Endpoint configurations on the Server.\n\n```\ntemporal operator nexus endpoint list\n```" } s.Command.Args = cobra.NoArgs s.Command.Run = func(c *cobra.Command, args []string) { @@ -993,11 +993,11 @@ func NewTemporalOperatorNexusEndpointUpdateCommand(cctx *CommandContext, parent s.Parent = parent s.Command.DisableFlagsInUseLine = true s.Command.Use = "update [flags]" - s.Command.Short = "Update an existing Nexus Endpoint (EXPERIMENTAL)." + s.Command.Short = "Update an existing Nexus Endpoint (EXPERIMENTAL)" if hasHighlighting { - s.Command.Long = "The temporal operator nexus endpoint update command updates an existing Nexus Endpoint on the Server.\n\nAn endpoint name is used by in workflow code to invoke Nexus operations.\nThe endpoint target may either be a worker, in which case \x1b[1m--target-namespace\x1b[0m and \x1b[1m--target-task-queue\x1b[0m must both be\nprovided, or an external URL, in which case \x1b[1m--target-url\x1b[0m must be provided.\n\nThe endpoint is patched leaving any existing fields for which flags are not provided as they were.\n\n**Update only the target task queue**:\n\n\x1b[1mtemporal operator nexus endpoint update \\\n --name my-endpoint \\\n --target-task-queue my-other-queue\x1b[0m\n\n**Update only the description**:\n\n\x1b[1mtemporal operator nexus endpoint update \\\n --name my-endpoint \\\n --description-file DESCRIPTION.md\x1b[0m" + s.Command.Long = "Update an existing Nexus Endpoint on the Server.\n\nAn endpoint name is used in workflow code to invoke Nexus operations. The\nendpoint target may either be a worker, in which case \x1b[1m--target-namespace\x1b[0m and\n\x1b[1m--target-task-queue\x1b[0m must both be provided, or an external URL, in which case\n\x1b[1m--target-url\x1b[0m must be provided.\n\nThe endpoint is patched; existing fields for which flags are not provided are\nleft as they were.\n\nUpdate only the target task queue:\n\n\x1b[1mtemporal operator nexus endpoint update \\\n --name your-endpoint \\\n --target-task-queue your-other-queue\x1b[0m\n\nUpdate only the description:\n\n\x1b[1mtemporal operator nexus endpoint update \\\n --name your-endpoint \\\n --description-file DESCRIPTION.md\x1b[0m" } else { - s.Command.Long = "The temporal operator nexus endpoint update command updates an existing Nexus Endpoint on the Server.\n\nAn endpoint name is used by in workflow code to invoke Nexus operations.\nThe endpoint target may either be a worker, in which case `--target-namespace` and `--target-task-queue` must both be\nprovided, or an external URL, in which case `--target-url` must be provided.\n\nThe endpoint is patched leaving any existing fields for which flags are not provided as they were.\n\n**Update only the target task queue**:\n\n```\ntemporal operator nexus endpoint update \\\n --name my-endpoint \\\n --target-task-queue my-other-queue\n```\n\n**Update only the description**:\n\n```\ntemporal operator nexus endpoint update \\\n --name my-endpoint \\\n --description-file DESCRIPTION.md\n```" + s.Command.Long = "Update an existing Nexus Endpoint on the Server.\n\nAn endpoint name is used in workflow code to invoke Nexus operations. The\nendpoint target may either be a worker, in which case `--target-namespace` and\n`--target-task-queue` must both be provided, or an external URL, in which case\n`--target-url` must be provided.\n\nThe endpoint is patched; existing fields for which flags are not provided are\nleft as they were.\n\nUpdate only the target task queue:\n\n```\ntemporal operator nexus endpoint update \\\n --name your-endpoint \\\n --target-task-queue your-other-queue\n```\n\nUpdate only the description:\n\n```\ntemporal operator nexus endpoint update \\\n --name your-endpoint \\\n --description-file DESCRIPTION.md\n```" } s.Command.Args = cobra.NoArgs s.Command.Flags().StringVar(&s.Name, "name", "", "Endpoint name. Required.") @@ -1585,9 +1585,9 @@ func NewTemporalTaskQueueDescribeCommand(cctx *CommandContext, parent *TemporalT s.Command.Use = "describe [flags]" s.Command.Short = "Show active Workers" if hasHighlighting { - s.Command.Long = "Display a list of active Workers that have recently polled a Task Queue. The\nTemporal Server records each poll request time. A \x1b[1mLastAccessTime\x1b[0m over one\nminute may indicate the Worker is at capacity or has shut down. Temporal\nWorkers are removed if 5 minutes have passed since the last poll request.\n\nInformation about the Task Queue can be returned to troubleshoot server issues.\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue\x1b[0m\n\nThis command provides poller information for a given Task Queue.\nWorkflow and Activity polling use separate Task Queues:\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --task-queue-type \"activity\"\x1b[1m\x1b[0m\n\nThis command provides the following task queue statistics:\n- \x1b[0mApproximateBacklogCount\x1b[1m: The approximate number of tasks backlogged in this\n task queue. May count expired tasks but eventually converges to the right\n value.\n- \x1b[0mApproximateBacklogAge\x1b[1m: Approximate age of the oldest task in the backlog\n based on the creation time of the task at the head of the queue, measured in\n seconds.\n- \x1b[0mTasksAddRate\x1b[1m: Approximate tasks per second added to the task queue,\n averaging over the last 30 seconds. Includes tasks whether or not they were\n added from the backlog or those that were dispatched immediately without going\n to the backlog (sync-matched).\n- \x1b[0mTasksDispatchRate\x1b[1m: Approximate tasks per second dispatched to the task\n queue, averaging over the last 30 seconds. Includes tasks whether or not they\n were dispatched from the backlog or those that were dispatched immediately\n without going to the backlog (sync-matched).\n- \x1b[0mBacklog Increase Rate\x1b[1m: Approximate net tasks per second added to the\n backlog, averaging the last 30 seconds. This is calculated as\n \x1b[0mTasksAddRate\x1b[1m - \x1b[0mTasksDispatchRate\x1b[1m.\n\nSafely retire Workers assigned a Build ID by checking reachability across\nall task types. Use the flag \x1b[0m--report-reachability\x1b[1m:\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --build-id \"YourBuildId\" \\\n --report-reachability\x1b[0m\n\nTask reachability information is returned for the requested versions and all\ntask types, which can be used to safely retire Workers with old code versions,\nprovided that they were assigned a Build ID.\n\nNote that task reachability status is experimental and may significantly change\nor be removed in a future release. Also, determining task reachability incurs a\nnon-trivial computing cost.\n\nTask reachability states are reported per build ID. The state may be one of the\nfollowing:\n\n- \x1b[0mReachable\x1b[1m: using the current versioning rules, the Build ID may be used\n by new Workflow Executions or Activities OR there are currently open\n Workflow or backlogged Activity tasks assigned to the queue.\n- \x1b[0mClosedWorkflowsOnly\x1b[1m: the Build ID does not have open Workflow Executions\n and can't be reached by new Workflow Executions. It MAY have closed\n Workflow Executions within the Namespace retention period.\n- \x1b[0mUnreachable\x1b[1m: this Build ID is not used for new Workflow Executions and\n isn't used by any existing Workflow Execution within the retention period.\n\nTask reachability is eventually consistent. You may experience a delay until\nreachability converges to the most accurate value. This is designed to act\nin the most conservative way until convergence. For example, \x1b[0mReachable\x1b[1m is\nmore conservative than \x1b[0mClosedWorkflowsOnly`." + s.Command.Long = "Display a list of active Workers that have recently polled a Task Queue. The\nTemporal Server records each poll request time. A \x1b[1mLastAccessTime\x1b[0m over one\nminute may indicate the Worker is at capacity or has shut down. Temporal\nWorkers are removed if 5 minutes have passed since the last poll request.\n\nInformation about the Task Queue can be returned to troubleshoot server issues.\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue\x1b[0m\n\nThis command provides poller information for a given Task Queue.\nWorkflow and Activity polling use separate Task Queues:\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --task-queue-type \"activity\"\x1b[1m\x1b[0m\n\nThis command provides the following task queue statistics:\n- \x1b[0mApproximateBacklogCount\x1b[1m: The approximate number of tasks backlogged in this\n task queue. May count expired tasks but eventually converges to the right\n value.\n- \x1b[0mApproximateBacklogAge\x1b[1m: How far \"behind\" the task queue is running. This is\n the difference in age between the oldest and newest tasks in the backlog,\n measured in seconds.\n- \x1b[0mTasksAddRate\x1b[1m: Approximate rate at which tasks are being added to the task\n queue, measured in tasks per second, averaged over the last 30 seconds.\n Includes tasks dispatched immediately without going to the backlog\n (sync-matched tasks), as well as tasks added to the backlog.\n- \x1b[0mTasksDispatchRate\x1b[1m: Approximate rate at which tasks are being dispatched from\n the task queue, measured in tasks per second, averaged over the last 30\n seconds. Includes tasks dispatched immediately without going to the backlog\n (sync-matched tasks), as well as tasks added to the backlog.\n- \x1b[0mBacklog Increase Rate\x1b[1m: Approximate rate at which the backlog size is\n increasing (if positive) or decreasing (if negative), measured in tasks per\n second, averaged over the last 30 seconds. This is equivalent to:\n \x1b[0mTasksAddRate\x1b[1m - \x1b[0mTasksDispatchRate\x1b[1m.\n\nSafely retire Workers assigned a Build ID by checking reachability across\nall task types. Use the flag \x1b[0m--report-reachability\x1b[1m:\n\n\x1b[1mtemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --build-id \"YourBuildId\" \\\n --report-reachability\x1b[0m\n\nTask reachability information is returned for the requested versions and all\ntask types, which can be used to safely retire Workers with old code versions,\nprovided that they were assigned a Build ID.\n\nNote that task reachability status is experimental and may significantly change\nor be removed in a future release. Also, determining task reachability incurs a\nnon-trivial computing cost.\n\nTask reachability states are reported per build ID. The state may be one of the\nfollowing:\n\n- \x1b[0mReachable\x1b[1m: using the current versioning rules, the Build ID may be used\n by new Workflow Executions or Activities OR there are currently open\n Workflow or backlogged Activity tasks assigned to the queue.\n- \x1b[0mClosedWorkflowsOnly\x1b[1m: the Build ID does not have open Workflow Executions\n and can't be reached by new Workflow Executions. It MAY have closed\n Workflow Executions within the Namespace retention period.\n- \x1b[0mUnreachable\x1b[1m: this Build ID is not used for new Workflow Executions and\n isn't used by any existing Workflow Execution within the retention period.\n\nTask reachability is eventually consistent. You may experience a delay until\nreachability converges to the most accurate value. This is designed to act\nin the most conservative way until convergence. For example, \x1b[0mReachable\x1b[1m is\nmore conservative than \x1b[0mClosedWorkflowsOnly`." } else { - s.Command.Long = "Display a list of active Workers that have recently polled a Task Queue. The\nTemporal Server records each poll request time. A `LastAccessTime` over one\nminute may indicate the Worker is at capacity or has shut down. Temporal\nWorkers are removed if 5 minutes have passed since the last poll request.\n\nInformation about the Task Queue can be returned to troubleshoot server issues.\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue\n```\n\nThis command provides poller information for a given Task Queue.\nWorkflow and Activity polling use separate Task Queues:\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --task-queue-type \"activity\"`\n```\n\nThis command provides the following task queue statistics:\n- `ApproximateBacklogCount`: The approximate number of tasks backlogged in this\n task queue. May count expired tasks but eventually converges to the right\n value.\n- `ApproximateBacklogAge`: Approximate age of the oldest task in the backlog\n based on the creation time of the task at the head of the queue, measured in\n seconds.\n- `TasksAddRate`: Approximate tasks per second added to the task queue,\n averaging over the last 30 seconds. Includes tasks whether or not they were\n added from the backlog or those that were dispatched immediately without going\n to the backlog (sync-matched).\n- `TasksDispatchRate`: Approximate tasks per second dispatched to the task\n queue, averaging over the last 30 seconds. Includes tasks whether or not they\n were dispatched from the backlog or those that were dispatched immediately\n without going to the backlog (sync-matched).\n- `Backlog Increase Rate`: Approximate net tasks per second added to the\n backlog, averaging the last 30 seconds. This is calculated as\n `TasksAddRate` - `TasksDispatchRate`.\n\nSafely retire Workers assigned a Build ID by checking reachability across\nall task types. Use the flag `--report-reachability`:\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --build-id \"YourBuildId\" \\\n --report-reachability\n```\n\nTask reachability information is returned for the requested versions and all\ntask types, which can be used to safely retire Workers with old code versions,\nprovided that they were assigned a Build ID.\n\nNote that task reachability status is experimental and may significantly change\nor be removed in a future release. Also, determining task reachability incurs a\nnon-trivial computing cost.\n\nTask reachability states are reported per build ID. The state may be one of the\nfollowing:\n\n- `Reachable`: using the current versioning rules, the Build ID may be used\n by new Workflow Executions or Activities OR there are currently open\n Workflow or backlogged Activity tasks assigned to the queue.\n- `ClosedWorkflowsOnly`: the Build ID does not have open Workflow Executions\n and can't be reached by new Workflow Executions. It MAY have closed\n Workflow Executions within the Namespace retention period.\n- `Unreachable`: this Build ID is not used for new Workflow Executions and\n isn't used by any existing Workflow Execution within the retention period.\n\nTask reachability is eventually consistent. You may experience a delay until\nreachability converges to the most accurate value. This is designed to act\nin the most conservative way until convergence. For example, `Reachable` is\nmore conservative than `ClosedWorkflowsOnly`." + s.Command.Long = "Display a list of active Workers that have recently polled a Task Queue. The\nTemporal Server records each poll request time. A `LastAccessTime` over one\nminute may indicate the Worker is at capacity or has shut down. Temporal\nWorkers are removed if 5 minutes have passed since the last poll request.\n\nInformation about the Task Queue can be returned to troubleshoot server issues.\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue\n```\n\nThis command provides poller information for a given Task Queue.\nWorkflow and Activity polling use separate Task Queues:\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --task-queue-type \"activity\"`\n```\n\nThis command provides the following task queue statistics:\n- `ApproximateBacklogCount`: The approximate number of tasks backlogged in this\n task queue. May count expired tasks but eventually converges to the right\n value.\n- `ApproximateBacklogAge`: How far \"behind\" the task queue is running. This is\n the difference in age between the oldest and newest tasks in the backlog,\n measured in seconds.\n- `TasksAddRate`: Approximate rate at which tasks are being added to the task\n queue, measured in tasks per second, averaged over the last 30 seconds.\n Includes tasks dispatched immediately without going to the backlog\n (sync-matched tasks), as well as tasks added to the backlog.\n- `TasksDispatchRate`: Approximate rate at which tasks are being dispatched from\n the task queue, measured in tasks per second, averaged over the last 30\n seconds. Includes tasks dispatched immediately without going to the backlog\n (sync-matched tasks), as well as tasks added to the backlog.\n- `Backlog Increase Rate`: Approximate rate at which the backlog size is\n increasing (if positive) or decreasing (if negative), measured in tasks per\n second, averaged over the last 30 seconds. This is equivalent to:\n `TasksAddRate` - `TasksDispatchRate`.\n\nSafely retire Workers assigned a Build ID by checking reachability across\nall task types. Use the flag `--report-reachability`:\n\n```\ntemporal task-queue describe \\\n --task-queue YourTaskQueue \\\n --build-id \"YourBuildId\" \\\n --report-reachability\n```\n\nTask reachability information is returned for the requested versions and all\ntask types, which can be used to safely retire Workers with old code versions,\nprovided that they were assigned a Build ID.\n\nNote that task reachability status is experimental and may significantly change\nor be removed in a future release. Also, determining task reachability incurs a\nnon-trivial computing cost.\n\nTask reachability states are reported per build ID. The state may be one of the\nfollowing:\n\n- `Reachable`: using the current versioning rules, the Build ID may be used\n by new Workflow Executions or Activities OR there are currently open\n Workflow or backlogged Activity tasks assigned to the queue.\n- `ClosedWorkflowsOnly`: the Build ID does not have open Workflow Executions\n and can't be reached by new Workflow Executions. It MAY have closed\n Workflow Executions within the Namespace retention period.\n- `Unreachable`: this Build ID is not used for new Workflow Executions and\n isn't used by any existing Workflow Execution within the retention period.\n\nTask reachability is eventually consistent. You may experience a delay until\nreachability converges to the most accurate value. This is designed to act\nin the most conservative way until convergence. For example, `Reachable` is\nmore conservative than `ClosedWorkflowsOnly`." } s.Command.Args = cobra.NoArgs s.Command.Flags().StringVarP(&s.TaskQueue, "task-queue", "t", "", "Task queue name. Required.") diff --git a/temporalcli/commandsmd/commands.md b/temporalcli/commandsmd/commands.md index 51ac0775..dde1798a 100644 --- a/temporalcli/commandsmd/commands.md +++ b/temporalcli/commandsmd/commands.md @@ -876,112 +876,141 @@ temporal operator namespace update \ Archive visibility data to this `URI`. Once enabled, can't be changed. -### temporal operator nexus: Commands for managing Nexus resources (EXPERIMENTAL). +### temporal operator nexus: Commands for managing Nexus resources (EXPERIMENTAL) Nexus commands enable managing Nexus resources. -Nexus commands follow this syntax: `temporal operator nexus [command] [command] [command options]` +Nexus commands follow this syntax: -### temporal operator nexus endpoint: Commands for managing Nexus Endpoints (EXPERIMENTAL). +``` +temporal operator nexus [command] [command] [command options] +``` + +### temporal operator nexus endpoint: Commands for managing Nexus Endpoints (EXPERIMENTAL) Endpoint commands enable managing Nexus Endpoints. -Endpoint commands follow this syntax: `temporal operator nexus endpoint [command] [command options]` +Endpoint commands follow this syntax: + +``` +temporal operator nexus endpoint [command] [command options] +``` -### temporal operator nexus endpoint create: Create a new Nexus Endpoint (EXPERIMENTAL). +### temporal operator nexus endpoint create: Create a new Nexus Endpoint (EXPERIMENTAL) -The temporal operator nexus endpoint create command creates a new Nexus Endpoint on the Server. +Create a new Nexus Endpoint on the Server. -An endpoint name is used by 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. +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 will fail if an endpoint with the same name is already registered. +This command will fail if an endpoint with the same name is already registered. ``` temporal operator nexus endpoint create \ - --name my-endpoint \ - --target-namespace my-namespace \ - --target-task-queue my-task-queue \ + --name your-endpoint \ + --target-namespace your-namespace \ + --target-task-queue your-task-queue \ --description-file DESCRIPTION.md ``` #### Options -* `--name` (string) - Endpoint name. Required. -* `--description` (string) - Endpoint description in markdown format (encoded using the configured codec server). -* `--description-file` (string) - Endpoint description file in markdown format (encoded using the configured codec server). -* `--target-namespace` (string) - Namespace in which a handler worker will be polling for Nexus tasks on. -* `--target-task-queue` (string) - Task Queue in which a handler worker will be polling for Nexus tasks on. -* `--target-url` (string) - URL to direct Nexus requests to. +* `--name` (string) - + Endpoint name. Required. +* `--description` (string) - + Endpoint description in markdown format (encoded using the configured codec server). +* `--description-file` (string) - + Endpoint description file in markdown format (encoded using the configured codec server). +* `--target-namespace` (string) - + Namespace in which a handler worker will be polling for Nexus tasks on. +* `--target-task-queue` (string) - + Task Queue in which a handler worker will be polling for Nexus tasks on. +* `--target-url` (string) - + URL to direct Nexus requests to. -### temporal operator nexus endpoint delete: Delete a Nexus Endpoint (EXPERIMENTAL). +### temporal operator nexus endpoint delete: Delete a Nexus Endpoint (EXPERIMENTAL) -The temporal operator nexus endpoint delete deletes a Nexus Endpoint configuration from the Server. +Delete a Nexus Endpoint configuration from the Server. ``` -temporal operator nexus endpoint delete --name my-endpoint +temporal operator nexus endpoint delete --name your-endpoint ``` #### Options -* `--name` (string) - Endpoint name. Required. +* `--name` (string) - + Endpoint name. + Required. -### temporal operator nexus endpoint get: Get a Nexus Endpoint by name (EXPERIMENTAL). +### temporal operator nexus endpoint get: Get a Nexus Endpoint by name (EXPERIMENTAL) -The temporal operator nexus endpoint get gets a Nexus Endpoint configuration by name from the Server. +Get a Nexus Endpoint configuration by name from the Server. ``` -temporal operator nexus endpoint get --name my-endpoint +temporal operator nexus endpoint get --name your-endpoint ``` #### Options -* `--name` (string) - Endpoint name. Required. +* `--name` (string) - + Endpoint name. + Required. -### temporal operator nexus endpoint list: List Nexus Endpoints (EXPERIMENTAL). +### temporal operator nexus endpoint list: List Nexus Endpoints (EXPERIMENTAL) -The temporal operator nexus endpoint list lists all Nexus Endpoint configurations on the Server. +List all Nexus Endpoint configurations on the Server. ``` temporal operator nexus endpoint list ``` -### temporal operator nexus endpoint update: Update an existing Nexus Endpoint (EXPERIMENTAL). +### temporal operator nexus endpoint update: Update an existing Nexus Endpoint (EXPERIMENTAL) -The temporal operator nexus endpoint update command updates an existing Nexus Endpoint on the Server. +Update an existing Nexus Endpoint on the Server. -An endpoint name is used by 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. +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 leaving any existing fields for which flags are not provided as they were. +The endpoint is patched; existing fields for which flags are not provided are +left as they were. -**Update only the target task queue**: +Update only the target task queue: ``` temporal operator nexus endpoint update \ - --name my-endpoint \ - --target-task-queue my-other-queue + --name your-endpoint \ + --target-task-queue your-other-queue ``` -**Update only the description**: +Update only the description: ``` temporal operator nexus endpoint update \ - --name my-endpoint \ + --name your-endpoint \ --description-file DESCRIPTION.md ``` #### Options -* `--name` (string) - Endpoint name. Required. -* `--description` (string) - Endpoint description in markdown format (encoded using the configured codec server). -* `--description-file` (string) - Endpoint description file in markdown format (encoded using the configured codec server). -* `--unset-description` (bool) - Unset the description. -* `--target-namespace` (string) - Namespace in which a handler worker will be polling for Nexus tasks on. -* `--target-task-queue` (string) - Task Queue in which a handler worker will be polling for Nexus tasks on. -* `--target-url` (string) - URL to direct Nexus requests to. +* `--name` (string) - + Endpoint name. + Required. +* `--description` (string) - + Endpoint description in markdown format (encoded using the configured codec server). +* `--description-file` (string) - + Endpoint description file in markdown format (encoded using the configured codec server). +* `--unset-description` (bool) - + Unset the description. +* `--target-namespace` (string) - + Namespace in which a handler worker will be polling for Nexus tasks on. +* `--target-task-queue` (string) - + Task Queue in which a handler worker will be polling for Nexus tasks on. +* `--target-url` (string) - + URL to direct Nexus requests to. ### temporal operator search-attribute: Search Attribute operations @@ -1490,19 +1519,20 @@ This command provides the following task queue statistics: - `ApproximateBacklogCount`: The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges to the right value. -- `ApproximateBacklogAge`: Approximate age of the oldest task in the backlog - based on the creation time of the task at the head of the queue, measured in - seconds. -- `TasksAddRate`: Approximate tasks per second added to the task queue, - averaging over the last 30 seconds. Includes tasks whether or not they were - added from the backlog or those that were dispatched immediately without going - to the backlog (sync-matched). -- `TasksDispatchRate`: Approximate tasks per second dispatched to the task - queue, averaging over the last 30 seconds. Includes tasks whether or not they - were dispatched from the backlog or those that were dispatched immediately - without going to the backlog (sync-matched). -- `Backlog Increase Rate`: Approximate net tasks per second added to the - backlog, averaging the last 30 seconds. This is calculated as +- `ApproximateBacklogAge`: How far "behind" the task queue is running. This is + the difference in age between the oldest and newest tasks in the backlog, + measured in seconds. +- `TasksAddRate`: Approximate rate at which tasks are being added to the task + queue, measured in tasks per second, averaged over the last 30 seconds. + Includes tasks dispatched immediately without going to the backlog + (sync-matched tasks), as well as tasks added to the backlog. +- `TasksDispatchRate`: Approximate rate at which tasks are being dispatched from + the task queue, measured in tasks per second, averaged over the last 30 + seconds. Includes tasks dispatched immediately without going to the backlog + (sync-matched tasks), as well as tasks added to the backlog. +- `Backlog Increase Rate`: Approximate rate at which the backlog size is + increasing (if positive) or decreasing (if negative), measured in tasks per + second, averaged over the last 30 seconds. This is equivalent to: `TasksAddRate` - `TasksDispatchRate`. Safely retire Workers assigned a Build ID by checking reachability across