Updated on 2024-10-30 GMT+08:00

Overview

Background

CodeArts proposes a feasible agile development methodology — HE2E DevOps implementation framework by using years of R&D experience and industry-leading practices.

Figure 1 HE2E DevOps implementation framework
  • Planning and Design
    The first two steps in the diagram depict the product planning process where service personnel (or customers) collaborate with technical personnel to establish the product's overall logic, plan and design the product, and break down requirements at a specific granularity.
    • Software development solves issues and delivers value, not simply provides functions. Impact mapping identifies user requirements and root causes.
    • User stories convey objectives and requirements in specific scenarios, facilitating communication between customers, service personnel, and developers. If you only view separate requirement items, you cannot consider them from the entire solution's perspective. User stories focus on scenarios, sort out and display stages and activities in a tree structure. In this way, you will view both requirement items and overall requirement scenarios.
  • Planning, Tracking, and Iteration
    Steps 3 to 10 are the main management practices in the Scrum framework.
    • Scrum defines a relatively complete framework for agile process management. CodeArts well integrates the Scrum framework with daily activities of development teams. Main process deliverables include the product backlog, sprint backlog, potential deliverable product increments, and issue list. Core team activities include sprint planning meetings, daily Scrums, sprint reviews, sprint retrospective meetings, and daily updates.
  • Continuous Delivery
    Starting from step 11 is the engineering practice, that is, the CI/CD process.
    • Continuous delivery is based on code configuration management. It not only covers traditional security control of code assets, concurrent development, and version and baseline management, but also reflects team collaboration and communication.
    • The pipeline connects code check (or static scanning), automated build, automated testing in all stages, and automated deployment.
    • Continuous delivery also covers continuous artifact management and environment management at different levels, including development, test, quasi-production, and production environments.
    • The continuous delivery pipeline manages stages, environments, activities, entry and pass quality gates, and input and output artifacts in each stage.

Application Scenarios

We will use the sample code for an auto part e-mall named "Phoenix Mall" and the "DevOps Full-Process" sample project to describe how to use CodeArts to implement the HE2E DevOps framework. This solution is applicable to Scrum R&D projects.

Solution Architecture

  • Phoenix Mall Architecture

    Figure 2 shows the architecture of the Phoenix Mall sample program.

    Figure 2 Technical architecture of Phoenix Mall

    The sample program consists of five microservice components that can be independently developed, tested, and deployed, as shown in Table 1.

    Table 1 Microservice components of Phoenix Mall

    Microservice Component

    Description

    Web client server (corresponding to the Vote function in the sample code)

    • Service logic: Users can use a browser to access the web UI of this service. When a user clicks Like on a specific offering, the service saves the record of the selected offering in the Redis cache.
    • Technology stack: Python and Flask frameworks
    • Application server: Gunicorn

    Web management server (corresponding to the Result function in the sample code)

    • Service logic: Users can use a browser to access the web UI of this service. The statistics about Like clicked by users on the UI are dynamically displayed. The data is obtained from the PostgreSQL database.
    • Technology stack: Node.js and Express frameworks
    • Application server: server.js

    Background order batch processing program (corresponding to the Worker function in the sample code)

    • Service logic: This service is a background process. It monitors item records in the Redis cache, obtains new records, and saves them in the PostgreSQL database so that the management UI can extract data for statistics display.
    • Technology stack: .NET Core or Java (This service provides two technology stacks to implement the same function. You can modify the configuration and select one of the technology stacks as the runtime process.)

    Order cache

    • Service logic: Persists data for the client UI.
    • Technology stack: Redis

    Order database

    • Service logic: Serves as the data source of the management UI.
    • Technology stack: PostgreSQL
  • Composition of the DevOps Full-Process Sample Project

    This project uses Scrum and presets some service templates. Products and services involved in this project.

    Table 2 List of involved products/services

    Service

    Description

    CodeArts

    Req

    Presets three planned and completed Sprints, project module settings, and several statistical reports.

    Repo

    Presets the code repository phoenix-sample to store project sample code.

    Check

    Presets four tasks.

    Build

    Presets five tasks.

    Artifact

    Stores software packages generated by build tasks.

    Deploy

    Presets three applications.

    TestPlan

    Presets more than 10 test cases in a function test case library.

    Pipeline

    Presets five pipelines.

    Other components and services

    Identity and Access Management (IAM)

    Manages accounts.

    SoftWare Repository for Container (SWR)

    Stores Docker images generated by build tasks.

    Cloud Container Engine (CCE)

    Deploys software packages, which is different from ECS-based deployment.

    Elastic Cloud Server (ECS)

    Deploys software packages, which is different from CCE-based deployment.

Advantages

  • We provide a one-stop cloud platform to manage the entire software development process, to address R&D pain points such as frequent requirement changes, complex development and test environments, difficult multi-version maintenance, and failure to effectively monitor the progress and quality.
  • This service provides visualized and customizable pipeline services for continuous delivery, doubling the software rollout speed.