Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/add-pr-comment
Submodule add-pr-comment added at dd126d
9 changes: 6 additions & 3 deletions .github/workflows/apisix-conformance-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

permissions:
pull-requests: write

jobs:
prepare:
name: Prepare
Expand Down Expand Up @@ -116,7 +119,7 @@ jobs:
if: ${{ github.event_name == 'push' }}
uses: actions/upload-artifact@v4
with:
name: apisix-ingress-controller-conformance-report.yaml
name: apisix-ingress-controller-conformance-report-${{ matrix.provider_type }}.yaml
path: apisix-ingress-controller-conformance-report.yaml

- name: Format Conformance Test Report
Expand All @@ -129,8 +132,8 @@ jobs:

- name: Report Conformance Test Result to PR Comment
if: ${{ github.event_name == 'pull_request' }}
uses: mshick/add-pr-comment@v2
uses: ./.github/actions/add-pr-comment
with:
message-id: 'apisix-conformance-test-report'
message-id: 'apisix-conformance-test-report-${{ matrix.provider_type }}'
message-path: |
report.md
26 changes: 26 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.

[submodule ".github/actions/paths-filter"]
path = .github/actions/paths-filter
url = https://github.com/dorny/paths-filter.git
[submodule ".github/actions/markdown-link-check"]
path = .github/actions/markdown-link-check
url = https://github.com/gaurav-nelson/github-action-markdown-link-check.git
[submodule ".github/actions/add-pr-comment"]
path = .github/actions/add-pr-comment
url = https://github.com/mshick/add-pr-comment.git
9 changes: 9 additions & 0 deletions api/adc/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ const (
PassHostRewrite = "rewrite"
)

const (
TypeRoute = "route"
TypeService = "service"
TypeConsumer = "consumer"
TypeSSL = "ssl"
TypeGlobalRule = "global_rule"
TypePluginMetadata = "plugin_metadata"
)

type Object interface {
GetLabels() map[string]string
}
Expand Down
39 changes: 39 additions & 0 deletions docs/en/latest/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"version": "0.3.0",
"sidebar": [
{
"type": "doc",
"id": "getting-started"
},
{
"type": "category",
"label": "Concepts",
"items": [
"concepts/resources",
"concepts/gateway-api",
"concepts/deployment-architecture"
]
},
{
"type": "doc",
"id": "install"
},
{
"type": "doc",
"id": "developer-guide"
},
{
"type": "doc",
"id": "api-reference"
},
{
"type": "doc",
"id": "upgrade-guide"
},
{
"type": "link",
"label": "CHANGELOG",
"href": "https://github.com/apache/apisix-ingress-controller/blob/master/CHANGELOG.md"
}
]
}
98 changes: 98 additions & 0 deletions docs/en/latest/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
title: Install with Helm
keywords:
- APISIX ingress
- Apache APISIX
- Kubernetes ingress
- kind
description: Guide to install APISIX ingress controller on kind.
---
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.
#
-->

Helm is a package manager for Kubernetes that automates the release and management of software on Kubernetes.

This document guides you through installing the APISIX ingress controller using Helm.

## Prerequisites

Before installing APISIX ingress controller, ensure you have:

1. A working Kubernetes cluster (version 1.26+)
- Production: TKE, EKS, AKS, or other cloud-managed clusters
- Development: minikube, kind, or k3s
2. [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured to access your cluster
3. [Helm](https://helm.sh/) (version 3.8+) installed

Make sure to update the Helm repositories:

```bash
helm repo add apisix https://charts.apiseven.com
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
```

## Install APISIX and APISIX Ingress Controller

The script below installs APISIX and APISIX Ingress Controller:

```bash
helm install apisix \
--namespace ingress-apisix \
--create-namespace \
--set ingress-controller.enabled=true \
--set ingress-controller.apisix.adminService.namespace=ingress-apisix \
--set ingress-controller.gatewayProxy.createDefault=true \
apisix/apisix
```

## Install APISIX and APISIX Ingress Controller (Standalone API-driven mode)

To run APISIX in [APISIX Standalone API-driven mode](https://apisix.apache.org/docs/apisix/deployment-modes/#api-driven-experimental), use the following script to install APISIX and the APISIX Ingress Controller:

```bash
helm install apisix \
--namespace ingress-apisix \
--create-namespace \
--set apisix.deployment.role=traditional \
--set apisix.deployment.role_traditional.config_provider=yaml \
--set etcd.enabled=false \
--set ingress-controller.enabled=true \
--set ingress-controller.config.provider.type=apisix-standalone \
--set ingress-controller.apisix.adminService.namespace=ingress-apisix \
--set ingress-controller.gatewayProxy.createDefault=true \
apisix/apisix
```

## Install APISIX Ingress Controller

The script below installs APISIX Ingress Controller:

```bash
# Set the access address and adminkey for apisix
helm install apisix-ingress-controller \
--create-namespace \
-n ingress-apisix \
--set gatewayProxy.createDefault=true \
--set gatewayProxy.provider.controlPlane.auth.adminKey.value=edd1c9f034335f136f87ad84b625c8f1 \
--set apisix.adminService.namespace=apisix-ingress \
--set apisix.adminService.name=apisix-admin \
--set apisix.adminService.port=9180 \
apisix/apisix-ingress-controller
```
Loading
Loading