Creating Service Endpoints

Scenario

A service endpoint is an extension of CodeArts. It enables CodeArts to connect to third-party services.

For example, when your CodeArts tasks need to obtain project source code from a third-party GitHub repository or need to run with Jenkins, you can create an endpoint to connect to each service.

The following table lists the endpoints supported by CodeArts.

**Table 1** Service endpoints
Type	Scenario
Docker repository	Connect to a third-party Docker image repository. After the connection is successful, CodeArts Deploy can obtain Docker images from the repository.
Kubernetes	Connect to a Kubernetes cluster. After the connection is successful, you can deploy applications to the relevant Kubernetes cluster.
IAM user	Delegate your AK/SK to an IAM user so that the user can obtain a token to perform tasks that require higher permissions.

Prerequisites

You must have the DevMarket > Endpoint > create permission to create service endpoints. For details, see
The third-party service to connect can be accessed from the public network without restrictions.

Creating a Service Endpoint

Go to the CodeArts homepage.

Log in to the CodeArts console, and click Access Service.
Click the target project name to go to the project.
In the navigation pane, choose Settings > General > Service Endpoints.
Click Create Endpoint and select an endpoint type from the drop-down list.
In the displayed dialog box, configure the service endpoint.

The new endpoint is displayed.

The tables below describe the parameters for configuring different types of service endpoints.

Docker Repository

**Table 2** Creating a Docker repository service endpoint
Parameter	Description
Service Endpoint Name	The name of the service endpoint. Enter a maximum of 256 characters. Letters, digits, hyphens (-), underscores (_), periods (.), and spaces are supported.
Repository Address	The address of the Docker repository to connect. HTTP and HTTPS addresses are supported.
Username	The username of this Docker repository.
Password	The password of this Docker repository.

Kubernetes

**Table 3** Creating a Kubernetes service endpoint
Parameter	Description
Service Endpoint Name	The name of the service endpoint. Enter a maximum of 256 characters. Letters, digits, hyphens (-), underscores (_), periods (.), and spaces are supported.
Kubernetes URL	The server address of the cluster to connect. Obtain it by searching for server in the cluster configuration file kubeconfig.json.
Kubeconfig	The configuration of this cluster. You can enter all the content of the kubeconfig.json file.

IAM User

**Table 4** Creating an IAM user service endpoint
Parameter	Description
Service Endpoint Name	The name of the service endpoint. Enter a maximum of 256 characters. Letters, digits, hyphens (-), underscores (_), periods (.), and spaces are supported.
Access Key Id	The AK of the IAM user to connect. Obtain it from the My Credentials page. For details, see Access Keys.
Secret Access Key	The SK of the IAM user to connect. Obtain it from the My Credentials page. For details, see Access Keys.

Managing a Service Endpoint

Go to the CodeArts homepage.

Log in to the CodeArts console, and click Access Service.
Click the target project name to go to the project.
In the navigation pane, choose Settings > General > Service Endpoints.

Locate the service endpoint you want to manage, and perform the operations listed in the table below as needed.

**Table 5** Managing a service endpoint
Operation	Description
Edit	Click Edit. In the displayed dialog box, edit the parameters and click Save. The modified information is displayed.
Delete	WARNING: The deletion cannot be undone. Exercise caution when performing this operation. Click Delete. In the displayed dialog box, click OK. The deleted service endpoint is no longer displayed in the list.