mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 18:35:44 +03:00
Docs/license (#8076)
* license cli documentation license docs backout doc change more docs * license api endpoint documentation
This commit is contained in:
Drew Bailey
@@ -108,6 +108,10 @@ export default [
|
||||
'validate'
|
||||
]
|
||||
},
|
||||
{
|
||||
category: 'license',
|
||||
content: ['get', 'put']
|
||||
},
|
||||
'monitor',
|
||||
{
|
||||
category: 'namespace',
|
||||
|
||||
@@ -470,4 +470,110 @@ server state is authoritative.
|
||||
|
||||
- `Index` - Current Raft index when the request was received.
|
||||
|
||||
|
||||
## Get Nomad Enterprise License Info
|
||||
|
||||
This endpoint gets information about the current license.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------ | ------------------- | ------------------ |
|
||||
| `GET` | `/v1/operator/license` | `application/json` |
|
||||
|
||||
|
||||
The table below shows this endpoint's support for
|
||||
[blocking queries](/api-docs#blocking-queries) and
|
||||
[required ACLs](/api-docs#acls).
|
||||
|
||||
| Blocking Queries | ACL Required |
|
||||
| ---------------- | ---------------- |
|
||||
| `NO` | `operator:write` |
|
||||
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
http://127.0.0.1:8500/v1/operator/license
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"KnownLeader": false,
|
||||
"LastContact": 0,
|
||||
"LastIndex": 0,
|
||||
"License": {
|
||||
"CustomerID": "temporary license customer",
|
||||
"ExpirationTime": "2020-06-01T14:50:16.581304556-04:00",
|
||||
"Features": [
|
||||
"Automated Upgrades",
|
||||
"Enhanced Read Scalability",
|
||||
"Redundancy Zones",
|
||||
"Namespaces",
|
||||
"Resource Quotas",
|
||||
"Preemption",
|
||||
"Audit Logging",
|
||||
"Setinel Policies"
|
||||
],
|
||||
"Flags": {
|
||||
"modules": [
|
||||
"governance-policy"
|
||||
]
|
||||
},
|
||||
"InstallationID": "*",
|
||||
"IssueTime": "2020-06-01T08:50:16.581304556-04:00",
|
||||
"LicenseID": "temporary-license",
|
||||
"Modules": [
|
||||
"governance-policy"
|
||||
],
|
||||
"Product": "nomad",
|
||||
"StartTime": "2020-06-01T08:50:16.581304556-04:00",
|
||||
"TerminationTime": "2020-06-01T14:50:16.581304556-04:00"
|
||||
},
|
||||
"RequestTime": 0
|
||||
}
|
||||
```
|
||||
|
||||
## Updating the Nomad Enterprise License
|
||||
|
||||
This endpoint updates the Nomad license.
|
||||
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------ | ------------------- | ------------------ |
|
||||
| `PUT` | `/v1/operator/license` | `application/json` |
|
||||
|
||||
|
||||
|
||||
The table below shows this endpoint's support for
|
||||
[blocking queries](/api-docs#blocking-queries) and
|
||||
[required ACLs](/api-docs#acls).
|
||||
|
||||
| Blocking Queries | ACL Required |
|
||||
| ---------------- | ---------------- |
|
||||
| `NO` | `operator:write` |
|
||||
|
||||
|
||||
### Sample Payload
|
||||
|
||||
The payload is the raw license blob.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--request PUT \
|
||||
--data @consul.license \
|
||||
http://127.0.0.1:8500/v1/operator/license
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"Index": 15
|
||||
}
|
||||
```
|
||||
|
||||
[`default_scheduler_config`]: /docs/configuration/server#default_scheduler_config
|
||||
|
||||
51
website/pages/docs/commands/license/get.mdx
Normal file
51
website/pages/docs/commands/license/get.mdx
Normal file
@@ -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
website/pages/docs/commands/license/index.mdx
Normal file
29
website/pages/docs/commands/license/index.mdx
Normal file
@@ -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
website/pages/docs/commands/license/put.mdx
Normal file
54
website/pages/docs/commands/license/put.mdx
Normal file
@@ -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>
|
||||
```
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user