Apache APISIX packaged by Bitnami¶

Apache APISIX is high-performance, real-time API Gateway. Features load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, amongst others.

Overview of Apache APISIX

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/apisix

Introduction¶

This chart bootstraps a Apache APISIX deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Looking to use Apache APISIX in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.0+

Installing the Chart¶

To install the chart with the release name my-release:

helm install my-release my-repo/apisix

The command deploys apisix on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart¶

To uninstall/delete the my-release deployment:

helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters¶

Global parameters¶

Common parameters¶

APISIX Data Plane parameters¶

APISIX Data Plane Traffic Exposure Parameters¶

APISIX Data Plane Autoscaling configuration¶

APISIX Data Plane RBAC Parameters¶

APISIX Data Plane Metrics Parameters¶

APISIX Control Plane Parameters¶

APISIX Control Plane Traffic Exposure Parameters¶

APISIX Control Plane Autoscaling configuration¶

APISIX Control Plane RBAC parameters¶

APISIX Control Plane Metrics Parameters¶

APISIX Dashboard Parameters¶

APISIX Dashboard Traffic Exposure Parameters¶

APISIX Dashboard Autoscaling configuration¶

APISIX Dashboard RBAC Parameters¶

APISIX Ingress Controller Parameters¶

APISIX Ingress Controller Traffic Exposure Parameters¶

APISIX Ingress Controller Autoscaling configuration¶

APISIX Ingress Controller RBAC Parameters¶

Init containers parameters¶

External etcd settings¶

etcd sub-chart parameters¶

The above parameters map to the env variables defined in bitnami/apisix. For more information please refer to the bitnami/apisix image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set controlPlane.enabled=true \
    my-repo/apisix

The above command enables the APISIX Control Plane deployment.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml my-repo/apisix

Tip: You can use the default values.yaml

Configuration and installation details¶

Rolling VS Immutable tags¶

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Deployment modes¶

Apache APISIX supports multiple deployment modes. The Bitnami APISIX chart deploys the decoupled mode by default, but it is possible to deploy in traditional or standalone modes as well.

Traditional mode¶

The following values configure the traditional mode:

dataPlane:
  enabled: false
controlPlane:
  extraConfig:
    deployment:
      role: traditional
      role_traditional:
        config_provider: etcd
  service:
    extraPorts:
      - name: http
        port: 80
        targetPort: 9080
      - name: https
        port: 443
        targetPort: 9443

Standalone mode¶

The following values configure the standalone mode:

controlPlane:
  enabled: false
ingressController:
  enabled: false
etcd:
  enabled: false
dataPlane:
  extraConfig:
    deployment:
      role_data_plane:
        config_provider: yaml
  extraVolumes:
    - name: routes
      configMap:
        name: apisix-routes
  extraVolumeMounts:
    - name: routes
      mountPath: /opt/bitnami/apisix/conf/apisix.yaml
      subPath: apisix.yaml
extraDeploy:
  - apiVersion: v1
    kind: ConfigMap
    metadata:
      name: apisix-routes
    data:
      apisix.yaml: |-
        routes:
          -
            uri: /hello
            upstream:
                nodes:
                    "127.0.0.1:1980": 1
                type: roundrobin

Ingress¶

This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application.

To enable Ingress integration, set ingress.enabled to true. The ingress.hostname property can be used to set the host name. The ingress.tls parameter can be used to add the TLS configuration for this host. It is also possible to have more than one host, with a separate TLS configuration for each host. Learn more about configuring and using Ingress.

TLS secrets¶

The chart also facilitates the creation of TLS secrets for use with the Ingress controller, with different options for certificate management. Learn more about TLS secrets.

External etcd support¶

You may want to have Mastodon connect to an external etcd rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalEtcd parameter. You should also disable the etcd installation with the etcd.enabled option. Here is an example:

etcd:
  enabled: false
externalEtcd:
  hosts:
    - externalhost

Additional environment variables¶

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property inside the dataPlane, controlPlane, dashboard and ingressController sections.

dataPlane:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values inside the dataPlane, controlPlane, dashboard and ingressController sections.

Sidecars¶

If additional containers are needed in the same pod as apisix (such as additional metrics or logging exporters), they can be defined using the sidecars parameter inside the dataPlane, controlPlane, dashboard and ingressController sections. If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter. Learn more about configuring and using sidecar containers.

Pod affinity¶

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters inside the dataPlane, controlPlane, dashboard and ingressController sections.

Troubleshooting¶

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading¶

To 2.0.0¶

This major updates the etcd subchart to it newest major, 9.0.0. For more information on this subchart's major, please refer to etcd upgrade notes.

License¶

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.