mirror of https://github.com/hashicorp/consul
docs: update structure (#8506)
- moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary pagepull/8598/head
Jasmine W
GitHub
parent
b6f902d516
commit
a9df6ac50b
|
|
@ -40,19 +40,172 @@
|
|||
/docs/connect/terminating_gateway /docs/connect/gateways/terminating-gateway 301!
|
||||
/docs/connect/terminating_gateway.html /docs/connect/gateways/terminating-gateway 301!
|
||||
/docs/connect/terminating-gateway /docs/connect/gateways/terminating-gateway 301!
|
||||
/docs/k8s/connect.html /docs/k8s/connect 301!
|
||||
/docs/agent/cloud-auto-join /docs/install/cloud-auto-join 301!
|
||||
/docs/internals/security /docs/security 301!
|
||||
/docs/acl/ /docs/security/acl/ 301!
|
||||
/docs/acl/acl-system /docs/security/acl/acl-system 301!
|
||||
/docs/acl/acl-rules /docs/security/acl/acl-rules 301!
|
||||
/docs/acl/acl-legacy /docs/security/acl/acl-legacy 301!
|
||||
/docs/acl/acl-migrate-tokens /docs/security/acl/acl-migrate-tokens 301!
|
||||
/docs/acl/auth-methods /docs/security/acl/auth-methods 301!
|
||||
/docs/acl/auth-methods/kubernetes /docs/security/acl/auth-methods/kubernetes 301!
|
||||
/docs/acl/auth-methods/jwt /docs/security/acl/auth-methods/jwt 301!
|
||||
/docs/acl/auth-methods/oidc /docs/security/acl/auth-methods/oidc 301!
|
||||
/docs/agent/kv /docs/dynamic-app-config/kv 301!
|
||||
/docs/internals/sessions /docs/dynamic-app-config/sessions 301!
|
||||
/docs/agent/watches /docs/dynamic-app-config/watches 301!
|
||||
/docs/connect/l7-traffic-management /docs/connect/l7-traffic/ 301!
|
||||
/docs/internals/discovery-chain /docs/connect/l7-traffic/discovery-chain 301!
|
||||
/docs/k8s/operations/upgrading /docs/k8s/upgrade 301!
|
||||
/docs/k8s/operations/uninstalling /docs/k8s/uninstall 301!
|
||||
/docs/k8s/operations/tls-on-existing-cluster /docs/k8s/tls-on-existing-cluster 301!
|
||||
/docs/k8s/helm /docs/k8s/installation/helm 301!
|
||||
/docs/agent/services /docs/discovery/services 301!
|
||||
/docs/agent/checks /docs/discovery/checks 301!
|
||||
/docs/agent/dns /docs/discovery/dns 301!
|
||||
/docs/agent/encryption /docs/security/encryption 301!
|
||||
/docs/internals/architecture /docs/architecture 301!
|
||||
/docs/internals/anti-entropy /docs/architecture/anti-entropy 301!
|
||||
/docs/internals/consensus /docs/architecture/consensus 301!
|
||||
/docs/internals/gossip /docs/architecture/gossip 301!
|
||||
/docs/internals/jepsen /docs/internals/jepsen 301!
|
||||
/docs/internals/coordinates /docs/architecture/coordinates 301!
|
||||
/docs/glossary /docs/install/glossary 301!
|
||||
/docs/connect/gateways/mesh-gateways /docs/connect/gateways/mesh-gateway 301!
|
||||
/docs/connect/gateways/wan-federation-via-mesh-gateways /docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways 301!
|
||||
/docs/faq /docs/troubleshoot/faq 301!
|
||||
/docs/common-errors /docs/troubleshoot/common-errors 301!
|
||||
/intro /docs/intro 301!
|
||||
/intro/vs /docs/intro/vs 301!
|
||||
/intro/vs/zookeeper /docs/intro/vs/zookeeper 301!
|
||||
/intro/vs/chef-puppet /docs/intro/vs/chef-puppet 301!
|
||||
/intro/vs/nagios-sensu /docs/intro/vs/nagios-sensu 301!
|
||||
/intro/vs/skydns /docs/intro/vs/skydns 301!
|
||||
/intro/vs/smartstack /docs/intro/vs/smartstack 301!
|
||||
/intro/vs/serf /docs/intro/vs/serf 301!
|
||||
/intro/vs/eureka /docs/intro/vs/eureka 301!
|
||||
/intro/vs/istio /docs/intro/vs/istio 301!
|
||||
/intro/vs/proxies /docs/intro/vs/proxies 301!
|
||||
/intro/vs/custom /docs/intro/vs/custom 301!
|
||||
/download-tools /docs/download-tools 301!
|
||||
|
||||
# CLI redirects
|
||||
/docs/commands /commands 301!
|
||||
/docs/commands/acl /commands/acl 301!
|
||||
/docs/commands/acl/auth-method /commands/acl/auth-method 301!
|
||||
/docs/commands/acl/auth-method/create /commands/acl/auth-method/create 301!
|
||||
/docs/commands/acl/auth-method/delete /commands/acl/auth-method/delete 301!
|
||||
/docs/commands/acl/auth-method/list /commands/acl/auth-method/list 301!
|
||||
/docs/commands/acl/auth-method/read /commands/acl/auth-method/read 301!
|
||||
/docs/commands/acl/auth-method/update /commands/acl/auth-method/update 301!
|
||||
/docs/commands/acl/binding-rule /commands/acl/binding-rule 301!
|
||||
/docs/commands/acl/binding-rule/create /commands/acl/binding-rule/create 301!
|
||||
/docs/commands/acl/binding-rule/delete /commands/acl/binding-rule/delete 301!
|
||||
/docs/commands/acl/binding-rule/list /commands/acl/binding-rule/list 301!
|
||||
/docs/commands/acl/binding-rule/read /commands/acl/binding-rule/read 301!
|
||||
/docs/commands/acl/binding-rule/update /commands/acl/binding-rule/update 301!
|
||||
/docs/commands/acl/bootstrap /commands/acl/bootstrap 301!
|
||||
/docs/commands/acl/policy/ /commands/acl/policy 301!
|
||||
/docs/commands/acl/policy/create /commands/acl/policy/create 301!
|
||||
/docs/commands/acl/policy/delete /commands/acl/policy/delete 301!
|
||||
/docs/commands/acl/policy/list /commands/acl/policy/list 301!
|
||||
/docs/commands/acl/policy/read /commands/acl/policy/read 301!
|
||||
/docs/commands/acl/policy/update /commands/acl/policy/update 301!
|
||||
/docs/commands/acl/set-agent-token /commands/acl/set-agent-token 301!
|
||||
/docs/commands/acl/token /commands/acl/token 301!
|
||||
/docs/commands/acl/token/clone /commands/acl/token/clone 301!
|
||||
/docs/commands/acl/token/create /commands/acl/token/create 301!
|
||||
/docs/commands/acl/token/delete /commands/acl/token/delete 301!
|
||||
/docs/commands/acl/token/list /commands/acl/token/list 301!
|
||||
/docs/commands/acl/token/read /commands/acl/token/read 301!
|
||||
/docs/commands/acl/token/update /commands/acl/token/update 301!
|
||||
/docs/commands/acl/translate-rules /commands/acl/translate-rules 301!
|
||||
/docs/commands/agent /commands/agent 301!
|
||||
/docs/commands/catalog /commands/catalog 301!
|
||||
/docs/commands/catalog/datacenters /commands/catalog/datacenters 301!
|
||||
/docs/commands/catalog/nodes /commands/catalog/nodes 301!
|
||||
/docs/commands/catalog/services /commands/catalog/services 301!
|
||||
/docs/commands/config /commands/config 301!
|
||||
/docs/commands/config/delete /commands/config/delete 301!
|
||||
/docs/commands/config/list /commands/config/list 301!
|
||||
/docs/commands/config/read /commands/config/read 301!
|
||||
/docs/commands/config/write /commands/config/write 301!
|
||||
/docs/commands/connect /commands/connect 301!
|
||||
/docs/commands/connect/ca /commands/connect/ca 301!
|
||||
/docs/commands/connect/proxy /commands/connect/proxy 301!
|
||||
/docs/commands/connect/envoy /commands/connect/envoy 301!
|
||||
/docs/commands/connect/expose /commands/connect/expose 301!
|
||||
/docs/commands/debug /commands/debug 301!
|
||||
/docs/commands/event /commands/event 301!
|
||||
/docs/commands/exec /commands/exec 301!
|
||||
/docs/commands/force-leave /commands/force-leave 301!
|
||||
/docs/commands/info /commands/info 301!
|
||||
/docs/commands/intention /commands/intention 301!
|
||||
/docs/commands/intention/check /commands/intention/check 301!
|
||||
/docs/commands/intention/create /commands/intention/create 301!
|
||||
/docs/commands/intention/delete /commands/intention/delete 301!
|
||||
/docs/commands/intention/get /commands/intention/get 301!
|
||||
/docs/commands/intention/match /commands/intention/match 301!
|
||||
/docs/commands/join /commands/join 301!
|
||||
/docs/commands/keygen /commands/keygen 301!
|
||||
/docs/commands/keyring /commands/keyring 301!
|
||||
/docs/commands/kv /commands/kv 301!
|
||||
/docs/commands/kv/delete /commands/kv/delete 301!
|
||||
/docs/commands/kv/export /commands/kv/export 301!
|
||||
/docs/commands/kv/get /commands/kv/get 301!
|
||||
/docs/commands/kv/import /commands/kv/import 301!
|
||||
/docs/commands/kv/put /commands/kv/put 301!
|
||||
/docs/commands/leave /commands/leave 301!
|
||||
/docs/commands/license /commands/license 301!
|
||||
/docs/commands/lock /commands/lock 301!
|
||||
/docs/commands/login /commands/login 301!
|
||||
/docs/commands/logout /commands/logout 301!
|
||||
/docs/commands/maint /commands/maint 301!
|
||||
/docs/commands/members /commands/members 301!
|
||||
/docs/commands/monitor /commands/monitor 301!
|
||||
/docs/commands/namespace /commands/namespace 301!
|
||||
/docs/commands/namespace/create /commands/namespace/create 301!
|
||||
/docs/commands/namespace/delete /commands/namespace/delete 301!
|
||||
/docs/commands/namespace/list /commands/namespace/list 301!
|
||||
/docs/commands/namespace/read /commands/namespace/read 301!
|
||||
/docs/commands/namespace/update /commands/namespace/update 301!
|
||||
/docs/commands/namespace/write /commands/namespace/write 301!
|
||||
/docs/commands/operator /commands/operator 301!
|
||||
/docs/commands/operator/area /commands/operator/area 301!
|
||||
/docs/commands/operator/autopilot /commands/operator/autopilot 301!
|
||||
/docs/commands/operator/raft /commands/operator/raft 301!
|
||||
/docs/commands/reload /commands/reload 301!
|
||||
/docs/commands/rft /commands/rft 301!
|
||||
/docs/commands/rtt /commands/rtt 301!
|
||||
/docs/commands/services /commands/services 301!
|
||||
/docs/commands/services/register /commands/services/register 301!
|
||||
/docs/commands/services/deregister /commands/services/deregister 301!
|
||||
/docs/commands/snapshot /commands/snapshot 301!
|
||||
/docs/commands/snapshot/agent /commands/snapshot/agent 301!
|
||||
/docs/commands/snapshot/inspect /commands/snapshot/inspect 301!
|
||||
/docs/commands/snapshot/restore /commands/snapshot/restore 301!
|
||||
/docs/commands/snapshot/save /commands/snapshot/save 301!
|
||||
/docs/commands/tls /commands/tls 301!
|
||||
/docs/commands/tls/ca /commands/tls/ca 301!
|
||||
/docs/commands/tls/cert /commands/tls/cert 301!
|
||||
/docs/commands/validate /commands/validate 301!
|
||||
/docs/commands/version /commands/version 301!
|
||||
/docs/commands/watch /commands/watch 301!
|
||||
/commands/index /commands 301!
|
||||
|
||||
# CLI renames
|
||||
|
||||
/docs/commands/acl/acl-bootstrap.html /docs/commands/acl/bootstrap.html 301!
|
||||
/docs/commands/acl/acl-bootstrap /docs/commands/acl/bootstrap.html 301!
|
||||
/docs/commands/acl/acl-policy.html /docs/commands/acl/policy.html 301!
|
||||
/docs/commands/acl/acl-policy /docs/commands/acl/policy.html 301!
|
||||
/docs/commands/acl/acl-set-agent-token.html /docs/commands/acl/set-agent-token.html 301!
|
||||
/docs/commands/acl/acl-set-agent-token /docs/commands/acl/set-agent-token.html 301!
|
||||
/docs/commands/acl/acl-token.html /docs/commands/acl/token.html 301!
|
||||
/docs/commands/acl/acl-token /docs/commands/acl/token.html 301!
|
||||
/docs/commands/acl/acl-translate-rules.html /docs/commands/acl/translate-rules.html 301!
|
||||
/docs/commands/acl/acl-translate-rules /docs/commands/acl/translate-rules.html 301!
|
||||
/docs/commands/acl/acl-bootstrap.html /commands/acl/bootstrap 301!
|
||||
/docs/commands/acl/acl-bootstrap /commands/acl/bootstrap 301!
|
||||
/docs/commands/acl/acl-policy.html /commands/acl/policy 301!
|
||||
/docs/commands/acl/acl-policy /commands/acl/policy 301!
|
||||
/docs/commands/acl/acl-set-agent-token.html /commands/acl/set-agent-token 301!
|
||||
/docs/commands/acl/acl-set-agent-token /commands/acl/set-agent-token 301!
|
||||
/docs/commands/acl/acl-token.html /commands/acl/token 301!
|
||||
/docs/commands/acl/acl-token /commands/acl/token 301!
|
||||
/docs/commands/acl/acl-translate-rules.html /commands/acl/translate-rules 301!
|
||||
/docs/commands/acl/acl-translate-rules /commands/acl/translate-rules 301!
|
||||
|
||||
# Consul Learn Redirects
|
||||
/docs/guides/acl.html https://learn.hashicorp.com/consul/security-networking/production-acls 301!
|
||||
|
|
|
|||
|
|
@ -1,10 +1,6 @@
|
|||
.g-learn-callout {
|
||||
padding-top: 88px;
|
||||
padding-bottom: 88px;
|
||||
background-image: url(/img/nomad-panel-learn.svg);
|
||||
background-size: contain;
|
||||
background-position: bottom right;
|
||||
background-repeat: no-repeat;
|
||||
|
||||
@media (max-width: 768px) {
|
||||
padding-top: 64px;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,78 @@
|
|||
export default [
|
||||
'index',
|
||||
{
|
||||
category: 'acl',
|
||||
content: [
|
||||
{
|
||||
category: 'auth-method',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
{
|
||||
category: 'binding-rule',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'bootstrap',
|
||||
{
|
||||
category: 'policy',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
{
|
||||
category: 'role',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'set-agent-token',
|
||||
{
|
||||
category: 'token',
|
||||
content: ['clone', 'create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'translate-rules',
|
||||
],
|
||||
},
|
||||
'agent',
|
||||
{ category: 'catalog', content: ['datacenters', 'nodes', 'services'] },
|
||||
{ category: 'config', content: ['delete', 'list', 'read', 'write'] },
|
||||
{ category: 'connect', content: ['ca', 'proxy', 'envoy', 'expose'] },
|
||||
'debug',
|
||||
'event',
|
||||
'exec',
|
||||
'force-leave',
|
||||
'info',
|
||||
{
|
||||
category: 'intention',
|
||||
content: ['check', 'create', 'delete', 'get', 'match'],
|
||||
},
|
||||
'join',
|
||||
'keygen',
|
||||
'keyring',
|
||||
{
|
||||
category: 'kv',
|
||||
content: ['delete', 'export', 'get', 'import', 'put'],
|
||||
},
|
||||
'leave',
|
||||
'license',
|
||||
'lock',
|
||||
'login',
|
||||
'logout',
|
||||
'maint',
|
||||
'members',
|
||||
'monitor',
|
||||
{
|
||||
category: 'namespace',
|
||||
content: ['create', 'delete', 'list', 'read', 'update', 'write'],
|
||||
},
|
||||
{
|
||||
category: 'operator',
|
||||
content: ['area', 'autopilot', 'raft'],
|
||||
},
|
||||
'reload',
|
||||
'rtt',
|
||||
{ category: 'services', content: ['register', 'deregister'] },
|
||||
{
|
||||
category: 'snapshot',
|
||||
content: ['agent', 'inspect', 'restore', 'save'],
|
||||
},
|
||||
{ category: 'tls', content: ['ca', 'cert'] },
|
||||
'validate',
|
||||
'version',
|
||||
'watch',
|
||||
]
|
||||
|
|
@ -7,178 +7,85 @@
|
|||
// serve as the category title in the sidebar
|
||||
|
||||
export default [
|
||||
{ category: 'install', content: ['ports', 'bootstrapping', 'performance'] },
|
||||
{
|
||||
category: 'upgrading',
|
||||
content: ['compatibility', 'upgrade-specific'],
|
||||
},
|
||||
'glossary',
|
||||
{
|
||||
category: 'internals',
|
||||
content: [
|
||||
'architecture',
|
||||
'consensus',
|
||||
'gossip',
|
||||
'coordinates',
|
||||
'sessions',
|
||||
'anti-entropy',
|
||||
'security',
|
||||
'jepsen',
|
||||
'discovery-chain',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'commands',
|
||||
category: 'intro',
|
||||
content: [
|
||||
{
|
||||
category: 'acl',
|
||||
category: 'vs',
|
||||
content: [
|
||||
{
|
||||
category: 'auth-method',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
{
|
||||
category: 'binding-rule',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'bootstrap',
|
||||
{
|
||||
category: 'policy',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
{
|
||||
category: 'role',
|
||||
content: ['create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'set-agent-token',
|
||||
{
|
||||
category: 'token',
|
||||
content: ['clone', 'create', 'delete', 'list', 'read', 'update'],
|
||||
},
|
||||
'translate-rules',
|
||||
'zookeeper',
|
||||
'chef-puppet',
|
||||
'nagios-sensu',
|
||||
'skydns',
|
||||
'smartstack',
|
||||
'serf',
|
||||
'eureka',
|
||||
'istio',
|
||||
'proxies',
|
||||
'custom',
|
||||
],
|
||||
},
|
||||
'agent',
|
||||
{ category: 'catalog', content: ['datacenters', 'nodes', 'services'] },
|
||||
{ category: 'config', content: ['delete', 'list', 'read', 'write'] },
|
||||
{ category: 'connect', content: ['ca', 'proxy', 'envoy', 'expose'] },
|
||||
'debug',
|
||||
'event',
|
||||
'exec',
|
||||
'force-leave',
|
||||
'info',
|
||||
{
|
||||
category: 'intention',
|
||||
content: ['check', 'create', 'delete', 'get', 'match'],
|
||||
},
|
||||
'join',
|
||||
'keygen',
|
||||
'keyring',
|
||||
{
|
||||
category: 'kv',
|
||||
content: ['delete', 'export', 'get', 'import', 'put'],
|
||||
},
|
||||
'leave',
|
||||
'license',
|
||||
'lock',
|
||||
'login',
|
||||
'logout',
|
||||
'maint',
|
||||
'members',
|
||||
'monitor',
|
||||
{
|
||||
category: 'namespace',
|
||||
content: ['create', 'delete', 'list', 'read', 'update', 'write'],
|
||||
},
|
||||
{
|
||||
category: 'operator',
|
||||
content: ['area', 'autopilot', 'raft'],
|
||||
},
|
||||
'reload',
|
||||
'rtt',
|
||||
{ category: 'services', content: ['register', 'deregister'] },
|
||||
{
|
||||
category: 'snapshot',
|
||||
content: ['agent', 'inspect', 'restore', 'save'],
|
||||
},
|
||||
{ category: 'tls', content: ['ca', 'cert'] },
|
||||
'validate',
|
||||
'version',
|
||||
'watch',
|
||||
],
|
||||
},
|
||||
|
||||
{
|
||||
category: 'agent',
|
||||
category: 'install',
|
||||
content: [
|
||||
'dns',
|
||||
'options',
|
||||
{
|
||||
category: 'config-entries',
|
||||
content: [
|
||||
'ingress-gateway',
|
||||
'proxy-defaults',
|
||||
'service-defaults',
|
||||
'service-resolver',
|
||||
'service-router',
|
||||
'service-splitter',
|
||||
'terminating-gateway',
|
||||
],
|
||||
},
|
||||
{ title: 'Consul Agent', href: '/docs/agent' },
|
||||
'glossary',
|
||||
'ports',
|
||||
'bootstrapping',
|
||||
'cloud-auto-join',
|
||||
'services',
|
||||
'checks',
|
||||
'kv',
|
||||
'sentinel',
|
||||
'encryption',
|
||||
'telemetry',
|
||||
'watches',
|
||||
'performance',
|
||||
{ title: 'Kubernetes', href: '/docs/k8s' },
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'acl',
|
||||
content: [
|
||||
'acl-system',
|
||||
'acl-rules',
|
||||
'acl-legacy',
|
||||
'acl-migrate-tokens',
|
||||
{ category: 'auth-methods', content: ['kubernetes', 'jwt', 'oidc'] },
|
||||
],
|
||||
category: 'discovery',
|
||||
name: 'Service Discovery',
|
||||
content: ['services', 'dns', 'checks'],
|
||||
},
|
||||
|
||||
{
|
||||
category: 'connect',
|
||||
content: [
|
||||
'configuration',
|
||||
'connectivity-tasks',
|
||||
'connect-internals',
|
||||
'observability',
|
||||
'l7-traffic-management',
|
||||
'intentions',
|
||||
'configuration',
|
||||
{
|
||||
category: 'proxies',
|
||||
content: ['envoy', 'built-in', 'integrate'],
|
||||
},
|
||||
{
|
||||
category: 'registration',
|
||||
content: ['service-registration', 'sidecar-service'],
|
||||
},
|
||||
'intentions',
|
||||
'observability',
|
||||
{
|
||||
category: 'l7-traffic',
|
||||
content: ['discovery-chain'],
|
||||
},
|
||||
'connectivity-tasks',
|
||||
{
|
||||
category: 'gateways',
|
||||
content: [
|
||||
'mesh-gateway',
|
||||
'wan-federation-via-mesh-gateways',
|
||||
{
|
||||
category: 'mesh-gateway',
|
||||
content: ['wan-federation-via-mesh-gateways'],
|
||||
},
|
||||
|
||||
'ingress-gateway',
|
||||
'terminating-gateway',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'registration',
|
||||
content: ['service-registration', 'sidecar-service'],
|
||||
},
|
||||
'security',
|
||||
'nomad',
|
||||
{ title: 'Kubernetes', href: '/docs/k8s/connect' },
|
||||
{ category: 'native', content: ['go'] },
|
||||
{
|
||||
category: 'ca',
|
||||
content: ['consul', 'vault', 'aws'],
|
||||
},
|
||||
{ category: 'native', content: ['go'] },
|
||||
'dev',
|
||||
'nomad',
|
||||
{ title: 'Kubernetes', href: '/docs/k8s/connect' },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
@ -187,6 +94,7 @@ export default [
|
|||
{
|
||||
category: 'installation',
|
||||
content: [
|
||||
'helm',
|
||||
{
|
||||
category: 'platforms',
|
||||
name: 'Platform Guides',
|
||||
|
|
@ -229,11 +137,7 @@ export default [
|
|||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'operations',
|
||||
name: 'Operations',
|
||||
content: ['upgrading', 'tls-on-existing-cluster', 'uninstalling'],
|
||||
},
|
||||
'tls-on-existing-cluster',
|
||||
{
|
||||
category: 'connect',
|
||||
content: [
|
||||
|
|
@ -245,14 +149,50 @@ export default [
|
|||
'service-sync',
|
||||
'dns',
|
||||
'ambassador',
|
||||
'helm',
|
||||
'upgrade',
|
||||
'uninstall',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'dynamic-app-config',
|
||||
name: 'Dynamic App Configuration',
|
||||
content: ['kv', 'sessions', 'watches'],
|
||||
},
|
||||
{
|
||||
category: 'agent',
|
||||
content: [
|
||||
'options',
|
||||
{
|
||||
category: 'config-entries',
|
||||
content: [
|
||||
'ingress-gateway',
|
||||
'proxy-defaults',
|
||||
'service-defaults',
|
||||
'service-resolver',
|
||||
'service-router',
|
||||
'service-splitter',
|
||||
'terminating-gateway',
|
||||
],
|
||||
},
|
||||
'telemetry',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'security',
|
||||
content: [
|
||||
{
|
||||
category: 'acl',
|
||||
content: [
|
||||
'acl-system',
|
||||
'acl-rules',
|
||||
'acl-legacy',
|
||||
'acl-migrate-tokens',
|
||||
{ category: 'auth-methods', content: ['kubernetes', 'jwt', 'oidc'] },
|
||||
],
|
||||
},
|
||||
'encryption',
|
||||
],
|
||||
},
|
||||
'-------',
|
||||
'common-errors',
|
||||
'faq',
|
||||
'--------',
|
||||
'partnerships',
|
||||
{
|
||||
category: 'enterprise',
|
||||
content: [
|
||||
|
|
@ -260,11 +200,30 @@ export default [
|
|||
'backups',
|
||||
'upgrades',
|
||||
'read-scale',
|
||||
{
|
||||
title: 'Single sign-on - OIDC',
|
||||
href: '/docs/security/acl/auth-methods/oidc',
|
||||
},
|
||||
'redundancy',
|
||||
'federation',
|
||||
'network-segments',
|
||||
'namespaces',
|
||||
'network-segments',
|
||||
'sentinel',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'architecture',
|
||||
content: ['anti-entropy', 'consensus', 'gossip', 'jepsen', 'coordinates'],
|
||||
},
|
||||
'partnerships',
|
||||
'download-tools',
|
||||
{
|
||||
category: 'upgrading',
|
||||
content: ['compatibility', 'upgrade-specific'],
|
||||
},
|
||||
{
|
||||
category: 'troubleshoot',
|
||||
name: 'Troubleshoot',
|
||||
content: ['common-errors', 'faq'],
|
||||
},
|
||||
]
|
||||
|
|
|
|||
|
|
@ -6,22 +6,4 @@
|
|||
// the landing page for the category, or a "name" property to
|
||||
// serve as the category title in the sidebar
|
||||
|
||||
export default [
|
||||
'index',
|
||||
{
|
||||
category: 'vs',
|
||||
content: [
|
||||
'zookeeper',
|
||||
'chef-puppet',
|
||||
'nagios-sensu',
|
||||
'skydns',
|
||||
'smartstack',
|
||||
'serf',
|
||||
'eureka',
|
||||
'istio',
|
||||
'proxies',
|
||||
'custom',
|
||||
],
|
||||
},
|
||||
'getting-started',
|
||||
]
|
||||
export default ['getting-started']
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
export default [
|
||||
{ text: 'Overview', url: '/intro' },
|
||||
{ text: 'Overview', url: '/docs/intro' },
|
||||
{
|
||||
text: 'Use Cases',
|
||||
submenu: [
|
||||
|
|
@ -39,6 +39,11 @@ export default [
|
|||
url: '/api-docs',
|
||||
type: 'inbound',
|
||||
},
|
||||
{
|
||||
text: 'CLI',
|
||||
url: '/commands',
|
||||
type: 'inbound,'
|
||||
},
|
||||
{
|
||||
text: 'Community',
|
||||
url: '/community',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
import DocsPage from '@hashicorp/react-docs-page'
|
||||
import order from '../data/commands-navigation.js'
|
||||
import { frontMatter as data } from '../pages/commands/**/*.mdx'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
import { createMdxProvider } from '@hashicorp/nextjs-scripts/lib/providers/docs'
|
||||
|
||||
const MDXProvider = createMdxProvider({ product: 'consul' })
|
||||
|
||||
function CommandsLayoutWrapper(pageMeta) {
|
||||
function CommandsLayout(props) {
|
||||
return (
|
||||
<MDXProvider>
|
||||
<DocsPage
|
||||
{...props}
|
||||
product="consul"
|
||||
head={{
|
||||
is: Head,
|
||||
title: `${pageMeta.page_title} | Consul by HashiCorp`,
|
||||
description: pageMeta.description,
|
||||
siteName: 'Consul by HashiCorp',
|
||||
}}
|
||||
sidenav={{
|
||||
Link,
|
||||
category: 'commands',
|
||||
currentPage: props.path,
|
||||
data,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/consul/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
/>
|
||||
</MDXProvider>
|
||||
)
|
||||
}
|
||||
|
||||
CommandsLayout.getInitialProps = ({ asPath }) => ({ path: asPath })
|
||||
|
||||
return CommandsLayout
|
||||
}
|
||||
|
||||
export default CommandsLayoutWrapper
|
||||
|
|
@ -56,9 +56,9 @@
|
|||
},
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"build": "node --max-old-space-size=2048 ./node_modules/.bin/next build",
|
||||
"build": "node --max-old-space-size=4096 ./node_modules/.bin/next build",
|
||||
"dynamic": "NODE_ENV=production next build && next start",
|
||||
"export": "node --max-old-space-size=2048 ./node_modules/.bin/next export",
|
||||
"export": "node --max-old-space-size=4096 ./node_modules/.bin/next export",
|
||||
"format": "next-hashicorp format",
|
||||
"generate:component": "next-hashicorp generate component",
|
||||
"generate:readme": "next-hashicorp markdown-blocks README.md",
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
- `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
|
||||
created by this auth method. When set it will initialize the
|
||||
[`ExpirationTime`](/api/acl/tokens.html#expirationtime) field on all tokens
|
||||
[`ExpirationTime`](/api/acl/tokens#expirationtime) field on all tokens
|
||||
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
|
||||
persisted beyond its initial use. Can be specified in the form of `"60s"` or
|
||||
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). This value must be no
|
||||
|
|
@ -232,7 +232,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
- `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
|
||||
created by this auth method. When set it will initialize the
|
||||
[`ExpirationTime`](/api/acl/tokens.html#expirationtime) field on all tokens
|
||||
[`ExpirationTime`](/api/acl/tokens#expirationtime) field on all tokens
|
||||
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
|
||||
persisted beyond its initial use. Can be specified in the form of `"60s"` or
|
||||
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). This value must be no
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@ $ curl \
|
|||
|
||||
- `ReplicatedTokenIndex` - The last token index that was successfully replicated.
|
||||
This index can be compared with the value of the `X-Consul-Index` header returned
|
||||
by the [`/v1/acl/tokens`](/api/acl/tokens#list-acls) endpoint to determine
|
||||
by the [`/v1/acl/tokens`](/api/acl/tokens#list-tokens) endpoint to determine
|
||||
if the replication process has gotten all available ACL tokens. Note that ACL
|
||||
replication is rate limited so the indexes may lag behind the primary
|
||||
datacenter.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Method Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Method Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Methods'
|
||||
sidebar_title: auth-method
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Method List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Method Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Auth Method Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule'
|
||||
sidebar_title: binding-rule
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Binding Rule Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Bootstrap'
|
||||
sidebar_title: bootstrap
|
||||
---
|
||||
|
|
@ -11,7 +11,7 @@ Command: `consul acl bootstrap`
|
|||
The `acl bootstrap` command will request Consul to generate a new token with unlimited privileges to use
|
||||
for management purposes and output its details. This can only be done once and afterwards bootstrapping
|
||||
will be disabled. If all tokens are lost and you need to bootstrap again you can follow the bootstrap
|
||||
[reset procedure](https://learn.hashicorp.com/tutorials/consul/access-control-troubleshoot?utm_source=consul.io&utm_medium=docs#reset-the-acl-system).
|
||||
[reset procedure](https://learn.hashicorp.com/consul/security-networking/acl-troubleshooting?utm_source=consul.io&utm_medium=docs#reset-the-acl-system).
|
||||
|
||||
The ACL system can also be bootstrapped via the [HTTP API](/api/acl/acl#bootstrap-acls).
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL'
|
||||
sidebar_title: acl
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy'
|
||||
sidebar_title: policy
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Policy Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role'
|
||||
sidebar_title: role
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Role Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Set Agent Token'
|
||||
sidebar_title: set-agent-token
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token Clone'
|
||||
sidebar_title: clone
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token'
|
||||
sidebar_title: token
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Token Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -56,8 +56,8 @@ Usage: `consul acl token update [options]`
|
|||
specified grant equivalent or appropriate access for the existing clients using
|
||||
this token. You can find examples on how to use the parameter in the [legacy
|
||||
token
|
||||
migration](https://learn.hashicorp.com/tutorials/consul/access-control-token-migration)
|
||||
tutorial.
|
||||
migration](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens)
|
||||
guide.
|
||||
|
||||
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: ACL Translate Rules'
|
||||
sidebar_title: translate-rules
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Agent'
|
||||
sidebar_title: agent
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Catalog List Datacenters'
|
||||
sidebar_title: datacenters
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Catalog'
|
||||
sidebar_title: catalog
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Catalog List Nodes'
|
||||
sidebar_title: nodes
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Catalog List Services'
|
||||
sidebar_title: services
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Config Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Config'
|
||||
sidebar_title: config
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Config List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Config Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Config Write'
|
||||
sidebar_title: write
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Connect CA'
|
||||
sidebar_title: ca
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Connect Proxy'
|
||||
sidebar_title: envoy
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Connect Expose'
|
||||
sidebar_title: expose
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Connect'
|
||||
sidebar_title: connect
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Connect Proxy'
|
||||
sidebar_title: proxy
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Debug'
|
||||
sidebar_title: debug
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Event'
|
||||
sidebar_title: event
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Exec'
|
||||
sidebar_title: exec
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Force Leave'
|
||||
sidebar_title: force-leave
|
||||
description: >-
|
||||
|
|
@ -48,7 +48,7 @@ consul force-leave ec2-001-staging
|
|||
```
|
||||
|
||||
When run on a server that is part of a
|
||||
[WAN gossip pool](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan),
|
||||
[WAN gossip pool](https://learn.hashicorp.com/consul/security-networking/datacenters),
|
||||
`force-leave` can remove failed servers in other datacenters from the WAN pool.
|
||||
|
||||
The identifying node-name in a WAN pool is `[node-name].[datacenter]`.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: Commands
|
||||
sidebar_title: Commands (CLI)
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Info'
|
||||
sidebar_title: info
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention Check'
|
||||
sidebar_title: check
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention Get'
|
||||
sidebar_title: get
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention'
|
||||
sidebar_title: intention
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Intention Match'
|
||||
sidebar_title: match
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Join'
|
||||
sidebar_title: join
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Keygen'
|
||||
sidebar_title: keygen
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Keyring'
|
||||
sidebar_title: keyring
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV Export'
|
||||
sidebar_title: export
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV Get'
|
||||
sidebar_title: get
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV Import'
|
||||
sidebar_title: import
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV'
|
||||
sidebar_title: kv
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: KV Put'
|
||||
sidebar_title: put
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Leave'
|
||||
sidebar_title: leave
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: License'
|
||||
sidebar_title: license
|
||||
description: >
|
||||
|
|
@ -17,8 +17,8 @@ The `license` command provides datacenter-level management of the Consul Enterpr
|
|||
|
||||
If ACLs are enabled then a token with operator privileges may be required in
|
||||
order to use this command. Requests are forwarded internally to the leader
|
||||
if required, so this can be run from any Consul node in a cluster. Review the
|
||||
[ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
||||
if required, so this can be run from any Consul node in a cluster. See the
|
||||
[ACL Guide](https://learn.hashicorp.com/consul/security-networking/production-acls) for more information.
|
||||
|
||||
```text
|
||||
Usage: consul license <subcommand> [options] [args]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Lock'
|
||||
sidebar_title: lock
|
||||
description: >-
|
||||
|
|
@ -19,11 +19,11 @@ communication is disrupted, the child process is terminated.
|
|||
|
||||
The number of lock holders is configurable with the `-n` flag. By default,
|
||||
a single holder is allowed, and a lock is used for mutual exclusion. This
|
||||
uses the [leader election algorithm](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
|
||||
uses the [leader election algorithm](https://learn.hashicorp.com/consul/developer-configuration/elections).
|
||||
|
||||
If the lock holder count is more than one, then a semaphore is used instead.
|
||||
A semaphore allows more than a single holder, but this is less efficient than
|
||||
a simple lock. This follows the [semaphore algorithm](https://learn.hashicorp.com/tutorials/consul/distributed-semaphore).
|
||||
a simple lock. This follows the [semaphore algorithm](https://learn.hashicorp.com/consul/developer-configuration/semaphore).
|
||||
|
||||
All locks using the same prefix must agree on the value of `-n`. If conflicting
|
||||
values of `-n` are provided, an error will be returned.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Login'
|
||||
sidebar_title: login
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Logout'
|
||||
sidebar_title: logout
|
||||
description: >
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Maint'
|
||||
sidebar_title: maint
|
||||
description: |
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Members'
|
||||
sidebar_title: members
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Monitor'
|
||||
sidebar_title: monitor
|
||||
description: >-
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace Create'
|
||||
sidebar_title: create
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace Delete'
|
||||
sidebar_title: delete
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace'
|
||||
sidebar_title: namespace
|
||||
description: |
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace List'
|
||||
sidebar_title: list
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace Read'
|
||||
sidebar_title: read
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace Update'
|
||||
sidebar_title: update
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Namespace Write'
|
||||
sidebar_title: write
|
||||
---
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Operator Area'
|
||||
sidebar_title: area
|
||||
description: >
|
||||
|
|
@ -22,7 +22,7 @@ and relationships can be made between independent pairs of datacenters, so not a
|
|||
need to be fully connected. This allows for complex topologies among Consul datacenters like
|
||||
hub/spoke and more general trees.
|
||||
|
||||
Review the [Network Areas tutorial](https://learn.hashicorp.com/tutorials/consul/federation-network-areas) for more details.
|
||||
See the [Network Areas Guide](https://learn.hashicorp.com/consul/day-2-operations/advanced-federation) for more details.
|
||||
|
||||
```text
|
||||
Usage: consul operator area <subcommand> [options]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Operator Autopilot'
|
||||
sidebar_title: autopilot
|
||||
description: >
|
||||
|
|
@ -12,8 +12,8 @@ description: >
|
|||
Command: `consul operator autopilot`
|
||||
|
||||
The Autopilot operator command is used to interact with Consul's Autopilot subsystem. The
|
||||
command can be used to view or modify the current Autopilot configuration. Review the
|
||||
[Autopilot tutorial](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations) for more information about Autopilot.
|
||||
command can be used to view or modify the current Autopilot configuration. See the
|
||||
[Autopilot Guide](https://learn.hashicorp.com/consul/day-2-operations/autopilot) for more information about Autopilot.
|
||||
|
||||
```text
|
||||
Usage: consul operator autopilot <subcommand> [options]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Operator'
|
||||
sidebar_title: operator
|
||||
description: |
|
||||
|
|
@ -18,12 +18,12 @@ outage and even loss of data.
|
|||
|
||||
If ACLs are enabled then a token with operator privileges may be required in
|
||||
order to use this command. Requests are forwarded internally to the leader
|
||||
if required, so this can be run from any Consul node in a cluster. Review the
|
||||
[ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
||||
if required, so this can be run from any Consul node in a cluster. See the
|
||||
[ACL Guide](https://learn.hashicorp.com/consul/security-networking/production-acls) for more information.
|
||||
|
||||
Review the [Outage Recovery](https://learn.hashicorp.com/tutorials/consul/recovery-outage) tutorial for some examples of how
|
||||
See the [Outage Recovery](https://learn.hashicorp.com/consul/day-2-operations/outage) guide for some examples of how
|
||||
this command is used. For an API to perform these operations programmatically,
|
||||
please check the documentation for the [Operator](/api/operator)
|
||||
please see the documentation for the [Operator](/api/operator)
|
||||
endpoint.
|
||||
|
||||
## Usage
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: docs
|
||||
layout: commands
|
||||
page_title: 'Commands: Operator Raft'
|
||||
sidebar_title: raft
|
||||
description: >
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue