• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Consul
  • Install
  • Tutorials
  • Documentation
  • API
  • CLI
  • Try Cloud(opens in new tab)
  • Sign up
Consul Home

Documentation

Skip to main contentOverview
  • What is Consul?




  • HCP Consul

    • Overview
    • Installation
    • Technical Specifications
    • Upgrades
      • Overview
      • Gateway
      • GatewayClass
      • GatewayClassConfig
      • Routes
      • MeshService

  • Resources

  • Tutorial Library
  • Certifications
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Consul
  3. Documentation
  4. Consul API Gateway
  5. Configuration
  • Consul
  • v1.13.x
  • v1.12.x
  • v1.11.x
  • v1.10.x
  • v1.9.x
  • v1.8.x

ยปConsul API Gateway Configuration Overview

This topic provides an overview of the configuration items that enable Consul API Gateway to manage traffic into your Consul service mesh.

  • Gateway defines the main infrastructure resource that links API gateway components. It specifies the name of the GatewayClass and one or more listeners, which specify the logical endpoints bound to the gateway's addresses.
  • GatewayClass defines a class of gateway resources that you can use as a template for creating gateways.
  • GatewayClassConfig describes additional Consul API Gateway-related configuration parameters for the GatewayClass resource.
  • Routes specifies the path from the gateway to the backend service(s) client to the listener.

You can create a basic Gateway object using the default gatewayClassName (consul-api-gateway). If you want to create custom Gateways suitable for your environment, complete the following steps:

  1. Define a GatewayClassConfig that contains your custom configurations.
  2. Define a GatewayClass and configure the parametersRef.name to reference the name of your GatewayClassConfig.
  3. Define a Gateway and configure the gatewayClassName to reference the name of your GatewayClass.
Edit this page on GitHub
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)