mirror of https://github.com/hashicorp/consul
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1960 lines
53 KiB
1960 lines
53 KiB
[
|
|
{
|
|
"title": "What is Consul?",
|
|
"path": "intro"
|
|
},
|
|
{
|
|
"title": "Why Choose Consul?",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "consul-vs-other"
|
|
},
|
|
{
|
|
"title": "Service Meshes",
|
|
"path": "consul-vs-other/service-mesh-compare"
|
|
},
|
|
{
|
|
"title": "DNS Tools",
|
|
"path": "consul-vs-other/dns-tools-compare"
|
|
},
|
|
{
|
|
"title": "Configuration Management Tools",
|
|
"path": "consul-vs-other/config-management-compare"
|
|
},
|
|
{
|
|
"title": "API Gateways",
|
|
"path": "consul-vs-other/api-gateway-compare"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Core Concepts",
|
|
"routes": [
|
|
{
|
|
"title": "Service Discovery",
|
|
"path": "concepts/service-discovery"
|
|
},
|
|
{
|
|
"title": "Service Mesh",
|
|
"path": "concepts/service-mesh"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Get Started",
|
|
"routes": [
|
|
{
|
|
"title": "Install Consul",
|
|
"path": "install"
|
|
},
|
|
{
|
|
"title": "Learn HCP Consul",
|
|
"href": "https://developer.hashicorp.com/consul/tutorials/get-started-hcp"
|
|
},
|
|
{
|
|
"title": "Learn Consul on Kubernetes",
|
|
"href": "https://developer.hashicorp.com/consul/tutorials/get-started-kubernetes"
|
|
},
|
|
{
|
|
"title": "Learn Consul on VMs",
|
|
"href": "https://developer.hashicorp.com/consul/tutorials/get-started-vms"
|
|
},
|
|
{
|
|
"title": "Manual Bootstrap",
|
|
"path": "install/manual-bootstrap",
|
|
"hidden": true
|
|
},
|
|
{
|
|
"title": "Consul Agent",
|
|
"href": "/docs/agent"
|
|
},
|
|
{
|
|
"title": "Glossary",
|
|
"path": "install/glossary"
|
|
},
|
|
{
|
|
"title": "Required Ports",
|
|
"path": "install/ports"
|
|
},
|
|
{
|
|
"title": "Bootstrapping a Datacenter",
|
|
"path": "install/bootstrapping"
|
|
},
|
|
{
|
|
"title": "Cloud Auto-join",
|
|
"path": "install/cloud-auto-join"
|
|
},
|
|
{
|
|
"title": "Server Performance",
|
|
"path": "install/performance"
|
|
},
|
|
{
|
|
"title": "Kubernetes",
|
|
"href": "/docs/k8s"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Architecture",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "architecture"
|
|
},
|
|
{
|
|
"title": "Improving Consul Resilience",
|
|
"path": "architecture/improving-consul-resilience"
|
|
},
|
|
{
|
|
"title": "Anti-Entropy",
|
|
"path": "architecture/anti-entropy"
|
|
},
|
|
{
|
|
"title": "Consensus Protocol",
|
|
"path": "architecture/consensus"
|
|
},
|
|
{
|
|
"title": "Gossip Protocol",
|
|
"path": "architecture/gossip"
|
|
},
|
|
{
|
|
"title": "Jepsen Testing",
|
|
"path": "architecture/jepsen"
|
|
},
|
|
{
|
|
"title": "Network Coordinates",
|
|
"path": "architecture/coordinates"
|
|
},
|
|
{
|
|
"title": "Consul at Scale",
|
|
"path": "architecture/scale"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"divider": true
|
|
},
|
|
{
|
|
"title": "Release Notes",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "release-notes"
|
|
},
|
|
{
|
|
"title": "Consul",
|
|
"routes": [
|
|
{
|
|
"title": "v1.16.x",
|
|
"path": "release-notes/consul/v1_16_x"
|
|
},
|
|
{
|
|
"title": "v1.15.x",
|
|
"path": "release-notes/consul/v1_15_x"
|
|
},
|
|
{
|
|
"title": "v1.14.x",
|
|
"path": "release-notes/consul/v1_14_x"
|
|
},
|
|
{
|
|
"title": "v1.13.x",
|
|
"path": "release-notes/consul/v1_13_x"
|
|
},
|
|
{
|
|
"title": "v1.12.x",
|
|
"path": "release-notes/consul/v1_12_x"
|
|
},
|
|
{
|
|
"title": "v1.11.x",
|
|
"path": "release-notes/consul/v1_11_x"
|
|
},
|
|
{
|
|
"title": "v1.10.x",
|
|
"path": "release-notes/consul/v1_10_x"
|
|
},
|
|
{
|
|
"title": "v1.9.x",
|
|
"path": "release-notes/consul/v1_9_x"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Consul K8s",
|
|
"routes": [
|
|
{
|
|
"title": "v1.2.x",
|
|
"path": "release-notes/consul-k8s/v1_2_x"
|
|
},
|
|
{
|
|
"title": "v1.1.x",
|
|
"path": "release-notes/consul-k8s/v1_1_x"
|
|
},
|
|
{
|
|
"title": "v1.0.x",
|
|
"path": "release-notes/consul-k8s/v1_0_x"
|
|
},
|
|
{
|
|
"title": "v0.49.x",
|
|
"path": "release-notes/consul-k8s/v0_49_x"
|
|
},
|
|
{
|
|
"title": "v0.48.x",
|
|
"path": "release-notes/consul-k8s/v0_48_x"
|
|
},
|
|
{
|
|
"title": "v0.47.x",
|
|
"path": "release-notes/consul-k8s/v0_47_x"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "API Gateway for Kubernetes",
|
|
"routes": [
|
|
{
|
|
"title": "v0.5.x",
|
|
"path": "release-notes/consul-api-gateway/v0_5_x"
|
|
},
|
|
{
|
|
"title": "v0.4.x",
|
|
"path": "release-notes/consul-api-gateway/v0_4_x"
|
|
},
|
|
{
|
|
"title": "v0.3.x",
|
|
"path": "release-notes/consul-api-gateway/v0_3_x"
|
|
},
|
|
{
|
|
"title": "v0.2.x",
|
|
"path": "release-notes/consul-api-gateway/v0_2_x"
|
|
},
|
|
{
|
|
"title": "v0.1.x",
|
|
"path": "release-notes/consul-api-gateway/v0_1_x"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Consul ECS",
|
|
"routes": [
|
|
{
|
|
"title": "v0.5.x",
|
|
"path": "release-notes/consul-ecs/v0_5_x"
|
|
},
|
|
{
|
|
"title": "v0.4.x",
|
|
"path": "release-notes/consul-ecs/v0_4_x"
|
|
},
|
|
{
|
|
"title": "v0.3.x",
|
|
"path": "release-notes/consul-ecs/v0_3_x"
|
|
},
|
|
{
|
|
"title": "v0.2.x",
|
|
"path": "release-notes/consul-ecs/v0_2_x"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Consul Terraform Sync",
|
|
"routes": [
|
|
{
|
|
"title": "v0.6.x",
|
|
"path": "release-notes/consul-terraform-sync/v0_6_x"
|
|
},
|
|
{
|
|
"title": "v0.5.x",
|
|
"path": "release-notes/consul-terraform-sync/v0_5_x"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Upgrade",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "upgrading"
|
|
},
|
|
{
|
|
"title": "Compatibility Promise",
|
|
"path": "upgrading/compatibility"
|
|
},
|
|
{
|
|
"title": "Specific Version Details",
|
|
"path": "upgrading/upgrade-specific"
|
|
},
|
|
{
|
|
"title": "Upgrade Instructions",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "upgrading/instructions"
|
|
},
|
|
{
|
|
"title": "General Process",
|
|
"path": "upgrading/instructions/general-process"
|
|
},
|
|
{
|
|
"title": "Upgrading to Latest 1.2.x",
|
|
"path": "upgrading/instructions/upgrade-to-1-2-x"
|
|
},
|
|
{
|
|
"title": "Upgrading to Latest 1.6.x",
|
|
"path": "upgrading/instructions/upgrade-to-1-6-x"
|
|
},
|
|
{
|
|
"title": "Upgrading to Latest 1.8.x",
|
|
"path": "upgrading/instructions/upgrade-to-1-8-x"
|
|
},
|
|
{
|
|
"title": "Upgrading to Latest 1.10.x",
|
|
"path": "upgrading/instructions/upgrade-to-1-10-x"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"divider": true
|
|
},
|
|
{
|
|
"title": "Services",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "services/services"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Define services",
|
|
"path": "services/usage/define-services"
|
|
},
|
|
{
|
|
"title": "Define health checks",
|
|
"path": "services/usage/checks"
|
|
},
|
|
{
|
|
"title": "Register services and health checks",
|
|
"path": "services/usage/register-services-checks"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Discover services with DNS",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "services/discovery/dns-overview"
|
|
},
|
|
{
|
|
"title": "Configure DNS behavior",
|
|
"path": "services/discovery/dns-configuration"
|
|
},
|
|
{
|
|
"title": "Perform static DNS lookups",
|
|
"path": "services/discovery/dns-static-lookups"
|
|
},
|
|
{
|
|
"title": "Enable dynamic DNS lookups",
|
|
"path": "services/discovery/dns-dynamic-lookups"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "services/configuration/services-configuration-overview"
|
|
},
|
|
{
|
|
"title": "Services",
|
|
"path": "services/configuration/services-configuration-reference"
|
|
},
|
|
{
|
|
"title": "Health checks",
|
|
"path": "services/configuration/checks-configuration-reference"
|
|
},
|
|
{
|
|
"title": "Service defaults",
|
|
"href": "connect/config-entries/service-defaults"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service Mesh",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect"
|
|
},
|
|
{
|
|
"title": "How Service Mesh Works",
|
|
"path": "connect/connect-internals"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"path": "connect/configuration"
|
|
},
|
|
{
|
|
"title": "Configuration entries",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/config-entries"
|
|
},
|
|
{
|
|
"title": "API gateway",
|
|
"href": "/consul/docs/connect/gateways/api-gateway/configuration/api-gateway"
|
|
},
|
|
{
|
|
"title": "HTTP route",
|
|
"href": "/consul/docs/connect/gateways/api-gateway/configuration/http-route"
|
|
},
|
|
{
|
|
"title": "TCP route",
|
|
"href": "/consul/docs/connect/gateways/api-gateway/configuration/tcp-route"
|
|
},
|
|
{
|
|
"title": "Inline certificate",
|
|
"href": "/consul/docs/connect/gateways/api-gateway/configuration/inline-certificate"
|
|
},
|
|
{
|
|
"title": "Ingress gateway",
|
|
"path": "connect/config-entries/ingress-gateway"
|
|
},
|
|
{
|
|
"title": "JWT Provider",
|
|
"path": "connect/config-entries/jwt-provider"
|
|
},
|
|
{
|
|
"title": "Mesh",
|
|
"path": "connect/config-entries/mesh"
|
|
},
|
|
{
|
|
"title": "Exported services",
|
|
"path": "connect/config-entries/exported-services"
|
|
},
|
|
{
|
|
"title": "Proxy defaults",
|
|
"path": "connect/config-entries/proxy-defaults"
|
|
},
|
|
{
|
|
"title": "Sameness Group",
|
|
"path": "connect/config-entries/sameness-group"
|
|
},
|
|
{
|
|
"title": "Service Defaults",
|
|
"path": "connect/config-entries/service-defaults"
|
|
},
|
|
{
|
|
"title": "Service intentions",
|
|
"path": "connect/config-entries/service-intentions"
|
|
},
|
|
{
|
|
"title": "Service resolver",
|
|
"path": "connect/config-entries/service-resolver"
|
|
},
|
|
{
|
|
"title": "Service router",
|
|
"path": "connect/config-entries/service-router"
|
|
},
|
|
{
|
|
"title": "Service splitter",
|
|
"path": "connect/config-entries/service-splitter"
|
|
},
|
|
{
|
|
"title": "Terminating gateway",
|
|
"path": "connect/config-entries/terminating-gateway"
|
|
},
|
|
{
|
|
"title": "Control plane request limit",
|
|
"path": "connect/config-entries/control-plane-request-limit"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Proxies",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/proxies"
|
|
},
|
|
{
|
|
"title": "Deploy service mesh proxies",
|
|
"path": "connect/proxies/deploy-service-mesh-proxies"
|
|
},
|
|
{
|
|
"title": "Deploy sidecar services",
|
|
"path": "connect/proxies/deploy-sidecar-services"
|
|
},
|
|
{
|
|
"title": "Envoy Extensions",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/proxies/envoy-extensions"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Delegate authorization to Apigee",
|
|
"path": "connect/proxies/envoy-extensions/usage/apigee-ext-authz"
|
|
},
|
|
{
|
|
"title": "Delegate authorization to external services",
|
|
"path": "connect/proxies/envoy-extensions/usage/ext-authz"
|
|
},
|
|
{
|
|
"title": "Run Lua scripts in Envoy proxies",
|
|
"path": "connect/proxies/envoy-extensions/usage/lua"
|
|
},
|
|
{
|
|
"title": "Invoke Lambda functions in Envoy proxies",
|
|
"path": "connect/proxies/envoy-extensions/usage/lambda"
|
|
},
|
|
{
|
|
"title": "Send access logs to OpenTelemetry collector service",
|
|
"path": "connect/proxies/envoy-extensions/usage/otel-access-logging"
|
|
},
|
|
{
|
|
"title": "Configure Envoy proxy properties",
|
|
"path": "connect/proxies/envoy-extensions/usage/property-override"
|
|
},
|
|
{
|
|
"title": "Run WebAssembly plug-ins in Envoy proxies",
|
|
"path": "connect/proxies/envoy-extensions/usage/wasm"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "External authorization",
|
|
"path": "connect/proxies/envoy-extensions/configuration/ext-authz"
|
|
},
|
|
{
|
|
"title": "OpenTelemetry Access Logging",
|
|
"path": "connect/proxies/envoy-extensions/configuration/otel-access-logging"
|
|
},
|
|
{
|
|
"title": "Property override",
|
|
"path": "connect/proxies/envoy-extensions/configuration/property-override"
|
|
},
|
|
{
|
|
"title": "WebAssembly",
|
|
"path": "connect/proxies/envoy-extensions/configuration/wasm"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Proxy integration",
|
|
"path": "connect/proxies/integrate"
|
|
},
|
|
{
|
|
"title": "Proxy defaults configuration reference",
|
|
"href": "/consul/docs/connect/config-entries/proxy-defaults"
|
|
},
|
|
{
|
|
"title": "Envoy proxies reference",
|
|
"path": "connect/proxies/envoy"
|
|
},
|
|
{
|
|
"title": "Built-in proxy reference",
|
|
"path": "connect/proxies/built-in"
|
|
},
|
|
{
|
|
"title": "Service mesh proxy configuration reference",
|
|
"path": "connect/proxies/proxy-config-reference"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service intentions",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/intentions"
|
|
},
|
|
{
|
|
"title": "Create and manage service intentions",
|
|
"path": "connect/intentions/create-manage-intentions"
|
|
},
|
|
{
|
|
"title": "JWT authorization for intentions",
|
|
"path": "connect/intentions/jwt-authorization"
|
|
},
|
|
{
|
|
"title": "Service intentions legacy mode",
|
|
"path": "connect/intentions/legacy"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"href": "/consul/docs/connect/config-entries/service-intentions"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Observability",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/observability"
|
|
},
|
|
{
|
|
"title": "Access Logs",
|
|
"path": "connect/observability/access-logs"
|
|
},
|
|
{
|
|
"title": "UI Visualization",
|
|
"path": "connect/observability/ui-visualization"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "L7 Traffic Management",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/l7-traffic"
|
|
},
|
|
{
|
|
"title": "Discovery Chain",
|
|
"path": "connect/l7-traffic/discovery-chain"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Connectivity Tasks",
|
|
"path": "connect/connectivity-tasks"
|
|
},
|
|
{
|
|
"title": "Distributed Tracing",
|
|
"path": "connect/distributed-tracing"
|
|
},
|
|
{
|
|
"title": "Gateways",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/gateways"
|
|
},
|
|
{
|
|
"title": "API Gateways",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/gateways/api-gateway"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"path": "connect/gateways/api-gateway/usage"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "API Gateway",
|
|
"path": "connect/gateways/api-gateway/configuration/api-gateway"
|
|
},
|
|
{
|
|
"title": "HTTP Route",
|
|
"path": "connect/gateways/api-gateway/configuration/http-route"
|
|
},
|
|
{
|
|
"title": "TCP Route",
|
|
"path": "connect/gateways/api-gateway/configuration/tcp-route"
|
|
},
|
|
{
|
|
"title": "Inline Certificate",
|
|
"path": "connect/gateways/api-gateway/configuration/inline-certificate"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Mesh Gateways",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/gateways/mesh-gateway"
|
|
},
|
|
{
|
|
"title": "Enabling WAN Federation Control Plane Traffic",
|
|
"path": "connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways"
|
|
},
|
|
{
|
|
"title": "Enabling Service-to-service Traffic Across WAN Federated Datacenters",
|
|
"path": "connect/gateways/mesh-gateway/service-to-service-traffic-wan-datacenters"
|
|
},
|
|
{
|
|
"title": "Enabling Service-to-service Traffic Across Admin Partitions",
|
|
"path": "connect/gateways/mesh-gateway/service-to-service-traffic-partitions"
|
|
},
|
|
{
|
|
"title": "Enabling Peering Control Plane Traffic",
|
|
"path": "connect/gateways/mesh-gateway/peering-via-mesh-gateways"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Ingress Gateways",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/gateways/ingress-gateway"
|
|
},
|
|
{
|
|
"title": "Implement an ingress gateway",
|
|
"path": "connect/gateways/ingress-gateway/usage"
|
|
},
|
|
{
|
|
"title": "Serve TLS certificates from an external service",
|
|
"path": "connect/gateways/ingress-gateway/tls-external-service"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"href": "/consul/docs/connect/config-entries/ingress-gateway"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Terminating Gateways",
|
|
"path": "connect/gateways/terminating-gateway"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Cluster Peering",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/cluster-peering"
|
|
},
|
|
{
|
|
"title": "Technical Specifications",
|
|
"path": "connect/cluster-peering/tech-specs"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Establish Cluster Peering Connections",
|
|
"path": "connect/cluster-peering/usage/establish-cluster-peering"
|
|
},
|
|
{
|
|
"title": "Manage Cluster Peering Connections",
|
|
"path": "connect/cluster-peering/usage/manage-connections"
|
|
},
|
|
{
|
|
"title": "Manage L7 Traffic With Cluster Peering",
|
|
"path": "connect/cluster-peering/usage/peering-traffic-management"
|
|
},
|
|
{
|
|
"title": "Create Sameness Groups",
|
|
"path": "connect/cluster-peering/usage/create-sameness-groups"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Failover",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/failover"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Configure failover services for Kubernetes",
|
|
"href": "/docs/k8s/l7-traffic/failover-tproxy"
|
|
},
|
|
{
|
|
"title": "Automate geo-failover with prepared queries",
|
|
"href": "/tutorials/developer-discovery/automate-geo-failover"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "Service resolver",
|
|
"href": "/consul/docs/connect/config-entries/service-resolver"
|
|
},
|
|
{
|
|
"title": "Service intentions",
|
|
"href": "/consul/docs/connect/config-entries/service-intentions"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Nomad",
|
|
"path": "connect/nomad"
|
|
},
|
|
{
|
|
"title": "Kubernetes",
|
|
"href": "/docs/k8s/connect"
|
|
},
|
|
{
|
|
"title": "Native App Integration",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/native"
|
|
},
|
|
{
|
|
"title": "Go Integration",
|
|
"path": "connect/native/go"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Certificate Management",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/ca"
|
|
},
|
|
{
|
|
"title": "Built-In CA",
|
|
"path": "connect/ca/consul"
|
|
},
|
|
{
|
|
"title": "Vault",
|
|
"path": "connect/ca/vault"
|
|
},
|
|
{
|
|
"title": "ACM Private CA",
|
|
"path": "connect/ca/aws"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Develop and Debug",
|
|
"path": "connect/dev"
|
|
},
|
|
{
|
|
"title": "Security",
|
|
"path": "connect/security",
|
|
"hidden": true
|
|
},
|
|
{
|
|
"title": "Consul Dataplane",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/dataplane"
|
|
},
|
|
{
|
|
"title": "CLI Reference",
|
|
"path": "connect/dataplane/consul-dataplane"
|
|
},
|
|
{
|
|
"title": "Telemetry",
|
|
"path": "connect/dataplane/telemetry"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Dynamic App Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "Consul KV",
|
|
"path": "dynamic-app-config/kv"
|
|
},
|
|
{
|
|
"title": "Sessions",
|
|
"path": "dynamic-app-config/sessions"
|
|
},
|
|
{
|
|
"title": "Watches",
|
|
"path": "dynamic-app-config/watches"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Security",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "security"
|
|
},
|
|
{
|
|
"title": "Access Control (ACLs)",
|
|
"routes": [
|
|
{
|
|
"title": "ACL System Overview",
|
|
"path": "security/acl"
|
|
},
|
|
{
|
|
"title": "Tokens",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "security/acl/tokens"
|
|
},
|
|
{
|
|
"title": "Create ACL Tokens",
|
|
"routes": [
|
|
{
|
|
"title": "Create a service token",
|
|
"path": "security/acl/tokens/create/create-a-service-token"
|
|
},
|
|
{
|
|
"title": "Create an agent token",
|
|
"path": "security/acl/tokens/create/create-an-agent-token"
|
|
},
|
|
{
|
|
"title": "Create a UI token",
|
|
"path": "security/acl/tokens/create/create-a-ui-token"
|
|
},
|
|
{
|
|
"title": "Create a mesh gateway token",
|
|
"path": "security/acl/tokens/create/create-a-mesh-gateway-token"
|
|
},
|
|
{
|
|
"title": "Create an ingress gateway token",
|
|
"path": "security/acl/tokens/create/create-an-ingress-gateway-token"
|
|
},
|
|
{
|
|
"title": "Create a terminating gateway token",
|
|
"path": "security/acl/tokens/create/create-a-terminating-gateway-token"
|
|
},
|
|
{
|
|
"title": "Create a DNS token",
|
|
"path": "security/acl/tokens/create/create-a-dns-token"
|
|
},
|
|
{
|
|
"title": "Create a replication token",
|
|
"path": "security/acl/tokens/create/create-a-replication-token"
|
|
},
|
|
{
|
|
"title": "Create a snapshot agent token",
|
|
"path": "security/acl/tokens/create/create-a-snapshot-agent-token"
|
|
},
|
|
{
|
|
"title": "Create a token for Vault's Consul storage backend",
|
|
"path": "security/acl/tokens/create/create-a-token-for-vault-consul-storage"
|
|
},
|
|
{
|
|
"title": "Create a Consul ESM token",
|
|
"path": "security/acl/tokens/create/create-a-consul-esm-token"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Policies",
|
|
"path": "security/acl/acl-policies"
|
|
},
|
|
{
|
|
"title": "Roles",
|
|
"path": "security/acl/acl-roles"
|
|
},
|
|
{
|
|
"title": "Rules Reference",
|
|
"path": "security/acl/acl-rules"
|
|
},
|
|
{
|
|
"title": "ACLs in Federated Datacenters",
|
|
"path": "security/acl/acl-federated-datacenters"
|
|
},
|
|
{
|
|
"title": "Auth Methods",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "security/acl/auth-methods"
|
|
},
|
|
{
|
|
"title": "Kubernetes",
|
|
"path": "security/acl/auth-methods/kubernetes"
|
|
},
|
|
{
|
|
"title": "JWT",
|
|
"path": "security/acl/auth-methods/jwt"
|
|
},
|
|
{
|
|
"title": "OIDC",
|
|
"path": "security/acl/auth-methods/oidc"
|
|
},
|
|
{
|
|
"title": "AWS IAM",
|
|
"path": "security/acl/auth-methods/aws-iam"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Encryption",
|
|
"path": "security/encryption"
|
|
},
|
|
{
|
|
"title": "Security Models",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "security/security-models"
|
|
},
|
|
{
|
|
"title": "Core",
|
|
"path": "security/security-models/core"
|
|
},
|
|
{
|
|
"title": "Network Infrastructure Automation",
|
|
"path": "security/security-models/nia"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Agent",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "agent"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "General",
|
|
"path": "agent/config"
|
|
},
|
|
{
|
|
"title": "CLI Reference",
|
|
"path": "agent/config/cli-flags"
|
|
},
|
|
{
|
|
"title": "Configuration Reference",
|
|
"path": "agent/config/config-files"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Limit traffic rates",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "agent/limits"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Initialize rate limit settings",
|
|
"path": "agent/limits/usage/init-rate-limits"
|
|
},
|
|
{
|
|
"title": "Monitor traffic rate limits",
|
|
"path": "agent/limits/usage/monitor-rate-limits"
|
|
},
|
|
{
|
|
"title": "Set global traffic rate limits",
|
|
"path": "agent/limits/usage/set-global-traffic-rate-limits"
|
|
},
|
|
{
|
|
"title": "Limit traffic rates from source IP addresses",
|
|
"path": "agent/limits/usage/limit-request-rates-from-ips"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"href": "/docs/connect/config-entries/control-plane-request-limit"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration Entries",
|
|
"path": "agent/config-entries"
|
|
},
|
|
{
|
|
"title": "Telemetry",
|
|
"path": "agent/telemetry"
|
|
},
|
|
{
|
|
"title": "Sentinel",
|
|
"path": "agent/sentinel"
|
|
},
|
|
{
|
|
"title": "Experimental WAL LogStore",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "agent/wal-logstore"
|
|
},
|
|
{
|
|
"title": "Enable WAL LogStore backend",
|
|
"path": "agent/wal-logstore/enable"
|
|
},
|
|
{
|
|
"title": "Monitor Raft metrics and logs for WAL",
|
|
"path": "agent/wal-logstore/monitoring"
|
|
},
|
|
{
|
|
"title": "Revert to BoltDB",
|
|
"path": "agent/wal-logstore/revert-to-boltdb"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Integrations",
|
|
"routes": [
|
|
{
|
|
"title": "Consul Integration Program",
|
|
"path": "integrate/partnerships"
|
|
},
|
|
{
|
|
"title": "NIA Integration Program",
|
|
"path": "integrate/nia-integration"
|
|
},
|
|
{
|
|
"title": "Vault Integration",
|
|
"href": "/docs/connect/ca/vault"
|
|
},
|
|
{
|
|
"title": "Proxy Integration",
|
|
"href": "/docs/connect/proxies/integrate"
|
|
},
|
|
{
|
|
"title": "Consul Tools",
|
|
"path": "integrate/download-tools"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Troubleshoot",
|
|
"routes": [
|
|
{
|
|
"title": "Service-to-Service Troubleshooting",
|
|
"path": "troubleshoot/troubleshoot-services"
|
|
},
|
|
{
|
|
"title": "Common Error Messages",
|
|
"path": "troubleshoot/common-errors"
|
|
},
|
|
{
|
|
"title": "FAQ",
|
|
"path": "troubleshoot/faq"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"divider": true
|
|
},
|
|
{
|
|
"title": "Kubernetes",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s"
|
|
},
|
|
{
|
|
"title": "Architecture",
|
|
"path": "k8s/architecture"
|
|
},
|
|
{
|
|
"title": "Installation",
|
|
"routes": [
|
|
{
|
|
"title": "Install from Consul K8s CLI",
|
|
"path": "k8s/installation/install-cli"
|
|
},
|
|
{
|
|
"title": "Install from Helm Chart",
|
|
"path": "k8s/installation/install"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Deployment Configurations",
|
|
"routes": [
|
|
{
|
|
"title": "Consul Clients Outside Kubernetes",
|
|
"path": "k8s/deployment-configurations/clients-outside-kubernetes"
|
|
},
|
|
{
|
|
"title": "Consul Servers Outside Kubernetes",
|
|
"path": "k8s/deployment-configurations/servers-outside-kubernetes"
|
|
},
|
|
{
|
|
"title": "Single Consul Datacenter in Multiple Kubernetes Clusters",
|
|
"path": "k8s/deployment-configurations/single-dc-multi-k8s"
|
|
},
|
|
{
|
|
"title": "Consul Enterprise",
|
|
"path": "k8s/deployment-configurations/consul-enterprise"
|
|
},
|
|
{
|
|
"title": "Multi-Cluster Federation",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/deployment-configurations/multi-cluster"
|
|
},
|
|
{
|
|
"title": "Federation Between Kubernetes Clusters",
|
|
"path": "k8s/deployment-configurations/multi-cluster/kubernetes"
|
|
},
|
|
{
|
|
"title": "Federation Between VMs and Kubernetes",
|
|
"path": "k8s/deployment-configurations/multi-cluster/vms-and-kubernetes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Vault as Secrets Backend",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/deployment-configurations/vault"
|
|
},
|
|
{
|
|
"title": "Systems Integration",
|
|
"path": "k8s/deployment-configurations/vault/systems-integration"
|
|
},
|
|
{
|
|
"title": "Data Integration",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/deployment-configurations/vault/data-integration"
|
|
},
|
|
{
|
|
"title": "Bootstrap Token",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/bootstrap-token"
|
|
},
|
|
{
|
|
"title": "Enterprise License",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/enterprise-license"
|
|
},
|
|
{
|
|
"title": "Gossip Encryption Key",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/gossip"
|
|
},
|
|
{
|
|
"title": "Partition Token",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/partition-token"
|
|
},
|
|
{
|
|
"title": "Replication Token",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/replication-token"
|
|
},
|
|
{
|
|
"title": "Server TLS",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/server-tls"
|
|
},
|
|
{
|
|
"title": "Service Mesh Certificates",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/connect-ca"
|
|
},
|
|
{
|
|
"title": "Snapshot Agent Config",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/snapshot-agent-config"
|
|
},
|
|
{
|
|
"title": "Webhook Certificates",
|
|
"path": "k8s/deployment-configurations/vault/data-integration/webhook-certs"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "WAN Federation",
|
|
"path": "k8s/deployment-configurations/vault/wan-federation"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Platform Guides",
|
|
"routes": [
|
|
{
|
|
"title": "Minikube",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-minikube?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=mk"
|
|
},
|
|
{
|
|
"title": "Kind",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-kind?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=kind"
|
|
},
|
|
{
|
|
"title": "AKS (Azure)",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-aks-azure?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=aks"
|
|
},
|
|
{
|
|
"title": "EKS (AWS)",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-eks-aws?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=eks"
|
|
},
|
|
{
|
|
"title": "GKE (Google Cloud)",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-gke-google?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=gke"
|
|
},
|
|
{
|
|
"title": "Red Hat OpenShift",
|
|
"href": "https://learn.hashicorp.com/tutorials/consul/kubernetes-openshift-red-hat?utm_source=consul.io&utm_medium=docs&utm_content=k8s&utm_term=openshift"
|
|
},
|
|
{
|
|
"title": "Self Hosted Kubernetes",
|
|
"path": "k8s/platforms/self-hosted-kubernetes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service Mesh",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/connect"
|
|
},
|
|
{
|
|
"title": "Admin Partitions",
|
|
"href": "/docs/enterprise/admin-partitions"
|
|
},
|
|
{
|
|
"title": "Cluster Peering",
|
|
"routes": [
|
|
{
|
|
"title": "Technical Specifications",
|
|
"path": "k8s/connect/cluster-peering/tech-specs"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Establish Cluster Peering Connections",
|
|
"path": "k8s/connect/cluster-peering/usage/establish-peering"
|
|
},
|
|
{
|
|
"title": "Manage Cluster Peering Connections",
|
|
"path": "k8s/connect/cluster-peering/usage/manage-peering"
|
|
},
|
|
{
|
|
"title": "Manage L7 Traffic With Cluster Peering",
|
|
"path": "k8s/connect/cluster-peering/usage/l7-traffic"
|
|
},
|
|
{
|
|
"title": "Create Sameness Groups",
|
|
"path": "k8s/connect/cluster-peering/usage/create-sameness-groups"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Transparent Proxy",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/connect/transparent-proxy"
|
|
},
|
|
{
|
|
"title": "Enable transparent proxy",
|
|
"path": "k8s/connect/transparent-proxy/enable-transparent-proxy"
|
|
},
|
|
{
|
|
"title": "Route traffic to virtual services",
|
|
"href": "/docs/k8s/l7-traffic/route-to-virtual-services"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Onboarding services in transparent proxy mode",
|
|
"path": "k8s/connect/onboarding-tproxy-mode"
|
|
},
|
|
{
|
|
"title": "Ingress Gateways",
|
|
"path": "k8s/connect/ingress-gateways"
|
|
},
|
|
{
|
|
"title": "Terminating Gateways",
|
|
"path": "k8s/connect/terminating-gateways"
|
|
},
|
|
{
|
|
"title": "Ingress Controllers",
|
|
"path": "k8s/connect/ingress-controllers"
|
|
},
|
|
{
|
|
"title": "Configuring a Connect CA Provider",
|
|
"path": "k8s/connect/connect-ca-provider"
|
|
},
|
|
{
|
|
"title": "Health Checks",
|
|
"path": "k8s/connect/health"
|
|
},
|
|
{
|
|
"title": "Observability",
|
|
"routes": [
|
|
{
|
|
"title": "Metrics",
|
|
"path": "k8s/connect/observability/metrics"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "L7 traffic management",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"href": "/docs/connect/l7-traffic"
|
|
},
|
|
{
|
|
"title": "Configure failover services",
|
|
"path": "k8s/l7-traffic/failover-tproxy"
|
|
},
|
|
{
|
|
"title": "Route traffic to virtual services",
|
|
"path": "k8s/l7-traffic/route-to-virtual-services"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service Sync",
|
|
"path": "k8s/service-sync"
|
|
},
|
|
{
|
|
"title": "Custom Resource Definitions",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/crds"
|
|
},
|
|
{
|
|
"title": "Upgrade An Existing Cluster to CRDs",
|
|
"path": "k8s/crds/upgrade-to-crds"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Annotations and Labels",
|
|
"path": "k8s/annotations-and-labels"
|
|
},
|
|
{
|
|
"title": "Consul DNS",
|
|
"path": "k8s/dns"
|
|
},
|
|
{
|
|
"title": "Upgrade",
|
|
"routes": [
|
|
{
|
|
"title": "Upgrading Consul on Kubernetes",
|
|
"path": "k8s/upgrade"
|
|
},
|
|
{
|
|
"title": "Upgrading Consul K8s CLI",
|
|
"path": "k8s/upgrade/upgrade-cli"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Consul Dataplane",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"href": "/docs/connect/dataplane"
|
|
},
|
|
{
|
|
"title": "CLI Reference",
|
|
"href": "/docs/connect/dataplane/consul-dataplane"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Operations",
|
|
"routes": [
|
|
{
|
|
"title": "Uninstall",
|
|
"path": "k8s/operations/uninstall"
|
|
},
|
|
{
|
|
"title": "Certificate Rotation",
|
|
"path": "k8s/operations/certificate-rotation"
|
|
},
|
|
{
|
|
"title": "Gossip Encryption Key Rotation",
|
|
"path": "k8s/operations/gossip-encryption-key-rotation"
|
|
},
|
|
{
|
|
"title": "Configure TLS on an Existing Cluster",
|
|
"path": "k8s/operations/tls-on-existing-cluster"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Troubleshoot",
|
|
"routes": [
|
|
{
|
|
"title": "Common Error Messages",
|
|
"href": "/docs/troubleshoot/common-errors#common-errors-on-kubernetes"
|
|
},
|
|
{
|
|
"title": "FAQ",
|
|
"href": "/docs/troubleshoot/faq#consul-on-kubernetes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Compatibility Matrix",
|
|
"path": "k8s/compatibility"
|
|
},
|
|
{
|
|
"title": "Helm Chart Configuration",
|
|
"path": "k8s/helm"
|
|
},
|
|
{
|
|
"title": "Consul K8s CLI Reference",
|
|
"path": "k8s/k8s-cli"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "AWS ECS",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "ecs"
|
|
},
|
|
{
|
|
"title": "Requirements",
|
|
"path": "ecs/requirements"
|
|
},
|
|
{
|
|
"title": "Task Resource Usage",
|
|
"path": "ecs/task-resource-usage"
|
|
},
|
|
{
|
|
"title": "Install with Terraform",
|
|
"routes": [
|
|
{
|
|
"title": "Installation",
|
|
"path": "ecs/terraform/install"
|
|
},
|
|
{
|
|
"title": "Secure Configuration",
|
|
"path": "ecs/terraform/secure-configuration"
|
|
},
|
|
{
|
|
"title": "Migrate Existing Tasks",
|
|
"path": "ecs/terraform/migrate-existing-tasks"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Install Manually",
|
|
"routes": [
|
|
{
|
|
"title": "Installation",
|
|
"path": "ecs/manual/install"
|
|
},
|
|
{
|
|
"title": "Secure Configuration",
|
|
"path": "ecs/manual/secure-configuration"
|
|
},
|
|
{
|
|
"title": "ACL Controller",
|
|
"path": "ecs/manual/acl-controller"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Architecture",
|
|
"path": "ecs/architecture"
|
|
},
|
|
{
|
|
"title": "Consul Enterprise",
|
|
"path": "ecs/enterprise"
|
|
},
|
|
{
|
|
"title": "Configuration Reference",
|
|
"path": "ecs/configuration-reference"
|
|
},
|
|
{
|
|
"title": "Compatibility Matrix",
|
|
"path": "ecs/compatibility"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "AWS Lambda",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "lambda"
|
|
},
|
|
{
|
|
"title": "Register Lambda Functions",
|
|
"routes": [
|
|
{
|
|
"title": "Requirements",
|
|
"path": "lambda/registration"
|
|
},
|
|
{
|
|
"title": "Automate Registration",
|
|
"path": "lambda/registration/automate"
|
|
},
|
|
{
|
|
"title": "Manual Registration",
|
|
"path": "lambda/registration/manual"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Invoke Lambda Functions from Services",
|
|
"path": "lambda/invocation"
|
|
},
|
|
{
|
|
"title": "Invoke Services from Lambda Functions",
|
|
"path": "lambda/invoke-from-lambda",
|
|
"badge": {
|
|
"text": "BETA",
|
|
"type": "outlined",
|
|
"color": "neutral"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"divider": true
|
|
},
|
|
{
|
|
"title": "HCP Consul",
|
|
"href": "https://cloud.hashicorp.com/docs/consul"
|
|
},
|
|
{
|
|
"title": "Consul Enterprise",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "enterprise"
|
|
},
|
|
{
|
|
"title": "Admin Partitions",
|
|
"path": "enterprise/admin-partitions"
|
|
},
|
|
{
|
|
"title": "Audit Logging",
|
|
"path": "enterprise/audit-logging"
|
|
},
|
|
{
|
|
"title": "Automated Backups",
|
|
"path": "enterprise/backups"
|
|
},
|
|
{
|
|
"title": "Automated Upgrades",
|
|
"path": "enterprise/upgrades"
|
|
},
|
|
{
|
|
"title": "Enhanced Read Scalability",
|
|
"path": "enterprise/read-scale"
|
|
},
|
|
{
|
|
"title": "FIPS",
|
|
"path": "enterprise/fips"
|
|
},
|
|
{
|
|
"title": "Single sign-on - OIDC",
|
|
"href": "/docs/security/acl/auth-methods/oidc"
|
|
},
|
|
{
|
|
"title": "Redundancy Zones",
|
|
"path": "enterprise/redundancy"
|
|
},
|
|
{
|
|
"title": "Advanced Federation",
|
|
"path": "enterprise/federation"
|
|
},
|
|
{
|
|
"title": "Network Segments",
|
|
"routes": [
|
|
{
|
|
"title": "Network Segments Overview",
|
|
"path": "enterprise/network-segments/network-segments-overview"
|
|
},
|
|
{
|
|
"title": "Create a Network Segment",
|
|
"path": "enterprise/network-segments/create-network-segment"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Namespaces",
|
|
"path": "enterprise/namespaces"
|
|
},
|
|
{
|
|
"title": "NIA with TFE",
|
|
"href": "/docs/nia/enterprise"
|
|
},
|
|
{
|
|
"title": "License",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "enterprise/license/overview"
|
|
},
|
|
{
|
|
"title": "Automated entitlement utilization reporting",
|
|
"path": "enterprise/license/utilization-reporting"
|
|
},
|
|
{
|
|
"title": "FAQ",
|
|
"path": "enterprise/license/faq"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"divider": true
|
|
},
|
|
{
|
|
"title": "API Gateway for Kubernetes",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "api-gateway"
|
|
},
|
|
{
|
|
"title": "Installation",
|
|
"path": "api-gateway/install"
|
|
},
|
|
{
|
|
"title": "Technical Specifications",
|
|
"path": "api-gateway/tech-specs"
|
|
},
|
|
{
|
|
"title": "Upgrades",
|
|
"path": "api-gateway/upgrades"
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Deploy",
|
|
"path": "api-gateway/usage/usage"
|
|
},
|
|
{
|
|
"title": "Reroute HTTP Requests",
|
|
"path": "api-gateway/usage/reroute-http-requests"
|
|
},
|
|
{
|
|
"title": "Route Traffic to Peered Services",
|
|
"path": "api-gateway/usage/route-to-peered-services"
|
|
},
|
|
{
|
|
"title": "Error Messages",
|
|
"path": "api-gateway/usage/errors"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "api-gateway/configuration"
|
|
},
|
|
{
|
|
"title": "Gateway",
|
|
"path": "api-gateway/configuration/gateway"
|
|
},
|
|
{
|
|
"title": "GatewayClass",
|
|
"path": "api-gateway/configuration/gatewayclass"
|
|
},
|
|
{
|
|
"title": "GatewayClassConfig",
|
|
"path": "api-gateway/configuration/gatewayclassconfig"
|
|
},
|
|
{
|
|
"title": "Routes",
|
|
"path": "api-gateway/configuration/routes"
|
|
},
|
|
{
|
|
"title": "MeshService",
|
|
"path": "api-gateway/configuration/meshservice"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Network Infrastructure Automation",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia"
|
|
},
|
|
{
|
|
"title": "Get Started",
|
|
"routes": [
|
|
{
|
|
"title": "Installation",
|
|
"path": "nia/installation/install"
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"path": "nia/installation/configure"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Usage",
|
|
"routes": [
|
|
{
|
|
"title": "Requirements",
|
|
"path": "nia/usage/requirements"
|
|
},
|
|
{
|
|
"title": "Run Consul-Terraform-Sync",
|
|
"path": "nia/usage/run"
|
|
},
|
|
{
|
|
"title": "Run Consul-Terraform-Sync with High Availability",
|
|
"path": "nia/usage/run-ha"
|
|
},
|
|
{
|
|
"title": "Error Messages",
|
|
"path": "nia/usage/errors-ref"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Architecture",
|
|
"path": "nia/architecture"
|
|
},
|
|
{
|
|
"title": "API",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia/api"
|
|
},
|
|
{
|
|
"title": "Status",
|
|
"path": "nia/api/status"
|
|
},
|
|
{
|
|
"title": "Tasks",
|
|
"path": "nia/api/tasks"
|
|
},
|
|
{
|
|
"title": "Health",
|
|
"path": "nia/api/health"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "CLI",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia/cli"
|
|
},
|
|
{
|
|
"title": "task",
|
|
"path": "nia/cli/task"
|
|
},
|
|
{
|
|
"title": "start",
|
|
"path": "nia/cli/start"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Configuration",
|
|
"path": "nia/configuration"
|
|
},
|
|
{
|
|
"title": "Tasks",
|
|
"path": "nia/tasks"
|
|
},
|
|
{
|
|
"title": "Terraform Modules",
|
|
"path": "nia/terraform-modules"
|
|
},
|
|
{
|
|
"title": "Enterprise",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia/enterprise"
|
|
},
|
|
{
|
|
"title": "License",
|
|
"path": "nia/enterprise/license"
|
|
},
|
|
{
|
|
"title": "Terraform Cloud Driver",
|
|
"href": "/docs/nia/network-drivers/terraform-cloud"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Network Drivers",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia/network-drivers"
|
|
},
|
|
{
|
|
"title": "Terraform",
|
|
"path": "nia/network-drivers/terraform"
|
|
},
|
|
{
|
|
"title": "Terraform Cloud",
|
|
"path": "nia/network-drivers/terraform-cloud"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Compatibility",
|
|
"path": "nia/compatibility"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Internals",
|
|
"hidden": true,
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "internals"
|
|
},
|
|
{
|
|
"title": "ACL",
|
|
"path": "internals/acl"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Guides",
|
|
"path": "guides",
|
|
"hidden": true
|
|
}
|
|
]
|