低代码平台之部署openfaas及基本操作

迈不过友情╰ 2022-10-31 01:45 369阅读 0赞

## 简介 ##

`OpenFaaS`是打包源代码、二进制文件或者容器作为`Serverless`函数编程的框架，可以在`windows、linux`等平台上运行。  
使用它构建函数的流程如下：

1.  通过模板`new`创建函数
2.  `build`函数为`docker`镜像
3.  `push`镜像到`docker registry`
4.  `deploy`函数
5.  `invoke`函数

其实这些步骤对应的是`faas-cli`客户端的几个命令，下面会提到，同时，我也围绕这几个流程来扩展它的实际应用。

## 学习须知 ##

本博客是基于`linux、k8s、dockers、openfaas`，使用的是`root`用户。`k8s`和`docker`的版本及安装参见前面的博客，`openfaas`直接使用的最新的版本。

本博客是使用`js`的`express`框架作为发布的函数，其实我们不需要关注这个`express`框架，只需要记住它帮我们启动了一个`nodejs`的`web`服务器。

## 基于k8s部署openfaas ##

官网提供了三种方式部署`openfaas`：`arkade`、`helm3`和静态`yaml`文件。  
官网推荐使用`arkade`，但学习成本高。  
`helm3`稍微麻烦点，但是可以修改配置文件实现细粒度的设置。  
静态`yaml`好像没有过多的介绍，但是在`openfaas`的`git`上，看到了`faas-netes`仓库，通过一些介绍，我猜测是指这个。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center]  
现在，咱们就用`faas-netes`来搞吧，因为最简单，随后再研究`helm3`部署。  
注：我们外网使用的是`helm3`进行部署的。

### 使用faas-netes部署 ###

没有安装`git`的话，就先安装`git`吧，这里就不多介绍`git`安装了。

git clone https://github.com/openfaas/faas-netes
    cd faas-netes
    kubectl apply -f namespaces.yml
    kubectl -n openfaas create secret generic basic-auth \
        --from-literal=basic-auth-user=admin \
        --from-literal=basic-auth-password=admin
    kubectl apply -f ./yaml/

上面一大串的代码，直接复制粘贴，其中

*  `kubectl apply -f namespaces.yml`  
    是创建`openfaas`相关的命名空间，分别为`openfaas`和`openfaas-fn`两个，以后发布的函数会被部署在`openfaas-fn`命名空间下。  
    ![在这里插入图片描述][20210220235507728.png]
 *  `kubectl -n openfaas create secret generic basic-auth --from-literal=basic-auth-user=admin --from-literal=basic-auth-password=admin`  
    新建`openfaas ui`界面的账号密码
 *  `kubectl apply -f ./yaml/`  
    执行这个命令后，会启动`openfaas`相关的`pod`，`kubectl get pods -A`查看`pod`的状态，这些`pod`可能启动起来会太耗时，我的耗时半小时才全部启动成功，和网速有关系  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center 1]
 *  `kubectl delete -f ./yaml/`  
    这个是移除所有`pod`的命令

### 查看openfaas界面 ###

`openfaas`所有的`pod`都启动成功后，`openfaas`默认端口为31112，使用`google`浏览器登录，360浏览器不兼容，打不开。

登录的账号密码是上面命令中配置的。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center 2]

## 安装faas-cli客户端 ##

`faas-cli`是`openfaas`官方的客户端，用来操作上面提到的`new、build、push、deploy`等命令的。  
官网有安装教程，包括`linux`和`windows`，这里直接来安装`linux`版本。

curl -sSL https://cli.openfaas.com | sudo sh

如果上面的命令提示你去官网手动下载，那么你就去官网下一个faas-cli，按照提示去操作就可以了。

[root@yanzhao opt]# curl -sSL https://cli.openfaas.com | sudo sh
    Finding latest version from GitHub
    
    Failed while attempting to install faas-cli. Please manually install:
    
    1. Open your web browser and go to https://github.com/openfaas/faas-cli/releases
    2. Download the latest release for your platform. Call it 'faas-cli'.
    3. chmod +x ./faas-cli
    4. mv ./faas-cli /usr/local/bin
    5. ln -sf /usr/local/bin/faas-cli /usr/local/bin/faas

使用`faas-cli`登录`openfaas`

export OPENFAAS_URL=111.229.208.187:31112
    faas-cli login -u admin -p admin --gateway http://111.229.208.187:31112

永久有效

echo export OPENFAAS_URL=111.229.208.187:31112 >> ~/.bashrc
    source ~/.bashrc

## faas-cli基本操作 ##

这里介绍的是上面提到的`new、build、push、deploy`等命令，当然也会扩展一些其他内容。

### faas-cli new ###

案例：

faas-cli new flow-001 --lang node12

使用模板创建函数，生成`flow-001`文件夹和`flow-001.yml`文件。  
![在这里插入图片描述][20210221155455421.png]

*  flow-001文件夹  
    `flow-001`文件夹中包含`handler.js`和`package.json`两个文件，`handler.js`是一个简单的js文件，在函数部署后，`openfaas`会调用`handler.js`文件。说到这里，你需要记住的是，`handler.js`的内容可以自定义，但是要符合`openfaas`的模板的要求。  
    ![在这里插入图片描述][20210221155527618.png]
 *  flow-001.yml  
    `flow-001.yml`文件是`faas-cli`操作的文件，`build、push、deploy`等命令都要用到这个文件。文件的内容是`openfaas`识别的，不要和`k8s`的`yml`文件混肴。

在实际应用中，我们会把自定义的文件放到`flow-001`文件夹中，通过修改`flow-001.yml`文件，定义函数`push、deploy`的镜像地址、镜像版本、拉取镜像策略，函数部署后请求读写的超时时间、最大最小`cpu`和`memory`等配置。

注：

1.  **flow-001.yml中的`gateway`要和`faas-cli login`登录的网关保存一致，否则`deploy`时会报错，返回401**
2.  **如果`cpu`和`memory`大小分配不当，会导致函数部署不成功，或者函数在运行过程中导致内存溢出**

例如下面的截图，左侧是外网的配置（`helm3`部署的`openfaas`)，右侧是测试的例子  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70]

### faas-cli build ###

在执行此命令前，需要做三件事：

1.  下载`openfaas`的的模板文件，或者你安装了`git`，`openfaas`自动下载，否则执行会报错。因为这个命令会根据你使用的语言，拷贝相应的模板文件进行打包。  
    ![在这里插入图片描述][20210221153950264.png_pic_center]
2.  修改模板中的文件，例如使用`node12`，可以修改对应文件夹中的文件，我们关心最多的就是`Dockerfile`这个文件，可以自定义容器，其他文件不需要修改。另外`function`文件夹中的文件在执行`build`命令时，会被覆盖，下面再说。  
    ![在这里插入图片描述][20210221154223977.png]  
    ![在这里插入图片描述][20210221154123478.png]
3.  将修改的模板保存起来，以后每次发布新函数，都用自己修改的模板发布。

案例：

faas-cli build -f flow-001.yml

执行`build`命令，会生成`build`文件夹，目录结构如下，其中`Dockerfile、index.js、package.json、template.yml`都是从模板中拷贝的，`function`文件夹也是从模板拷贝的，但是`function`中的文件是拷贝`faas-cli new`生成的文件，也就是我们自定义的`handler.js`文件。  
![在这里插入图片描述][20210221154834794.png]

### faas-cli push ###

`push`命令会把镜像推送到`docker`仓库，推送的地址就是`flow-001.yml`中配置的`image`的地址。  
`openfaas`默认的策略是每次部署都要从`docker`仓库拉取镜像，因此要先推送到`docker`仓库。当然这个策略可以修改，但是不建议修改，因为怕拉取不到已修改的镜像。  
我使用的`docker`仓库是`https://hub.docker.com/`

案例：

docker login -u username -p password
    faas-cli push -f flow-001.yml

### faas-cli deploy ###

在部署前，要先配置`docker`的登录信息，为了解决`k8s`拉取镜像时校验登录的问题。

dockerregistrykey=`base64 -w 0 ~/.docker/config.json`
    cat > dockerregistrykey.yaml <<EOF apiVersion: v1 kind: Secret metadata: name: dockerregistrykey data: .dockerconfigjson: $dockerregistrykey type: kubernetes.io/dockerconfigjson EOF
    kubectl delete secret dockerregistrykey -n openfaas-fn
    kubectl create -f dockerregistrykey.yaml -n openfaas-fn

上面又是一大串代码，直接拷贝执行，主要是把`docker`登录的信息（`faas-cli push`时已经登录了）生成`k8s`认识的`secret`密钥。

案例：

faas-cli deploy -f flow-001.yml

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70 1]  
执行完`deploy`后返回了`http://111.229.208.187:31112/function/flow-001.openfaas-fn`，我们可以直接在`google`中调用此地址。  
![在这里插入图片描述][20210221162559355.png]

### faas-cli up ###

`up`是集`build、push、deploy`为一体的命令。

## 添加新的命名空间 ##

`https://github.com/openfaas/faas-netes` 的`Namespaces`下有提到

By default all OpenFaaS functions and services are deployed to the openfaas 
    and openfaas-fn namespaces. To alter the namespace use the helm chart.

默认情况下，所有`OpenFaaS`函数和服务都部署到`OpenFaaS`和`OpenFaaS fn`名称空间。要更改名称空间，请使用`helm`。

## 拓展 ##

*  在使用`helm`部署`openfaas`后，可以更方便的拓展命名空间，这样可以根据命名空间做资源配额，资源隔离。
 *  更好的利用`k8s`带来的便利
 *  结合业务映射`openfaas`返回的`url`
 *  快速开发轻量级应用

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center]: /images/20221024/06bab26b542b4c5fb1bdd2aafdd81ab1.png
[20210220235507728.png]: /images/20221024/75409fc400044da88607521c0e2d8707.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221024/89d6722dfaf743fbb2895ac4c4ad14b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221024/8785b1b23396471ca4e1693c2f9e6bec.png
[20210221155455421.png]: /images/20221024/7b726a07d7e44756990166f7217a409d.png
[20210221155527618.png]: /images/20221024/568bf32e92514ae8a3bcbb62066fc65c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70]: /images/20221024/49be1b0f4c8b4960b572ceb83ba13ee1.png
[20210221153950264.png_pic_center]: /images/20221024/e20bf7e7d38a4f8c9413ce6ca8e75ab3.png
[20210221154223977.png]: /images/20221024/e3c3b6b8eb5c47f9903699642833d005.png
[20210221154123478.png]: /images/20221024/6768ebe4585740aaaab279d0fc40d638.png
[20210221154834794.png]: /images/20221024/0826892b1eb945cbbbda2c97c783fe25.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx_size_16_color_FFFFFF_t_70 1]: /images/20221024/3d1a50b537e348a78028640c11cb4dd4.png
[20210221162559355.png]: /images/20221024/45899c7f2d844d75a342c339903440d3.png