An endpoint is an instance of a DevOps application that connects to Code Stream and provides data for your pipelines to run, such as a data source, repository, or notification system.
Your role in Code Stream determines how you use endpoints.
- Administrators and developers can create, update, delete, and view endpoints.
- Administrators can mark an endpoint as restricted, and run pipelines that use restricted endpoints.
- Users who have the viewer role can see endpoints, but cannot create, update, or delete them.
For more information, see How do I manage user access and approvals in Code Stream.
To connect Code Stream to an endpoint, follow these steps.
- Add a task in your pipeline
- Configure the task so that it communicates with the endpoint.
- Verify that Code Stream can connect to the endpoint by clicking Validate.
- Then, when you run the pipeline, the task connects to the endpoint so that it can run the task.
For information about the task types that use these endpoints, see What types of tasks are available in Code Stream.
| Endpoint | What it provides | Versions supported | Requirements |
|---|---|---|---|
| Bamboo | Creates build plans. | 6.9.* | |
| Docker | Native builds can use Docker hosts for deployment. | When a pipeline includes an image from Docker Hub, you must ensure that the image has cURL or wget embedded before you run the pipeline. When the pipeline runs, Code Stream downloads a binary file that uses cURL or wget to run commands. |
|
| Docker Registry | Registers container images so that a Docker build host can pull images. | 2.7.1 | |
| Gerrit | Connects to a Gerrit server for reviews and trigger | 2.14.* | |
| Git | Triggers pipelines when developers update code and check it in to the repository. | Git Hub Enterprise 2.1.8 Git Lab Enterprise 11.9.12-ee |
|
| Jenkins | Builds code artifacts. | 1.6.* and 2.* | |
| Jira | Creates a Jira ticket when a pipeline task fails. | 8.3.* | |
| Kubernetes | Automates the steps that deploy, scale, and manage containerized applications. | All versions supported for Cloud Assembly 8.4 and later 1.18 for Cloud Assembly 8.3 and prior |
When using a Kubernetes API endpoint in the pipeline workspace, Code Stream creates the necessary Kubernetes resources such as ConfigMap, Secret, and Pod to run the continuous integration (CI) task or custom task. Code Stream communicates with the container by using the NodePort. For more information about configuring the workspace, see Configuring the Pipeline Workspace. |
| PowerShell | Create tasks that run PowerShell scripts on Windows or Linux machines. | 4 and 5 | |
| SSH | Create tasks that run SSH scripts on Windows or Linux machines. | 7.0 | |
| TFS, Team Foundation Server | Manages source code, automated builds, testing, and related activities. | 2015 and 2017 | |
| vRealize Orchestrator | Arranges and automates the workflows in your build process. | 7.* and 8.* |
Example YAML code for a GitHub endpoint
This example YAML code defines a GitHub endpoint that you can refer to in a Git task.
--- name: github-k8s tags: [ ] kind: ENDPOINT properties: serverType: GitHub repoURL: https://github.com/autouser/testrepok8s branch: master userName: autouser password: encryptedpassword privateToken: '' description: '' type: scm:git isLocked: false ---
