Creating and Deploying a Component Based on a Container Using YAML Configurations

*Component Name

Name of a component, which cannot be changed after the component is created and deployed.

Enter 2 to 64 characters. Start with a letter and end with a letter or digit. Only use letters, digits, underscores (_), and hyphens (-).

• Components with the same name in different applications can be deployed in the same environment.
• Components with the same name in the same application can be deployed in different CCE clusters in the same HA environment.
• Components with the same name in the same application can be deployed in different environments.

*Component Version

Component version number, which can be automatically generated or customized.

• Automatically-generated: Click Generate. By default, the version number is the time when you click Generate. The format is yyyy.mmdd.hhmms, where s is the ones place of the second in the timestamp. For example, if the timestamp is 2022.0803.104321, the version number is 2022.0803.10431.
• Customized: Enter a value in the format of 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.

*Environment

Select Kubernetes or VM + Kubernetes.

For details, see Environment Overview.

*Select Cluster

Select a CCE cluster for deploying and running the component when Environment is an HA environment.

*Namespace

Namespace of the container where the component instance is located, which is used to isolate the component instance. For details, see Managing Namespaces.

*Deployment Mode

Select Container.

This parameter is mandatory when Environment is set to VM + Kubernetes. For details, see Deploying a Component.

*Application

Application to which the component belongs.

*Workload Type

A workload is an application running on Kubernetes. No matter how many components are there in your workload, you can run it in a group of Kubernetes pods. A workload is an abstract model of a group of pods in Kubernetes. Select a workload type as required.

• Stateless: Workloads are completely independent and have the same functions. They support auto scaling and rolling upgrade. Typical scenario: Nginx.
• Stateful: Workloads have persistent storage and support orderly deployment, scaling, and deletion. Typical scenario: MySQL-HA and etcd.

*Workload

The workload name is automatically generated by default, and can also be customized.

The default workload name consists of the Component Name and Environment you set, and six random characters generated by the system. The total length cannot exceed 52 characters.

• If the Component Name contains 45 characters or fewer, the default workload name is:

  All of the component name-All or part of the environment name-Six random characters generated by the system

  Underscores (_) in the name will be replaced with hyphens (-), and uppercase letters will be converted to lowercase letters.

  For example, if the component name is Com_calc and the environment is env-cce, the default workload name is:

  com-calc-env-cce-1uw8g0

• If the Component Name contains more than 45 characters, the default workload name is:

  First 45 characters of the component name-Six random characters generated by the system

  Underscores (_) in the name will be replaced with hyphens (-), and uppercase letters will be converted to lowercase letters.

  For example, if the component name is C_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, the default workload name is:

  c-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-1uw8g0

You can also customize the workload name.

• If Workload Type is Stateful, enter 1 to 52 characters starting with a lowercase letter and ending with a letter or digit. Only lowercase letters, digits, and hyphens (-) are allowed.
• If Workload Type is Stateless, enter 1 to 63 characters. Start with a lowercase letter and end with a lowercase letter or digit. Only use lowercase letters, digits, and hyphens (-).

The workload name cannot be changed after the component is created and deployed.

*Label

ServiceStage allows you to add labels of the key-value pair type to manage and select components, for example, for Configuring a Scheduling Policy of a Component Instance. Each component can have a maximum of 20 labels.

1. Click Add Label.
2. In the Add Label dialog box, click Add Label.
3. Enter a key and value.
   • The key contains 1 to 36 characters, including digits, letters, underscores (_), or hyphens (-).
   • The value contains 2 to 43 characters, including digits, letters, underscores (_), periods (.), or hyphens (-).
   NOTICE:

   The key cannot be the built-in app, casid, or version.

4. Click OK.

Description

Component description.

1. Click and enter up to 128 characters.
2. Click to save the component description.

*Stack

1. Select a component technology stack type based on the component deployment mode. For details, see Table 1.

   Only enabled technology stacks in the Enabling state can be selected. For details, see Enabling a Technology Stack.

2. Select a technology stack version from the Name drop-down list.

   Only enabled technology stack versions in the Enabling state can be selected. For details, see Enabling a Technology Stack Version.

3. Set JVM to configure the memory parameter size during Java code running. This parameter is available when a Java or Tomcat technology stack is selected.

   Click Stack Settings and set JVM, for example, -Xms256m -Xmx1024m. Multiple parameters are separated by spaces.

4. Set Tomcat to configure the parameters such as Tomcat request path and port number. This parameter is available when a Tomcat technology stack is selected.
   1. Click Stack Settings and select Tomcat. The Tomcat dialog box is displayed.
   2. Click Use Sample Code and edit the template file based on service requirements.
      NOTE:

      In Tomcat configuration, the default server.xml configuration is used. The context path is /, and no application path is specified.

      If you need to customize an application path, customize the Tomcat context path by referring to How Do I Customize a Tomcat Context Path?

   3. Click OK.

*Source Code/Software Package

• If you select Source code repository, create authorization by referring to Creating Repository Authorization and set the code source.
• If you select a software package (JAR, WAR, or ZIP), the software package type supported by the component source is determined by the selected technology stack type. For details, see Table 1.

*Upload Method

If the component source is software package or image package, select an uploaded software package or image package. For details about the upload method, see Component Source.

• If the component source is software package and Custom file address is selected, perform the following operations:
  1. Enter the custom HTTP/HTTPS file download address of the software package.
  2. 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.

• If the component source is image package:
  • You can customize the container name. The name contains 1 to 63 characters, including lowercase letters, digits, and hyphens (-), and must start with a lowercase letter and end with a lowercase letter or digit.
  • Click in the upper right corner of the selected image package to change the image package source.

Image Access Credential

• You can select up to 16 image access credentials.
• Click Create Secret to create an image access credential. Secret Type must be kubernetes.io/dockerconfigjson. For details, see Creating a Secret.

*Container Name

• By default, the container name is the same as the workload name in 5. You can also customize the container name. The name contains 1 to 63 characters, including lowercase letters, digits, and hyphens (-), and must start with a lowercase letter and end with a lowercase letter or digit.
• If the source of the component selected for Upload Method is image package and multi-container deployment is enabled, you need to customize a container name for the new container. The name contains 1 to 63 characters, including lowercase letters, digits, and hyphens (-), and must start with a lowercase letter and end with a lowercase letter or digit.

*Command

If the component source is Source code repository, set Command based on service requirements.

• Default command or script: preferentially executes build.sh in the root directory. If build.sh does not exist, the code will be compiled 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.
  NOTICE:

  • If Custom command is selected, exercise caution when inputting sensitive information in the echo, cat, or debug command, or encrypt sensitive information to avoid information leakage.
  • To run the compilation command in the project subdirectory, you need to go to the project subdirectory and then run other script commands. Example:

    cd ./weather/

    mvn clean package

*Dockerfile Address

If the component source is Source code repository, set Dockerfile Address based on service requirements.

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.

If Dockerfile Address is not specified, the system searches for the Dockerfile in the root directory of the project by default. If the Dockerfile does not exist in the root directory, the system automatically generates the Dockerfile based on the selected operating environment.

*Organization

An organization is used to manage images generated during component build.

*Build

Select the type of the environment used to build an image. The build environment must be a Kubernetes environment, and can access the Internet.

You are advised to select Use current environment. If the CCE cluster in the current environment cannot access the Internet and you have planned an independent build environment, you can select Use independent environment.

• Use independent environment: Use an independent build environment to build an image. The CCE clusters in the independent build environment and in the current component deployment environment must have the same CPU architecture. Otherwise, the component deployment fails.
• Use current environment: Use the deployment environment to which the component belongs to build an image. In the current environment, masters and nodes in the CCE cluster must have the same CPU architecture. Otherwise, the component build fails.

*Environment

• If Use independent environment is selected for Build, select an independent build environment different from that to which the component belongs.
• If Use current environment is selected for Build, select the deployment environment to which the component belongs.

*Namespace

Select the namespace of the CCE cluster in the environment where the build is executed, which is used to isolate build data. For details, see Managing Namespaces.

Node Label

You can use a node label to deliver the build job to a fixed node bound with an EIP.

In the following cases, set a node label to deliver the build job to the fixed node bound with an EIP to ensure that the component can be successfully built and deployed:

• If Use independent environment is selected for Build, set a node label to deliver the build job to the node in the independent environment, to ensure that the node CPU architecture is the same as that of the node in the current component deployment environment.
• If Use current environment is selected for Build and the CPU architecture of a node is different from that of the master node in the environment, set a node label to deliver the build job to the node that has the same CPU architecture as the master node.

For details about how to add a label, see Managing Node Labels.

YAML Mode

Enable it by clicking to use the YAML configurations to deploy component.

*Service Name

Enter the name of the service that can be accessed by external services.

A service is an abstract method that exposes a group of applications running on a pod as network services.

*Port Settings

Set the following port parameters:

• Port Name: name of the port for communication between pods.
• Container Port: port used by an application for listening in a container.
• Access Port: port for accessing the service.

To add port settings, click Add Setting.

Yes

Click Create and Deploy.

• On the Deployment Records page, view the deployment logs and wait until the component deployment is complete.

  If "Querying the Status of a Workload Instance" is displayed, click View Event to view details.

• If the technology stack type of the component selected in 6 is Java, Tomcat, Node.js, Python, or PHP, the system creates a build job of the System created type after the component is deployed. For details, see Viewing Build Jobs.

No

Click Save as Draft.

The component is saved as a draft in the component list of the application selected in 5. When you create a component but do not complete the parameter settings, you can save the draft to prevent the parameters from being lost due to factors such as page closing. You can use the saved component draft to continue creating a component.