Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
AlinsRan merged PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450 -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
AlinsRan commented on code in PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450#discussion_r2184891221 ## docs/en/latest/getting-started.md: ## @@ -0,0 +1,194 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- + + +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 APISIX’s own declarative and easy-to-use custom resources. The controller translates these resources into 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 + +### Install APISIX and APISIX Ingress Controller + +Install the Gateway API CRDs, 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 +``` + +### Set Up a Sample Upstream + +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 +``` + +### Configure a Route + +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. + +
Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
AlinsRan commented on code in PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450#discussion_r2184889511 ## docs/en/latest/getting-started.md: ## @@ -0,0 +1,194 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- + + +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 APISIX’s own declarative and easy-to-use custom resources. The controller translates these resources into 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 + +### Install APISIX and APISIX Ingress Controller + +Install the Gateway API CRDs, 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 +``` + +### Set Up a Sample Upstream + +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 +``` + +### Configure a Route Review Comment: During Helm installation, ingressclass and gatewayproxy will be set -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
kayx23 commented on code in PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450#discussion_r2184874048 ## docs/en/latest/getting-started.md: ## @@ -0,0 +1,194 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- + + +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 APISIX’s own declarative and easy-to-use custom resources. The controller translates these resources into 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 + +### Install APISIX and APISIX Ingress Controller + +Install the Gateway API CRDs, 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 +``` + +### Set Up a Sample Upstream + +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 +``` + +### Configure a Route + +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. + +
Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
kayx23 commented on code in PR #2450: URL: https://github.com/apache/apisix-ingress-controller/pull/2450#discussion_r2184872209 ## docs/en/latest/getting-started.md: ## @@ -0,0 +1,194 @@ +--- +title: Getting started +keywords: + - APISIX ingress + - Apache APISIX + - Kubernetes ingress +description: Guide to get started with Apache APISIX ingress controller. +--- + + +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 APISIX’s own declarative and easy-to-use custom resources. The controller translates these resources into 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 + +### Install APISIX and APISIX Ingress Controller + +Install the Gateway API CRDs, 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 +``` + +### Set Up a Sample Upstream + +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 +``` + +### Configure a Route Review Comment: No need to set up GatewayProxy, GatewayClass/IngressClass etc before configuring routes? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] doc: add getting-started doc [apisix-ingress-controller]
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. +--- + + +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. +--- + + +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. +--- + + +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. +--- + + +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. +--- + + +import Tabs from '@theme/Tabs';
