Updated on 2025-02-08 GMT+08:00

Deploying an Application with a Custom Kubernetes Cluster

This section introduces how to deploy an application in a Kubernetes cluster with a manifest file defining Kubernetes objects. In this way, self-built or third-party Kubernetes clusters can be deployed.

Prerequisites

A custom cluster is available.

Procedure

  1. Obtain the kubeconfig file.

    • Your Kubernetes cluster is used as an example.

      For details, see Configure Access to Multiple Clusters.

    • Example of a CCE cluster
      1. Go to the console. In the upper left corner of the page, choose Service List > Containers > . Click the target cluster and click Bind next to EIP to bind the public IP address.

        The CodeArts Deploy official resource pool and your Kubernetes cluster are not in the same VPC. Therefore, you can access the Kubernetes cluster only through an EIP.

      2. Click Configure next to kubectl in the Connection Information area. On the displayed page, click Download under Download the kubeconfig file to download the configuration file.

        After the download is complete, a kubeconfig.json file is available.

  2. Create a Kubernetes endpoint.

    1. Log in to CodeArts Deploy.
    2. Click Create Application, enter basic information, click Next, select Blank Template, and click OK. The Deployment Actions page is displayed.
    3. Click All, search for Deploy a Custom Kubernetes Cluster, and click Add.
    4. Create an endpoint for accessing the Kubernetes cluster.

      Click Create to create a Kubernetes access point.

      After entering the information, click Verify and OK to check whether the endpoint is configured successfully.
      Table 1 Parameters

      Parameter

      Description

      Service Endpoint Name

      Name of the service endpoint.

      Kubernetes URL

      Set this parameter to the public API Server address in the custom cluster.

      Kubeconfig

      Copy all content in the kubeconfig.json file.

    5. Configure other required parameters as prompted to complete deployment over the public network with Kubernetes.
      Table 2 Parameters

      Parameter

      Description

      Kubernetes Service Endpoint

      Select the target Kubernetes access point. You can create and manage Kubernetes access points.

      kubectl Command

      Select the target kubectl command by referring to Command line tool (kubectl).

      Use Manifest File

      If this option is selected, you need to select the target manifest file for deployment. The file name must be suffixed with .yaml, .yml, or .json.

      Manifest File Source

      Select Artifact or Repo as the file source.

      Manifest file or folder

      This parameter is mandatory. Select a manifest file or folder to be deployed. Files must be suffixed with .yaml, .yml, or .json.

      Click . On the file selection page that is displayed, select a Manifest File to be deployed in Artifact. By default, the project cannot be changed. You can search for the manifest file by keyword or upload the local manifest file to the repository, click , refresh the repository file, and select a manifest file. Click .

      kubectl Command Parameters

      kubectl command parameters to be executed.

      If the kubectl Command is set to "patch", the -p and file path will be automatically added in the kubectl Command Parameters. The node, pod, and deployment are provided in the patch command.

      Take the deployment type as an example. To modify the deployment type, enter deployment deployment-test in Kubectl Command Parameters. The deployment is the kind, and the deployment-test is the name of the kind.

      Action Control

      Continue the task even if this action fails.