Merge pull request #27 from devsapp/new_docs

New docs

Author: anycodes

custom-container-function/fc-custom-container-event-cpp/cloudshell.md

@@ -0,0 +1,67 @@
+# 快速体验 Custom Container C++ Event 函数案例
+
+欢迎您使用Serverless Devs开发者工具进行项目开发，本实验是基于Serverless Devs部署 Custom Container C++ Event 案例到阿里云函数计算。
+
+整个实验过程包括：
+- [下载工具](#下载工具)
+- [配置密钥](#配置密钥)
+- [初始化项目](#初始化项目)
+- [部署项目](#部署项目)
+- [更多信息](#更多信息)
+
+> - [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/custom-function/cpp/fc-custom-cpp-event/src)
+
+## 下载工具
+
+> 由于本系统已经默认集成了Serverless Devs，所以该步骤在本次试验中可以跳过
+
+通过`npm`安装Serverless Devs开发者工具：
+
+```
+npm install -g @serverless-devs/s
+```
+
+除了上述的安装方法之外，您还可以参考[Serverless Devs Cli 安装文档](https://www.serverless-devs.com/serverless-devs/install) 查看更多安装方法。
+
+## 配置密钥
+
+> 由于本系统已经配置了密钥信息，所以该步骤在本次试验中可以跳过
+
+配置阿里云账号的 AccessKeyID, AccessKeySecret 以及密钥别名。
+
+配置方法可以通过`s config add`指令，选择`Alibaba Cloud`并根据提示进行配置。
+
+除了上述的配置方法之外，您还可以参考[Serverless Devs 配置阿里云密钥信息](https://www.serverless-devs.com/fc/config) 查看更多密钥配置方法。
+
+## 初始化项目
+
+进行项目初始化：
+
+```
+s init start-fc-custom-container-event-cpp -d start-cc-event-cpp
+```
+
+在初始化的过程中，可能涉及到部分服务的开通、参数的获取以及参数的定义，请根据命令行的提醒进行具体的操作。
+
+## 部署项目
+
+- 进入项目：`cd start-cc-event-cpp`
+- 进行项目的部署：`s deploy`
+
+稍等片刻，即可完成项目的部署。
+
+## 更多信息
+
+- 组件仓库地址：https://github.com/devsapp/fc
+- 组件帮助文档：https://www.serverless-devs.com/fc/readme
+- Yaml参考文档：https://www.serverless-devs.com/fc/yaml/readme
+- 关于：
+    - Serverless Devs和FC组件的关系、如何声明/部署多个函数、超过50M的代码包如何部署
+    - 关于.fcignore使用方法、工具中.s目录是做什么、函数进行build操作之后如何处理build的产物    
+  等问题，可以参考文档：https://www.serverless-devs.com/fc/tips
+- 关于如何做CICD等问题，可以参考：https://www.serverless-devs.com/serverless-devs/cicd
+- 关于如何进行环境划分等问题，可以参考：https://www.serverless-devs.com/serverless-devs/extend
+
+更多函数计算案例，可参考：https://github.com/devsapp/awesome/
+
+> 有问题快来钉钉群问一下吧：33947367

custom-container-function/fc-custom-container-event-cpp/hook/index.js

@@ -7,16 +7,16 @@ async function preInit(inputObj) {
 }
 
 async function postInit(inputObj) {
-    console.log(`\n    Welcome to the Aliyun FC start application
-     This application requires to open these services: 
+    console.log(`\nThis application requires to open these services: 
          FC : https://fc.console.aliyun.com/
          ACR: https://cr.console.aliyun.com/
      
-     * 额外说明：s.yaml中声明了actions：
-        部署前执行：s build --use-docker --dockerfile ./code/Dockerfile
-       如果不需要每次都构建项目，或者部署前不需要构建，或者已经手动构建了，可以注释掉这部分内容
-       > PS：部署的时候还需要修改s.yaml中image字段为自己的acr配置的地址
-     * 项目初始化完成，您可以直接进入项目目录下，并使用 s deploy 进行项目部署
+    * Additional note: 
+      1. [actions] are declared in s.yaml, execute before deployment: [s build --use-docker --dockerfile ./code/Dockerfile]
+         If you don't need to build the project every time, or you don't need to build before deployment, or you have built it manually, you can comment out this part
+         > PS: When deploying, you also need to modify the image field in s.yaml to configure the address for your own acr
+      2. The Serverless Devs version required by the current project is at least v2.0.103. You can view the current version through [s -v] and upgrade the version through [npm install -g @serverless-devs/s].
+    * After the project is initialized, you can directly enter the project directory and use s deploy to deploy the project
      \n`)
 }
 

custom-container-function/fc-custom-container-event-cpp/publish.yaml

@@ -2,8 +2,8 @@ Type: Application
 Name: start-fc-custom-container-event-cpp
 Provider:
   - 阿里云
-Version: 1.1.11
-Description: 快速部署一个基于custom container runtime 的C++ Event 类型的 Hello World 到阿里云函数计算
+Version: 1.2.0
+Description: 快速部署一个基于 Custom Container Runtime 的 C++ Event 类型的 Hello World 到阿里云函数计算
 HomePage: https://github.com/devsapp/start-fc
 Tags:
   - 函数计算
@@ -13,8 +13,55 @@ Category: 新手入门
 Service:
   函数计算:
     Authorities:
-      - 创建函数
-      - 删除函数
-      - 创建服务
-      - 删除服务
+      - AliyunFCFullAccess
+      - AliyunContainerRegistryFullAccess
     Runtime: custom container
+Parameters:
+  type: object
+  additionalProperties: false # 不允许增加其他属性
+  required: # 必填项
+    - region
+    - serviceName
+    - functionName
+    - acrRegistry
+  properties:
+    region:
+      title: 地域
+      type: string
+      default: cn-hangzhou
+      description: 创建应用所在的地区
+      enum:
+        - cn-beijing
+        - cn-hangzhou
+        - cn-shanghai
+        - cn-qingdao
+        - cn-zhangjiakou
+        - cn-huhehaote
+        - cn-shenzhen
+        - cn-chengdu
+        - cn-hongkong
+        - ap-southeast-1
+        - ap-southeast-2
+        - ap-southeast-3
+        - ap-southeast-5
+        - ap-northeast-1
+        - eu-central-1
+        - eu-west-1
+        - us-west-1
+        - us-east-1
+        - ap-south-1
+    serviceName:
+      title: 服务名
+      type: string
+      default: hello-world-service
+      description: 服务名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间
+    functionName:
+      title: 函数名
+      type: string
+      default: custom-cpp-event-function
+      description: 函数名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-64 之间
+    acrRegistry:
+      title: 镜像仓库
+      type: string
+      examples: ['registry.cn-hangzhou.aliyuncs.com/fc-demo/fc-cpp-event:v0.1']
+      description: 镜像仓库地址，需要在 https://cr.console.aliyun.com/ 中开通服务、创建仓库以及设置访问凭证

custom-container-function/fc-custom-container-event-cpp/readme-zh.md

@@ -1,31 +1,58 @@
-# Alibaba Cloud Function Computing Custom Container C++ Event function
+# 阿里云函数计算 Custom Container C++ Event 函数案例
 
-You can quickly experience one-click deployment of a C++ application on Alibaba Cloud Function Computing Service in just a few steps:
+<toc>
 
-- Initialize the project: `s init start-fc-custom-container-event-cpp -d start-cc-event-cpp`
-- Enter the project: `cd start-cc-event-cpp`
-- Modify Image in s.yaml to be your own ACR mirror address
-- Deployment project: `s deploy -y`
-- Invoke function: `s invoke -e "{\"key\":\"val\"}"`
+<p align="center"> 中文 | <a href="./readme_en.md">英文 </a> </p>
 
-# Secondary development
+- [快速开始](#快速开始)
+    - [通过应用中心部署](#通过应用中心部署)
+    - [通过命令行工具部署](#通过命令行工具部署)
+    - [通过阿里云CloudShell部署](#通过阿里云CloudShell部署)
+- [应用详情](#应用详情)
+- [关于我们](#关于我们)
 
-Modify the two function logic in code/sample/src/handlers/echo_handler.cpp:
+</toc>
 
--EchoHandler::OnInvoke
--EchoHandler::OnInitialize
+# 快速开始
 
-> This application warehouse address: https://github.com/devsapp/start-fc
+- [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/custom-function/cpp/fc-custom-cpp-event/src)
 
-------------------------------------
-> # More
-> Welcome to use Alibaba Cloud Function Compute FC component for project development
-> 
-> Component warehouse address/help document: https://github.com/devsapp/fc
-> 
-> Yaml reference documentation: https://github.com/devsapp/fc/blob/main/docs/zh/yaml.md
-> 
-> Quick start:
->   - Quickly create an application: https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_application.md
->   - Quick use of commands: https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_function.md
-------------------------------------
+## 通过应用中心部署
+
+<appcenter>
+
+您可以在阿里云 [:earth_asia: Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-fc-custom-container-event-cpp)，快速体验该应用。
+
+</appcenter>
+
+## 通过命令行工具部署
+
+> 在开始之前，需要先安装 Serverless Devs 开发者工具：`npm install @serverless-devs/s -g`，更多安装方法，可以参考[Serverless Devs 安装文档](https://www.serverless-devs.com/serverless-devs/install) ，针对阿里云还需要配置密钥信息，配置密钥信息的方法可以参考[阿里云密钥配置文档](https://www.serverless-devs.com/fc/config)
+
+- 初始化项目：`s init start-fc-custom-container-event-cpp -d start-cc-event-cpp`    
+    > 涉及到确定密钥的选择、服务名称的确定、函数名称的确定以及容器镜像的确定    
+- 进入项目：`cd start-cc-event-cpp`
+- 部署项目：`s deploy -y`
+- 调用函数：`s invoke -e "{\"key\":\"val\"}"`
+
+## 通过阿里云CloudShell部署
+
+如果您不想在应用中心中快速体验，也不想下载命令行工具体验，您也可以在[ :rocket:  阿里云 CloudShell](https://api.aliyun.com/new#/tutorial?action=git_open&git_repo=https://github.com/devsapp/start-fc.git&tutorial=custom-container-function/fc-custom-container-event-cpp/cloudshell.md) 中快速体验。
+
+# 应用详情
+
+该应用是阿里云函数计算 Custom Container C++ Event 函数案例，如果想要基于该应用进行完善，可以修改`code/sample/src/handlers/echo_handler.cpp`中的两个函数逻辑即可：
+
+- EchoHandler::OnInvoke
+- EchoHandler::OnInitialize
+
+# 关于我们
+
+- Serverless Devs 工具：
+    - 仓库：[https://www.github.com/serverless-devs/serverless-devs](https://www.github.com/serverless-devs/serverless-devs)    
+      > 欢迎帮我们增加一个 :star2: 
+    - 官网：[https://www.serverless-devs.com/](https://www.serverless-devs.com/)
+- 阿里云函数计算组件：
+    - 仓库：[https://github.com/devsapp/fc](https://github.com/devsapp/fc)
+    - 帮助文档：[https://www.serverless-devs.com/fc/readme](https://www.serverless-devs.com/fc/readme)
+- 钉钉交流群：33947367    

custom-container-function/fc-custom-container-event-cpp/readme.md

@@ -0,0 +1,44 @@
+# Alibaba Cloud Function Compute Custom Container C++ Event function case
+
+<toc>
+
+<p align="center"> <a href="./readme.md"> 中文 </a> | 英文 </p>
+
+- [Quick start](#Quick-start)
+    - [Deploy via command line tool](#Deploy-via-command-line-tools)
+- [Application details](#Application-details)
+- [About Us](#About-Us)
+
+</toc>
+
+# Quick start
+
+- [:octocat: source](https://github.com/devsapp/start-fc/tree/master/custom-function/cpp/fc-custom-cpp-event/src)
+
+## Deploy via command line tools
+
+> Before starting, you need to install the Serverless Devs developer tools: `npm install @serverless-devs/s -g`, for more installation methods, please refer to [Serverless Devs Installation Documentation](https://www.serverless-devs.com/serverless-devs/install) , you also need to configure key information for Alibaba Cloud. For the method of configuring key information, please refer to [Alibaba Cloud Key Configuration Document](https://www.serverless-devs.com/fc/config)
+
+- Initialize the project: `s init start-fc-custom-container-event-cpp -d start-cc-event-cpp`
+    > It involves determining the selection of the key, the determination of the service name, the determination of the function name, and the determination of the container image
+- Enter the project: `cd start-cc-event-cpp`
+- Deploy the project: `s deploy -y`
+- Invoke function: `s invoke -e "{\"key\":\"val\"}"`
+
+# Application details
+
+This application is a case of Alibaba Cloud Function Computing Custom Container C++ Event function. If you want to improve based on this application, you can modify the two function logics in `code/sample/src/handlers/echo_handler.cpp`:
+
+- EchoHandler::OnInvoke
+- EchoHandler::OnInitialize
+
+# About Us
+
+- Serverless Devs Tools:
+    - Repository: [https://www.github.com/serverless-devs/serverless-devs](https://www.github.com/serverless-devs/serverless-devs)
+      > Welcome to add a :star2:
+    - Official website: [https://www.serverless-devs.com/](https://www.serverless-devs.com/)
+- Alibaba Cloud Function Compute components:
+    - Repository: [https://github.com/devsapp/fc](https://github.com/devsapp/fc)
+    - Help document: [https://www.serverless-devs.com/fc/readme](https://www.serverless-devs.com/fc/readme)
+- Dingding communication group: 33947367