From 736ad3ed3260cd6ef477a4baf594bdb38cae2340 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Wed, 14 Jun 2023 14:52:06 -0400 Subject: [PATCH] docs: note namespace apply/delete behaviors, fix metric (#17527) This changeset includes some fixes to documentation discovered while working on node pools, but we didn't want to include in the node pool PRs so they can get backported easily: * namespace apply/delete commands are forwarded to the authoritative region * deleting a namespace requires there are no non-terminal jobs in any of the federated regions * fixed a typo in the name of the `nomad.client.allocated.disk` metric --- command/namespace_apply.go | 4 +++- command/namespace_delete.go | 4 ++++ website/content/docs/commands/namespace/apply.mdx | 4 +++- website/content/docs/commands/namespace/delete.mdx | 4 ++++ website/content/docs/operations/metrics-reference.mdx | 2 +- 5 files changed, 15 insertions(+), 3 deletions(-) diff --git a/command/namespace_apply.go b/command/namespace_apply.go index 4186e7e24..0dbe6383c 100644 --- a/command/namespace_apply.go +++ b/command/namespace_apply.go @@ -34,7 +34,9 @@ Usage: nomad namespace apply [options] Instead of a file, you may instead pass the namespace name to create or update as the only argument. - If ACLs are enabled, this command requires a management ACL token. + If ACLs are enabled, this command requires a management ACL token. In + federated clusters, the namespace will be created in the authoritative region + and will be replicated to all federated regions. General Options: diff --git a/command/namespace_delete.go b/command/namespace_delete.go index ee8fcec18..fac47c74b 100644 --- a/command/namespace_delete.go +++ b/command/namespace_delete.go @@ -22,6 +22,10 @@ Usage: nomad namespace delete [options] If ACLs are enabled, this command requires a management ACL token. + You cannot delete a namespace that has non-terminal jobs. In federated + clusters, you cannot delete a namespace that has non-terminal jobs in any of + the federated regions. + General Options: ` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) diff --git a/website/content/docs/commands/namespace/apply.mdx b/website/content/docs/commands/namespace/apply.mdx index d9f4a854a..347fa969c 100644 --- a/website/content/docs/commands/namespace/apply.mdx +++ b/website/content/docs/commands/namespace/apply.mdx @@ -25,7 +25,9 @@ expected. Instead of a file, you may instead pass the namespace name to create or update as the only argument. -If ACLs are enabled, this command requires a management ACL token. +If ACLs are enabled, this command requires a management ACL token. In federated +clusters, the namespace will be created in the authoritative region and will be +replicated to all federated regions. ## General Options diff --git a/website/content/docs/commands/namespace/delete.mdx b/website/content/docs/commands/namespace/delete.mdx index 14b6cb719..5e2edef27 100644 --- a/website/content/docs/commands/namespace/delete.mdx +++ b/website/content/docs/commands/namespace/delete.mdx @@ -22,6 +22,10 @@ The `namespace delete` command requires the name of the namespace to be deleted. If ACLs are enabled, this command requires a management ACL token. +You cannot delete a namespace that has non-terminal jobs. In federated clusters, +you cannot delete a namespace that has non-terminal jobs in any of the federated +regions. + ## General Options @include 'general_options_no_namespace.mdx' diff --git a/website/content/docs/operations/metrics-reference.mdx b/website/content/docs/operations/metrics-reference.mdx index 539fd8977..48a600eb4 100644 --- a/website/content/docs/operations/metrics-reference.mdx +++ b/website/content/docs/operations/metrics-reference.mdx @@ -154,7 +154,7 @@ Nomad will emit [tagged metrics][tagged-metrics], in the below format: | --------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | ----- | ------------------------------------------------------------------------------------- | | `nomad.client.allocated.cpu` | Total amount of CPU shares the scheduler has allocated to tasks | Mhz | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | | `nomad.client.allocated.memory` | Total amount of memory the scheduler has allocated to tasks | Megabytes | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | -| `nomad.client.allocated_disk` | Total amount of disk space the scheduler has allocated to tasks | Megabytes | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | +| `nomad.client.allocated.disk` | Total amount of disk space the scheduler has allocated to tasks | Megabytes | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | | `nomad.client.allocations.blocked` | Number of allocations waiting for previous versions to exit | Integer | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | | `nomad.client.allocations.migrating` | Number of allocations migrating data from previous versions (see [`sticky`][sticky])| Integer | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status | | `nomad.client.allocations.pending` | Number of allocations pending (received by the client but not yet running) | Integer | Gauge | datacenter, host, node_class, node_id, node_scheduling_eligibility, node_status |