# 初次使用

# 登录

CLI 有少数命令无需登录即可执行，例如 migrate 相关命令。但多数子命令需在登陆后执行，登录相关参数如下：

--host 指定需登录的 Erda 平台地址。
-u，--username 指定登录用户名。
-p，--password 指定登录密码。

提示

当前目录为代码目录，CLI 将通过 git remote get-url <remote-name> 尝试获取平台地址、企业名称、项目 ID、应用 ID，其中 remote-name 可通过 --remote 指定，默认为 origin。

若您未通过登录参数指定登录信息，则需通过交互方式填写。

$ erda-cli clone https://erda.cloud/trial/dop/projects/599
Enter your erda username: <YourName>
Enter your erda password: <YourPassword>
ORGID    NAME         DESCRIPTION
100060   erda         Erda 开源组织
100046   trial        Trial 企业

提示

登录成功后将保存 Session。Session 过期后需重新登录。

# 本地研发

# 项目准备

警告

请先在 Erda 的 Web 界面完成项目和应用创建，并提交代码。

本文假设创建的组织名称为 trial，项目名称为 bestpractice，应用名称为 echo-service。

克隆项目至本地：

$ erda-cli clone https://erda.cloud/trial/dop/projects/599
  Application 'echo-service' cloning ...
  Application 'echo-service' cloned.
  Application 'echo-web' cloning ...
  Application 'echo-web' cloned.
✔ Project 'bestpractice' and your applications cloned.

# 进入项目工作空间
$ cd bestpractice

# 事项处理

列出待完成的需求：

$ erda-cli issue --requirement
ISSUEID   FINISHDATE   STATE    ISSUENAME
298064    2022-03-31   待处理   实现公司统一单点登录

列出待完成的任务：

$ erda-cli issue --task
ISSUEID   FINISHDATE   STATE    ISSUENAME
298068    2022-03-30   待处理   移动端登陆认证
298067    2022-03-28   待处理   用户身份统一认证

创建代码分支处理事项：

$ erda-cli issue fix 298067 --application echo-service --branch feature/auth
[INFO] No base branch set, use branch 'master'.
[INFO] Switched to a new branch 'feature/auth'
[INFO] [feature/auth f7add11] init branch 'feature/auth'
[INFO] remote:
remote: Create a pipeline request for 'feature/auth' on Erda by visiting:
remote:      https://erda.cloud/trial/dop/projects/599/pipelines/list
remote:
To https://erda.cloud/trial/dop/bestpractice/echo-service
 * [new branch]      feature/auth -> feature/auth
Branch 'feature/auth' set up to track remote branch 'feature/auth' from 'origin'.
[INFO] Branch 'feature/auth' created in application 'echo-service' to fix issue '298067'.

在应用 echo-service 中创建分支 feature/auth 用于处理任务 298067。随后需在新特性分支中进行代码编写。

# 应用构建

执行流水线并查看构建状态。

$ cd echo-service
$ erda-cli  build pipeline.yml
✔ run pipeline: pipeline.yml for branch: master, pipelineID: 14174832, you can view building status via `erda-cli view -i 14174832`

$ erda-cli view -i 14174832
Pipeline progress (current/total): 1/4
PIPELINEID   TASKID     TASKNAME       TASKSTATUS   STARTEDAT
14174832     14411986   git-checkout   Success      2022-03-11 15:38:27
14174832     14411988   java-build     Running      2022-03-11 15:38:36
14174832     0          release        Analyzed     0001-01-01 00:00:00
14174832     0          dice           Analyzed     0001-01-01 00:00:00

# 分支合并

完成编码和构建后提交合并请求：

$ erda-cli mr create --from=feature/auth --to=master --title='auth service' --description='all auth handle by the same service'
[INFO] source branch feature/auth, target branch master
[INFO] Merge request created.
[INFO] To https://erda.cloud/trial/dop/projects/599/apps/7097/repo/mr/open/1

# 项目初始化

# 创建项目

# 基于工程包

您可基于标准产品的项目制品生产项目工程包，用于在实施环境中快速创建项目。

在标准项目中创建流水线。

version: "1.1"
stages:
  - stage:
      - project-package:
          alias: project-package
          description: 用于 Erda 平台制作项目工程包
          version: "1.0"
          params:
            artifacts:
              - name: gaia-oms
                type: project
                version: "1.0"

其中 artifacts 描述工程包关联的制品。运行流水线完成工程包制作，随后通过下载链接获取。

工程包的结构如下：

.
├── artifacts
│   └── gaia-oms_1.0.zip
├── environments
│   ├── DEV-env.yml
│   ├── PROD-env.yml
│   ├── STAGING-env.yml
│   └── TEST-env.yml
├── metadata.yml
├── project.yml
├── repos
│   ├── gaia-oms-go-demo-release-1.0.zip
│   └── gaia-oms-rust-demo-release-1.0.zip
├── values.yml

工程包包含：

应用列表
应用代码
项目制品
环境配置，包括 Custom Addon、集群及配额

填写配置。

请在工程包的 values.yml 文件中填写新项目所需的具体配置：

values.DEV.addons.oss.config.OSS_ACCESS_KEY_ID: ""
values.DEV.addons.oss.config.OSS_ACCESS_KEY_SECRET: ""
values.DEV.addons.oss.config.OSS_BUCKET: ""
values.DEV.addons.oss.config.OSS_ENDPOINT: ""
values.DEV.addons.oss.config.OSS_HOST: ""
values.DEV.addons.oss.config.OSS_PROVIDER: ""
values.DEV.addons.oss.config.OSS_REGION: ""
values.DEV.addons.oss.config.OSS_STORE_DIR: ""
values.DEV.addons.test.config.abc: ""
values.DEV.cluster.name: ""
values.DEV.cluster.quota.cpuQuota: 0
values.DEV.cluster.quota.memoryQuota: 0
...
values.PROD.cluster.name: ""
values.PROD.cluster.quota.cpuQuota: 0
values.PROD.cluster.quota.memoryQuota: 0

使用工程包初始化项目。

$ erda-cli create --host https://erda.cloud --org erda -n demo-project -d 'demo project' --init-package project_package_20220310194452.zip
Enter your erda username: <Your Username>
Enter your erda password: <Your Password>
  Devops project demo-project creating...
  Devops project demo-project created.
  Msp tenant demo-project creating...
  Msp tenant demo-project created.
  Project package importing...
  Project package importing...
  Project package imported.
✔ Project 'demo-project' created.

其中 project_package_20220310194452.zip 为项目工程包。

初始化过程将完成以下内容：

项目创建
监控租户创建
工程包导入，包括创建应用、推送代码、创建 Custom Addon、导入制品

# 项目工程

# 项目克隆

通过 clone 命令将 Erda 上的项目克隆至本地，从而可在本地项目空间中进行后续操作。

$ erda-cli clone https://erda.cloud/trial/dop/projects/599
  Application 'echo-service' cloning ...
  Application 'echo-service' cloned.
  Application 'echo-web' cloning ...
  Application 'echo-web' cloned.
✔ Project 'bestpractice' and your applications cloned.

默认 --cloneApps 选项为 true，将项目中各个应用及代码同样克隆至本地。

完成克隆后，将在本地以项目名称创建目录，项目目录即为项目空间，其下有隐藏文件记录项目信息。

$ cd bestpractice/
$ cat .erda.d/config
version: v0.0.1
server: https://openapi.erda.cloud
org: trial
org_id: 100046
project: bestpractice
project_id: 599
applications:
    - name: echo-service
      id: 7097
      mode: SERVICE
      desc: "web server supplies services"
    - name: echo-web
      id: 7083
      mode: SERVICE
      desc: "web server supplies apis"

在项目空间中执行 CLI 命令，默认将加载项目及应用的信息。

# 项目推送

您可将本地项目空间中的应用及代码推送至 Erda 平台上的任一项目中，便于快速部署和二次开发。

$ erda-cli push https://one.gts.terminus.io/trial/dop/projects/127 --application echo-web --application echo-service
  Application 'echo-web' pushed.
✔ Project 'bestpractice' pushed to server https://openapi.erda.cloud.

← CLI 安装 CLI 命令 →