最佳实践

安装与配置

最近更新时间:2019-12-03 10:28:54

安装 CLI (Windows)

方式1 通过 cmd 安装

  1. 安装 Python 2.7 或 3.6+ 版本及 pip,您可以参考 Python 及 pip 安装教程 进行安装。
  2. 执行 pip install scf 命令,安装 CLI。
  3. 升级 CLI 可直接执行 pip install -U scf 命令。

方式2 一键安装

  1. 前往 CLI 下载,获取 SCF CLI 安装包。
    说明:

    选择此方式,升级 CLI 需获取最新安装包并重新进行安装。

  2. 对已下载的 “scfcli.exe” 文件单击右键,选择【以管理员身份运行】进行安装。
  3. 执行 scf --version 命令,验证 CLI 是否安装成功。
    scf CLI, version 0.0.1
    返回类似如上信息,则表示安装成功。

安装 CLI (Mac / Linux)

  1. 安装 Python 2.7 或 3.6+ 版本及 pip,您可以参考 Python 及 pip 安装教程 进行安装。
  2. 执行以下命令,检查 Python 版本。
    Python --version
  3. 执行以下命令,安装 SCF CLI。
    pip install scf
  4. 执行以下命令,验证 SCF CLI 是否安装成功。
    scf --version
    返回类似如下信息,则表示安装成功。
    scf CLI, version 0.0.1

配置账号信息

安装完成 SCF CLI 后,需要进行初始化配置,将账号信息配置到 SCF CLI 的配置文件中,便于后续使用。

获取配置信息

SCF CLI 可配置的内容包括默认操作地域、账号 ID、账号的 SecretID 及 SecretKey。 各个配置信息的获取位置如下:

  • 地域:产品期望所属的地域。地域列表及对应的英文写法可 点此 参阅,填写【地域】即可,无需填写可用区。
  • 账号 ID:即 APPID。通过访问控制台中的【账号中心】>【账号信息】,可以查询到您的账号 ID,请复制粘贴到记事本,稍后会用到。
  • SecretID 及 SecretKey:指云 API 的密钥 ID 和密钥 Key。您可以通过登录【访问管理控制台】,选择【云 API 密钥】>【API 密钥管理】,获取相关密钥或创建相关密钥,请复制粘贴到记事本,稍后会用到。

配置操作

SCF CLI 提供了“交互式配置” 和 “非交互式配置”,您可以根据使用习惯自行选择。

交互式配置:

通过执行 scf configure set 命令,可将获取的配置信息配置到 SCF CLI 中,也可修改某个配置项的信息。
例如,用户希望在广州地区使用云函数,并获取到账号 ID 为 1253970223,SecretId 和 SecretKey 分别为 AKIxxxxxxxxxx,uxxlxxxxxxxx。您可以选择以下命令,完成 SCF CLI 的配置。

注意:

using-cos 是指在部署时是否通过 COS 部署,默认为关闭状态,建议开启此功能。使用 COS 部署会显著提升部署速度,在部署频次和包非常大时(如上万次部署或几 G 的包,详情可参考 COS 免费额度),可能会产生 COS 计费。

执行以下命令,并按照提示输入对应信息:

$ scf configure set
[-] appid = 1255721742
[-] region = ap-guangzhou
[-] secret-id = ********************************cEr7
[-] secret-key = ****************************mkYA
[-] using-cos = True (By default, it is deployed by COS.)
Allow report information to help us optimize scfcli(Y/n):

非交互式配置:
(已配置过的用户可跳过该步骤)您也可以执行以下命令,将参数追加在命令后进行配置。

$ scf configure set --region ap-beijing --appid xxxxxxxxxx --secret-id xxxxxxxxxxxxxx --secret-key xxxxxxxxxxxxxx

修改配置

您可以执行 scf configure set --修改项 修改某个配置,例如,将使用区域修改为上海,则可执行以下命令:

$ scf configure set --region ap-shanghai
说明:

修改 using-cos 配置项时,请注意:

  • 开启此项请使用 scf configure set --using-cos y 命令。
  • 关闭此项请使用 scf configure set --using-cos n 命令。

查询配置

执行以下命令,获取已配置的信息。

$ scf configure get

返回类似如下配置的信息:

appid = 1255721742
Python2-path = None
Python3-path = None
region = ap-guangzhou
secret-id = xxxxxxxxxxxxxxxx
secret-key = xxxxxxxxxxxxxxxx
using-cos = True (By default, it is deployed by COS.)

您也可以在 ~/.tcli_config.ini 看到所有配置信息。

升级 SCF CLI

注意:

若您已采用 win 安装包方式完成 SCF CLI 的安装,升级 SCF CLI 请沿用此方式进行升级。

如果您已经安装过 SCF CLI,可以通过如下步骤,将 SCF CLI 升级至最新版本。

pip 安装方式

执行以下命令,完成 SCF CLI 的升级。

$ pip install -U scf

win 安装包方式

前往下载 最新的安装包,然后【右键】选择【以管理员身份运行】。
执行$ scf --version,验证 SCF CLI 是否升级成功。

$ scf --version
SCF CLI, version 0.0.1

返回类似如上信息,可以通过版本号查看升级后的版本。

安装 Python 及 pip

安装 Python

由于 SCF CLI 是通过使用 Python 语言开发完成的,因此在安装 SCF CLI 前您需要先完成 Python 的安装。 您可以在 官方下载说明页面官方下载地址 中,找到合适您的平台以及指定版本的 Python 安装程序。

注意:

建议您安装 Python 2.7(及以上版本)或 Python 3.6(及以上版本)。

  • 针对 Windows 及 Mac 平台,您可以直接在 Python 官方网站中下载安装包,并根据普通软件的安装方式完成安装。
  • 针对 Linux 平台,大部分 Linux 发行版已经内置了 Python 环境。未内置的 Linux 发行版,您可以通过包管理工具完成安装,或者通过源码进行安装。

更多详细信息请访问 Python 官方网站

安装 pip

完成 Python 环境的安装后,您需要安装 Python 的包管理工具 pip。通过使用 pip,您可以很方便的完整 SCF 的安装、升级。 通过 pip 官方安装指南,可以了解到最简单的安装 pip 方法如下:

  1. 执行以下命令,下载 get-pip.py 文件。
    curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
    说明:

    您还可以通过在线访问 get-pip.py 文件的方式,将文件保存到本地。请点此访问 >>

  2. 执行以下命令,安装 pip。
    python get-pip.py
  3. 执行以下命令,验证 pip 是否安装成功。
    $ pip --version
    返回类似如下信息,则表示安装成功。
    pip 18.1 from /Library/Python/2.7/site-packages/pip (Python 2.7)

安装 Docker(可选)

SCF CLI 支持使用 Docker 容器管理工具启动和使用容器,作为在本地运行函数代码的环境。SCF CLI 的 local invoke 命令将会使用 Docker 的管理接口实现相关交互。例如,在容器内运行代码,并获取到容器内的运行日志。

注意:

  • 如果您需要使用本地调试、运行能力,请确保 Docker 已正确安装。
  • 如果您当前不需要使用 Docker 或者计划稍后再安装 Docker 时,可跳过此步骤。

在 Windows 上安装 Docker

在 Windows 平台上安装并运行容器需要使用到操作系统的虚拟化能力。Windows 7 及更早版本与 Windows 10 有不同的 Docker 安装方法。

  • 针对 Microsoft Windows 10 Professional or Enterprise 64-bit 版本
    1. 访问 docker-ce-desktop 的 Windows 版本下载地址
    2. 注册并登录该网站。
    3. 下载 Docker for Windows Installer 安装文件。
    4. 双击安装文件,启动安装。

完成安装后,Docker 将自动启动,小鲸鱼标识将出现在通知栏。

  • 针对 Windows 7 及更早版本
    针对不符合 Docker Desktop 需求的 Windows 版本,需要使用 Docker Toolbox 实现 Docker 的安装。
    1. 访问 Docker Toolbox 概览页面,获取 Windows 版本的 Toolbox 下载地址。
    2. 根据 Toolbox 提供的 Windows 安装指导,双击 Toolbox 安装工具,安装 Toolbox。 Toolbox 内集成了 cli、docker machine、docker VirtualBox 等组件。
    3. 完成安装后,双击桌面上 Docker QuickStart 图标,启动 Docker。

当 Docker 启动完成后,会出现终端窗口等待输入。此时,您可以通过输入 docker version 命令确定 Docker 是否安装成功、启动成功。

在 Mac 上安装 Docker

安装完成后,顶部状态栏上将出现 Docker 的小鲸鱼标识,即表示 Docker 已经完成启动。

  • 针对 Apple Mac OS Sierra 10.12 以下版本
    针对 Apple Mac OS Sierra 10.12 以下版本,需要使用 Docker Toolbox 实现 Docker 的安装。
    1. 访问 Docker Toolbox 概览页面,获取 Mac 版本的 Toolbox 下载地址。
    2. 根据 Toolbox 提供的 macOS 安装指导,双击 Toolbox 安装工具,安装 Toolbox。
    3. 完成安装后,双击 Launchpad 中新增的 Docker Quickstart Terminal 图标,启动 Docker。

当 Docker 启动完成后,会出现终端窗口等待输入。此时,您可以通过输入 docker version 命令确定 Docker 是否安装成功、启动成功。

在 Linux 上安装 Docker

Linux 中的 Docker,可以通过各个发行版中带有的包管理工具完成安装,也可以通过二进制包完成安装。各不同发行版本的 Linux 安装方法可见如下链接:

  • CentOS 操作系统
    1. 获取 CentOS 版本的 Docker 安装包
    2. 执行 sudo yum install docker-ce docker-ce-cli containerd.io 命令,安装 Docker。
  • Debian 操作系统
    1. 获取 Debian 版本的 Docker 安装包
    2. 执行 sudo apt-get install docker-ce docker-ce-cli containerd.io 命令,安装 Docker。
  • Fedora 操作系统
    1. 获取 Fedora 版本的 Docker 安装包
    2. 执行 sudo dnf install docker-ce docker-ce-cli containerd.io 命令,安装 Docker。
  • Ubuntu 操作系统
    1. 获取 Ubuntu 版本的 Docker 安装包
    2. 执行 sudo apt-get install docker-ce docker-ce-cli containerd.io 命令,安装 Docker。
  • 二进制包
    1. 获取 二进制包
    2. 解压并运行二进制包,即可完成 Docker 的下载安装和启动。

常见问题

工具安装或使用常见问题参考 SCF 工具类常见问题

目录