Skip to main content

Gateway URL Configuration

Overview​

After creating a Gateway instance, you must register one or more Gateway URLs to expose it to the outside world. This includes defining the base domain, TLS certificates, ingress settings, and optional metadata (labels, annotations). This tutorial demonstrates how to configure a complete Gateway URL with both simple and advanced annotation methods using mock data.

Prerequisites​

  • A Gateway has already been created (e.g., gateway-test-01)
  • You have access to the TLS certificate and private key files
  • The base domain is mapped in DNS (e.g., api.sksample.co.kr)
  • You are logged in as an administrator

Step-by-Step Tutorial​

Step 1. Open Gateway URL Configuration​

  • Go to the Gateway Management screen
  • Select the target gateway (e.g., gateway-test-01) to access Gateway Edit screen
  • Scroll down to the Gateway URL section and click the Add button to add a new Gateway URL

Step 2. Enter Gateway URL & Base Path​

Field Example
Gateway URLapi.sksample.co.kr
Global BasePath/gateway-test-01

The full API URL will become https://api.sksample.co.kr/gateway-test-01

Step 3. Enable HTTPS and Upload Certificates​

  • Toggle HTTPS Only to ON
  • Paste your TLS Certificate (tls.crt). Example:
----BEGIN CERTIFICATE-----
MIIFzjCCBbegAwIBAgISBKKPTR3WPWUG2AcFUD4Dn45iMA0GCSqGSIb3DQEBCwUA
...
-----END CERTIFICATE-----
  • Paste your TLS Private Key (tls.key). Example:
----BEGIN PRIVATE KEY-----
MIIEv...
...
-----END PRIVATE KEY-----

Certificates must be valid and match the specified domain name.

Step 4. Set Ingress Class​

Select the ingress class to be used by the gateway:

Field Value
Ingress Classnginx

Step 5. Define Labels (Optional)​

You may add metadata labels for identification or automation:

KeyValue
envproduction
regionkr-central

To add more, click the plus icon. Click on the cross icon to remove added label.

Step 6. Add Annotations​

There are two methods to input annotations:

Method 1: Key-Value Input (JSON Toggle OFF)

KeyValue
nginx.ingress.kubernetes.io/ssl-redirecttrue
nginx.ingress.kubernetes.io/backend-protocolHTTPS

Use this mode for clarity and individual editing.

Method2: JSON Mode (JSON Toggle ON)

Click the JSON toggle and enter the following structure:

{
"nginx.ingress.kubernetes.io/ssl-redirect": "true",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}

This mode is useful when importing a large annotation set at once.

Step 7. Save the Configuration​

Click the GATEWAY URL Save button. Wait for confirmation and ensure the URL appears in the list.

Tips & Best Practices​

  • Use HTTPS Only to enforce secure traffic
  • Match certificate domains exactly with the Gateway URL
  • Annotations control critical ingress behaviors - review your Kubernetes ingress controller documentation for full options
  • Use labels to enable future automation (e.g., CI/CD routing, monitoring filters)