mirror of https://github.com/status-im/consul.git
1327 lines
33 KiB
JSON
1327 lines
33 KiB
JSON
[
|
|
{
|
|
"title": "What is Consul?",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "intro"
|
|
},
|
|
{
|
|
"title": "Use Cases",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "intro/usecases",
|
|
"hidden": true
|
|
},
|
|
{
|
|
"title": "What is a Service Mesh?",
|
|
"path": "intro/usecases/what-is-a-service-mesh"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Get Started",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "install"
|
|
},
|
|
{
|
|
"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": "API",
|
|
"href": "/api-docs"
|
|
},
|
|
{
|
|
"title": "Commands (CLI)",
|
|
"href": "/commands"
|
|
},
|
|
{
|
|
"title": "Service Discovery",
|
|
"routes": [
|
|
{
|
|
"title": "Register Services - Service Definitions",
|
|
"path": "discovery/services"
|
|
},
|
|
{
|
|
"title": "Find Services - DNS Interface",
|
|
"path": "discovery/dns"
|
|
},
|
|
{
|
|
"title": "Monitor Services - Check Definitions",
|
|
"path": "discovery/checks"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": "Ingress Gateway",
|
|
"path": "connect/config-entries/ingress-gateway"
|
|
},
|
|
{
|
|
"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": "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": "Supported Proxies",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/proxies"
|
|
},
|
|
{
|
|
"title": "Envoy",
|
|
"path": "connect/proxies/envoy"
|
|
},
|
|
{
|
|
"title": "Built-in Proxy",
|
|
"path": "connect/proxies/built-in"
|
|
},
|
|
{
|
|
"title": "Proxy Integration",
|
|
"path": "connect/proxies/integrate"
|
|
},
|
|
{
|
|
"title": "Managed (Deprecated)",
|
|
"path": "connect/proxies/managed-deprecated",
|
|
"hidden": true
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Registering Proxies",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/registration"
|
|
},
|
|
{
|
|
"title": "Proxy Service Registration",
|
|
"path": "connect/registration/service-registration"
|
|
},
|
|
{
|
|
"title": "Sidecar Service Registration",
|
|
"path": "connect/registration/sidecar-service"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service-to-service permissions - Intentions",
|
|
"path": "connect/intentions"
|
|
},
|
|
{
|
|
"title": "Service-to-service permissions - Intentions (Legacy Mode)",
|
|
"path": "connect/intentions-legacy"
|
|
},
|
|
{
|
|
"title": "Transparent Proxy",
|
|
"path": "connect/transparent-proxy"
|
|
},
|
|
{
|
|
"title": "Observability",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "connect/observability"
|
|
},
|
|
{
|
|
"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": "Mesh Gateways",
|
|
"routes": [
|
|
{
|
|
"title": "WAN Federation",
|
|
"path": "connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways"
|
|
},
|
|
{
|
|
"title": "Enabling Service-to-service Traffic Across Datacenters",
|
|
"path": "connect/gateways/mesh-gateway/service-to-service-traffic-datacenters"
|
|
},
|
|
{
|
|
"title": "Enabling Service-to-service Traffic Across Admin Partitions",
|
|
"path": "connect/gateways/mesh-gateway/service-to-service-traffic-partitions"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Ingress Gateways",
|
|
"path": "connect/gateways/ingress-gateway"
|
|
},
|
|
{
|
|
"title": "Terminating Gateways",
|
|
"path": "connect/gateways/terminating-gateway"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Cluster Peering",
|
|
"routes": [
|
|
{
|
|
"title": "What is Cluster Peering",
|
|
"path": "connect/cluster-peering"
|
|
},
|
|
{
|
|
"title": "Create and Manage Peering Connections",
|
|
"path": "connect/cluster-peering/create-manage-peering"
|
|
},
|
|
{
|
|
"title": "Cluster Peering on Kubernetes",
|
|
"path": "connect/cluster-peering/k8s"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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 API Gateway",
|
|
"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": "Basic Usage",
|
|
"path": "api-gateway/usage/basic-usage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": "Kubernetes",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s"
|
|
},
|
|
{
|
|
"title": "Architecture",
|
|
"path": "k8s/architecture"
|
|
},
|
|
{
|
|
"title": "Get Started",
|
|
"routes": [
|
|
{
|
|
"title": "Installing Consul on Kubernetes",
|
|
"path": "k8s/installation/install"
|
|
},
|
|
{
|
|
"title": "Installing Consul K8s CLI",
|
|
"path": "k8s/installation/install-cli"
|
|
},
|
|
{
|
|
"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/installation/platforms/self-hosted-kubernetes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Deployment Configurations",
|
|
"routes": [
|
|
{
|
|
"title": "Consul Clients Outside Kubernetes",
|
|
"path": "k8s/installation/deployment-configurations/clients-outside-kubernetes"
|
|
},
|
|
{
|
|
"title": "Consul Servers Outside Kubernetes",
|
|
"path": "k8s/installation/deployment-configurations/servers-outside-kubernetes"
|
|
},
|
|
{
|
|
"title": "Single Consul Datacenter in Multiple Kubernetes Clusters",
|
|
"path": "k8s/installation/deployment-configurations/single-dc-multi-k8s"
|
|
},
|
|
{
|
|
"title": "Consul Enterprise",
|
|
"path": "k8s/installation/deployment-configurations/consul-enterprise"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Multi-Cluster Federation",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/installation/multi-cluster"
|
|
},
|
|
{
|
|
"title": "Federation Between Kubernetes Clusters",
|
|
"path": "k8s/installation/multi-cluster/kubernetes"
|
|
},
|
|
{
|
|
"title": "Federation Between VMs and Kubernetes",
|
|
"path": "k8s/installation/multi-cluster/vms-and-kubernetes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Vault as Secrets Backend",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/installation/vault"
|
|
},
|
|
{
|
|
"title": "Systems Integration",
|
|
"path": "k8s/installation/vault/systems-integration"
|
|
},
|
|
{
|
|
"title": "Data Integration",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/installation/vault/data-integration"
|
|
},
|
|
{
|
|
"title": "Bootstrap Token",
|
|
"path": "k8s/installation/vault/data-integration/bootstrap-token"
|
|
},
|
|
{
|
|
"title": "Enterprise License",
|
|
"path": "k8s/installation/vault/data-integration/enterprise-license"
|
|
},
|
|
{
|
|
"title": "Gossip Encryption Key",
|
|
"path": "k8s/installation/vault/data-integration/gossip"
|
|
},
|
|
{
|
|
"title": "Partition Token",
|
|
"path": "k8s/installation/vault/data-integration/partition-token"
|
|
},
|
|
{
|
|
"title": "Replication Token",
|
|
"path": "k8s/installation/vault/data-integration/replication-token"
|
|
},
|
|
{
|
|
"title": "Server TLS",
|
|
"path": "k8s/installation/vault/data-integration/server-tls"
|
|
},
|
|
{
|
|
"title": "Service Mesh Certificates",
|
|
"path": "k8s/installation/vault/data-integration/connect-ca"
|
|
},
|
|
{
|
|
"title": "Snapshot Agent Config",
|
|
"path": "k8s/installation/vault/data-integration/snapshot-agent-config"
|
|
},
|
|
{
|
|
"title": "Webhook Certificates",
|
|
"path": "k8s/installation/vault/data-integration/webhook-certs"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "WAN Federation",
|
|
"path": "k8s/installation/vault/wan-federation"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Service Mesh",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "k8s/connect"
|
|
},
|
|
{
|
|
"title": "Transparent Proxy",
|
|
"href": "/docs/connect/transparent-proxy"
|
|
},
|
|
{
|
|
"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": "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": "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 <sup>BETA</sup>",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "lambda"
|
|
},
|
|
{
|
|
"title": "Register Lambda Functions",
|
|
"path": "lambda/registration"
|
|
},
|
|
{
|
|
"title": "Invoke Lambda Functions",
|
|
"path": "lambda/invocation"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Network Infrastructure Automation",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "nia"
|
|
},
|
|
{
|
|
"title": "Get Started",
|
|
"routes": [
|
|
{
|
|
"title": "Installation",
|
|
"path": "nia/installation/install"
|
|
},
|
|
{
|
|
"title": "Requirements",
|
|
"path": "nia/installation/requirements"
|
|
},
|
|
{
|
|
"title": "Configure",
|
|
"path": "nia/installation/configure"
|
|
},
|
|
{
|
|
"title": "Run Consul-Terraform-Sync",
|
|
"path": "nia/installation/run"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": "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": "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": "Configuration Entries",
|
|
"path": "agent/config-entries"
|
|
},
|
|
{
|
|
"title": "Telemetry",
|
|
"path": "agent/telemetry"
|
|
},
|
|
{
|
|
"title": "Sentinel",
|
|
"path": "agent/sentinel"
|
|
},
|
|
{
|
|
"title": "RPC",
|
|
"path": "agent/rpc",
|
|
"hidden": true
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Security",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "security"
|
|
},
|
|
{
|
|
"title": "Access Control (ACLs)",
|
|
"routes": [
|
|
{
|
|
"title": "ACL System Overview",
|
|
"path": "security/acl"
|
|
},
|
|
{
|
|
"title": "Tokens",
|
|
"path": "security/acl/acl-tokens"
|
|
},
|
|
{
|
|
"title": "Policies",
|
|
"path": "security/acl/acl-policies"
|
|
},
|
|
{
|
|
"title": "Roles",
|
|
"path": "security/acl/acl-roles"
|
|
},
|
|
{
|
|
"title": "Rules Reference",
|
|
"path": "security/acl/acl-rules"
|
|
},
|
|
{
|
|
"title": "Legacy Mode",
|
|
"path": "security/acl/acl-legacy"
|
|
},
|
|
{
|
|
"title": "Token Migration",
|
|
"path": "security/acl/acl-migrate-tokens"
|
|
},
|
|
{
|
|
"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": "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": "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",
|
|
"path": "enterprise/network-segments"
|
|
},
|
|
{
|
|
"title": "Namespaces",
|
|
"path": "enterprise/namespaces"
|
|
},
|
|
{
|
|
"title": "NIA with TFE",
|
|
"href": "/docs/nia/enterprise"
|
|
},
|
|
{
|
|
"title": "Sentinel",
|
|
"path": "enterprise/sentinel"
|
|
},
|
|
{
|
|
"title": "License",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "enterprise/license/overview"
|
|
},
|
|
{
|
|
"title": "FAQ",
|
|
"path": "enterprise/license/faq"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": "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": "download-tools"
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Troubleshoot",
|
|
"routes": [
|
|
{
|
|
"title": "Common Error Messages",
|
|
"path": "troubleshoot/common-errors"
|
|
},
|
|
{
|
|
"title": "FAQ",
|
|
"path": "troubleshoot/faq"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Release Notes",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "release-notes"
|
|
},
|
|
{
|
|
"title": "Consul",
|
|
"routes": [
|
|
{
|
|
"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 API Gateway",
|
|
"routes": [
|
|
{
|
|
"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.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": "Internals",
|
|
"hidden": true,
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "internals"
|
|
},
|
|
{
|
|
"title": "ACL",
|
|
"path": "internals/acl"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Guides",
|
|
"path": "guides",
|
|
"hidden": true
|
|
}
|
|
]
|