Though I had always worked on the Dev side of IT, I was also interested in the Ops side. I even had a short experience being a WebSphere admin: I used it several times, helping Ops deal with the Admin console while being a developer. Providing a single package that Ops can configure and deploy in different environments is very important. As a JVM developer, I've been happy using and its wealth of configuration options: command-line parameters, JVM parameters, files, profiles, environment variables, etc. Spring Boot In this short post, I'd like to describe how you can do the same with in the context of containers. Apache APISIX File-based configuration The foundation of configuring Apache APISIX is file-based. The default values are found in the configuration file. For example, by default, Apache APISIX runs on port , and the admin port is . That's because of the default configuration: /usr/local/apisix/conf/apisix/config-default.yaml 9080 9180 apisix:
  node_listen:
    - 9080           #1

#...

deployment:
  admin:
    admin_listen:
      ip: 0.0.0.0
      port: 9180     #2 Regular port Admin port To override values, we need to provide a file named in the directory: config.yaml /usr/local/apisix/conf/apisix apisix:
  node_listen:
    - 9090           #1
deployment:
  admin:
    admin_listen:
      port: 9190     #1 Override values Now, Apache APISIX should run on port , and the admin port should be . Here's how to run the Apache APISIX container with the above configuration: 9090 9190 docker run -it --rm apache/apisix:3.4.1-debian \
                 -p 9090:9090 -p 9190:9190 \
                 -v ./config.yaml:/usr/local/apisix/conf/apisix/config.yaml Environment-based configuration The downside of a pure file-based configuration is that you must provide a dedicated file for each environment, even if only a single parameter changes. Apache APISIX allows replacement via environment variables in the configuration file to account for that. apisix:
  node_listen:
    - ${{APISIX_NODE_LISTEN:=}}                  #1
deployment:
  admin:
    admin_listen:
      port: ${{DEPLOYMENT_ADMIN_ADMIN_LISTEN:=}} #1 Replace the placeholder with its environment variable value at runtime We can reuse the same file in every environment and hydrate it with the context-dependent environment variables: docker run -it --rm apache/apisix:3.4.1-debian \
                 -e APISIX_NODE_LISTEN=9090 \
                 -e DEPLOYMENT_ADMIN_ADMIN_LISTEN=9190 \
                 -p 9090:9090 -p 9190:9190 \
                 -v ./config.yaml:/usr/local/apisix/conf/apisix/config.yaml Icing on the cake, we can also offer a default value: apisix:
  node_listen:
    - ${{APISIX_NODE_LISTEN:=9080}}                  #1
deployment:
  admin:
    admin_listen:
      port: ${{DEPLOYMENT_ADMIN_ADMIN_LISTEN:=9180}} #1 If no environment variable is provided, use those ports; otherwise, use the environment variables' value The trick works in standalone mode with the file. You can parameterize every context-dependent variable secret with it: apisix. yaml and routes:
  - uri: /*
    upstream:
      nodes:
        "httpbin:80": 1
    plugins:
      openid-connect:
        client_id: apisix
        client_secret: ${{OIDC_SECRET}}
        discovery: https://${{OIDC_ISSUER}}/.well-known/openid-configuration
        redirect_uri: http://localhost:9080/callback
        scope: openid
        session:
          secret: ${{SESSION_SECRET}} Conclusion When configuring Apache APISIX, we should ensure it's as operable as possible. In this post, I've described several ways to make it so. Happy Apache APISIX! To go further: Default configuration Configuration file switching based on environment variables Originally published at on August 13th, 2023 A Java Geek

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

What is the Tower Library? - An Introduction

Is Gradle Really Better Than Maven? - My Final Verdict

Read all my posts!

Read My Stories

Follow @nicolas_frankel on Twitter

Too Long; Didn't Read

Make resilience your competitive advantage

Streamlining Apache APISIX for Operations

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

16 Best Practices For Securing Your APIs with Apache APISIX - Part 1

Apache APISIX vs. Spring Cloud Gateway

Apache APISIX Without etcd?

Creating a Poor Man's API Using PostgREST

Creating a Simple gRPC Service on the Client Side

16 Best Practices For Securing Your APIs with Apache APISIX - Part 1

Apache APISIX vs. Spring Cloud Gateway

Apache APISIX Without etcd?

Creating a Poor Man's API Using PostgREST

Creating a Simple gRPC Service on the Client Side

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps