diff --git a/README.md b/README.md index 6447e4e..cb5a742 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,16 @@ ## 文档 -| 文档 | 描述 | -|-----------------------------------------|--------------| -| [快速入门](docs/getting-started.md) | 10 分钟上手指南 | -| [算法开发指南](docs/algorithm-development.md) | 详细的算法开发教程 | -| [API 参考](docs/api-reference.md) | 完整的 API 文档 | -| [监控指南](docs/monitoring.md) | 监控和告警配置 | -| [API 规范](docs/api/README.md) | OpenAPI 规范说明 | -| [Kubernetes 部署](docs/kubernetes-deployment.md) | K8s 集群部署指南 | -| [日志集成(Loki)](docs/loki-quick-reference.md) | 日志收集部署说明 | +| 文档 | 描述 | +|------------------------------------------------|--------------| +| [快速入门](docs/getting-started.md) | 10 分钟上手指南 | +| [算法开发指南](docs/algorithm-development.md) | 详细的算法开发教程 | +| [API 参考](docs/api-reference.md) | 完整的 API 文档 | +| [监控指南](docs/monitoring.md) | 监控和告警配置 | +| [API 规范](docs/api/README.md) | OpenAPI 规范说明 | +| [Kubernetes 部署](docs/kubernetes-deployment.md) | K8s 集群部署指南 | +| [日志集成(Loki)](docs/loki-quick-reference.md) | 日志收集部署说明 | +| [阿里云函数运算FC部署入门](docs/fc-deploy.md) | 阿里云FC部署入门 | ## 快速开始 diff --git a/docs/fc-deploy.md b/docs/fc-deploy.md new file mode 100644 index 0000000..2dee5d1 --- /dev/null +++ b/docs/fc-deploy.md @@ -0,0 +1,58 @@ +# 阿里云 函数运算FC 部署入门 + +本指南帮助快速上手 FunctionalScaffold 脚手架,在 10 分钟内完成第一个算法服务的开发和部署。 + +## 环境准备 + +- 安装 [Serverless Devs CLI](https://serverless-devs.com/docs/overview) + +1. 首先安装Node 环境,在Node官网下载 + - [Node.js 下载地址](https://nodejs.org/en/download/) +2. 安装 Serverless Devs CLI + +```bash +npm install @serverless-devs/s -g +``` + +## 初始化 serverless dev cli 配置 + +执行以下命令初始化 serverless dev cli 配置 + +```bash +s config add +``` + +根据引导进行操作,填入你的access key id 和 access key secret + +## 部署算法服务 + +部署算法服务前,请确保已经完成环境准备和配置。 + +修改 `s.yaml` 文件中的 vars 部分 + +```yaml +# 阿里云函数计算 FC 3.0 配置 +# 使用 Serverless Devs 部署: cd deployment/serverless && s deploy +edition: 3.0.0 +name: functional-scaffold +access: default + +vars: + region: cn-hangzhou # 换成你的区域 + image: registry.cn-hangzhou.aliyuncs.com/your-namespace/functional-scaffold:latest # 换成你的docker 镜像 + redis_host: r-xxxxx.redis.rds.aliyuncs.com # 换成你的redis连接 + redis_port: "6379" # redis 端口号 + redis_password: "your-password" #redis 密码,如果没有可留空 +``` + +```bash +cd deployment && s deploy +``` + +部署完成后,可以在控制台查看服务的运行状态和日志。 + +## 删除算法服务 + +```bash +cd deployment && s remove +``` \ No newline at end of file