Chever-John commented on code in PR #994:
URL:
https://github.com/apache/apisix-ingress-controller/pull/994#discussion_r866121211
##########
docs/en/latest/practices/how-to-use-go-plugin-runner-in-apisix-ingress.md:
##########
@@ -0,0 +1,400 @@
+# How to use go-plugin-runner in APISIX Ingress
+
+## Background Description
Review Comment:
OK, I will check this section.
##########
docs/en/latest/practices/how-to-use-go-plugin-runner-in-apisix-ingress.md:
##########
@@ -0,0 +1,400 @@
+# How to use go-plugin-runner in APISIX Ingress
+
+## Background Description
+
+While wandering around the community, I found a user confused about "how to
use multilingual plugins in APISIX Ingress environment". I happen to be a user
of go-plugin-runner and have a little knowledge of the APISIX Ingress project,
so this document was born.
+
+## Proposal Description
+
+Based on version 0.3 of the go-plugin-runner plugin and version 1.4.0 of
APISIX Ingress, this article goes through building the cluster, building the
image, customizing the helm chart package, and finally, deploying the
resources. It is guaranteed that the final result can be derived in full based
on this documentation.
+
+```bash
+go-plugin-runner: 0.3
+APISIX Ingress: 1.4.0
+
+kind: kind v0.12.0 go1.17.8 linux/amd64
+kubectl version: Client Version: v1.23.5/Server Version: v1.23.4
+golang: go1.18 linux/amd64
+```
+
+## Begin
+
+### Build a cluster environment
+
+Select `kind` to build a local cluster environment. The command is as follows:
+
+```bash
+cat <<EOF | kind create cluster --config=-
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+ kubeadmConfigPatches:
+ - |
+ kind: InitConfiguration
+ nodeRegistration:
+ kubeletExtraArgs:
+ node-labels: "ingress-ready=true"
Review Comment:
The following installation commands?
##########
docs/en/latest/practices/how-to-use-go-plugin-runner-in-apisix-ingress.md:
##########
@@ -0,0 +1,400 @@
+# How to use go-plugin-runner in APISIX Ingress
+
+## Background Description
+
+While wandering around the community, I found a user confused about "how to
use multilingual plugins in APISIX Ingress environment". I happen to be a user
of go-plugin-runner and have a little knowledge of the APISIX Ingress project,
so this document was born.
+
+## Proposal Description
+
+Based on version 0.3 of the go-plugin-runner plugin and version 1.4.0 of
APISIX Ingress, this article goes through building the cluster, building the
image, customizing the helm chart package, and finally, deploying the
resources. It is guaranteed that the final result can be derived in full based
on this documentation.
+
+```bash
+go-plugin-runner: 0.3
+APISIX Ingress: 1.4.0
+
+kind: kind v0.12.0 go1.17.8 linux/amd64
+kubectl version: Client Version: v1.23.5/Server Version: v1.23.4
+golang: go1.18 linux/amd64
+```
+
+## Begin
+
+### Build a cluster environment
+
+Select `kind` to build a local cluster environment. The command is as follows:
+
+```bash
+cat <<EOF | kind create cluster --config=-
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+ kubeadmConfigPatches:
+ - |
+ kind: InitConfiguration
+ nodeRegistration:
+ kubeletExtraArgs:
+ node-labels: "ingress-ready=true"
+ extraPortMappings:
+ - containerPort: 80
+ hostPort: 80
+ protocol: TCP
+ - containerPort: 443
+ hostPort: 443
+ protocol: TCP
+EOF
+```
+
+### Build the go-plugin-runner executable
+
+If you have finished writing the plugin, you can start compiling the
executable to run with APISIX.
+
+This article recommends two packaging build options.
+
+1. put the packaging process into the Dockerfile and finish the compilation
process when you build the docker image later.
+2. You can also follow the scheme used in this document, building the
executable first and then copying the packaged executable to the image.
+
+How you choose the option should depend on your local hardware considerations.
The reason for selecting the second option here is that I want to rely on my
powerful local hardware to increase the building speed and speed up the process.
+
+### Go to the go-plugin-runner directory
+
+Choose a folder address `/home/chever/api7/cloud_native/tasks/plugin-runner`
and place our `apisix-go-plugin-runner` project in this folder.
+
+After successful placement, the file tree is shown below:
+
+```bash
+chever@cloud-native-01:~/api7/cloud_native/tasks/plugin-runner$ tree -L 1
+.
+└── apisix-go-plugin-runner
+
+1 directory, 0 files
+```
+
+Then you need to go to the `apisix-go-plugin-runner/cmd/go-runner/plugins`
directory and write the plugins you need in that directory. This article will
use the default plugin `say` for demonstration purposes.
+
+```bash
+chever@cloud-native-01:~/api7/cloud_native/tasks/plugin-runner/apisix-go-plugin-runner$
tree cmd
+cmd
+└── go-runner
+ ├── main.go
+ ├── main_test.go
+ ├── plugins
+ │ ├── fault_injection.go
+ │ ├── fault_injection_test.go
+ │ ├── limit_req.go
+ │ ├── limit_req_test.go
+ │ ├── say.go
+ │ └── say_test.go
+ └── version.go
+
+2 directories, 10 files
+```
+
+After writing the plugins, start compiling the executable formally, and note
here that you should build static executables, not dynamic ones.
+
+The package compile command is as follows.
+
+```bash
+CGO_ENABLED=0 go build -a -ldflags '-extldflags "-static"' .
+```
+
+This successfully packages a statically compiled `go-runner` executable.
+
+In the `apisix-go-plugin-runner/cmd/go-runner/` directory, you can see that
the current file tree looks like this:
+
+```bash
+chever@cloud-native-01:~/api7/cloud_native/tasks/plugin-runner/apisix-go-plugin-runner/cmd/go-runner$
tree -L 1
+.
+├── go-runner
+├── main.go
+├── main_test.go
+├── plugins
+└── version.go
+
+1 directory, 4 files
+```
+
+Please remember the path `apisix-go-plugin-runner/cmd/go-runner/go-runner`, we
will use it later.
+
+### Build Docker Image
+
+The image is built here in preparation for installing APISIX later using
`helm`.
+
+#### Write Dockerfile
+
+Return to the path `/home/chever/api7/cloud_native/tasks/plugin-runner` and
create a Dockerfile in that directory, a demonstration of which is given here.
+
+```dockerfile
+ARG ENABLE_PROXY=false
+
+# Build Apache APISIX
+FROM api7/apisix-base:1.19.9.1.5
+
+ADD ./apisix-go-plugin-runner /usr/local/apisix-go-plugin-runner
+
+ARG APISIX_VERSION=2.13.1
+LABEL apisix_version="${APISIX_VERSION}"
+
+ARG ENABLE_PROXY
+RUN set -x \
+ && (test "${ENABLE_PROXY}" != "true" || /bin/sed -i
's,http://dl-cdn.alpinelinux.org,https://mirrors.aliyun.com,g'
/etc/apk/repositories) \
+ && apk add --no-cache --virtual .builddeps \
+ build-base \
+ automake \
+ autoconf \
+ make \
+ libtool \
+ pkgconfig \
+ cmake \
+ unzip \
+ curl \
+ openssl \
+ git \
+ openldap-dev \
+ && luarocks install
https://github.com/apache/apisix/raw/master/rockspec/apisix-${APISIX_VERSION}-0.rockspec
--tree=/usr/local/apisix/deps PCRE_DIR=/usr/local/openresty/pcre \
+ && cp -v
/usr/local/apisix/deps/lib/luarocks/rocks-5.1/apisix/${APISIX_VERSION}-0/bin/apisix
/usr/bin/ \
+ && (function ver_lt { [ "$1" = "$2" ] && return 1 || [ "$1" = "`echo -e
"$1\n$2" | sort -V | head -n1`" ]; }; if [ "$APISIX_VERSION" = "master" ] ||
ver_lt 2.2.0 $APISIX_VERSION; then echo 'use shell ';else bin='#!
/usr/local/openresty/luajit/bin/luajit\npackage.path =
"/usr/local/apisix/?.lua;" .. package.path'; sed -i "1s@.*@$bin@"
/usr/bin/apisix ; fi;) \
+ && mv /usr/local/apisix/deps/share/lua/5.1/apisix /usr/local/apisix \
+ && apk del .builddeps \
+ && apk add --no-cache \
+ bash \
+ curl \
+ libstdc++ \
+ openldap \
+ tzdata \
+ # forward request and error logs to docker log collector
+ && ln -sf /dev/stdout /usr/local/apisix/logs/access.log \
+ && ln -sf /dev/stderr /usr/local/apisix/logs/error.log
+
+WORKDIR /usr/local/apisix
+
+ENV
PATH=$PATH:/usr/local/openresty/luajit/bin:/usr/local/openresty/nginx/sbin:/usr/local/openresty/bin
+
+EXPOSE 9080 9443
+
+CMD ["sh", "-c", "/usr/bin/apisix init && /usr/bin/apisix init_etcd &&
/usr/local/openresty/bin/openresty -p /usr/local/apisix -g 'daemon off;'"]
+
+STOPSIGNAL SIGQUIT
+```
+
+This Dockerfile configuration document, from this
[link](https://github.com/apache/apisix-docker/blob/master/alpine/Dockerfile).
The only changes I made were as follows:
+
+```bash
+ARG ENABLE_PROXY=false
+
+# Build Apache APISIX
+FROM api7/apisix-base:1.19.9.1.5
+
+ADD ./apisix-go-plugin-runner /usr/local/apisix-go-plugin-runner
+
+ARG APISIX_VERSION=2.13.1
+LABEL apisix_version="${APISIX_VERSION}"
+
+ARG ENABLE_PROXY
+
+```
+
+Package all the `/apisix-go-plugin-runner` files in the
`/home/chever/api7/cloud_native/tasks/plugin-runner` directory into a Docker
image. Note down the location of the executable
`apisix-go-plugin-runner/cmd/go-runner/go-runner` and the location of the
`/usr/local/apisix-go-plugin-runner` directory in the Dockerfile above to get
the final location of the executable in the Docker image is located as follows.
+
+```bash
+/usr/local/apisix-go-plugin-runner/cmd/go-runner/go-runner
+```
+
+Please make a note of this address. We will use it in the rest of the
configuration.
Review Comment:
Will this be the decisive reason? Maybe let me know what you would do if it
were you, appreciate it!
##########
docs/en/latest/practices/how-to-use-go-plugin-runner-in-apisix-ingress.md:
##########
@@ -0,0 +1,400 @@
+# How to use go-plugin-runner in APISIX Ingress
+
+## Background Description
+
+While wandering around the community, I found a user confused about "how to
use multilingual plugins in APISIX Ingress environment". I happen to be a user
of go-plugin-runner and have a little knowledge of the APISIX Ingress project,
so this document was born.
+
+## Proposal Description
+
+Based on version 0.3 of the go-plugin-runner plugin and version 1.4.0 of
APISIX Ingress, this article goes through building the cluster, building the
image, customizing the helm chart package, and finally, deploying the
resources. It is guaranteed that the final result can be derived in full based
on this documentation.
+
+```bash
+go-plugin-runner: 0.3
+APISIX Ingress: 1.4.0
+
+kind: kind v0.12.0 go1.17.8 linux/amd64
+kubectl version: Client Version: v1.23.5/Server Version: v1.23.4
+golang: go1.18 linux/amd64
+```
+
+## Begin
+
+### Build a cluster environment
+
+Select `kind` to build a local cluster environment. The command is as follows:
+
+```bash
+cat <<EOF | kind create cluster --config=-
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+ kubeadmConfigPatches:
+ - |
+ kind: InitConfiguration
+ nodeRegistration:
+ kubeletExtraArgs:
+ node-labels: "ingress-ready=true"
+ extraPortMappings:
+ - containerPort: 80
+ hostPort: 80
+ protocol: TCP
+ - containerPort: 443
+ hostPort: 443
+ protocol: TCP
+EOF
+```
+
+### Build the go-plugin-runner executable
+
+If you have finished writing the plugin, you can start compiling the
executable to run with APISIX.
+
+This article recommends two packaging build options.
+
+1. put the packaging process into the Dockerfile and finish the compilation
process when you build the docker image later.
+2. You can also follow the scheme used in this document, building the
executable first and then copying the packaged executable to the image.
+
+How you choose the option should depend on your local hardware considerations.
The reason for selecting the second option here is that I want to rely on my
powerful local hardware to increase the building speed and speed up the process.
+
+### Go to the go-plugin-runner directory
+
+Choose a folder address `/home/chever/api7/cloud_native/tasks/plugin-runner`
and place our `apisix-go-plugin-runner` project in this folder.
+
+After successful placement, the file tree is shown below:
+
+```bash
+chever@cloud-native-01:~/api7/cloud_native/tasks/plugin-runner$ tree -L 1
+.
+└── apisix-go-plugin-runner
+
+1 directory, 0 files
+```
+
+Then you need to go to the `apisix-go-plugin-runner/cmd/go-runner/plugins`
directory and write the plugins you need in that directory. This article will
use the default plugin `say` for demonstration purposes.
+
+```bash
+chever@cloud-native-01:~/api7/cloud_native/tasks/plugin-runner/apisix-go-plugin-runner$
tree cmd
+cmd
+└── go-runner
+ ├── main.go
+ ├── main_test.go
+ ├── plugins
+ │ ├── fault_injection.go
+ │ ├── fault_injection_test.go
+ │ ├── limit_req.go
+ │ ├── limit_req_test.go
+ │ ├── say.go
+ │ └── say_test.go
+ └── version.go
+
+2 directories, 10 files
+```
+
+After writing the plugins, start compiling the executable formally, and note
here that you should build static executables, not dynamic ones.
+
+The package compile command is as follows.
+
+```bash
+CGO_ENABLED=0 go build -a -ldflags '-extldflags "-static"' .
+```
+
+This successfully packages a statically compiled `go-runner` executable.
+
+In the `apisix-go-plugin-runner/cmd/go-runner/` directory, you can see that
the current file tree looks like this:
Review Comment:
Is it possible to make it clearer? I understand that you want me to put the
packing steps in the image?
--
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]
