Files
nomad/website/data/docs-nav-data.json
2025-09-26 07:44:58 +01:00

1741 lines
45 KiB
JSON

[
{
"heading": "Get started"
},
{
"title": "What is Nomad?",
"path": "what-is-nomad"
},
{
"title": "Quickstart",
"path": "quickstart"
},
{
"title": "Use cases",
"path": "use-cases"
},
{
"title": "Architecture",
"routes": [
{
"title": "Overview",
"path": "architecture"
},
{
"title": "Cluster",
"routes": [
{
"title": "Cluster Consensus",
"path": "architecture/cluster/consensus"
},
{
"title": "Multi-cluster federation",
"path": "architecture/cluster/federation"
},
{
"title": "Node identity",
"path": "architecture/cluster/node-identity"
},
{
"title": "Node pools",
"path": "architecture/cluster/node-pools"
}
]
},
{
"title": "CPU",
"path": "architecture/cpu"
},
{
"title": "Security",
"routes": [
{
"title": "Overview",
"path": "architecture/security"
},
{
"title": "Cluster Gossip",
"path": "architecture/security/gossip"
}
]
},
{
"title": "Storage",
"routes": [
{
"title": "Overview",
"path": "architecture/storage"
},
{
"title": "CSI",
"path": "architecture/storage/csi"
},
{
"title": "Host volumes",
"path": "architecture/storage/host-volumes"
},
{
"title": "Stateful workload considerations",
"path": "architecture/storage/stateful-workloads"
}
]
}
]
},
{
"title": "Concepts",
"routes": [
{
"title": "Allocation filesystem",
"path": "concepts/filesystem"
},
{
"title": "Job",
"path": "concepts/job"
},
{
"title": "Nomad variables",
"path": "concepts/variables"
},
{
"title": "Scheduling",
"routes": [
{
"title": "Overview",
"path": "concepts/scheduling"
},
{
"title": "How scheduling works",
"path": "concepts/scheduling/how-scheduling-works"
},
{
"title": "Placement",
"path": "concepts/scheduling/placement"
},
{
"title": "Preemption",
"path": "concepts/scheduling/preemption"
},
{
"title": "Job schedulers",
"path": "concepts/scheduling/schedulers"
}
]
},
{
"title": "Stateful deployments",
"path": "concepts/stateful-deployments"
},
{
"title": "Workload identity",
"path": "concepts/workload-identity"
}
]
},
{
"divider": "true"
},
{
"heading": "Nomad operations"
},
{
"title": "Deploy and run Nomad",
"routes": [
{
"title": "Install Nomad",
"path": "deploy"
},
{
"title": "Production deployment",
"routes": [
{
"title": "Overview",
"path": "deploy/production"
},
{
"title": "Requirements",
"path": "deploy/production/requirements"
},
{
"title": "Reference architecture",
"path": "deploy/production/reference-architecture"
},
{
"title": "Deployment guide",
"href": "https://developer.hashicorp.com/nomad/tutorials/enterprise/production-deployment-guide-vm-with-consul"
},
{
"title": "Windows service",
"path": "deploy/production/windows-service"
}
]
},
{
"title": "Operate a Nomad agent",
"path": "deploy/nomad-agent"
},
{
"title": "Build Nomad clusters",
"routes": [
{
"title": "Overview",
"path": "deploy/clusters"
},
{
"title": "Connect nodes into a cluster",
"path": "deploy/clusters/connect-nodes"
},
{
"title": "Multi-region federation considerations",
"path": "deploy/clusters/federation-considerations"
},
{
"title": "Federation failure scenarios",
"path": "deploy/clusters/federation-failure-scenarios"
},
{
"title": "Federate multi-region clusters",
"path": "deploy/clusters/federate-regions"
},
{
"title": "Load balancing",
"href": "https://developer.hashicorp.com/nomad/tutorials/load-balancing"
},
{
"title": "Configure a web UI reverse proxy",
"path": "deploy/clusters/reverse-proxy-ui"
}
]
},
{
"title": "Configure task drivers",
"routes": [
{
"title": "Overview",
"path": "deploy/task-driver"
},
{
"title": "Docker",
"path": "deploy/task-driver/docker"
},
{
"title": "Isolated Fork/Exec",
"path": "deploy/task-driver/exec"
},
{
"title": "Java",
"path": "deploy/task-driver/java"
},
{
"title": "QEMU",
"path": "deploy/task-driver/qemu"
},
{
"title": "Raw Fork/Exec",
"path": "deploy/task-driver/raw_exec"
},
{
"title": "Task driver plugins",
"routes": [
{
"title": "Exec2",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/exec2"
},
{
"title": "Podman",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/podman"
},
{
"title": "Virt <sup>Beta</sup>",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/virt"
},
{
"title": "Community",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/community"
}
]
}
]
}
]
},
{
"title": "Govern Nomad's use",
"routes": [
{
"title": "Overview",
"path": "govern"
},
{
"title": "Namespaces",
"path": "govern/namespaces"
},
{
"title": "Node pools",
"path": "govern/use-node-pools"
},
{
"title": "Resource quotas",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "govern/resource-quotas"
},
{
"title": "Sentinel policies",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "govern/sentinel"
}
]
},
{
"title": "Manage Nomad",
"routes": [
{
"title": "Overview",
"path": "manage"
},
{
"title": "Autopilot",
"path": "manage/autopilot"
},
{
"title": "Format CLI output",
"path": "manage/format-cli-output"
},
{
"title": "Garbage collection",
"path": "manage/garbage-collection"
},
{
"title": "Key management",
"path": "manage/key-management"
},
{
"title": "Migrate workloads",
"path": "manage/migrate-workloads"
},
{
"title": "Nomad variables",
"href": "https://developer.hashicorp.com/nomad/tutorials/variables/variables-create"
},
{
"title": "Recovery",
"path": "manage/outage-recovery"
}
]
},
{
"title": "Monitor Nomad",
"routes": [
{
"title": "Overview",
"path": "monitor"
},
{
"title": "Event stream",
"path": "monitor/event-stream"
},
{
"title": "Inspect job workloads",
"path": "monitor/inspect-workloads"
},
{
"title": "Inspect clusters",
"path": "monitor/inspect-cluster"
},
{
"title": "Cluster topology",
"path": "monitor/cluster-topology"
},
{
"title": "Use Prometheus",
"href": "https://developer.hashicorp.com/nomad/tutorials/manage-clusters/prometheus-metrics"
},
{
"title": "Monitor job service metrics",
"href": "https://developer.hashicorp.com/nomad/tutorials/manage-clusters/prometheus-service-mesh-metrics"
}
]
},
{
"title": "Network Nomad",
"routes": [
{
"title": "Overview",
"path": "networking"
},
{
"title": "Bridge networking with CNI",
"path": "networking/cni"
},
{
"title": "Service discovery",
"path": "networking/service-discovery"
},
{
"title": "Consul",
"routes": [
{
"title": "Overview",
"path": "networking/consul"
},
{
"title": "Service mesh",
"path": "networking/consul/service-mesh"
}
]
},
{
"title": "IPv6 support",
"path": "networking/ipv6"
}
]
},
{
"title": "Scale Nomad",
"routes": [
{
"title": "Overview",
"path": "scale"
},
{
"title": "Nomad Autoscaler",
"href": "https://developer.hashicorp.com/nomad/tools/autoscaling"
},
{
"title": "Benchmark and load test",
"path": "scale/benchmarking"
}
]
},
{
"title": "Secure Nomad",
"routes": [
{
"title": "Overview",
"path": "secure"
},
{
"title": "Access control list",
"routes": [
{
"title": "Overview",
"path": "secure/acl"
},
{
"title": "Bootstrap the ACL system",
"path": "secure/acl/bootstrap"
},
{
"title": "Integrate Consul ACL",
"path": "secure/acl/consul"
},
{
"title": "Policies",
"routes": [
{
"title": "Overview",
"path": "secure/acl/policies"
},
{
"title": "Create policies",
"path": "secure/acl/policies/create-policy"
}
]
},
{
"title": "Tokens",
"routes": [
{
"title": "Overview",
"path": "secure/acl/tokens"
},
{
"title": "Generate tokens with Vault",
"path": "secure/acl/tokens/vault"
}
]
}
]
},
{
"title": "Authentication",
"routes": [
{
"title": "Configure JWT",
"path": "secure/authentication/jwt"
},
{
"title": "Configure OIDC",
"path": "secure/authentication/oidc"
},
{
"title": "SSO with Auth0",
"path": "secure/authentication/sso-auth0"
},
{
"title": "SSO with Vault",
"path": "secure/authentication/sso-vault"
},
{
"title": "SSO with PKCE and private key JWT ",
"path": "secure/authentication/sso-pkce-jwt"
}
]
},
{
"title": "Traffic encryption",
"routes": [
{
"title": "Overview",
"path": "secure/traffic"
},
{
"title": "Enable gossip encryption",
"path": "secure/traffic/gossip-encryption"
},
{
"title": "Enable TLS",
"path": "secure/traffic/tls"
}
]
},
{
"title": "Vault",
"routes": [
{
"title": "Overview",
"path": "secure/vault"
},
{
"title": "ACL",
"path": "secure/vault/acl"
}
]
},
{
"title": "Workload identity",
"routes": [
{
"title": "Overview",
"path": "secure/workload-identity"
},
{
"title": "Federate AWS Access",
"path": "secure/workload-identity/aws-oidc-provider"
},
{
"title": "Federate GCP access",
"href": "https://developer.hashicorp.com/nomad/tutorials/fed-workload-identity/integration-gcp"
},
{
"title": "Use workload identities with Vault",
"path": "secure/workload-identity/vault"
}
]
}
]
},
{
"title": "Upgrade Nomad",
"routes": [
{
"title": "Overview",
"path": "upgrade"
},
{
"title": "Specific version details",
"path": "upgrade/upgrade-specific"
}
]
},
{
"title": "Release notes",
"routes": [
{
"title": "Overview",
"path": "release-notes"
},
{
"title": "Nomad",
"routes": [
{
"title": "Upcoming",
"path": "release-notes/nomad/upcoming"
},
{
"title": "v1.10.x",
"path": "release-notes/nomad/v1-10-x"
},
{
"title": "v1.9.x",
"path": "release-notes/nomad/v1_9_x"
},
{
"title": "v1.8.x",
"path": "release-notes/nomad/v1_8_x"
}
]
}
]
},
{
"title": "Agent configuration reference",
"href": "https://developer.hashicorp.com/nomad/docs/configuration/"
},
{
"divider": "true"
},
{
"heading": "Jobs"
},
{
"title": "Declare jobs",
"routes": [
{
"title": "Overview",
"path": "job-declare"
},
{
"title": "Create a job specification",
"path": "job-declare/create-job"
},
{
"title": "Configure tasks",
"path": "job-declare/configure-tasks"
},
{
"title": "Create a parameterized job",
"href": "https://developer.hashicorp.com/nomad/tutorials/job-specifications/job-spec-parameterized"
},
{
"title": "Use task drivers",
"routes": [
{
"title": "Overview",
"path": "job-declare/task-driver"
},
{
"title": "Docker",
"path": "job-declare/task-driver/docker"
},
{
"title": "Isolated Fork/Exec",
"path": "job-declare/task-driver/exec"
},
{
"title": "Java",
"path": "job-declare/task-driver/java"
},
{
"title": "QEMU",
"path": "job-declare/task-driver/qemu"
},
{
"title": "Raw Fork/Exec",
"path": "job-declare/task-driver/raw_exec"
},
{
"title": "Task driver plugins",
"routes": [
{
"title": "Exec2",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/exec2"
},
{
"title": "Podman",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/podman"
},
{
"title": "Virt <sup>Beta</sup>",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/virt"
},
{
"title": "Community",
"href": "http://developer.hashicorp.com/nomad/plugins/drivers/community"
}
]
}
]
},
{
"title": "Use device plugins",
"href": "https://developer.hashicorp.com/nomad/plugins/devices"
},
{
"title": "Use Consul service mesh",
"path": "job-declare/consul-service-mesh"
},
{
"title": "Use Vault",
"path": "job-declare/vault"
},
{
"title": "Configure deployment strategies",
"routes": [
{
"title": "Overview",
"path": "job-declare/strategy"
},
{
"title": "Configure blue/green and canary",
"path": "job-declare/strategy/blue-green-canary"
},
{
"title": "Configure rolling",
"path": "job-declare/strategy/rolling"
}
]
},
{
"title": "Configure multi-region deployments",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "job-declare/multiregion"
},
{
"title": "Configure task dependencies",
"path": "job-declare/task-dependencies"
},
{
"title": "Use Nomad actions",
"path": "job-declare/nomad-actions"
},
{
"title": "Use Nomad variables",
"path": "job-declare/nomad-variables"
},
{
"title": "Configure exit signals",
"path": "job-declare/exit-signals"
},
{
"title": "Handle failure",
"routes": [
{
"title": "Overview",
"path": "job-declare/failure"
},
{
"title": "Local restarts",
"path": "job-declare/failure/restart"
},
{
"title": "Health check restarts",
"path": "job-declare/failure/check-restart"
},
{
"title": "Reschedule",
"path": "job-declare/failure/reschedule"
}
]
}
]
},
{
"title": "Run jobs",
"routes": [
{
"title": "Overview",
"path": "job-run"
},
{
"title": "Inspect running jobs",
"path": "job-run/inspect"
},
{
"title": "Access logs for troubleshooting",
"path": "job-run/logs"
},
{
"title": "Collect resource utilization metrics",
"path": "job-run/utilization-metrics"
},
{
"title": "Create job versions",
"path": "job-run/versions"
}
]
},
{
"title": "Stateful workloads",
"routes": [
{
"title": "Overview",
"path": "stateful-workloads"
},
{
"title": "Use CSI volumes",
"path": "stateful-workloads/csi-volumes"
},
{
"title": "Use dynamic host volumes",
"path": "stateful-workloads/dynamic-host-volumes"
},
{
"title": "Use static host volumes",
"path": "stateful-workloads/static-host-volumes"
}
]
},
{
"title": "Workload networking",
"routes": [
{
"title": "Overview",
"path": "job-networking"
},
{
"title": "Service discovery",
"path": "job-networking/service-discovery"
},
{
"title": "Use a CNI network",
"path": "job-networking/cni"
}
]
},
{
"title": "Advanced scheduling for efficiency",
"routes": [
{
"title": "Overview",
"path": "job-scheduling"
},
{
"title": "Fault tolerance with spread",
"path": "job-scheduling/spread"
},
{
"title": "Job placement with affinities",
"path": "job-scheduling/affinity"
},
{
"title": "Job priority with preemption",
"path": "job-scheduling/preemption"
},
{
"title": "Memory oversubscription",
"href": "https://developer.hashicorp.com/nomad/tutorials/advanced-scheduling/memory-oversubscription"
}
]
},
{
"title": "Job templates with Nomad Pack",
"href": "/tools/nomad-pack/create-packs#write-the-templates"
},
{
"title": "Job specification reference",
"href": "https://developer.hashicorp.com/nomad/docs/job-specification/"
},
{
"divider": "true"
},
{
"heading": "Enterprise solutions"
},
{
"title": "Nomad Enterprise",
"routes": [
{
"title": "Features",
"path": "enterprise"
},
{
"title": "License",
"routes": [
{
"title": "Overview",
"path": "enterprise/license"
},
{
"title": "Automated license utilization reporting",
"path": "enterprise/license/utilization-reporting"
},
{
"title": "FAQ",
"path": "enterprise/license/faq"
}
]
}
]
},
{
"title": "Nomad ecosystem",
"path": "ecosystem"
},
{
"title": "Nomad partnerships",
"path": "partnerships"
},
{
"divider": "true"
},
{
"heading": "Reference docs"
},
{
"title": "Glossary",
"path": "glossary"
},
{
"title": "Agent configuration",
"routes": [
{
"title": "Overview",
"path": "configuration"
},
{
"title": "acl",
"path": "configuration/acl"
},
{
"title": "audit",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/audit"
},
{
"title": "autopilot",
"path": "configuration/autopilot"
},
{
"title": "client",
"path": "configuration/client"
},
{
"title": "consul",
"path": "configuration/consul"
},
{
"title": "keyring",
"routes": [
{
"title": "Overview",
"path": "configuration/keyring"
},
{
"title": "AWS KMS",
"path": "configuration/keyring/awskms"
},
{
"title": "Azure Key Vault",
"path": "configuration/keyring/azurekeyvault"
},
{
"title": "GCP Cloud KMS",
"path": "configuration/keyring/gcpckms"
},
{
"title": "Vault Transit",
"path": "configuration/keyring/transit"
}
]
},
{
"title": "plugin",
"path": "configuration/plugin"
},
{
"title": "reporting",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/reporting"
},
{
"title": "rpc",
"path": "configuration/rpc"
},
{
"title": "search",
"path": "configuration/search"
},
{
"title": "sentinel",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/sentinel"
},
{
"title": "server",
"path": "configuration/server"
},
{
"title": "server_join",
"path": "configuration/server_join"
},
{
"title": "telemetry",
"path": "configuration/telemetry"
},
{
"title": "tls",
"path": "configuration/tls"
},
{
"title": "ui",
"path": "configuration/ui"
},
{
"title": "vault",
"path": "configuration/vault"
}
]
},
{
"title": "Job specification",
"routes": [
{
"title": "Overview",
"path": "job-specification"
},
{
"title": "action",
"path": "job-specification/action"
},
{
"title": "affinity",
"path": "job-specification/affinity"
},
{
"title": "artifact",
"path": "job-specification/artifact"
},
{
"title": "change_script",
"path": "job-specification/change_script"
},
{
"title": "check",
"path": "job-specification/check"
},
{
"title": "check_restart",
"path": "job-specification/check_restart"
},
{
"title": "connect",
"path": "job-specification/connect"
},
{
"title": "constraint",
"path": "job-specification/constraint"
},
{
"title": "consul",
"path": "job-specification/consul"
},
{
"title": "csi_plugin",
"path": "job-specification/csi_plugin"
},
{
"title": "device",
"path": "job-specification/device"
},
{
"title": "disconnect",
"path": "job-specification/disconnect"
},
{
"title": "dispatch_payload",
"path": "job-specification/dispatch_payload"
},
{
"title": "env",
"path": "job-specification/env"
},
{
"title": "ephemeral_disk",
"path": "job-specification/ephemeral_disk"
},
{
"title": "expose",
"path": "job-specification/expose"
},
{
"title": "gateway",
"path": "job-specification/gateway"
},
{
"title": "group",
"path": "job-specification/group"
},
{
"title": "identity",
"path": "job-specification/identity"
},
{
"title": "job",
"path": "job-specification/job"
},
{
"title": "lifecycle",
"path": "job-specification/lifecycle"
},
{
"title": "logs",
"path": "job-specification/logs"
},
{
"title": "meta",
"path": "job-specification/meta"
},
{
"title": "migrate",
"path": "job-specification/migrate"
},
{
"title": "multiregion",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "job-specification/multiregion"
},
{
"title": "network",
"path": "job-specification/network"
},
{
"title": "numa",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "job-specification/numa"
},
{
"title": "parameterized",
"path": "job-specification/parameterized"
},
{
"title": "periodic",
"path": "job-specification/periodic"
},
{
"title": "proxy",
"path": "job-specification/proxy"
},
{
"title": "reschedule",
"path": "job-specification/reschedule"
},
{
"title": "resources",
"path": "job-specification/resources"
},
{
"title": "restart",
"path": "job-specification/restart"
},
{
"title": "scaling",
"path": "job-specification/scaling"
},
{
"title": "schedule",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "job-specification/schedule"
},
{
"title": "service",
"path": "job-specification/service"
},
{
"title": "sidecar_service",
"path": "job-specification/sidecar_service"
},
{
"title": "sidecar_task",
"path": "job-specification/sidecar_task"
},
{
"title": "spread",
"path": "job-specification/spread"
},
{
"title": "task",
"path": "job-specification/task"
},
{
"title": "template",
"path": "job-specification/template"
},
{
"title": "transparent_proxy",
"path": "job-specification/transparent_proxy"
},
{
"title": "ui",
"path": "job-specification/ui"
},
{
"title": "update",
"path": "job-specification/update"
},
{
"title": "upstreams",
"path": "job-specification/upstreams"
},
{
"title": "vault",
"path": "job-specification/vault"
},
{
"title": "volume",
"path": "job-specification/volume"
},
{
"title": "volume_mount",
"path": "job-specification/volume_mount"
}
]
},
{
"title": "Nomad object specifications",
"routes": [
{
"title": "Overview",
"path": "other-specifications"
},
{
"title": "ACL policy",
"path": "other-specifications/acl-policy"
},
{
"title": "Namespace",
"path": "other-specifications/namespace"
},
{
"title": "Node pool",
"path": "other-specifications/node-pool"
},
{
"title": "Resource quota",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "other-specifications/quota"
},
{
"title": "Nomad variables",
"path": "other-specifications/variables"
},
{
"title": "Volume",
"routes": [
{
"title": "Overview",
"path": "other-specifications/volume"
},
{
"title": "CSI",
"path": "other-specifications/volume/csi"
},
{
"title": "Dynamic host volumes",
"path": "other-specifications/volume/host"
},
{
"title": "capability",
"path": "other-specifications/volume/capability"
},
{
"title": "mount_options",
"path": "other-specifications/volume/mount_options"
},
{
"title": "topology_request",
"path": "other-specifications/volume/topology_request"
}
]
}
]
},
{
"title": "Reference",
"routes": [
{
"title": "Metrics",
"path": "reference/metrics"
},
{
"title": "Runtime environment settings",
"path": "reference/runtime-environment-settings"
},
{
"title": "Runtime variable interpolation",
"path": "reference/runtime-variable-interpolation"
},
{
"title": "Sentinel policy",
"badge": {
"text": "ENT",
"type": "outlined",
"color": "neutral"
},
"path": "reference/sentinel-policy"
},
{
"title": "Go template syntax",
"path": "reference/go-template-syntax"
},
{
"title": "HCL2",
"routes": [
{
"title": "Overview",
"path": "reference/hcl2"
},
{
"title": "Expressions",
"path": "reference/hcl2/expressions"
},
{
"title": "Functions",
"routes": [
{
"title": "Overview",
"path": "reference/hcl2/functions"
},
{
"title": "Collection Functions",
"routes": [
{
"title": "chunklist",
"path": "reference/hcl2/functions/collection/chunklist"
},
{
"title": "coalesce",
"path": "reference/hcl2/functions/collection/coalesce"
},
{
"title": "coalescelist",
"path": "reference/hcl2/functions/collection/coalescelist"
},
{
"title": "compact",
"path": "reference/hcl2/functions/collection/compact"
},
{
"title": "concat",
"path": "reference/hcl2/functions/collection/concat"
},
{
"title": "contains",
"path": "reference/hcl2/functions/collection/contains"
},
{
"title": "distinct",
"path": "reference/hcl2/functions/collection/distinct"
},
{
"title": "element",
"path": "reference/hcl2/functions/collection/element"
},
{
"title": "flatten",
"path": "reference/hcl2/functions/collection/flatten"
},
{
"title": "index",
"path": "reference/hcl2/functions/collection/index-fn"
},
{
"title": "keys",
"path": "reference/hcl2/functions/collection/keys"
},
{
"title": "length",
"path": "reference/hcl2/functions/collection/length"
},
{
"title": "lookup",
"path": "reference/hcl2/functions/collection/lookup"
},
{
"title": "merge",
"path": "reference/hcl2/functions/collection/merge"
},
{
"title": "range",
"path": "reference/hcl2/functions/collection/range"
},
{
"title": "reverse",
"path": "reference/hcl2/functions/collection/reverse"
},
{
"title": "setintersection",
"path": "reference/hcl2/functions/collection/setintersection"
},
{
"title": "setproduct",
"path": "reference/hcl2/functions/collection/setproduct"
},
{
"title": "setunion",
"path": "reference/hcl2/functions/collection/setunion"
},
{
"title": "slice",
"path": "reference/hcl2/functions/collection/slice"
},
{
"title": "sort",
"path": "reference/hcl2/functions/collection/sort"
},
{
"title": "values",
"path": "reference/hcl2/functions/collection/values"
},
{
"title": "zipmap",
"path": "reference/hcl2/functions/collection/zipmap"
}
]
},
{
"title": "Type Conversion Functions",
"routes": [
{
"title": "can",
"path": "reference/hcl2/functions/conversion/can"
},
{
"title": "convert",
"path": "reference/hcl2/functions/conversion/convert"
},
{
"title": "try",
"path": "reference/hcl2/functions/conversion/try"
}
]
},
{
"title": "Hash and Crypto Functions",
"routes": [
{
"title": "bcrypt",
"path": "reference/hcl2/functions/crypto/bcrypt"
},
{
"title": "md5",
"path": "reference/hcl2/functions/crypto/md5"
},
{
"title": "rsadecrypt",
"path": "reference/hcl2/functions/crypto/rsadecrypt",
"badge": {
"text": "Deprecated",
"type": "outlined",
"color": "neutral"
}
},
{
"title": "sha1",
"path": "reference/hcl2/functions/crypto/sha1"
},
{
"title": "sha256",
"path": "reference/hcl2/functions/crypto/sha256"
},
{
"title": "sha512",
"path": "reference/hcl2/functions/crypto/sha512"
}
]
},
{
"title": "Date and Time Functions",
"routes": [
{
"title": "formatdate",
"path": "reference/hcl2/functions/datetime/formatdate"
},
{
"title": "timeadd",
"path": "reference/hcl2/functions/datetime/timeadd"
}
]
},
{
"title": "Encoding Functions",
"routes": [
{
"title": "base64decode",
"path": "reference/hcl2/functions/encoding/base64decode"
},
{
"title": "base64encode",
"path": "reference/hcl2/functions/encoding/base64encode"
},
{
"title": "csvdecode",
"path": "reference/hcl2/functions/encoding/csvdecode"
},
{
"title": "jsondecode",
"path": "reference/hcl2/functions/encoding/jsondecode"
},
{
"title": "jsonencode",
"path": "reference/hcl2/functions/encoding/jsonencode"
},
{
"title": "urlencode",
"path": "reference/hcl2/functions/encoding/urlencode"
},
{
"title": "yamldecode",
"path": "reference/hcl2/functions/encoding/yamldecode"
},
{
"title": "yamlencode",
"path": "reference/hcl2/functions/encoding/yamlencode"
}
]
},
{
"title": "Filesystem Functions",
"routes": [
{
"title": "abspath",
"path": "reference/hcl2/functions/file/abspath"
},
{
"title": "basename",
"path": "reference/hcl2/functions/file/basename"
},
{
"title": "dirname",
"path": "reference/hcl2/functions/file/dirname"
},
{
"title": "file",
"path": "reference/hcl2/functions/file/file"
},
{
"title": "filebase64",
"path": "reference/hcl2/functions/file/filebase64"
},
{
"title": "fileexists",
"path": "reference/hcl2/functions/file/fileexists"
},
{
"title": "fileset",
"path": "reference/hcl2/functions/file/fileset"
},
{
"title": "pathexpand",
"path": "reference/hcl2/functions/file/pathexpand"
}
]
},
{
"title": "IP Network Functions",
"routes": [
{
"title": "cidrhost",
"path": "reference/hcl2/functions/ipnet/cidrhost"
},
{
"title": "cidrnetmask",
"path": "reference/hcl2/functions/ipnet/cidrnetmask"
},
{
"title": "cidrsubnet",
"path": "reference/hcl2/functions/ipnet/cidrsubnet"
},
{
"title": "cidrsubnets",
"path": "reference/hcl2/functions/ipnet/cidrsubnets"
}
]
},
{
"title": "Numeric Functions",
"routes": [
{
"title": "abs",
"path": "reference/hcl2/functions/numeric/abs"
},
{
"title": "ceil",
"path": "reference/hcl2/functions/numeric/ceil"
},
{
"title": "floor",
"path": "reference/hcl2/functions/numeric/floor"
},
{
"title": "log",
"path": "reference/hcl2/functions/numeric/log"
},
{
"title": "max",
"path": "reference/hcl2/functions/numeric/max"
},
{
"title": "min",
"path": "reference/hcl2/functions/numeric/min"
},
{
"title": "parseint",
"path": "reference/hcl2/functions/numeric/parseint"
},
{
"title": "pow",
"path": "reference/hcl2/functions/numeric/pow"
},
{
"title": "signum",
"path": "reference/hcl2/functions/numeric/signum"
}
]
},
{
"title": "String Functions",
"routes": [
{
"title": "chomp",
"path": "reference/hcl2/functions/string/chomp"
},
{
"title": "format",
"path": "reference/hcl2/functions/string/format"
},
{
"title": "formatlist",
"path": "reference/hcl2/functions/string/formatlist"
},
{
"title": "indent",
"path": "reference/hcl2/functions/string/indent"
},
{
"title": "join",
"path": "reference/hcl2/functions/string/join"
},
{
"title": "lower",
"path": "reference/hcl2/functions/string/lower"
},
{
"title": "regex_replace",
"path": "reference/hcl2/functions/string/regex_replace"
},
{
"title": "replace",
"path": "reference/hcl2/functions/string/replace"
},
{
"title": "split",
"path": "reference/hcl2/functions/string/split"
},
{
"title": "strlen",
"path": "reference/hcl2/functions/string/strlen"
},
{
"title": "strrev",
"path": "reference/hcl2/functions/string/strrev"
},
{
"title": "substr",
"path": "reference/hcl2/functions/string/substr"
},
{
"title": "title",
"path": "reference/hcl2/functions/string/title"
},
{
"title": "trim",
"path": "reference/hcl2/functions/string/trim"
},
{
"title": "trimprefix",
"path": "reference/hcl2/functions/string/trimprefix"
},
{
"title": "trimspace",
"path": "reference/hcl2/functions/string/trimspace"
},
{
"title": "trimsuffix",
"path": "reference/hcl2/functions/string/trimsuffix"
},
{
"title": "upper",
"path": "reference/hcl2/functions/string/upper"
}
]
},
{
"title": "UUID Functions",
"routes": [
{
"title": "uuidv4",
"path": "reference/hcl2/functions/uuid/uuidv4"
},
{
"title": "uuidv5",
"path": "reference/hcl2/functions/uuid/uuidv5"
}
]
}
]
},
{
"title": "Locals",
"path": "reference/hcl2/locals"
},
{
"title": "Syntax",
"path": "reference/hcl2/syntax"
},
{
"title": "Variables",
"path": "reference/hcl2/variables"
}
]
}
]
},
{
"title": "FAQ",
"path": "faq"
}
]