Skip to content

devsapp/cdn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f706623 · Mar 9, 2023

History

53 Commits
Jul 28, 2022
Aug 11, 2022
Jun 22, 2022
Mar 9, 2023
Aug 2, 2022
Aug 1, 2022
Jun 22, 2022
Aug 1, 2022
Aug 1, 2022
Sep 18, 2022
Sep 18, 2022
Jun 22, 2022

Repository files navigation

阿里云CDN组件

node.js version license issues

中文English

简介

本组件可以帮助你对阿里云CDN服务控制,实现部署加速域名(添加/修改)、启动加速域名停用加速域名刷新节点上的文件内容预热源站内容到缓存节点的功能。

快速开始

🙋 四步即可上手 CDN组件的使用:

  1. 安装 Serverless Devs 开发者工具npm install -g @serverless-devs/s

安装完成还需要配置密钥,可以参考密钥配置文档

  1. 初始化一个函数计算的 start-fc-cdn 项目:s init start-fc-cdn
  2. 初始化完成之后,系统会提示填写参数;
  3. cd 项目目录 && s deploy

所有与cdn相关的start应用都位于devsapp/start-cdn项目下

命令

deploy

修改或者添加加速域名的配置,参考文档 AddUpdateGet
输出如下:

cdn-service: 
  cdnType:       web
  domainName:    cdn.xxx.xyz
  status:        online
  cname:         cdn.fitzdev.xyz.w.kunlunaq.com
  sources: 
    - 
      content:  xxx-vue3.vue-service.xxx.cn-shenzhen.fc.devsapp.net
      port:     80
      priority: 20
      type:     fc_domain
      weight:   10
  refreshConfig: 
    objectPaths: 
      - http://cdn.xxx.xyz/
    objectType:  Directory

start

启动加速域名

stop

停用加速域名

refresh

刷新节点上的文件内容。被刷新的文件缓存将理解失效,新的请求将回源获取新的文件,支持URL批量刷新。如果需要将文件尽快缓存的缓存节点上可配合warmUp命令使用。

URL刷新配额

  • 默认情况下,一个账号每日最多可以提交10000条URL刷新和100个目录刷新,目录刷新包含子目录。如果您的阿里云账号的日带宽峰值大于200 Mbps,您可以参考配额管理申请提升每日配额,阿里云将根据您业务的实际需求进行评估和配置。
  • 默认情况下,一个账号每日最多可以提交20个正则刷新,如果您的阿里云账号的日带宽峰值大于10 Gbps,您可以通过提交工单来申请提升每日配额。
  • 每次请求最多支持提交1000条URL刷新或者100个目录刷新或者1个正则刷新。
  • 单个域名每分钟最多支持提交1000条URL刷新。

warmUp

将源站内容主动预热到L2缓存节点上。首次访问可直接命中缓存,缓解源站压力。

  • URL预热配额(每日):默认情况下,一个账号每日最多可以提交1000条URL预热任务,如果您账号的日带宽峰值大于200 Mbps,可通过配额管理申请提升每日配额,阿里云将根据您业务的实际需求进行评估和配置。
  • 每次最多可以提交100条URL预热任务。
  • 预热队列规则:每个账号的预热队列最大为50000条URL,CDN根据URL提交的先后顺序进行预热,当预热队列中未完成的任务达到了50000条URL时,阿里云CDN将会采取排队机制(即完成排序最前的一条URL预热后才可以继续提交下一条URL预热)完成预热。
  • 预热速度:预热任务的执行速度与需要预热资源的文件平均大小有关,文件平均大小越小,预热速度越快,反之越慢。
  • 单用户调用频率:50次/秒。

remove

删除加速域名。 输出如下:

cdn-service: 
  cdnType:       web
  domainName:    cdn.xxx.xyz
  status:        online
  cname:         cdn.fitzdev.xyz.w.kunlunaq.com
  sources: 
    - 
      content:  xxx-vue3.vue-service.xxx.cn-shenzhen.fc.devsapp.net
      port:     80
      priority: 20
      type:     fc_domain
      weight:   10

YAML规范

Yaml完整配置

edition: 1.0.0
name: component-test   #  项目名称
access: default # 密钥别名

services:
  component-test:
    component: devsapp/cdn
    props:
      cdnType: web # 加速域名的业务类型(必填项),可选值:web 图片小文件、download 大文件下载、video 视音频点播
      domainName: xxx.xyz # 加速域名(必填项) 支持泛域名,以英文句号(.)开头,例如.example.com。
      sources: # 回源地址列表(必填项)
        -
          type: oss # 源站类型(必填项),可选值:ipaddr IP源站、domain 域名源站、oss OSS Bucket为源站、fc_domain 函数计算为源站
          content: xxx-html.oss-cn-hangzhou.aliyuncs.com # 回源地址(必填项)
          prot: 80 # 端口(选填项项)可以指定443或80端口,也可以自定义端口,默认值为80端口。443端口支持HTTPS协议回源。
          priority: 20 # 优先级(选填项),可选值:默认值为20。20是主源,30是备源。
          weight: 10 # 回源权重(选填项),取值范围为100以内,默认值为10。
      checkUrl: # 健康检测URL(选填项)
      scope: domestic # 加速区域(选填项),可选值:domestic 仅中国内地、overseas 全球(不包含中国内地)、global 全球
      topLevelDomain: # 顶级接入域
      refreshConfig: # 刷新节点的文件内容配置(进行refresh操作时必填)
        objectPaths: # 刷新URL (必填项)
          - http://xxx.xyz/
        objectType: Directory # 刷新的类型(选填项),可选值:File 文件刷新、Directory 目录刷新、Regex 正则刷新
      pushObjectCacheConfig: # 预热源站内容配置(进行warmUp操作时必填)
        objectPaths: # 预热URL,必须以http://或https://开头,不能重复。
          - http://xxx.xyz/a.html
        area: # 预热区域(选填项),可选值:domestic 仅中国内地、overseas 全球(不包含中国内地)。如果不传该参数,默认的预热区域为您的域名所配置的CDN加速区域。
        l2Preload: # 是否直接预热到L2节点(选填项),true:代表预热的节点层级必须包含L2节点。false:代表仅预热回源层节点(false为默认值,回源层节点可能是L2节点,也可能是L3节点)。
      waitUntilFinished: true
      maxWaitMs: 120000
      refreshAfterDeploy: true
      autoOpen: true
      autoCreate: true
      autoStart: true

参数解析

名称 类型 必填 描述
cdnType String 加速域名的业务类型。取值:
- web:图片小文件。
- download:大文件下载。
- video:视音频点播。
domainName String 需要接入CDN的加速域名。
支持泛域名,以英文句号(.)开头,例如.example.com。
sources Array<Source> 回源地址列表。
checkUrl String 健康检测URL。
scope String 加速区域。取值:
- domestic(默认值):仅中国内地。
- overseas:全球(不包含中国内地)。
- global:全球。
topLevelDomain String 顶级接入域。
refreshConfig RefreshConfig 进行refresh操作时必填
刷新节点的文件内容配置
pushObjectCacheConfig pushObjectCacheConfig 进行warmUp操作时必填 预热源站内容配置
waitUntilFinished Boolean 是否等待完全执行再进行下一步,默认为true
maxWaitMs number 最长等待毫秒数,与waitUntilFinished参数配合使用,超过最长等待时间不再等待,直接执行下一步,默认最长等待七分钟
refreshAfterDeploy Boolean 部署后自动刷新cdn,默认为true
autoOpen Boolean cdn服务未开通时自动开通,默认为true
autoCreate Boolean start时,加速域名不存在自动创建,默认为true
autoStart Boolean 更新加速域名信息时,如果加速域名已停用自动启用,默认为true

sources

参数 类型 是否必选 描述
type String 源站类型。取值:
ipaddr:IP源站。
domain:域名源站。
oss:OSS Bucket为源站。
fc_domain:函数计算为源站。
content String 回源地址,可以是IP或域名。
port Integer 端口。
您可以指定443或80端口,也可以自定义端口,默认值为80端口。443端口支持HTTPS协议回源。
priority String 源站地址对应的优先级。
支持20和30,默认值为20。20是主源,30是备源。
weight String 回源权重,取值范围为100以内,默认值为10。

refreshConfig

参数 类型 是否必选 描述
objectPaths Array<String> 刷新URL列表
objectType String 刷新的类型。取值:
- File(默认值):文件刷新。
- Directory:目录刷新。
- Regex:正则刷新。
文件刷新和目录刷新的功能说明请参考刷新和预热资源,正则刷新的功能说明和操作示例请参考正则刷新说明
目录刷新默认采用标记资源过期的处理方式,不支持删除目录。目录刷新会将节点上对应目录置为过期,后续有用户访问时,CDN节点将会回源站校验目录是否更新,有更新时从源站重新拉取新版本返回给用户,未有更新时源站响应304状态码。

Tips: 如果refreshAfterDeploy为true且未设置refreshConfig,默认刷新加速域名在cdn节点缓存的所有文件

pushObjectCacheConfig

名称 类型 是否必选 描述
objectPaths Array<String> 预热URL,格式为加速域名/预热的文件。
area String 预热区域。取值:
- domestic:仅中国内地。
- overseas:全球(不包含中国内地)。
如果不传该参数,默认的预热区域为您的域名所配置的CDN加速区域。具体如下:
- 域名的加速区域为“仅中国内地”,预热区域是仅中国内地。
- 域名的加速区域为“全球”,预热区域是全球。
- 域名的加速区域为“全球(不包含中国内地)”,预热区域是全球(不包含中国内地)。
l2Preload Boolean 是否直接预热到L2节点。取值:
- true:代表预热的节点层级必须包含L2节点。
- false:代表仅预热回源层节点(false为默认值,回源层节点可能是L2节点,也可能是L3节点)。

开源许可

Serverless Devs CDN 组件遵循 MIT License 开源许可。

位于node_modules和外部目录中的所有文件都是本软件使用的外部维护库,具有自己的许可证;我们建议您阅读它们,因为它们的条款可能与MIT License的条款不同。

交流社区

您如果有关于错误的反馈或者未来的期待,您可以在 Serverless Devs repo IssuesCDN repo Issues 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 CDN 组件的最新动态,您可以通过以下渠道进行:

关注微信公众号:serverless 联系微信小助手:xiaojiangwh 加入钉钉交流群:33947367