craigwillis/apiserver

NDS Labs API Server

本文档介绍如何在开发环境中运行Labs Workbench API服务器。

镜像概述

NDS Labs API Server是Labs Workbench平台的核心后端服务，负责支撑平台的功能运行。它依赖Kubernetes（Minikube）和Etcd组件，提供API接口供前端或其他服务调用，适用于开发环境下的调试、测试与验证场景。

核心功能

1. 与Kubernetes集群（Minikube）集成，管理平台资源
2. 依赖Etcd实现数据存储
3. 提供完整的API服务接口
4. 支持外部服务部署模式
5. 可通过Postman进行集成测试

使用场景

• 本地开发环境下的API服务调试
• Labs Workbench功能模块的测试验证
• 集群外API服务的部署与验证

配置与运行指南

安装并配置Minikube

根据操作系统参考官方文档安装Minikube，启动实例并为节点添加标签：

bash
minikube start
kubectl label nodes minikube ndslabs-role-compute=true

安装Etcd

开发环境通过Docker本地部署Etcd：

bash
docker run --rm -p 4001:4001 -d ndslabs/etcd:2.2.5 /usr/local/bin/etcd \
         --bind-addr=0.0.0.0:4001 \
         --advertise-client-urls=http://127.0.0.1:4001

设置Go环境（Mac OS）

安装Go并配置路径：

bash
brew install go --cross-compile-common
mkdir $HOME/go
echo 'export GOPATH=$HOME/go' >> $HOME/.bash_profile
echo 'export PATH=$PATH:$GOPATH/bin' >> $HOME/.bash_profile
source $HOME/.bash_profile

克隆并构建API服务器

bash
mkdir -p $GOPATH/src/github.com/
cd $GOPATH/src/github.com/
git clone https://github.com/nds-org/ndslabs 
cd ndslabs/apiserver
./build.sh local

配置API服务器

克隆规格仓库并修改配置文件：

bash
git clone https://github.com/nds-org/ndslabs-specs
# 修改apiserver.json：设置support.email、kubernetes.address（替换为Minikube IP）、specs.path

运行API服务器

bash
./build/bin/apiserver-darwin-amd64

集成测试

安装Newman并运行测试：

bash
npm install -g newman
# 编辑Postman环境文件与集合文件（替换https为http）
cd postman
newman run --insecure --environment=workbench.postman_environment.json --delay-request=1000 Workbench.postman_collection_local.json

作为外部服务运行

创建外部服务配置文件external-apiserver.yaml：

yaml
kind: "Service"
apiVersion: "v1"
metadata:
  name: "ndslabs-apiserver"
spec:
  ports:
    - protocol: "TCP"
      port: 30001
      targetPort: 30001
---
kind: "Endpoints"
apiVersion: "v1"
metadata:
  name: "ndslabs-apiserver"
subsets:
  - addresses:
    - ip: "10.0.2.2" # Minikube VM内部地址
    ports:
    - port: 30001

部署外部服务：

bash
kubectl delete svc ndslabs-apiserver
kubectl create -f external-apiserver.yaml