kayx23 commented on code in PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450#discussion_r2184453695
########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. Review Comment: ```suggestion APISIX Ingress Controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: Review Comment: ```suggestion Before installing APISIX Ingress Controller, ensure you have: ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: + +1. A working Kubernetes cluster (version 1.26+) +2. [Helm](https://helm.sh/) (version 3.8+) installed + +### Installation Review Comment: ```suggestion ### Install APISIX and APISIX Ingress Controller ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: + +1. A working Kubernetes cluster (version 1.26+) +2. [Helm](https://helm.sh/) (version 3.8+) installed + +### Installation + +Install the Gateway API CRDs and APISIX and APISIX ingress controller using the following commands: Review Comment: ```suggestion Install the Gateway API CRDs, APISIX, and APISIX Ingress Controller using the following commands: ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. Review Comment: ```suggestion APISIX Ingress Controller can be configured using the native Kubernetes Ingress or Gateway API, as well as with APISIX’s own declarative and easy-to-use custom resources. The controller translates these resources into APISIX configuration. ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: + +1. A working Kubernetes cluster (version 1.26+) +2. [Helm](https://helm.sh/) (version 3.8+) installed + +### Installation + +Install the Gateway API CRDs and APISIX and APISIX ingress controller using the following commands: + +```bash +helm repo add apisix https://charts.apiseven.com +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo update + +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 the httpbin example application to test the configuration: + +```bash +https://raw.githubusercontent.com/apache/apisix-ingress-controller/refs/heads/v2.0.0/examples/httpbin/deployment.yaml +``` + Review Comment: ```suggestion ### Configure a Route ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: + +1. A working Kubernetes cluster (version 1.26+) +2. [Helm](https://helm.sh/) (version 3.8+) installed + +### Installation + +Install the Gateway API CRDs and APISIX and APISIX ingress controller using the following commands: + +```bash +helm repo add apisix https://charts.apiseven.com +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo update + +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 +``` + Review Comment: ```suggestion ### Set Up a Sample Upstream ``` ########## docs/en/latest/getting-started.md: ########## @@ -0,0 +1,190 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- +<!-- +# +# 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. +# +--> + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +APISIX ingress controller is a [Kubernetes ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) using [Apache APISIX](https://apisix.apache.org) as the high performance reverse proxy. + +APISIX ingress controller can be configured using the native Kubernetes Ingress or Gateway API as well as with the declarative and easy to use custom resources provided by APISIX. The APISIX ingress controller converts these resources to APISIX configuration. + +## Quick Start + +Get started with APISIX Ingress Controller in a few simple steps. + +### Prerequisites + +Before installing APISIX ingress controller, ensure you have: + +1. A working Kubernetes cluster (version 1.26+) +2. [Helm](https://helm.sh/) (version 3.8+) installed + +### Installation + +Install the Gateway API CRDs and APISIX and APISIX ingress controller using the following commands: + +```bash +helm repo add apisix https://charts.apiseven.com +helm repo add bitnami https://charts.bitnami.com/bitnami +helm repo update + +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 the httpbin example application to test the configuration: + +```bash +https://raw.githubusercontent.com/apache/apisix-ingress-controller/refs/heads/v2.0.0/examples/httpbin/deployment.yaml +``` + +Install an ApisixRoute or Ingress resource to route traffic to httpbin: + +> The examples below show how these differ. Both the examples configure a Route in APISIX that routes to an httpbin service as the Upstream. + +<Tabs +groupId="resources" +defaultValue="apisix" +values={[ +{label: 'APISIX Ingress CRD', value: 'apisix'}, +{label: 'Kubernetes Ingress API', value: 'ingress'}, +]}> + +<TabItem value="apisix"> + +```yaml title="httpbin-route.yaml" +apiVersion: apisix.apache.org/v2 +kind: ApisixRoute +metadata: + name: httpbin-route +spec: + ingressClassName: apisix + http: + - name: route-1 + match: + hosts: + - local.httpbin.org + paths: + - /* + backends: + - serviceName: httpbin + servicePort: 80 +``` + +</TabItem> + +<TabItem value="ingress"> + +```yaml title="httpbin-route.yaml" +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: httpbin-route +spec: + ingressClassName: apisix + rules: + - host: local.httpbin.org + http: + paths: + - backend: + service: + name: httpbin + port: + number: 80 + path: / + pathType: Prefix +``` + +</TabItem> +</Tabs> + +:::note + +More details on the installation can be found in the [Installation guide](./install.md). + +::: + +### Testing the Routing Configuration Review Comment: ```suggestion ### Verify Route Configuration ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
