open-nomad/website/content/docs/commands/namespace/status.mdx
Luiz Aoqui d5aa72190f
node pools: namespace integration (#17562)
Add structs and fields to support the Nomad Pools Governance Enterprise
feature of controlling node pool access via namespaces.

Nomad Enterprise allows users to specify a default node pool to be used
by jobs that don't specify one. In order to accomplish this, it's
necessary to distinguish between a job that explicitly uses the
`default` node pool and one that did not specify any.

If the `default` node pool is set during job canonicalization it's
impossible to do this, so this commit allows a job to have an empty node
pool value during registration but sets to `default` at the admission
controller mutator.

In order to guarantee state consistency the state store validates that
the job node pool is set and exists before inserting it.
2023-06-16 16:30:22 -04:00

78 lines
1.7 KiB
Plaintext

---
layout: docs
page_title: 'Commands: namespace status'
description: >
The namespace status command is used to view the status of a particular
namespace.
---
# Command: namespace status
The `namespace status` command is used to view the status of a particular
namespace.
<Tip>
Visit the <a href="https://developer.hashicorp.com/nomad/tutorials/manage-clusters/namespaces">
Nomad Namespaces tutorial
</a> for more information.
</Tip>
## Usage
```plaintext
nomad namespace status [options] <namespace_name>
```
If ACLs are enabled, this command requires a management ACL token or a token
that has a capability associated with the namespace.
## General Options
@include 'general_options_no_namespace.mdx'
## Status Options
- `-json` : Output the namespace status in its JSON format.
- `-t` : Format and display the namespace status using a Go template.
## Examples
View the status of a namespace:
```shell-session
$ nomad namespace status default
Name = api-prod
Description = Prod API servers
Quota = prod
EnabledDrivers = docker,exec
DisabledDrivers = raw_exec
Metadata
contact = platform-eng@example.com
Quota Limits
Region CPU Usage Memory Usage
global 500 / 2500 256 / 2000
```
The `-json` flag can be used to get the namespace status in json format:
```shell-session
$ nomad namespace status -json default
{
"Capabilities": null,
"CreateIndex": 1,
"Description": "Default shared namespace",
"Meta": null,
"ModifyIndex": 1,
"Name": "default",
"Quota": ""
}
Or use the `-t` flag to format and display the status using a Go template:
```shell-session
$ nomad namespace status -t {{.Description}} default
Default shared namespace
```