Deploy a central application instance

Deploy a central application instance

1. Log in to BizWorks, in the select Platform drop-down list selected microservice Development Platform.

2. Click the icon or the text box in the upper-right corner of the page. From the drop-down list, click the name of the project that you want to view and click the Applications tab. On the Applications page, click the name of the target central application.

3. In the left-side navigation pane, choose Application Deployment > Instances.

4. On the Application Deployment page, select the environment where you want to deploy the application, and then click the dashed-line box under the target environment.

   Note

   The Application Deployment page can display multiple instances in an environment, along with the workloads and workload types for each instance.

   In the deployment instance area for the environment, click Create Deployment Instance to create a new one. Existing instances display information such as the instance ID, execution status, operator, and operation time.

   Users with enterprise, project owner, or application owner roles can view and manage deployments in the development environment, testing environment, staging environment, and production environment. Other roles are restricted to viewing and managing deployments in the development environment and testing environment only.

   For more information about the BizWorks account and permission system, see Platform accounts and permissions.

5. If you did not configure an image repository to store the images for your central application when you created the project, the message No image repository is configured appears. You must configure an image repository first.

   For more information about how to configure an image repository, see Configure an image repository.

6. On the Create Instance Deployment - Deployment Configurations panel, complete the settings and click Next. On the following page, in addition to the application source and pipeline, you must configure the deployment policy, network settings, and resource quotas.

   The following table describes the configuration parameters.

   Parameter	Description
   Application source	From the Select Application Version drop-down list, select the target application version. You can choose a version that is either released or in development. If you select Code and the chosen version is in development, you must also select a code branch. You can also specify a Commit ID. This is optional. If you leave Commit ID empty, the latest version of the branch is used by default. If you select Image, click Select Image. In the Select Image dialog box, select the target image based on its Generation Time, Code Information, Image Tag, and Chip Architecture, then click OK. Note The image records listed in the Select Image dialog box come from pipeline runs (for more information, see View image list information). The platform automatically filters these records based on the following criteria: the application version at the time of image creation must match the version being deployed, and the chip architecture of the image must match the chip architecture of the target deployment environment. The source type is determined by the selection made during the version release process. For more information, see Create and release a central application version. If you selected the code-based method when releasing the version, deploying this version requires a full code compilation, build, and deployment process. If you selected the image-based method when releasing the version, deploying this version only involves deploying the image. Note We recommend selecting the image-based method when releasing a version.
   Pipeline	From the Select Pipeline drop-down list, select the target pipeline. Three types of pipelines are supported. For more information, see Manage central application pipelines.
   Deployment configurations	Deployment Policy: Default Policy: Performs a rolling update. A new replica is started, and an old one is stopped after the new one is ready. This process repeats until all replicas are updated. Custom Policy: You can choose By Pod Count or By Percentage. Advanced Options: Click Add and complete the relevant configurations. Toleration: You can use a record of a successful deployment in the target environment to determine the required image information, deployment parameters, and other settings for the application template. The toleration configuration includes the Key, Operator, Value, Effect, and Time (s) fields. You can click Delete to remove a configuration row. The configuration rules for Key and Value are as follows: Key: Cannot exceed 253 characters. Can contain letters, digits, hyphens (-), and periods (.). Must start and end with an alphanumeric character (a-z, 0-9, A-Z). Value: Cannot exceed 63 characters. Can contain letters, digits, hyphens (-), and periods (.). If the value is not empty, it must start and end with an alphanumeric character (a-z, 0-9, A-Z).
   Network configurations	The initial deployment of an instance does not include network configurations. You must add a network access policy after the deployment is successful. If the instance is deployed to an environment in an Alibaba Cloud BizWorks Serverless Public Edition cluster, you must specify a security group for the instance's elastic network interface. You can choose either Use the default security group of the environment or Use an existing security group.
   Resource quotas	Configure the Total number of instances and the Resource quota per instance. If the instance is deployed to an environment in a Container Service for Kubernetes (ACK) or Alibaba Cloud Serverless Kubernetes (ASK) cluster, you can specify the CPU and memory quotas: CPU resources are requested and limited in CPU units. A value of 0.1 is equivalent to 100 mCPU. Memory is requested and limited in bytes. A value of 1,024 MiB is equivalent to 1,024 MB. The resource limit must be greater than the resource request. If the instance is deployed to an environment in an Alibaba Cloud BizWorks Serverless cluster, you can only select from predefined quota options for vCPU and Memory.

7. On the New Instance Deployment - Environment Configuration panel, complete the environment configurations and click Start Deployment.

   1. Optional: Configure lifecycle management.

      After you enable the Lifecycle Management switch, you can configure the following fields: start command, start parameters (click Add to add parameters), post-start command (example: ["/bin/sh","-c","echo Hello from this PostStart handler"]), and pre-stop command (example: ["/bin/sh","-c","nginx -s quit; while killall -0 nginx; do sleep 1; done"]).

Configure the instance network policy

After a successful deployment, the instance is inaccessible until you configure a network policy. On the Application Deployment Instance page, click the target instance card to go to the instance details page. In the network policy section, create a new access policy.

You can create multiple access policies for an instance using either preset scenarios or a custom method. Select an option and follow the guide to create the network policy.

Deployment records and logs

1. On the Application Deployment page, click the target instance card. In the Deployment Records section of the Application Deployment Instance panel, you can view the deployment history. The table includes columns such as ID, Type, Status, Operator, and Completion Time. Operation types include rollback, restart, start, stop, scale-in, scale-out, update, and create. For each record, you can click Details or Logs to view more information.

2. Click Logs next to the target deployment record ID to view the detailed pipeline logs for that deployment process.

   Note

   You can only view logs for deployments of the Update and Create types.

   The results are displayed as follows:

   • If the default pipeline was selected for Deployment Pipeline, the Instance Change Record dialog box shows the execution status of each pipeline stage: Code Checkout, Compile and Build, and Deploy. The deployment log area on the right displays the Docker image push and deployment progress. The deployment status progresses through Prepare for application deployment [Success], Start application deployment [Pending Deployment], Check deployment status [Deploying], and Check deployment status [Deployment Successful], indicating that the pipeline deployment is complete.

   • If a third-party pipeline was selected for Deployment Pipeline, the deployment log pop-up window displays pipeline information at the top, such as Image-based Pipeline, Pipeline Instance ID, and Pipeline Instance Running Status (e.g., SUCCEEDED). The main area shows the scrolling log output from the build process.

     You can click View More Run Records to see more run records on the pipeline instance page.

   • If a custom pipeline was selected for Deployment Pipeline, the deployment logs appear as follows.

     This example uses a pipeline with an added Pipeline Control task to illustrate the deployment logs for a custom pipeline.

     In the Instance Change Record dialog box, the pipeline displays five stages in sequence: Code Checkout, Maven, Create Image, Pipeline Control, and Deploy. A green checkmark next to each stage indicates it is complete. When the Deploy to Target Environment node is selected in the left-side pane, the right-side log area shows the Docker image push logs and application deployment status, ultimately displaying "Check deployment status [Deployment Successful]".

     • The deployment log details for a process in an approval workflow are as follows. In the Instance Change Record panel, the pipeline progress shows the execution status of each stage: Code Checkout, Maven, Create Image, Pipeline Control, and Deploy. The current Pipeline Control stage is shown as Pending for Approval.

       Click View Progress to see the specific approval progress. The approval process details page displays the process instance ID, creation time, creator, and running status, which is currently In Progress. The business information section shows the associated central application, and you can click the View link for more details. The approval progress is presented as a timeline: the Start Node has been completed by the initiator, and the process is currently at the Manual Approval node, which requires all designated approvers to pass (countersign). It shows that two people are pending approval. The Approve and Reject buttons are available at the bottom of the page for approvers.

       Alternatively, in the Deployment Records section of the instance details panel, click Details next to the target deployment record. In the Deployment Record Details panel, click Approval Progress to go to the approval progress details page. You can also find the target deployment record in the list and click Details to view its detailed information. The deployment record details include fields such as Operation Type, Status, Deployer, Completion Time, Deployment Environment, Deployment Content, Deployment Pipeline, and Deployment Policy. The Approval Progress button next to the status bar is the entry point for viewing the progress.

     • To terminate the deployment process of a custom pipeline, click Terminate Process in the Instance Change Record dialog box. In the confirmation dialog box, click OK. The deployment log details page shows the pipeline stage bar (including Code Checkout, Maven, Create Image, Pipeline Control, and Deploy), with status icons indicating whether each stage is completed, in progress, or not started. You can select a specific build step on the left to view its corresponding log output on the right. The Terminate Process button in the upper-right corner allows you to stop the current pipeline execution at any time.

3. Optional: View the detailed deployment configuration of a specific deployment record.
   1. Click Details to the right of the target deployment record ID.
   2. On the Deployment Record Details pane, you can view information such as Deployment Content, Resource Specifications, and Deployment Policy.
   3. To roll back to this version, click Roll Back to This Version. In the Roll Back Application Deployment dialog box, set the rollback policy and Release Quantity, and then click Rollback.