Skip to content

Commit

Permalink
license cli documentation
Browse files Browse the repository at this point in the history
license docs

backout doc change

more docs
  • Loading branch information
drewbailey committed May 29, 2020
1 parent abbf4b2 commit 55a13b9
Show file tree
Hide file tree
Showing 5 changed files with 146 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/data/docs-navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ export default [
'validate'
]
},
{
category: 'license',
content: ['get', 'put']
},
'monitor',
{
category: 'namespace',
Expand Down
51 changes: 51 additions & 0 deletions website/pages/docs/commands/license/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
layout: docs
page_title: 'Commands: license get'
sidebar_title: get
description: |
The license get command is used to get the current license.
---

# Command: license get

The `license get` command is used to retrieve the current Nomad Enterprise license.

~> License commands are new in Nomad 0.12.0 and are only available with Nomad
Enterprise.

## Usage

```plaintext
nomad license get [options]
```

## General Options

@include 'general_options.mdx'

## Examples

```shell-session
$ nomad license get
Product = nomad
License Status = valid
License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec
Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2
Expires At = 2020-05-09 00:00:00 +0000 UTC
License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec
Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2
Terminates At = 2020-05-10 00:00:00 +0000 UTC
Datacenter = *
Modules:
governance-policy
Licensed Features:
Automated Upgrades
Enhanced Read Scalability
Redundancy Zones
Namespaces
Resource Quotas
Preemption
Audit Logging
Setinel Policies
```
29 changes: 29 additions & 0 deletions website/pages/docs/commands/license/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: docs
page_title: 'Commands: license'
sidebar_title: license
description: |
The license command is used to interact with an enterprise license.
---

# Command: license

~> License commands are new in Nomad 0.12.0 and are only available with Nomad Enterprise.

The `license` command provides cluster level management of the Nomad Enterprise license.

If ACLs are enabled then a token with operator privileges may be required in order to use
this command.

## Usage

Usage: `nomad license <subcommand> [options]`

Run `nomad license <subcommand> -h` for help on that subcommand. The following
subcommands are available:

- [`license get`][get] - Get the current license
- [`license put`][put] - Set the current license

[get]: /docs/commands/license/get `Get the current license`
[put]: /docs/commands/license/put `Set the current license`
54 changes: 54 additions & 0 deletions website/pages/docs/commands/license/put.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: docs
page_title: 'Commands: license put'
sidebar_title: put
description: |
The license put command is used to set the Nomad Enterprise license.
---

# Command: license put

The `license set` command is used to set the Nomad Enterprise license.

~> License commands are new in Nomad 0.12.0 and are only available with Nomad
Enterprise.

## Usage

```plaintext
nomad license put
```

## General Options

@include 'general_options.mdx'

## Put Options

```plaintext
Install a new license from a file:
$ nomad license put <path>
Install a new license from stdin:
$ nomad license put -
```

## Examples

Set a license using a path

```shell-session
$ nomad license put /path/to/my/license.txt
```

Set a license using a path

```shell-session
$ nomad license put -
02MV4UU43BK5HGYYTOJZWFQMTMNNEWU33JLJKES6S2NJMXUWLKIV2E2RCCNRMXSMBQLJKFSM2MK5KTKTLKLF2FS6SJPFNFIYZVJV5GI2S2K5LGUSLJO5UVSM2WPJSEOOLULJMEUZTBK5IWST3JJF5E4VCBPJHFIWTMJZJTANCZK5LGUTCXJJVVU2SRORHUIVLYJVBTC2KNNJATCTKEMM2VSMSONBNEISLJJRBUU4DCNZHDAWKXPBZVSWCSOBRDENLGMFLVC2KPNFEXCSLJO5UWCWCOPJSFOVTGMRDWY5C2KNETMSLKJF3U22SBORGUIVLUJVCGQVKNKRITMTLKJU3E26TDOVHHURJRJVVEC52NPJATGV3JJFZUS3SOGBMVQSRQLAZVE4DCK5KWST3JJF4U2RCJO5GFIQJRJRKECNCWIRAXOT3KIF3U62SBO5LWSSLTJFWVMNDDI5WHSWKYKJYGEMRVMZSEO3DULJJUSNSJNJEXOTLKIF2E2RCVORGUI3CVJVCECNSNIRATMTKEIJQUS2LXNFSEOVTZMJLWY5KZLBJHAYRSGVTGIR3MORNFGSJWJFVES52NNJAXITKEKV2E2VCCKVGUIQJWJVCECNSNIRBGCSLJO5UWGSCKOZNEQVTKMRBUSNSJNU2XMYSXIZVUS2LXNFNG26DILIZU22KPNZZWSYSXHFVWIV3YNRRXSSJWK54UU3TCGNNGYY3NGVUGE3KONRGFQQ
<ctrl-d>
```
8 changes: 8 additions & 0 deletions website/pages/docs/enterprise/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Nomad Enterprise adds collaboration, operational, and governance capabilities to

Please navigate the sub-sections for more information about each package and its features in detail.

## Nomad Enterprise Licensing

Nomad Enterprise requires a license to run. When a Enterprise server first starts it will be set with a temporary license that includes all features. This will be valid for 6 hours and allows users to test enterprise features and provide enough time for operators to apply their enterprise license.

If a server is never given a valid license and the temporary license expires, the server will shutdown. If a valid (non-temporary) license expires, the cluster will continue to function, but write operations to enterprise features will be disabled.

See the [License commands](/docs/commands/license) for more information on interacting with the Enterprise License.

## Nomad Enterprise Platform

Nomad Enterprise Platform enables operators to easily upgrade Nomad as well as enhances performance and availability through Advanced Autopilot features such as Automated Upgrades, Enhanced Read Scalability, and Redundancy Zones.
Expand Down

0 comments on commit 55a13b9

Please sign in to comment.