tokers commented on a change in pull request #479: URL: https://github.com/apache/apisix-ingress-controller/pull/479#discussion_r637641078
########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. Review comment: ```suggestion Here, we will deploy a single-node ETCD cluster without authentication inside the Kubernetes cluster. ``` ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step Review comment: Add Apache License Header. ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. + +In this case, we assume you have a storage provisioner. If you are using KiND, a local path provisioner will be created automatically. If you don't have a storage provisioner or don't want to use persistence volume, you could use an `emptyDir` as volume. + +```yaml +# etcd-headless.yaml +apiVersion: v1 +kind: Service +metadata: + name: etcd-headless + labels: + app.kubernetes.io/name: etcd + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" +spec: + type: ClusterIP + clusterIP: None + ports: + - name: "client" + port: 2379 + targetPort: client + - name: "peer" + port: 2380 + targetPort: peer + selector: + app.kubernetes.io/name: etcd + Review comment: Redundant empty line. ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. + +In this case, we assume you have a storage provisioner. If you are using KiND, a local path provisioner will be created automatically. If you don't have a storage provisioner or don't want to use persistence volume, you could use an `emptyDir` as volume. + +```yaml +# etcd-headless.yaml +apiVersion: v1 +kind: Service +metadata: + name: etcd-headless + labels: + app.kubernetes.io/name: etcd + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" +spec: + type: ClusterIP + clusterIP: None + ports: + - name: "client" + port: 2379 + targetPort: client + - name: "peer" + port: 2380 + targetPort: peer + selector: + app.kubernetes.io/name: etcd + +--- +# etcd.yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: etcd + labels: + app.kubernetes.io/name: etcd +spec: + selector: + matchLabels: + app.kubernetes.io/name: etcd + serviceName: etcd-headless + podManagementPolicy: Parallel + replicas: 1 + updateStrategy: + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/name: etcd + spec: + securityContext: + fsGroup: 1001 + runAsUser: 1001 + containers: + - name: etcd + image: docker.io/bitnami/etcd:3.4.14-debian-10-r0 + imagePullPolicy: "IfNotPresent" + # command: + # - /scripts/setup.sh + env: + - name: BITNAMI_DEBUG + value: "false" + - name: MY_POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + - name: MY_POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: ETCDCTL_API + value: "3" + - name: ETCD_NAME + value: "$(MY_POD_NAME)" + - name: ETCD_DATA_DIR + value: /etcd/data + - name: ETCD_ADVERTISE_CLIENT_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2379" + - name: ETCD_LISTEN_CLIENT_URLS + value: "http://0.0.0.0:2379"; + - name: ETCD_INITIAL_ADVERTISE_PEER_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2380" + - name: ETCD_LISTEN_PEER_URLS + value: "http://0.0.0.0:2380"; + - name: ALLOW_NONE_AUTHENTICATION + value: "yes" + ports: + - name: client + containerPort: 2379 + - name: peer + containerPort: 2380 + volumeMounts: + - name: data + mountPath: /etcd + volumeClaimTemplates: + - metadata: + name: data + spec: + accessModes: + - "ReadWriteOnce" + resources: + requests: + storage: "8Gi" +``` + +Apply these two yaml files to Kubernetes, wait few seconds, etcd installation should be successful. We could run a health check to ensure that. + +```bash +$ kubectl -n apisix exec -it etcd-0 -- etcdctl endpoint health +127.0.0.1:2379 is healthy: successfully committed proposal: took = 1.741883ms +``` + +Please notice that this etcd installation is quite simple and lack of many necessary production features, it should only be used for learning case. If you want to deploy a production-ready etcd, please refer [bitnami/etcd](https://bitnami.com/stack/etcd/helm). + +## APISIX Installation + +Create a config file for our APISIX. Notice that in the `apisix.allow_admin` config, we set `0.0.0.0/0` here just for test. Review comment: Should tell people, which APISIX version is used. ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. + +In this case, we assume you have a storage provisioner. If you are using KiND, a local path provisioner will be created automatically. If you don't have a storage provisioner or don't want to use persistence volume, you could use an `emptyDir` as volume. + +```yaml +# etcd-headless.yaml +apiVersion: v1 +kind: Service +metadata: + name: etcd-headless + labels: + app.kubernetes.io/name: etcd + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" +spec: + type: ClusterIP + clusterIP: None + ports: + - name: "client" + port: 2379 + targetPort: client + - name: "peer" + port: 2380 + targetPort: peer + selector: + app.kubernetes.io/name: etcd + +--- +# etcd.yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: etcd + labels: + app.kubernetes.io/name: etcd +spec: + selector: + matchLabels: + app.kubernetes.io/name: etcd + serviceName: etcd-headless + podManagementPolicy: Parallel + replicas: 1 + updateStrategy: + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/name: etcd + spec: + securityContext: + fsGroup: 1001 + runAsUser: 1001 + containers: + - name: etcd + image: docker.io/bitnami/etcd:3.4.14-debian-10-r0 + imagePullPolicy: "IfNotPresent" + # command: + # - /scripts/setup.sh + env: + - name: BITNAMI_DEBUG + value: "false" + - name: MY_POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + - name: MY_POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: ETCDCTL_API + value: "3" + - name: ETCD_NAME + value: "$(MY_POD_NAME)" + - name: ETCD_DATA_DIR + value: /etcd/data + - name: ETCD_ADVERTISE_CLIENT_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2379" + - name: ETCD_LISTEN_CLIENT_URLS + value: "http://0.0.0.0:2379"; + - name: ETCD_INITIAL_ADVERTISE_PEER_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2380" + - name: ETCD_LISTEN_PEER_URLS + value: "http://0.0.0.0:2380"; + - name: ALLOW_NONE_AUTHENTICATION + value: "yes" + ports: + - name: client + containerPort: 2379 + - name: peer + containerPort: 2380 + volumeMounts: + - name: data + mountPath: /etcd + volumeClaimTemplates: + - metadata: + name: data + spec: + accessModes: + - "ReadWriteOnce" + resources: + requests: + storage: "8Gi" +``` + +Apply these two yaml files to Kubernetes, wait few seconds, etcd installation should be successful. We could run a health check to ensure that. + +```bash +$ kubectl -n apisix exec -it etcd-0 -- etcdctl endpoint health +127.0.0.1:2379 is healthy: successfully committed proposal: took = 1.741883ms +``` + +Please notice that this etcd installation is quite simple and lack of many necessary production features, it should only be used for learning case. If you want to deploy a production-ready etcd, please refer [bitnami/etcd](https://bitnami.com/stack/etcd/helm). + +## APISIX Installation + +Create a config file for our APISIX. Notice that in the `apisix.allow_admin` config, we set `0.0.0.0/0` here just for test. Review comment: Give more detailed explanation that apisix-ingress-controller needs to communicate with the admin API. ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. + +In this case, we assume you have a storage provisioner. If you are using KiND, a local path provisioner will be created automatically. If you don't have a storage provisioner or don't want to use persistence volume, you could use an `emptyDir` as volume. + +```yaml +# etcd-headless.yaml +apiVersion: v1 +kind: Service +metadata: + name: etcd-headless + labels: + app.kubernetes.io/name: etcd + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" +spec: + type: ClusterIP + clusterIP: None + ports: + - name: "client" + port: 2379 + targetPort: client + - name: "peer" + port: 2380 + targetPort: peer + selector: + app.kubernetes.io/name: etcd + +--- +# etcd.yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: etcd + labels: + app.kubernetes.io/name: etcd +spec: + selector: + matchLabels: + app.kubernetes.io/name: etcd + serviceName: etcd-headless + podManagementPolicy: Parallel + replicas: 1 + updateStrategy: + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/name: etcd + spec: + securityContext: + fsGroup: 1001 + runAsUser: 1001 + containers: + - name: etcd + image: docker.io/bitnami/etcd:3.4.14-debian-10-r0 + imagePullPolicy: "IfNotPresent" + # command: + # - /scripts/setup.sh + env: + - name: BITNAMI_DEBUG + value: "false" + - name: MY_POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + - name: MY_POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: ETCDCTL_API + value: "3" + - name: ETCD_NAME + value: "$(MY_POD_NAME)" + - name: ETCD_DATA_DIR + value: /etcd/data + - name: ETCD_ADVERTISE_CLIENT_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2379" + - name: ETCD_LISTEN_CLIENT_URLS + value: "http://0.0.0.0:2379"; + - name: ETCD_INITIAL_ADVERTISE_PEER_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2380" + - name: ETCD_LISTEN_PEER_URLS + value: "http://0.0.0.0:2380"; + - name: ALLOW_NONE_AUTHENTICATION + value: "yes" + ports: + - name: client + containerPort: 2379 + - name: peer + containerPort: 2380 + volumeMounts: + - name: data + mountPath: /etcd + volumeClaimTemplates: + - metadata: + name: data + spec: + accessModes: + - "ReadWriteOnce" + resources: + requests: + storage: "8Gi" +``` + +Apply these two yaml files to Kubernetes, wait few seconds, etcd installation should be successful. We could run a health check to ensure that. + +```bash +$ kubectl -n apisix exec -it etcd-0 -- etcdctl endpoint health +127.0.0.1:2379 is healthy: successfully committed proposal: took = 1.741883ms +``` + +Please notice that this etcd installation is quite simple and lack of many necessary production features, it should only be used for learning case. If you want to deploy a production-ready etcd, please refer [bitnami/etcd](https://bitnami.com/stack/etcd/helm). + +## APISIX Installation + +Create a config file for our APISIX. Notice that in the `apisix.allow_admin` config, we set `0.0.0.0/0` here just for test. + +```yaml +apisix: + node_listen: 9080 # APISIX listening port + enable_heartbeat: true + enable_admin: true + enable_admin_cors: true + enable_debug: false + enable_dev_mode: false # Sets nginx worker_processes to 1 if set to true + enable_reuseport: true # Enable nginx SO_REUSEPORT switch if set to true. + enable_ipv6: true + config_center: etcd # etcd: use etcd to store the config value + + allow_admin: # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow + - 0.0.0.0/0 + port_admin: 9180 + + # Default token when use API to call for Admin API. + # *NOTE*: Highly recommended to modify this value to protect APISIX's Admin API. + # Disabling this configuration item means that the Admin API does not + # require any authentication. + admin_key: + # admin: can everything for configuration data + - name: "admin" + key: edd1c9f034335f136f87ad84b625c8f1 + role: admin + # viewer: only can view configuration data + - name: "viewer" + key: 4054f7cf07e344346cd3f287985e76a2 + role: viewer + # dns_resolver: + # - 127.0.0.1 + dns_resolver_valid: 30 + resolver_timeout: 5 + +nginx_config: # config for render the template to genarate nginx.conf + error_log: "/dev/stderr" + error_log_level: "warn" # warn,error + worker_rlimit_nofile: 20480 # the number of files a worker process can open, should be larger than worker_connections + event: + worker_connections: 10620 + http: + access_log: "/dev/stdout" + keepalive_timeout: 60s # timeout during which a keep-alive client connection will stay open on the server side. + client_header_timeout: 60s # timeout for reading client request header, then 408 (Request Time-out) error is returned to the client + client_body_timeout: 60s # timeout for reading client request body, then 408 (Request Time-out) error is returned to the client + send_timeout: 10s # timeout for transmitting a response to the client.then the connection is closed + underscores_in_headers: "on" # default enables the use of underscores in client request header fields + real_ip_header: "X-Real-IP" # http://nginx.org/en/docs/http/ngx_http_realip_module.html#real_ip_header + real_ip_from: # http://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from + - 127.0.0.1 + - 'unix:' + +etcd: + host: + - "http://etcd-headless.apisix.svc.cluster.local:2379"; + prefix: "/apisix" # apisix configurations prefix + timeout: 30 # seconds +plugins: # plugin list + - api-breaker + - authz-keycloak + - basic-auth + - batch-requests + - consumer-restriction + - cors + - echo + - fault-injection + - grpc-transcode + - hmac-auth + - http-logger + - ip-restriction + - jwt-auth + - kafka-logger + - key-auth + - limit-conn + - limit-count + - limit-req + - node-status + - openid-connect + - prometheus + - proxy-cache + - proxy-mirror + - proxy-rewrite + - redirect + - referer-restriction + - request-id + - request-validation + - response-rewrite + - serverless-post-function + - serverless-pre-function + - sls-logger + - syslog + - tcp-logger + - udp-logger + - uri-blocker + - wolf-rbac + - zipkin + - traffic-split +stream_plugins: + - mqtt-proxy +``` + +Please make sure `etcd.host` matches the headless service we created at first. In our case, it's `http://etcd-headless.apisix.svc.cluster.local:2379`. + +In this config, we defined an access key with the `admin` name under the `apisix.admin_key` section. This key is our API key, will be used to control APISIX later. + +Save this as `config.yaml`, then run `kubectl -n apisix create cm apisix-conf --from-file ./config.yaml` to create configmap. Later we will mount this configmap into APISIX deployment. + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: apisix + labels: + app.kubernetes.io/name: apisix +spec: + replicas: 1 + selector: + matchLabels: + app.kubernetes.io/name: apisix + template: + metadata: + labels: + app.kubernetes.io/name: apisix + spec: + containers: + - name: apisix + image: "apache/apisix:2.5-alpine" + imagePullPolicy: IfNotPresent + ports: + - name: http + containerPort: 9080 + protocol: TCP + - name: tls + containerPort: 9443 + protocol: TCP + - name: admin + containerPort: 9180 + protocol: TCP + readinessProbe: + failureThreshold: 6 + initialDelaySeconds: 10 + periodSeconds: 10 + successThreshold: 1 + tcpSocket: + port: 9080 + timeoutSeconds: 1 + lifecycle: + preStop: + exec: + command: + - /bin/sh + - -c + - "sleep 30" + volumeMounts: + - mountPath: /usr/local/apisix/conf/config.yaml + name: apisix-config + subPath: config.yaml + resources: {} + volumes: + - configMap: + name: apisix-conf + name: apisix-config +``` + +Now, APISIX should be ready to use. Use `kubectl get pods -n apisix -l app.kubernetes.io/name=apisix -o name` to list APISIX pod name. Here we assume the pod name is `apisix-7644966c4d-cl4k6`. + +Let's have a check: + +```bash +kubectl -n apisix exec -it apisix-7644966c4d-cl4k6 -- curl http://127.0.0.1:9080 +``` + +If you are using Linux or macOS, run the command below in bash: + +```bash +kubectl -n apisix exec -it $(kubectl get pods -n apisix -l app.kubernetes.io/name=apisix -o name) -- curl http://127.0.0.1:9080 +``` + +If APISIX works properly, it should output: `{"error_msg":"404 Route Not Found"}`. Because we haven't defined any route yet. + +## HTTPBIN service Review comment: We already have such a document, just add the link to https://github.com/apache/apisix-ingress-controller/blob/master/docs/en/latest/practices/proxy-the-httpbin-service.md is OK. ########## File path: docs/en/latest/practices/step-by-step.md ########## @@ -0,0 +1,804 @@ +# APISIX Step by Step + +In this tutorial, we will install APISIX in Kubernetes from native yaml. + +## Prerequisites + +If you don't have a Kubernetes cluster to use, we recommend you to use [KiND](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local Kubernetes cluster. + +```bash +kubectl create ns apisix +``` + +In this tutorial, all our operations will be performed at namespace `apisix`. + +## ETCD Installation + +Here, we will deploy a none authentication 1 member etcd server inside the Kubernetes cluster. + +In this case, we assume you have a storage provisioner. If you are using KiND, a local path provisioner will be created automatically. If you don't have a storage provisioner or don't want to use persistence volume, you could use an `emptyDir` as volume. + +```yaml +# etcd-headless.yaml +apiVersion: v1 +kind: Service +metadata: + name: etcd-headless + labels: + app.kubernetes.io/name: etcd + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" +spec: + type: ClusterIP + clusterIP: None + ports: + - name: "client" + port: 2379 + targetPort: client + - name: "peer" + port: 2380 + targetPort: peer + selector: + app.kubernetes.io/name: etcd + +--- +# etcd.yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: etcd + labels: + app.kubernetes.io/name: etcd +spec: + selector: + matchLabels: + app.kubernetes.io/name: etcd + serviceName: etcd-headless + podManagementPolicy: Parallel + replicas: 1 + updateStrategy: + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/name: etcd + spec: + securityContext: + fsGroup: 1001 + runAsUser: 1001 + containers: + - name: etcd + image: docker.io/bitnami/etcd:3.4.14-debian-10-r0 + imagePullPolicy: "IfNotPresent" + # command: + # - /scripts/setup.sh + env: + - name: BITNAMI_DEBUG + value: "false" + - name: MY_POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + - name: MY_POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: ETCDCTL_API + value: "3" + - name: ETCD_NAME + value: "$(MY_POD_NAME)" + - name: ETCD_DATA_DIR + value: /etcd/data + - name: ETCD_ADVERTISE_CLIENT_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2379" + - name: ETCD_LISTEN_CLIENT_URLS + value: "http://0.0.0.0:2379"; + - name: ETCD_INITIAL_ADVERTISE_PEER_URLS + value: "http://$(MY_POD_NAME).etcd-headless.apisix.svc.cluster.local:2380" + - name: ETCD_LISTEN_PEER_URLS + value: "http://0.0.0.0:2380"; + - name: ALLOW_NONE_AUTHENTICATION + value: "yes" + ports: + - name: client + containerPort: 2379 + - name: peer + containerPort: 2380 + volumeMounts: + - name: data + mountPath: /etcd + volumeClaimTemplates: + - metadata: + name: data + spec: + accessModes: + - "ReadWriteOnce" + resources: + requests: + storage: "8Gi" +``` + +Apply these two yaml files to Kubernetes, wait few seconds, etcd installation should be successful. We could run a health check to ensure that. + +```bash +$ kubectl -n apisix exec -it etcd-0 -- etcdctl endpoint health +127.0.0.1:2379 is healthy: successfully committed proposal: took = 1.741883ms +``` + +Please notice that this etcd installation is quite simple and lack of many necessary production features, it should only be used for learning case. If you want to deploy a production-ready etcd, please refer [bitnami/etcd](https://bitnami.com/stack/etcd/helm). Review comment: Actually, we don't need so elaborate steps to install ETCD, I prefer to hint users to how to install ETCD cluster and give them some links. -- 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. For queries about this service, please contact Infrastructure at: [email protected]
