Skip to content

Commit

Permalink
license docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewbailey committed May 29, 2020
1 parent 4a58fea commit 9a12b23
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 2 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
50 changes: 50 additions & 0 deletions website/pages/docs/commands/license/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
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-sessionnomad 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
```
26 changes: 26 additions & 0 deletions website/pages/docs/commands/license/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: docs
page_title: 'Commands: license'
sidebar_title: license
description: |
The license command is used to interact with an enterprise license.
---

# Command: license

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

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

## 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`
52 changes: 52 additions & 0 deletions website/pages/docs/commands/license/put.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
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>
```
2 changes: 0 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,6 @@ description: |

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

<EnterpriseAlert />

~> Namespace commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.

Expand Down

0 comments on commit 9a12b23

Please sign in to comment.