Skip to content

Commit 13f2618

Browse files
drewbaileydrewbailey
authored
Docs/license (#8076)
* license cli documentation license docs backout doc change more docs * license api endpoint documentation
1 parent 9ace1c8 commit 13f2618

File tree

6 files changed

+252
-0
lines changed

6 files changed

+252
-0
lines changed

‎website/data/docs-navigation.js

+4
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,10 @@ export default [
108108
'validate'
109109
]
110110
},
111+
{
112+
category: 'license',
113+
content: ['get', 'put']
114+
},
111115
'monitor',
112116
{
113117
category: 'namespace',

‎website/pages/api-docs/operator.mdx

+106
Original file line numberDiff line numberDiff line change
@@ -470,4 +470,110 @@ server state is authoritative.
470470

471471
- `Index` - Current Raft index when the request was received.
472472

473+
474+
## Get Nomad Enterprise License Info
475+
476+
This endpoint gets information about the current license.
477+
478+
| Method | Path | Produces |
479+
| ------ | ------------------- | ------------------ |
480+
| `GET` | `/v1/operator/license` | `application/json` |
481+
482+
483+
The table below shows this endpoint's support for
484+
[blocking queries](/api-docs#blocking-queries) and
485+
[required ACLs](/api-docs#acls).
486+
487+
| Blocking Queries | ACL Required |
488+
| ---------------- | ---------------- |
489+
| `NO` | `operator:write` |
490+
491+
492+
### Sample Request
493+
494+
```shell-session
495+
$ curl \
496+
http://127.0.0.1:8500/v1/operator/license
497+
```
498+
499+
### Sample Response
500+
501+
```json
502+
{
503+
"KnownLeader": false,
504+
"LastContact": 0,
505+
"LastIndex": 0,
506+
"License": {
507+
"CustomerID": "temporary license customer",
508+
"ExpirationTime": "2020-06-01T14:50:16.581304556-04:00",
509+
"Features": [
510+
"Automated Upgrades",
511+
"Enhanced Read Scalability",
512+
"Redundancy Zones",
513+
"Namespaces",
514+
"Resource Quotas",
515+
"Preemption",
516+
"Audit Logging",
517+
"Setinel Policies"
518+
],
519+
"Flags": {
520+
"modules": [
521+
"governance-policy"
522+
]
523+
},
524+
"InstallationID": "*",
525+
"IssueTime": "2020-06-01T08:50:16.581304556-04:00",
526+
"LicenseID": "temporary-license",
527+
"Modules": [
528+
"governance-policy"
529+
],
530+
"Product": "nomad",
531+
"StartTime": "2020-06-01T08:50:16.581304556-04:00",
532+
"TerminationTime": "2020-06-01T14:50:16.581304556-04:00"
533+
},
534+
"RequestTime": 0
535+
}
536+
```
537+
538+
## Updating the Nomad Enterprise License
539+
540+
This endpoint updates the Nomad license.
541+
542+
543+
| Method | Path | Produces |
544+
| ------ | ------------------- | ------------------ |
545+
| `PUT` | `/v1/operator/license` | `application/json` |
546+
547+
548+
549+
The table below shows this endpoint's support for
550+
[blocking queries](/api-docs#blocking-queries) and
551+
[required ACLs](/api-docs#acls).
552+
553+
| Blocking Queries | ACL Required |
554+
| ---------------- | ---------------- |
555+
| `NO` | `operator:write` |
556+
557+
558+
### Sample Payload
559+
560+
The payload is the raw license blob.
561+
562+
### Sample Request
563+
564+
```shell-session
565+
$ curl \
566+
--request PUT \
567+
--data @consul.license \
568+
http://127.0.0.1:8500/v1/operator/license
569+
```
570+
571+
### Sample Response
572+
573+
```json
574+
{
575+
"Index": 15
576+
}
577+
```
578+
473579
[`default_scheduler_config`]: /docs/configuration/server#default_scheduler_config

‎website/pages/docs/commands/license/get.mdx

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: docs
3+
page_title: 'Commands: license get'
4+
sidebar_title: get
5+
description: |
6+
The license get command is used to get the current license.
7+
---
8+
9+
# Command: license get
10+
11+
The `license get` command is used to retrieve the current Nomad Enterprise license.
12+
13+
~> License commands are new in Nomad 0.12.0 and are only available with Nomad
14+
Enterprise.
15+
16+
## Usage
17+
18+
```plaintext
19+
nomad license get [options]
20+
```
21+
22+
## General Options
23+
24+
@include 'general_options.mdx'
25+
26+
## Examples
27+
28+
```shell-session
29+
$ nomad license get
30+
31+
Product = nomad
32+
License Status = valid
33+
License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec
34+
Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2
35+
Expires At = 2020-05-09 00:00:00 +0000 UTC
36+
License ID = e23f63b1-00ec-4e67-e926-c22e7937ceec
37+
Customer ID = 350356e5-8aec-bdf4-8510-b205079ccad2
38+
Terminates At = 2020-05-10 00:00:00 +0000 UTC
39+
Datacenter = *
40+
Modules:
41+
governance-policy
42+
Licensed Features:
43+
Automated Upgrades
44+
Enhanced Read Scalability
45+
Redundancy Zones
46+
Namespaces
47+
Resource Quotas
48+
Preemption
49+
Audit Logging
50+
Setinel Policies
51+
```

‎website/pages/docs/commands/license/index.mdx

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: docs
3+
page_title: 'Commands: license'
4+
sidebar_title: license
5+
description: |
6+
The license command is used to interact with an enterprise license.
7+
---
8+
9+
# Command: license
10+
11+
~> License commands are new in Nomad 0.12.0 and are only available with Nomad Enterprise.
12+
13+
The `license` command provides cluster level management of the Nomad Enterprise license.
14+
15+
If ACLs are enabled then a token with operator privileges may be required in order to use
16+
this command.
17+
18+
## Usage
19+
20+
Usage: `nomad license <subcommand> [options]`
21+
22+
Run `nomad license <subcommand> -h` for help on that subcommand. The following
23+
subcommands are available:
24+
25+
- [`license get`][get] - Get the current license
26+
- [`license put`][put] - Set the current license
27+
28+
[get]: /docs/commands/license/get `Get the current license`
29+
[put]: /docs/commands/license/put `Set the current license`

‎website/pages/docs/commands/license/put.mdx

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: docs
3+
page_title: 'Commands: license put'
4+
sidebar_title: put
5+
description: |
6+
The license put command is used to set the Nomad Enterprise license.
7+
---
8+
9+
# Command: license put
10+
11+
The `license set` command is used to set the Nomad Enterprise license.
12+
13+
~> License commands are new in Nomad 0.12.0 and are only available with Nomad
14+
Enterprise.
15+
16+
## Usage
17+
18+
```plaintext
19+
nomad license put
20+
```
21+
22+
## General Options
23+
24+
@include 'general_options.mdx'
25+
26+
## Put Options
27+
28+
```plaintext
29+
Install a new license from a file:
30+
31+
$ nomad license put <path>
32+
33+
Install a new license from stdin:
34+
35+
$ nomad license put -
36+
```
37+
38+
## Examples
39+
40+
Set a license using a path
41+
42+
```shell-session
43+
$ nomad license put /path/to/my/license.txt
44+
```
45+
46+
Set a license using a path
47+
48+
```shell-session
49+
$ nomad license put -
50+
51+
02MV4UU43BK5HGYYTOJZWFQMTMNNEWU33JLJKES6S2NJMXUWLKIV2E2RCCNRMXSMBQLJKFSM2MK5KTKTLKLF2FS6SJPFNFIYZVJV5GI2S2K5LGUSLJO5UVSM2WPJSEOOLULJMEUZTBK5IWST3JJF5E4VCBPJHFIWTMJZJTANCZK5LGUTCXJJVVU2SRORHUIVLYJVBTC2KNNJATCTKEMM2VSMSONBNEISLJJRBUU4DCNZHDAWKXPBZVSWCSOBRDENLGMFLVC2KPNFEXCSLJO5UWCWCOPJSFOVTGMRDWY5C2KNETMSLKJF3U22SBORGUIVLUJVCGQVKNKRITMTLKJU3E26TDOVHHURJRJVVEC52NPJATGV3JJFZUS3SOGBMVQSRQLAZVE4DCK5KWST3JJF4U2RCJO5GFIQJRJRKECNCWIRAXOT3KIF3U62SBO5LWSSLTJFWVMNDDI5WHSWKYKJYGEMRVMZSEO3DULJJUSNSJNJEXOTLKIF2E2RCVORGUI3CVJVCECNSNIRATMTKEIJQUS2LXNFSEOVTZMJLWY5KZLBJHAYRSGVTGIR3MORNFGSJWJFVES52NNJAXITKEKV2E2VCCKVGUIQJWJVCECNSNIRBGCSLJO5UWGSCKOZNEQVTKMRBUSNSJNU2XMYSXIZVUS2LXNFNG26DILIZU22KPNZZWSYSXHFVWIV3YNRRXSSJWK54UU3TCGNNGYY3NGVUGE3KONRGFQQ
52+
53+
<ctrl-d>
54+
```

‎website/pages/docs/enterprise/index.mdx

+8
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ Nomad Enterprise adds collaboration, operational, and governance capabilities to
1616

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

19+
## Nomad Enterprise Licensing
20+
21+
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.
22+
23+
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.
24+
25+
See the [License commands](/docs/commands/license) for more information on interacting with the Enterprise License.
26+
1927
## Nomad Enterprise Platform
2028

2129
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.

0 commit comments

Comments
 (0)