Dev next

.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+ARG VARIANT=22
+FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>"

api/test/docker/apisix_config.yaml → .devcontainer/apisix_conf.yml

@@ -14,46 +14,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-# If you want to set the specified configuration value, you can set the new
-# in this file. For example if you want to specify the etcd address:
-#
-
-deployment:
-  admin:
-    allow_admin:
-      - 0.0.0.0/0
-  etcd:
-    host:
-      - "http://etcd:2379"
-    resync_delay: 0
 
 apisix:
-  id: "apisix-server1"
-  enable_control: true
-  control:
-    ip: "0.0.0.0"
-    port: 9090
+  node_listen: 9080 # APISIX listening port
+  enable_ipv6: false
+  proxy_mode: http&stream
   stream_proxy:
-    only: false
     tcp:
-      - addr: 10090
-      - addr: 10091
-      - addr: 10092
-      - addr: 10093
-        tls: true
+      - 9100
     udp:
-      - 10095
+      - 9200
 
-nginx_config:
-  error_log_level: "debug"
+deployment:
+  admin:
+    allow_admin: # https://nginx.org/en/docs/http/ngx_http_access_module.html#allow
+      - 0.0.0.0/0 # We need to restrict ip access rules for security. 0.0.0.0/0 is for test.
 
-plugin_attr:
-  server-info:
-    report_interval: 60
-    report_ttl: 3600
-  prometheus:
-    export_uri: /apisix/prometheus/metrics
-    enable_export_server: true
-    export_addr:
-      ip: "0.0.0.0"
-      port: 9091
+    admin_key:
+      - name: "admin"
+        key: edd1c9f034335f136f87ad84b625c8f1
+        role: admin # admin: manage all configuration data
+
+  etcd:
+    host: # it's possible to define multiple etcd hosts addresses of the same etcd cluster.
+      - "http://etcd:2379" # multiple etcd address
+    prefix: "/apisix" # apisix configurations prefix
+    timeout: 30 # 30 seconds

.devcontainer/devcontainer.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.base.schema.json",
+  "name": "APISIX Dashboard Dev Environment",
+  "dockerComposeFile": [
+    "./docker-compose.yml"
+  ],
+  "service": "apisix-dashboard",
+  "workspaceFolder": "/workspace",
+  "shutdownAction": "stopCompose",
+  "postCreateCommand": "pnpm i && echo '\nUse `pnpm dev` to continue'",
+  "forwardPorts": [
+    9080,
+    9180,
+    9100,
+    9200,
+    5173,
+    5174,
+    4173
+  ],
+  "portsAttributes": {
+    "5173": {
+      "label": "APISIX Dashboard",
+      "onAutoForward": "ignore"
+    },
+    "5174": {
+      "label": "APISIX Dashboard HMR WS",
+      "onAutoForward": "silent"
+    },
+    "9180": {
+      "label": "APISIX Admin API Port",
+      "onAutoForward": "notify"
+    },
+    "9100": {
+      "label": "APISIX Stream Proxy TCP Port",
+      "onAutoForward": "silent"
+    },
+    "9200": {
+      "label": "APISIX Stream Proxy UDP Port",
+      "onAutoForward": "silent"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "vunguyentuan.vscode-css-variables",
+        "dbaeumer.vscode-eslint",
+        "drKnoxy.eslint-disable-snippets",
+        "esbenp.prettier-vscode",
+        "christian-kohler.path-intellisense",
+        "lokalise.i18n-ally",
+        "formulahendry.auto-close-tag",
+        "formulahendry.auto-rename-tag",
+        "github.vscode-pull-request-github"
+      ]
+    }
+  }
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,52 @@
+services:
+  apisix-dashboard:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    command: sleep infinity
+    volumes:
+      - ..:/workspace:cached
+    networks:
+      - apisix
+    ports:
+      - '5173:5173'
+      - '5174:5174'
+
+  apisix:
+    image: 'apache/apisix:3.12.0-debian'
+    restart: always
+    volumes:
+      - ./apisix_conf.yml:/usr/local/apisix/conf/config.yaml:ro
+    depends_on:
+      - etcd
+    ports:
+      - '9180:9180/tcp'
+      - '9080:9080/tcp'
+      - '9091:9091/tcp'
+      - '9443:9443/tcp'
+    networks:
+      - apisix
+
+  etcd:
+    image: bitnami/etcd:3.4.9
+    user: root
+    restart: always
+    volumes:
+      - etcd_data:/etcd_data
+    environment:
+      ETCD_DATA_DIR: /etcd_data
+      ETCD_ENABLE_V2: 'true'
+      ALLOW_NONE_AUTHENTICATION: 'yes'
+      ETCD_ADVERTISE_CLIENT_URLS: 'http://etcd:2379'
+      ETCD_LISTEN_CLIENT_URLS: 'http://0.0.0.0:2379'
+    ports:
+      - '2379:2379/tcp'
+    networks:
+      - apisix
+
+networks:
+  apisix:
+    driver: bridge
+
+volumes:
+  etcd_data: