Updated on 2024-07-01 GMT+08:00

Upgrading a Component

If a component fails to be deployed, you can upgrade it for redeployment.

Procedure

  1. Log in to CAE.
  2. Choose Components.
  3. Select the target component and click Upgrade in the Operation column.
  4. Configure the component again by referring to the following table.

    Parameter

    Item

    Description

    Component

    -

    The value cannot be changed during upgrade.

    Version

    -

    Component version.

    The format is A.B.C or A.B.C.D. A. B, C, and D are natural numbers, for example, 1.0.0 or 1.0.0.0.

    Specifications

    -

    Select the instance specifications, for example, 0.5 Core, 1 GiB; 1 Core, 1 GiB; 1 Core, 2 GiB; 2 Core, 4 GiB.

    Code Source

    NOTE:

    During upgrade, the code source format is restricted. For example, components deployed using images, JAR, or WAR can only be upgraded using images, JAR, or WAR respectively.

    Source code repository

    1. Select a code source. GitHub, GitCode, GitLab, and Bitbucket code can be identified.
    2. Only Branch can be modified during upgrade.

      Branch: Select a branch to manage code.

    3. Build Type: Select Default or Custom.
      NOTE:

      The authorization mode varies depending on the code source.

      • Default command or script: preferentially executes build.sh in the root directory. If build.sh does not exist, the code will be built using the common method of the selected language. Example: mvn clean package for Java.
      • Custom command: Commands are customized using the selected language. Alternatively, the default command or script is used after build.sh is modified.
    4. Dockerfile: Set this parameter if the component source is Source code repository. You can select Custom or Default.
      NOTE:

      You can select Default to configure artifact files only when Language/Runtime System is set to Java.

    5. Dockerfile Address: Set this parameter if Dockerfile is set to Custom.
      • Dockerfile Address is the directory where the Dockerfile is located relative to the root directory (./) of the project. The Dockerfile is used to build an image.
      • The Docker program reads the Dockerfile file to generate a custom image.
      • The Dockerfile address contains 1 to 255 characters, including letters, digits, periods (.), hyphens (-), underscores (_), and slashes (/).
      • If the file name is Dockerfile, you can only enter a directory address and this address must end with a slash (/).
    6. Artifact File: Set this parameter if Dockerfile is set to Default.

      Select and run the specified JAR package from multiple JAR packages generated during Maven build. The JAR package ends with .jar. Fuzzy match is supported. Examples: demo-1.0.jar and demo*.jar.

    Image

    1. Upload the image package by Upload Through Client or Upload Through Page.
    2. On the My Images, Open Source Images, or Shared Images page, select an image package for deployment. You can search for an image by name.
      • My Images: image packages uploaded by users.
      • Open Source Images: images provided by SWR.
      • Shared Images: image packages shared by different accounts.
    3. (Optional) You can also click the link next to Code Source to go to the SWR console and perform more image management operations.
      NOTE:

      When you select Upload Through Page, only one image package can be added at a time. The file size cannot exceed 2 GB (after decompression). The image package can be in .tar or .tar.gz format. Only the image package created by the container engine client of version 1.11.2 or later can be uploaded. For details, see Creating an Image Package. To upload a file larger than 2 GB, select Upload Through Client.

    Software package

    1. Select CodeArts Release Repo or OBS where the software packages are located.
      • If you select CodeArts Release Repo, upload the software package to the software release repository in advance. For details, see Uploading a Software Package.
      • If you select OBS, upload the software package to the OBS bucket in advance. For details, see Uploading an Object.
    2. Build Type: Select System default or Custom Dockerfile.
      • System default: Use the default Dockerfile based on the selected language or runtime system.
      • Custom Dockerfile: Customize the Dockerfile based on the selected language.
    Figure 1 Upgrading a component

  5. Click Upgrade Now.