Skip to content

Commit

Permalink
docs: namespaces are oss in Nomad 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
schmichael committed Oct 22, 2020
1 parent 6c2f589 commit 47b8db8
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 38 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
FEATURES:

* **Event Stream**: Subscribe to change events as they occur in real time. [[GH-9013](https://github.com/hashicorp/nomad/issues/9013)]
* **Namespaces OSS**: Namespaces are now available in open source Nomad. [[GH-9135](https://github.com/hashicorp/nomad/issues/9135)]
* **Topology Visualization**: See all of the clients and allocations in a cluster at once. [[GH-9077](https://github.com/hashicorp/nomad/issues/9077)]

IMPROVEMENTS:
Expand Down
5 changes: 4 additions & 1 deletion website/pages/api-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ $ curl \

## Namespaces

Nomad Enterprise has support for namespaces, which allow jobs and their associated objects to be segmented from each other and other users of the cluster. When using non-default namespace, the API request must pass the target namespace as an API query parameter.
Nomad has support for namespaces, which allow jobs and their associated objects
to be segmented from each other and other users of the cluster. When using
non-default namespace, the API request must pass the target namespace as an API
query parameter. Prior to Nomad 1.0 namespaces were Enterprise-only.

Here is an example using curl:

Expand Down
2 changes: 1 addition & 1 deletion website/pages/api-docs/json-jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ The `Job` object supports the following keys:
- `Meta` - Annotates the job with opaque metadata.

- `Namespace` - The namespace to execute the job in, defaults to "default".
Values other than default are not allowed in non-Enterprise versions of Nomad.
Prior to Nomad 1.0 namespaces were Enterprise-only.

- `ParameterizedJob` - Specifies the job as a parameterized job such that it can
be dispatched against. The `ParameterizedJob` object supports the following
Expand Down
3 changes: 1 addition & 2 deletions website/pages/api-docs/namespaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ description: The /namespace endpoints are used to query for and interact with na

The `/namespace` endpoints are used to query for and interact with namespaces.

~> **Enterprise Only!** This API endpoint and functionality only exists in
Nomad Enterprise. This is not present in the open source version of Nomad.
~> Prior to Nomad 1.0 Namespaces were an Enterprise-only feature.

## List Namespaces

Expand Down
5 changes: 3 additions & 2 deletions website/pages/api-docs/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ description: The /search endpoint is used to search for Nomad objects

The `/search` endpoint returns matches for a given prefix and context, where a
context can be jobs, allocations, evaluations, nodes, deployments, plugins,
or volumes. When using Nomad Enterprise, the allowed contexts include quotas
and namespaces. Additionally, a prefix can be searched for within every context.
namespaces, or volumes. When using Nomad Enterprise, the allowed contexts
include quotas. Additionally, a prefix can be searched for within every
context.

| Method | Path | Produces |
| ------ | ------------ | ------------------ |
Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |

The `namespace apply` command is used create or update a namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |

The `namespace delete` command is used delete a namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |

The `namespace` command is used to interact with namespaces.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/inspect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ description: >
The `namespace inspect` command is used to view raw information about a particular
namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |

The `namespace list` command is used list available namespaces.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/pages/docs/commands/namespace/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ description: >
The `namespace status` command is used to view the status of a particular
namespace.

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
when introduced in Nomad 0.7.

## Usage

Expand Down
19 changes: 2 additions & 17 deletions website/pages/docs/enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ description: >-
Nomad Enterprise adds operations, collaboration, and governance capabilities
to Nomad.
Features include Namespaces, Resource Quotas, Sentinel Policies, and Advanced
Autopilot.
Features include Resource Quotas, Sentinel Policies, and Advanced Autopilot.
---

# Nomad Enterprise
Expand Down Expand Up @@ -62,7 +61,7 @@ See the [Vault Integration documentation](/docs/integrations/vault-integration#e

## Governance & Policy

Governance & Policy features are part of an add-on module that enables an organization to securely operate Nomad at scale across multiple teams through features such as Audit Logging, Namespaces, Resource Quotas, Sentinel Policies, and Cross-Namespace Queries.
Governance & Policy features are part of an add-on module that enables an organization to securely operate Nomad at scale across multiple teams through features such as Audit Logging, Resource Quotas, and Sentinel Policies.

### Audit Logging

Expand All @@ -72,14 +71,6 @@ With Audit Logging, enterprises can now proactively identify access anomalies, e

See the [Audit Logging Documentation](/docs/configuration/audit) for a thorough overview.

### Namespaces

Namespaces enable multiple teams to safely use a shared multi-region Nomad environment and reduce cluster fleet size. In Nomad Enterprise, a shared cluster can be partitioned into multiple namespaces which allow jobs and their associated objects to be isolated from each other and other users of the cluster.

Namespaces enhance the usability of a shared cluster by isolating teams from the jobs of others, by providing fine grain access control to jobs when coupled with ACLs, and by preventing bad actors from negatively impacting the whole cluster.

See the [Namespaces Guide](https://learn.hashicorp.com/tutorials/nomad/namespaces) for a thorough overview.

### Resource Quotas

Resource Quotas enable an operator to limit resource consumption across teams or projects to reduce waste and align budgets. In Nomad Enterprise, operators can define quota specifications and apply them to namespaces. When a quota is attached to a namespace, the jobs within the namespace may not consume more resources than the quota specification allows.
Expand All @@ -94,12 +85,6 @@ In Nomad Enterprise, operators can create Sentinel policies for fine-grained pol

See the [Sentinel Policies Guide](https://learn.hashicorp.com/tutorials/nomad/sentinel) for a thorough overview.

### Cross-Namespace Queries

Cross-Namespace Queries allows operators to query jobs and allocations across all namespaces for faster operator debugging and visibility in multi-tenant clusters. This enterprise feature accelerates and simplifies the debugging process by allowing operators to easily locate faulty jobs and allocations from developers.

See the individual Nomad CLI command documentation (e.g., [alloc exec](/docs/commands/alloc/exec#namespace)) for more information.

## Multi-Cluster & Efficiency

Multi-Cluster & Efficiency features are part of an add-on module that enables
Expand Down
5 changes: 2 additions & 3 deletions website/pages/docs/job-specification/job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ description: |-
The `job` stanza is the top-most configuration option in the job specification.
A job is a declarative specification of tasks that Nomad should run. Jobs have
one or more task groups, which are themselves collections of one or more tasks.
Job names are unique per [region][region] or [namespace][namespace] (if Nomad
Enterprise is used).
Job names are unique per [region][region] or [namespace][namespace].

```hcl
job "docs" {
Expand Down Expand Up @@ -96,7 +95,7 @@ job "docs" {
applied. Only service jobs with a count greater than 1 support migrate stanzas.

- `namespace` `(string: "default")` - The namespace in which to execute the job.
Values other than default are not allowed in non-Enterprise versions of Nomad.
Prior to Nomad 1.0 namespaces were Enterprise-only.

- `parameterized` <code>([Parameterized][parameterized]: nil)</code> - Specifies
the job as a parameterized job such that it can be dispatched against.
Expand Down

0 comments on commit 47b8db8

Please sign in to comment.