Files
nomad/website/content/docs/commands/namespace/index.mdx
Tim Gross d3ddb0aa49 docs: make it clear that federation features require ACLs (#20196)
Our documentation has a hidden assumption that users know that federation
replication requires ACLs to be enabled and bootstrapped. Add notes at some of
the places users are likely to look for it.

A separate follow-up PR to the federation tutorial should point to the ACL
multi-region tutorial as well.

Fixes: https://github.com/hashicorp/nomad/issues/20128
2024-03-22 15:15:00 -04:00

42 lines
1.5 KiB
Plaintext

---
layout: docs
page_title: 'Commands: namespace'
description: |
The namespace command is used to interact with namespaces.
---
# Command: namespace
The `namespace` command is used to interact with namespaces.
<Tip>
Visit the <a href="https://developer.hashicorp.com/nomad/tutorials/manage-clusters/namespaces">
Nomad Namespaces tutorial
</a> for more information.
</Tip>
## Usage
Usage: `nomad namespace <subcommand> [options]`
Run `nomad namespace <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`namespace apply`][apply] - Create or update a namespace
- [`namespace delete`][delete] - Delete a namespace
- [`namespace inspect`][inspect] - Inspect a namespace
- [`namespace list`][list] - List available namespaces
- [`namespace status`][status] - Display a namespace's status
In [federated][] clusters, all namespace updates are forwarded to the
[`authoritative_region`][] and replicated to non-authoritative regions. This
requires that ACLs have been bootstrapped in the authoritative region.
[apply]: /nomad/docs/commands/namespace/apply 'Create or update a namespace'
[delete]: /nomad/docs/commands/namespace/delete 'Delete a namespace'
[inspect]: /nomad/docs/commands/namespace/inspect 'Inspect a namespace'
[list]: /nomad/docs/commands/namespace/list 'List available namespaces'
[status]: /nomad/docs/commands/namespace/status "Display a namespace's status"
[federated]: /nomad/tutorials/manage-clusters/federation
[`authoritative_region`]: /nomad/docs/configuration/server#authoritative_region