Creating a Region Release Task Using a Release Task Template

Release Task Template Description

The created template file needs to be compressed into a .zip package. A release task template package can contain multiple applications. An application can contain multiple components. Example directory structure of a release task template package:

release/  
|-- app-1
|   |-- app.yaml
|   |-- component-1/
|   |   |-- spec.yaml
|   |   |-- variables.yaml
|   |   |-- values.yaml
|   |   |-- component/
|   |   |   |-- demo_component.yaml
|   |   |   |-- demo_config.yaml
|   |   |   |-- deployment.yaml
|   |   |   |-- configmap.yaml
|   |   |   |-- service.yaml
|   |   |--...(Other Kubernetes resource files)
|   |   |-- README.md
|   |-- component-2/
......
|-- app-2
......

release indicates the name of the released template package, app-1 and app-2 indicate the application directories in the template package, and component-1 and component-2 indicate the component directories of the application.

• Description of files in the application directory
  • app.yaml: application description file, which specifies the application name and the enterprise project to which the application belongs. Example file content:

    kind: ServiceStageApplication
    spec:
        name: test-application-zyh
        enterprise_project_id: 0

  • spec.yaml: application configuration information file, which contains the model version and model type. Example file content:

    # Model version number. Currently, only v1.0.0 is available.
    model_version: v1.0.0
    
    # Model type. Application indicates an application model.
    model_type: Application    

  • values.yaml: file that describes the default values of variables. Example file content:

    namespace: demo
    dep_name: demo-dep
    svc_port: 8080
    value: World
    image: swr.example.com/ss/demo-app:latest

  • variables.yaml: supported variable declaration file. All variables are declared in this file, including the variable name, type, description, and default value. Example file content:

    variable:
      namespace:
        type: string
        default: demo
        description: namespace
      dep_name:
        type: string
        default: demo-dep
        description: workload name
      svc_port:
        type: integer
        default: 8080
        description: service port number
      value:
        type: string
        default: World
        description: Hello interface response data
      cce_resource:
        type: cce
        description: CCE resource
      image:
        type: string
        description: workload image

• Description of files in the component directory

  See Component Template Description.

Prerequisites

• You have compressed the prepared release task template files into a ZIP package and uploaded the package to the repository. For details, see Release Task Template Description.
  • Upload the template package to the SWR repository. For details, see Uploading a Software Package.

    If PKIToken is disabled, the SWR repository is not supported.

  • Select the corresponding template package from OBS. Upload the template package to the OBS bucket in advance. For details, see Streaming Upload (PUT).
  • If you need to use JFrog (example) as the repository for storing the template package, you can use an HTTP/HTTPS custom file download address as the template package download address. Upload the template package to the custom file address in advance.
• If the release task template contains environment creation and basic resource tasks, contact the administrator to grant the RFS permissions to the user group to which the operation account belongs by referring to the following table. In addition, grant the permission to create basic resources to the user group to which the operation account belongs. For details, see Assigning Permissions to a User Group.

  ServiceStage Permission of the User Group to Which the Operation Account Belongs	Required RFS Permission of the User Group to Which the Operation Account Belongs
  ServiceStage FullAccess	RF FullAccess
  ServiceStage Administrator
  ServiceStage Developer

Procedure

1. Log in to ServiceStage.
2. Choose Release Management.
   • If the Release Management page of the new version is displayed by default, go to 4.

     Overview describes release management of the new version.

     

   • If the Release Management page of the old version is displayed by default, go to 3.

     Overview describes release management of the old version.

     

3. Click Try new edition now or Try New Edition to switch to the Release Management page of the new version.

   The data of the old and new versions are isolated. Switching them will not cause release task data loss.

4. Choose Region Release Tasks.
5. Click Use Template and set the parameters by referring to the following table. Parameters marked with an asterisk (*) are mandatory.

   Parameter	Description
   *Release Task	The release task name must be unique in the same enterprise project. Enter 2 to 64 characters. Start with a letter and end with a letter or digit. Only use letters, digits, underscores (_), and hyphens (-).
   *Enterprise Project	Enterprise projects let you manage cloud resources and users by project. It is available after the function is enabled. For details, see Enabling the Enterprise Project Function. Click the drop-down list to select an existing enterprise project. Click Create Enterprise Project to create an enterprise project and select it. For details, see Creating an Enterprise Project
   Description	Description of a release task. Click . Enter up to 128 characters. Click .

6. Set Set Template Package. Select the uploaded release task template package based on the template package storage mode by referring to the following table.

   Template Package Repository	Procedure
   CodeArts release repository	If PKIToken is disabled, the CodeArts software release repository is not supported. Click Select Software Package. Select the uploaded template package from the CodeArts release repository. Click OK.
   OBS	Click Select Software Package. Select the uploaded template package from the OBS bucket. Click OK.
   SWR	If PKIToken is disabled, the SWR repository is not supported. Click Select Software Package. Select the uploaded template package from the SWR repository. Click OK.
   Custom file address	If you need to use JFrog (example) as the repository for storing the template package, perform the following operations to obtain the template package that has been uploaded to the custom file address: Enter the HTTP/HTTPS custom file download address where the template package is located. The custom file address must be the complete path of the release task template package file, for example, https://172.16.0.1:8082/artifactory/template-release.zip. Click Add Custom File Address and enter the HTTP/HTTPS custom file download address where multiple template packages are located. Determine whether to enable authentication. If authentication is disabled, any user can download the software package in the custom file address by default. Click to enable authentication. Only authenticated users can download the software package in the custom file address. Authentication mode can be User name and password authentication or User-defined Header Authentication. The authentication mode and the corresponding authentication parameters are determined by the authentication mode supported by the server where the custom file directory is located.

7. Click Next.
   • In the Preview Template Package area, you can view the details of the release task template file.
   • In the Set Parameters area, you can view and modify the release task parameters.

8. Click Create and Deploy.
   • On the Release Process View page, you can view the release task process details.
   • After the release task is created, its Release Status is Initialized. For details about how to check the release task status, see Viewing Region Release Task Details.
   • After a release task is created, you can manage the release task by referring to Managing Region Release Tasks.