初次使用

初次使用

本文旨在通过软件研发全生命周期的案例演示，帮助您了解 Erda 平台的基本使用流程，带您快速上手。

预备知识

了解容器的运行机制和使用方法

Erda 是一站式云原生 PaaS 平台，其运行核心便是容器。掌握容器的运行机制和使用方法，可以帮助您更好地了解平台设计及操作。
熟知 Java 的基本概念，例如 Maven 构建、基于 Java 的微服务部署形式等

下文将以 Java 程序作为案例，了解 Java 的基本概念将有助于您快速上手。
本文将以如下两则微服务代码作为案例，请提前获取便于后续使用。
- Provider：提供内部接口服务
- Consumer：消费内部接口对外提供服务

安装配置

Erda 提供多种快速安装的方式：

基于 Docker Compose 部署 : 仅适用于不具备 Kubernetes 条件的情况下，在本地快速体验 Erda 的场景。
基于 Helm 最小化安装：适用于在 Kubernetes 集群上最小化安装 Erda 的场景。

您也可以选择 erda.cloud，注册个人账号后即可使用。

准备环境

:::tip 提示若您已加入项目，可跳过本章节。 :::

加入组织

若您使用的是自建 Erda 平台，请登录 admin 账号，根据界面提示创建组织。

::: tip 提示若无 admin 账号，请联系平台管理员处理。 :::
若您使用的是 erda.cloud，作为新用户，您可以登录个人账号自行创建组织。

您也可以选择浏览公开组织，查看具体项目信息。

加入项目

:::tip 提示创建项目需由组织管理员操作。请确认您的账号拥有组织管理员权限，或联系组织管理员处理。 :::

请进入 管理中心 > 项目管理 > 添加项目，进行项目创建。

:::tip 提示若您没有可选集群，请参见集群管理完成集群添加。 :::

加入项目后，您的操作将主要涉及以下两大功能：

DevOps
- 协同
- 代码托管
- CI/CD
- API 管理
- 测试（包括手动测试和自动化测试）
微服务治理
- 应用监控
- API 网关
- 注册中心&配置中心

下文案例将进行全流程演示，并覆盖多数功能。为保证操作顺利，请再次确认您的项目已配置集群资源，且资源充足（大约需要 2 核 CPU 和 8 GB 内存），具体设置方式请参见集群管理。

软件研发全生命周期案例

通常情况下，一个软件研发项目的实现包含以下五个阶段，对应 Erda 功能罗列如下：

需求分析：协同
架构设计：API 管理
研发实现：代码托管 + CI/CD
质量保障：自动化测试 + 应用监控（微服务治理）
长期运营：微服务治理

下文将按照以上软件研发全生命周期过程，结合一个虚拟的客户案例（一个高可用的博客网站）展开演示：

需求分析：协同，包括需求的收集、跟进及落地
研发实现：代码托管 + CI/CD，包括软件构建、部署及管理
质量保障：自动化测试 + 应用监控（微服务治理）

需求分析

软件研发是一项多人分工、协作的经营活动。当团队人数增长至一定规模时，口头协作已无法满足工作需求，此时便需要借助系统或工具来解决问题。

若您是一位个人开发者，同样建议您阅读本章节内容。协同工具不仅能够解决团队扩充带来的沟通问题，还能够帮助开发者有效记录和管理个人的工作。

针对该案例，您需要完成以下操作：

分析和抽象客户需求，进入 DevOps 平台 > 项目协同 > 需求 > 新建需求，将需求录入协同。

通常情况下，产品经理（PD）会将该需求内容补充完整，包括详细的需要描述、验收标准等。
需求最初列于 待处理 中，迭代开始前将通过评审确定是否放入迭代进行开发。

本案例假设该需求已通过评审，纳入 1.0 迭代开发。
团队领导（TL）组织团队进行架构设计和任务拆解，拆解的任务即需求的关联事项，可通过需求跟踪进展。

开发人员可基于不同视角查看各自的任务，也可评论进度或提出异议。

任务、缺陷中的 关联合并请求 能够将研发和协同更紧密地结合起来，具体请参见事项关联。

项目管理者还可以通过数据统计分析协同的效率和瓶颈。

研发实现

:::tip 提示本案例中涉及的软件架构设计无法作为真实研发活动的指导，仅供快速入门参考。 :::

在本案例中，假设 TL 已完成架构设计如下：

设计两个微服务 Service 和 Web，通过 Dubbo 协议通信，使用 Zookeeper 或其他兼容的注册中心（例如 Nacos）。
Service 启用两个实例以保证可靠性。
使用 MySQL 业务数据存储，Redis 用于存放 Session 和缓存。

针对该设计，您需要完成以下操作：

进入 DevOps 平台 > 应用列表 > 新建应用，创建两个应用。关于应用的更多信息，请参见应用管理。

完成代码推送后，创建 pipeline.yml。pipeline.yml 是用于描述 CI/CD 自动化过程的文件，具体请参见 pipeline.yml。

首先完成 CI 部分：

version: 1.1
stages:
  - stage:
      - git-checkout:
  - stage:
      - buildpack:
          alias: blog-server
          params:
            context: ${git-checkout}
            modules:
              - name: service
                path: service
      - buildpack:
          alias: blog-web
          params:
            context: ${git-checkout}
            modules:
              - name: web
                path: web

将此文件提交代码，随后即可以在界面上进行构建。

git add pipeline.yml
git commit -m 'add pipeline'
git push

您也可以通过 UI 界面直接操作，省去本地推送步骤。

完成 CD 部分：

version: 1.1
stages:
  - stage:
      - git-checkout:
  - stage:
      - buildpack:
          alias: blog-server
          params:
            context: ${git-checkout}
            modules:
              - name: service
                path: service
      - buildpack:
          alias: blog-web
          params:
            context: ${git-checkout}
            modules:
              - name: web
                path: web
  - stage:
      - release:
          params:
            erda_yaml: ${git-checkout}/erda.yml
            image:
              service: ${buildpack:OUTPUT:image-service}
              web: ${buildpack:OUTPUT:image-web}
  - stage:
      - deploy:
          params:
            release_id: ${release:OUTPUT:releaseID}

由上可见新增了 release 和 deploy 两个步骤，并且出现了新文件 erda.yml。关于 erda.yml 更多信息，请参见 erda.yml。

将文件补充完整后提交代码。

services:
  web:
    ports:
      - 8095
    deployments:
      replicas: 1
    resources:
      cpu: 0.5
      mem: 512
      disk: 0
    expose:
      - 8095
  service:
    deployments:
      replicas: 1
    resources:
      cpu: 0.5
      mem: 512
      disk: 0
    ports:
      - 20880
    expose:
      - 20880
addons:
  mysql:
    plan: "mysql:basic"
    options:
      version: "5.7.23"
  redis:
    plan: "redis:basic"
    options:
      version: "3.2.12"