├── ABOUT.md ├── CHANGELOG.md ├── CONTRIBUTING.md ├── CONTRIBUTORS.md ├── LICENSE ├── QA.md ├── README.md ├── READMORE ├── container install.md ├── installdocker&dockercompose.md ├── macdeploysolution.md └── 另一种操作实例方法.md └── image ├── architecture.png ├── architectureold.png ├── dockerfilesharing.png ├── service.png └── ui.png /ABOUT.md: -------------------------------------------------------------------------------- 1 | ![20170421149274059411420.png](http://oe5ahutux.bkt.clouddn.com/20170421149274059411420.png) 2 | 3 | 云框架（Cloud Frameworks）是即插即用的云端技术框架，通过典型实例梳理知识结构，帮助开发者快速掌握新技术，仅需替换部分业务代码，即可将最佳实践应用于生产环境并立即产生价值。 4 | 5 | ## 特性简介 6 | 7 | ### 实用干货 8 | 9 | 面向实际业务场景，解决真实业务问题； 10 | 11 | ### 快速学习 12 | 13 | 在边学边用的过程中快速掌握技术核心； 14 | 15 | ### 即插即用 16 | 17 | 仅需替换业务代码，即可用于生产环境； 18 | 19 | ### 最佳实践 20 | 21 | 源于实战经验，总结技术落地最优路径； 22 | 23 | ## 快速上手 24 | 25 | ### 目录结构 26 | 27 | ``` 28 | Cloud frameworks 29 | |-- user-guide 30 |    |--README.md   文档 31 |    |--CHANGELOG.md   更新日志 32 |    |--LICENSE.md   版权信息 33 |    |--CONTRIBUTING.md   参与贡献 34 |    |--CONTRIBUTORS.md   贡献者 35 |    |--QA.md   常见问题 36 |    |--ABOUT.md   关于云框架 37 |    |--images 38 | |-- 组件1 39 | |-- 组件2 40 | |-- 组件3 41 | `-- 组件n     42 | ``` 43 | 44 | ### user-guide 45 | 46 | 云框架主题展现为Github上的组织（organization），组织中仓库（repository）包括“user-guide-xxx”及一个或多个“组件”。 47 | 48 | 在user-guide仓库中，你可以很方便的找到帮助了解和使用云框架的文档，并根据“[README](README.md)”快速开始。 49 | 50 | ## 参与贡献 51 | 52 | [如何成为云框架贡献者？](CONTRIBUTING.md) 53 | 54 | ## 版权信息 55 | 56 | 云框架遵循APACHE LICENSE 2.0协议发布，并提供免费使用。 57 | 58 | 细节参阅 [LICENSE](LICENSE.md) 59 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # 如何成为云框架贡献者？ 2 | 3 | 如果你没有相关经验，建议花几分钟阅读一下[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)。 4 | 5 | ## Bug 6 | 7 | 如果你发现了bug，或是对代码、文档、项目有任何疑问，可以通过Issue系统来提出。 8 | 9 | ## Feature 10 | 11 | 如果你有能力修复bug或是想要为云框架增加feature，可以通过Pull Request来实现。 12 | 13 | 检查其他人的Pull Request，也是非常有益的贡献方式！ 14 | 15 | ## 文档 16 | 17 | 如果你在文档中发现了笔误或是你有很棒的内容来补充文档，可以编辑并通过Pull Request提交。 18 | 19 | ## 最简单的贡献方式 20 | 21 | 赠人玫瑰，手有余香。 22 | 23 | 帮助他人解决在学习和使用云框架过程中出现的疑问，是云框架最简单的贡献方式。 24 | 25 | 当你在社群中遇到与云框架相关的问题和讨论，请不吝赐教吧！ 26 | 27 | ## 成为云框架作者 28 | 29 | 如果你想要成为云框架作者，负责某一技术主题的创作和运营，可以通过[邮件](mailto:info@goodrain.com)联系我们。 30 | -------------------------------------------------------------------------------- /CONTRIBUTORS.md: -------------------------------------------------------------------------------- 1 | # 贡献者 2 | 3 | [如何成为云框架贡献者？](CONTRIBUTING.md) 4 | 5 | ## 出品人 6 | 7 | **Barnett** 8 | 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /QA.md: -------------------------------------------------------------------------------- 1 | # 常见问题 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [云框架]FaaS Serverless架构 2 | 3 | [FaaS](http://blog.alexellis.io/functions-as-a-service/)(Function as a Service)／[Serverless](https://martinfowler.com/articles/serverless.html)概念在最初并不为大众所接受，但随着微服务架构及[事件驱动架构](http://microservices.io/patterns/data/event-driven-architecture.html)的发展成熟，越来越多人认识到了其中价值。（[Serverless架构综述](https://martinfowler.com/articles/serverless.html?from=singlemessage&isappinstalled=0)） 4 | 5 | 简单来说，FaaS／Serverless是一种新的计算范例，为开发者和运营商提供简单、高效、可扩展的计算方法，我们可以把它看作是比微服务更细粒度的架构模式。FaaS／Serverless并不意味着没有服务器，而是通过将复杂的服务器架构透明化，使开发者专注于业务／任务本身，强调了一种减少计算资源关注、工作粒度从服务器切换到“任务”的思想。（[FaaS、PaaS和无服务器体系结构的优势](http://www.infoq.com/cn/news/2016/06/faas-serverless-architecture)） 6 | 7 | 对于开发者来说，FaaS／Serverless意味着： 8 | 9 | * 无需管理服务器，仅需关注业务代码，其他工作将由平台完成 10 | 11 | * 代码微小化，只完成一个功能，维护升级非常简单 12 | 13 | * 需要时执行计算任务，无需支付闲时费用（真正的按需计算和付费） 14 | 15 | 对于平台运营者来说，FaaS／Serverless意味着： 16 | 17 | * 资源利用率极高，只在实际计算时消耗资源 18 | 19 | * 一个适用于任何语言、任何技术设计的方法的统一运行平台 20 | 21 | 本篇[云框架](ABOUT.md)将以一个自建FaaS平台 http://www.faas.pro 及两个FaaS方法（function）实例[ETCD_v3](https://github.com/cloudframeworks-functionservice/function-example/tree/master/etcd_v3)、[Twitter Function Image](https://github.com/cloudframeworks-functionservice/function-example/tree/master/twitter)为例介绍FaaS／Serverless及其最佳实践。 22 | 23 | 适用于以下场景： 24 | 25 | * 低频请求场景 26 | 27 | * 流量突发场景 28 | 29 | # 内容概览 30 | 31 | * [在线演示](#在线演示) 32 | * [快速部署](#快速部署) 33 | * [平台部署](#平台部署) 34 | * [方法实例](#方法实例) 35 | * [框架说明-平台](#框架说明-平台) 36 | * [FaaS方法开发](#FaaS方法开发) 37 | * [生产环境](#生产环境) 38 | * [常见问题](#常见问题) 39 | * [更新计划](#更新计划) 40 | * [社群贡献](#参与贡献) 41 | 42 | # 在线演示 43 | 44 | http://www.faas.pro 45 | 46 | # 快速部署 47 | 48 | ## 平台部署 49 | 50 | 1. [安装Docker及Docker Compose](https://github.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/blob/master/READMORE/installdocker&dockercompose.md) 51 | 52 | 2. 准备域名（这里使用`faas.org`域名进行部署安装，若你有自己的域名，可使用自己的域名） 53 | 54 | * 增加本地域名解析（可能需要使用`sudo su`命令切换到root账户） 55 | 56 | ``` 57 | sudo echo "机器IP www.faas.org" >> /etc/hosts 58 | sudo echo "机器IP api.faas.org" >> /etc/hosts 59 | sudo echo "机器IP hub.faas.org" >> /etc/hosts 60 | ``` 61 | 62 | * 获取SSL证书（此处使用faas.org域名，你可以 [构建自签证书并使用自己的域名](https://xiaoai.me/?p=82)） 63 | 64 | ``` 65 | sudo wget -P /etc/ssl/faas.org/ fs.faas.pro/faas.org.key 66 | sudo wget -P /etc/ssl/faas.org/ fs.faas.pro/faas.org.crt 67 | ``` 68 | 69 | 3. 平台安装 70 | 71 | * docker-compose安装（执行前请确认已完成系统环境准备） 72 | 73 | ``` 74 | sudo curl fs.faas.pro/dc-up |sh 75 | ``` 76 | 77 | [Mac环境下部署可能报错解决方法](https://github.com/cloudframeworks-functionservice/user-guide-faas/blob/master/READMORE/macdeploysolution.md) 78 | 79 | * 或[基于镜像安装平台组件](https://github.com/cloudframeworks-functionservice/user-guide-faas/blob/master/READMORE/container%20install.md) 80 | 81 | * 镜像仓库注意：此处部署过程使用自签的ssl证书，使用仓库时需要注意添加自签CA证书或者域名的信任，参考：[搭建安全的Docker Private Registry完全指南](http://dockone.io/article/1277) 82 | 83 | 4. 安装Fn客户端([Fn - CLI tool](https://github.com/iron-io/functions/blob/master/fn/README.md)） 84 | 85 | ``` 86 | curl http://fs.faas.pro/fn | sh 87 | export API_URL=http://api.faas.org 88 | fn --help 89 | ``` 90 | 91 | 5. 访问平台 92 | 93 | * 通过 http://www.faas.org:9999 查看服务： 94 | 95 |
96 | 97 | * 通过 http://www.faas.org 进入控制台： 98 | 99 |
100 | 101 | # 方法实例 102 | 103 | **在进行操作实例前需注意：** 104 | 105 | * 确保上文平台及Fn客户端已完整部署 106 | 107 | * 确认配置环境变量`API_URL=http://api.faas.org` 108 | 109 | ## ETCD v3 FaaS方法实例 110 | 111 | [ETCD_v3介绍](http://www.infoq.com/cn/articles/etcd-interpretation-application-scenario-implement-principle) 112 | 113 | [查看方法源码](https://github.com/cloudframeworks-functionservice/function-example/tree/master/etcd_v3) 114 | 115 | 1. 部署一个ETCD_v3应用 ，若已部署忽略本步骤。 ([部署方式](https://github.com/cloudframeworks-functionservice/function-example/blob/master/etcd_v3/etcd_v3_server.md)) 116 | 117 | 2. 创建应用（etcd_v3 server地址替换`***`） 118 | 119 | ``` 120 | fn apps create --config ETCD_SERVER=*** etcd_v3 121 | ``` 122 | 123 | 3. 创建路由 124 | 125 | ``` 126 | fn routes create etcd_v3 /command -i hub.faas.pro/etcd_v3:0.0.1 127 | ``` 128 | 129 | 4. 运行方法 130 | 131 | * PUT 132 | 133 | ``` 134 | echo '{"method":"put","key":"hello","value":"world"}' | fn call etcd_v3 /command 135 | ``` 136 | 137 | * GET 138 | 139 | ``` 140 | echo '{"method":"get","key":"hello"}' | fn call etcd_v3 /command 141 | ``` 142 | 143 | ## Twitter Function Image方法实例 144 | 145 | Twitter Function Image可用于查看推文（**需要科学上网**） 146 | 147 | [查看方法源码](https://github.com/cloudframeworks-functionservice/function-example/tree/master/twitter) 148 | 149 | 1. 配置[Twitter App](https://apps.twitter.com/)及[configure Customer Access and Access Token](https://dev.twitter.com/oauth/overview/application-owner-access-tokens) 150 | 151 | 2. 创建应用(根据你的twitter账号信息更改`***`) 152 | 153 | ``` 154 | fn apps create --config ACCESS_SECRET=*** --config ACCESS_TOKEN=*** --config CUSTOMER_KEY=*** --config CUSTOMER_SECRET=*** twitter 155 | ``` 156 | 157 | 3. 创建路由 158 | 159 | ``` 160 | fn routes create twitter /tweets -i hub.faas.pro/func-twitter:0.0.1 161 | 162 | ``` 163 | 164 | 4. 运行方法,可以使用任何人的账号名替换`***`(username值) 165 | 166 | ``` 167 | echo '{"username":"***"}' | fn call twitter /tweets 168 | ``` 169 | 170 | # 框架说明-平台 171 | 172 | 平台架构图如下所示： 173 | 174 |
175 | 176 | * [Traefik](https://traefik.io/)：了解学习现代化反向代理／负载均衡 177 | 178 | * FunctionAPI：提供一个无状态的API服务。提供FaaS方法创建，配置，运行等API 179 | 180 | * Mysql：存储FaaS方法元数据 181 | 182 | * Redis：消息队列，每次方法调用API产生的任务送往消息队列，调度与执行器从消息队列获取任务并执行 183 | 184 | * Fn：命令行客户端，使你本地开发、本地部署 185 | 186 | * Hub：存储你的方法镜像，使用docker官方镜像仓库服务。项目地址：https://github.com/docker/distribution 187 | 188 | # 开发你的FaaS方法 189 | 190 | 如果想要自己开发FaaS方法，可参考[ETCD_v3](https://github.com/cloudframeworks-functionservice/function-example/tree/master/etcd_v3)、[Twitter Function Image](https://github.com/cloudframeworks-functionservice/function-example/tree/master/twitter)这两个例子。 191 | 192 | 需要注意的是，与普通应用相比，FaaS方法有以下特点／不同： 193 | 194 | * FaaS方法可使用任何语言进行开发 195 | * FaaS方法具有一定的运行时间，即完成计算后退出 196 | * FaaS方法从标准输入或环境变量获取输入数据，以标准输出输出计算结果 197 | * FaaS方法需要以dockerfile进行镜像打包 198 | 199 | **步骤：** 200 | 201 | 1. 使用fn命令构建你的代码： 202 | 203 | ``` 204 | # 创建func.yaml文件 - 用Docker Hub username替换$USERNAME 205 | fn init $USERNAME/hello 206 | 207 | # 创建function 208 | fn build 209 | 210 | # 测试 - 通过管道传入数据, 例如:`cat hello.payload.json | fn run` 211 | fn run 212 | 213 | # 完成后构建并将其push至Docker Hub 214 | fn build && fn push 215 | 216 | # 创建一个app - 每个app仅执行一次 217 | fn apps create myapp 218 | 219 | # 为function创建一个route 220 | fn routes create myapp /hello 221 | ``` 222 | 223 | 2. 使用lambda函数(确保你的node.js主处理函数文件名为：`func.js`) 224 | 225 | ``` 226 | fn init --runtime lambda-node hub.faas.org/lambda-node 227 | ``` 228 | 229 | # 生产环境 230 | 231 | `TODO` 232 | 233 | # 常见问题 234 | 235 | `TODO` 236 | 237 | # 更新计划 238 | 239 | `TODO` 240 | 241 | 点击查看[历史更新](CHANGELOG.md) 242 | 243 | # 社群贡献 244 | 245 | + QQ群: 457506070 246 | + [参与贡献](CONTRIBUTING.md) 247 | + [联系我们](mailto:info@goodrain.com) 248 | 249 | ------- 250 | 251 | [云框架](ABOUT.md)系列主题，遵循[APACHE LICENSE 2.0](LICENSE.md)协议发布。 252 | -------------------------------------------------------------------------------- /READMORE/container install.md: -------------------------------------------------------------------------------- 1 | * 安装数据持久化服务MYSQL 2 | 3 | ``` 4 | docker run -d --restart=always -v /opt/function/mysql/data:/var/lib/mysql \ 5 | --name function-mysql \ 6 | --restart=always \ 7 | -e MYSQL_DATABASE=func \ 8 | -e MYSQL_USER=func \ 9 | -e MYSQL_ROOT_PASSWORD=root-password\ 10 | -e MYSQL_PASSWORD=func-password \ 11 | mysql:5.5 12 | ``` 13 | 14 | * 安装消息队列服务REDIS 15 | 16 | ``` 17 | docker run -d --name function-redis \ 18 | --restart=always \ 19 | -v /opt/function/redis/data:/data\ 20 | redis redis-server --appendonly yes 21 | ``` 22 | 23 | * 安装API服务 24 | 25 | ``` 26 | docker run -d --link function-mysql:db \ 27 | --link function-redis:mq \ 28 | --restart always\ 29 | --name function \ 30 | -l traefik.port=8080\ 31 | -l traefik.tags=function-api \ 32 | -l traefik.frontend.entryPoints=http \ 33 | -l traefik.frontend.rule=Host:api.faas.org \ 34 | -v /var/run/docker.sock:/var/run/docker.sock \ 35 | -v /opt/function/data:/app/data \ 36 | -e DB_URL="mysql://func:func-password@tcp(db:3306)/func" \ 37 | -e MQ_URL="redis://mq:6379" \ 38 | hub.faas.pro/functions 39 | ``` 40 | 41 | * 安装UI控制台 42 | 43 | ``` 44 | docker run -d --restart=always --name function-ui --link function:api \ 45 | -e "API_URL=http://api:8080" \ 46 | -l traefik.tags=function-ui \ 47 | -l traefik.frontend.entryPoints=http \ 48 | -l traefik.port=4000 \ 49 | -l traefik.frontend.rule=Host:www.faas.org\ 50 | hub.faas.pro/functions-ui 51 | ``` 52 | 53 | * 安装镜像仓库服务 54 | 55 | ``` 56 | docker run -d --name function-hub \ 57 | --restart always \ 58 | -v /opt/function/hub/data:/var/lib/registry \ 59 | -l traefik.port=5000\ 60 | -l traefik.tags=function-hub\ 61 | -l traefik.frontend.rule=Host:hub.faas.org\ 62 | -l traefik.protocol=http\ 63 | -l traefik.frontend.entryPoints=https \ 64 | registry:2 65 | ``` 66 | 67 | * 安装负载均衡和代理服务traefik，编辑trafik的配置文件`traefik.toml` 68 | 69 | ``` 70 | [entryPoints] 71 | [entryPoints.http] 72 | address = ":80" 73 | [entryPoints.https] 74 | address = ":443" 75 | [entryPoints.https.tls] 76 | [[entryPoints.https.tls.certificates]] 77 | CertFile = "/etc/ssl/faas.org/faas.org.crt" 78 | KeyFile = "/etc/ssl/faas.org/faas.org.key" 79 | 80 | traefikLogsFile = "log/traefik.log" 81 | accessLogsFile = "log/access.log" 82 | logLevel = "DEBUG" 83 | 84 | [docker] 85 | constraints = ["tag==function-*"] 86 | # Requiredi 87 | endpoint = "unix:///var/run/docker.sock" 88 | # Required 89 | domain = "faas.org" 90 | watch = true 91 | exposedbydefault = true 92 | ``` 93 | 94 | ``` 95 | docker run -d -p 9999:8080 -p 80:80 -p 443:443\ 96 | -v /etc/traefik/traefik.toml:/etc/traefik/traefik.toml\ 97 | -v /var/run/docker.sock:/var/run/docker.sock\ 98 | -v /etc/ssl/faas.org/:/etc/ssl/faas.org\ 99 | --restart always\ 100 | -v /opt/function/traefik/log:/log\ 101 | --name=traefik\ 102 | traefik:1.3-alpine --web 103 | ``` 104 | -------------------------------------------------------------------------------- /READMORE/installdocker&dockercompose.md: -------------------------------------------------------------------------------- 1 | ## 安装 docker 2 | 3 | #### centos 4 | 5 | ``` 6 | 1.清除docker 旧版本 7 | 8 | rpm -qa |grep docker 9 | yum -y remove docker* 10 | 11 | 2.安装新的docker 12 | 13 | yum install -y docker-engine 14 | 15 | 3.systemctl start docker 16 | 17 | 4.docker info 查看docker状态 18 | ``` 19 | 20 | #### ubuntu 21 | 22 | ``` 23 | 1.更新apt包 24 | 25 | sudo apt-get update 26 | 27 | 2.安装 Docker 28 | 29 | sudo apt-get install docker-engine 30 | 31 | 3.sudo service docker start 32 | 33 | 4.docker info 查看docker状态 34 | ``` 35 | 36 | #### mac 37 | 38 | 请参考[https://docs.docker.com/docker-for-mac/](https://docs.docker.com/docker-for-mac/) 39 | 40 | ## 安装docker-compose 41 | 42 | ``` 43 | curl -L https://github.com/docker/compose/releases/download/1.13.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose 44 | sudo chmod +x /usr/local/bin/docker-compose 45 | docker-compose --version 46 | ``` 47 | 48 | -------------------------------------------------------------------------------- /READMORE/macdeploysolution.md: -------------------------------------------------------------------------------- 1 | # Mac下安装 2 | 3 | MAC环境下可能会出现无法成功部署安装的情况（原因不明确，可能是docker for mac bug，也可能是权限问题） 4 | 5 | 解决方法： 6 | 7 | 1. 在Macintosh HD下新建命名为`opt`的文件夹 8 | 9 | 2. 在`opt`文件夹内新建命名为`function`的文件夹 10 | 11 | 3. 在`function`文件夹内新建三个文件夹，分别命名为`mysql`、`redis`、`traefik` 12 | 13 | 4. 分别在`mysql`、`redis`、`traefik`三个文件夹内新建`data`文件夹 14 | 15 | 5. 在Docker -> Perfernece... ->File Sharing中，将上述三个`data`文件夹加入列表内 16 | 17 | ![](../image/dockerfilesharing.png) 18 | 19 | 6. 重新通过docker compose部署 20 | -------------------------------------------------------------------------------- /READMORE/另一种操作实例方法.md: -------------------------------------------------------------------------------- 1 | ## ETCD v3 FaaS操作实例 2 | 3 | [查看方法源码](https://github.com/cloudframeworks-functionservice/function-example/tree/master/etcd_v3) 4 | 5 | 1. 部署一个 ETCD v3 应用 ，若已部署忽略本步骤。 ([部署方式](https://github.com/cloudframeworks-functionservice/function-example/blob/master/etcd_v3/etcd_v3_server.md)) 6 | 7 | 2. 在平台运行 8 | 9 | 2.1 首先设置必须的环境变量 10 | 11 | ``` 12 | # Set your Function server address 13 | # Eg. api.faas.org 14 | FUNCAPI=api.faas.org 15 | # ETCD服务端地址需要先部署etcd 16 | ETCD_SERVER="" 17 | ``` 18 | 19 | 2.2 Running with Functions 20 | 21 | * 创建应用 22 | 23 | ``` 24 | curl -X POST --data '{ 25 | "app": { 26 | "name": "etcd_v3", 27 | "config": { 28 | "ETCD_SERVER": "'$ETCD_SERVER'", 29 | } 30 | } 31 | }' http://$FUNCAPI/v1/apps 32 | ``` 33 | 34 | * 创建路由 35 | 36 | ``` 37 | curl -X POST --data '{ 38 | "route": { 39 |              "image": "hub.faas.pro/etcd_v3:0.0.1", 40 | "path": "/command", 41 | } 42 | }' http://$FUNCAPI/v1/apps/etcd_v3/routes 43 | ``` 44 | 45 | 3. 云端运行 46 | 47 | ``` 48 | curl -X POST --data '{"method": "put","key":"/hello","value":"hello word"}' http://$FUNCAPI/r/etcd_v3/command 49 | curl -X POST --data '{"method": "get","key":"/hello"}' http://$FUNCAPI/r/etcd_v3/command 50 | 51 | ``` 52 | 53 | ## Twitter Function Image操作实例 54 | 55 | [查看方法源码](https://github.com/cloudframeworks-functionservice/function-example/tree/master/twitter) 56 | 57 | 1. 配置[Twitter App](https://apps.twitter.com/) 及 [configure Customer Access and Access Token](https://dev.twitter.com/oauth/overview/application-owner-access-tokens). 58 | 59 | 2. 在平台运行 60 | 61 | 2.1 首先设置必须的环境变量 62 | 63 | ``` 64 | # Set your Function server address 65 | # Eg. api.faas.org 66 | FUNCAPI=api.faas.org 67 | # 以下信息需要在 apps.twitter.com 申请和获取. 68 | CUSTOMER_KEY="XXXXXX" 69 | CUSTOMER_SECRET="XXXXXX" 70 | ACCESS_TOKEN="XXXXXX" 71 | ACCESS_SECRET="XXXXXX" 72 | 73 | ``` 74 | 2.2 Running with Functions 75 | 76 | * 创建应用 77 | 78 | ``` 79 | curl -X POST --data '{ 80 | "app": { 81 | "name": "twitter", 82 | "config": { 83 | "CUSTOMER_KEY": "'$CUSTOMER_KEY'", 84 | "CUSTOMER_SECRET": "'$CUSTOMER_SECRET'", 85 | "ACCESS_TOKEN": "'$ACCESS_TOKEN'", 86 | "ACCESS_SECRET": "'$ACCESS_SECRET'" 87 | } 88 | } 89 | }' http://$FUNCAPI/v1/apps 90 | ``` 91 | 92 | * 创建路由 93 | 94 | ``` 95 | curl -X POST --data '{ 96 | "route": { 97 | "image": "<镜像名>", 98 | "path": "/tweets", 99 | } 100 | }' http://$FUNCAPI/v1/apps/twitter/routes 101 | ``` 102 | 103 | 3. 云端运行 104 | 105 | ``` 106 | curl -X POST --data '{"username": "想要获取的Twitter账户名"}' http://$FUNCAPI/r/twitter/tweets 107 | 108 | ``` 109 | -------------------------------------------------------------------------------- /image/architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/75de17c4a273b46988267fc03c319344d11875bc/image/architecture.png -------------------------------------------------------------------------------- /image/architectureold.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/75de17c4a273b46988267fc03c319344d11875bc/image/architectureold.png -------------------------------------------------------------------------------- /image/dockerfilesharing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/75de17c4a273b46988267fc03c319344d11875bc/image/dockerfilesharing.png -------------------------------------------------------------------------------- /image/service.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/75de17c4a273b46988267fc03c319344d11875bc/image/service.png -------------------------------------------------------------------------------- /image/ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudframeworks-faas-serverless/user-guide-faas-serverless/75de17c4a273b46988267fc03c319344d11875bc/image/ui.png --------------------------------------------------------------------------------