安装与配置

最近更新时间:2019-08-16 19:38:10

操作场景

SCF CLI 在安装前依赖 Python 运行环境,pip 包管理工具,以及使用本地调试时的 Docker 工具。您可以按如下步骤完成依赖安装、SCF CLI 安装及配置:

  1. 安装 Python 及 pip
  2. 安装 Docker(可选)
  3. 安装 SCF CLI
  4. 升级 SCF CLI
  5. 配置 SCF CLI

操作步骤

安装 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 CLI

  1. 执行以下命令,完成 SCF 的安装。
    $ sudo pip install scf
  2. 执行以下命令,验证 SCF 是否安装成功。
    $ scf --version
    SCF CLI, version 0.0.1
    返回类似如上信息,则表示安装成功。
    • 针对 Ubuntu 操作系统,执行上述命令后,提示类似“找不到 scf 命令”的错误,则需要执行以下命令将 SCF 安装路径加入 PATH 环境变量。
      $ export PATH=$PATH:~/.local/bin
    • 针对 Unix-like 操作系统,可以执行以下命令,启动 SCF 命令的自动补全功能。
      $ eval "$(_SCF_COMPLETE=source scf)" 

升级 SCF CLI

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

  1. 执行以下命令,完成 SCF CLI 的升级。
    $ pip install -U scf
  2. 执行以下命令,验证 SCF CLI 是否升级成功。
    $ scf --version
    SCF CLI, version 0.0.1
    返回类似如上信息,可以通过版本号查看升级后的版本。

配置 SCF CLI

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

获取配置信息

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

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

配置操作

  • 通过执行 scf configure set 命令,将获取的配置信息配置到 SCF CLI 中。 例如,用户希望在广州区使用云函数,并获取到账号 ID 为 1253970223,SecretId 和 SecretKey 分别为 AKIxxxxxxxxxx,uxxlxxxxxxxx
    您可以通过执行以下命令,按照提示输入对应信息,完成 SCF CLI 的配置:

    注意:

    • 云函数项目语言非 Python ,可直接回车跳过 Python 路径的配置。
    • using-cos 是指在部署时是否通过 COS 部署。使用 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 也支持将参数追加在命令后进行配置(已经配置过的用户可跳过该步骤)。

    $ scf configure set --region ap-beijing --appid xxxxxxxxxx --secret-id xxxxxxxxxxxxxx --secret-key xxxxxxxxxxxxxx
  • 您也可以通过执行 scf configure set 命令,修改某个配置项。 例如,将使用区域修改为上海,则可执行以下命令:

    $ scf configure set --region ap-shanghai

    设置完成后您可以在 ~/.tcli_config.ini 看到所有配置信息。

查询操作

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

$ 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.)