Skip to content

Commit

Permalink
docs: Replace EDP with KubeRocketCI in README md (#268)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleksandr123234 authored and MykolaMarusenko committed Aug 23, 2024
1 parent a7e58e5 commit 9ff4ca9
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@
<!-- TOC -->

- [KubeRocketCI Tekton](#kuberocketci-tekton)
- [EDP Interceptor](#edp-interceptor)
- [KubeRocketCI Interceptor](#edp-interceptor)
- [Tekton Pipelines](#tekton-pipelines)

<!-- /TOC -->

The edp-tekton repository consolidates elements for Tekton integration with [KubeRocketCI](https://docs.kuberocketci.io) (former EPAM Delivery Platform (EDP)).
and disposes of two main components:

- **EDP Interceptor**. Follows [Tekton Interceptor](https://tekton.dev/vault/triggers-main/clusterinterceptors/) paradigm and enriches payload from different Version Control Systems (VCS) like Gerrit, GitHub or GitLab with the platform specific metadata.
- **KubeRocketCI Interceptor**. Follows [Tekton Interceptor](https://tekton.dev/vault/triggers-main/clusterinterceptors/) paradigm and enriches payload from different Version Control Systems (VCS) like Gerrit, GitHub or GitLab with the platform specific metadata.
- **Tekton Pipelines**. Consists of [Tekton Tasks, Pipelines, Triggers](https://tekton.dev/docs/pipelines/) and implements KubeRocketCI Pipelines logic. Some of the tasks are forks from [origin source](https://github.com/tektoncd/catalog), the others are platform specific.

## EDP Interceptor
## KubeRocketCI Interceptor

EDP Interceptor is used as a component that provides KubeRocketCI metadata for Tekton Pipelines. The code is based on [Upstream implementation](https://github.com/tektoncd/triggers/tree/main/pkg/interceptors).
KubeRocketCI Interceptor is used as a component that provides KubeRocketCI metadata for Tekton Pipelines. The code is based on [Upstream implementation](https://github.com/tektoncd/triggers/tree/main/pkg/interceptors).

EDP Interceptor extracts information from VCS payload, like `repository_name`. The `repository_name` has 1-2-1 mapping with the KubeRocketCI `Codebase` (kind: Codebase; apiVersion:v2.edp.epam.com/v1). Interceptor populates Tekton Pipelines with [Codebase SPEC](https://github.com/epam/edp-codebase-operator/blob/master/docs/api.md#codebasespec) data, see the diagram below:
KubeRocketCI Interceptor extracts information from VCS payload, like `repository_name`. The `repository_name` has 1-2-1 mapping with the KubeRocketCI `Codebase` (kind: Codebase; apiVersion:v2.edp.epam.com/v1). Interceptor populates Tekton Pipelines with [Codebase SPEC](https://github.com/epam/edp-codebase-operator/blob/master/docs/api.md#codebasespec) data, see the diagram below:

┌────────────┐ ┌─────────────────┐ ┌─────────────┐
│ │ │ EDP Interceptor │ │ Tekton │
│ VCS(Git) ├──────────────► ├───────► │
│ │ │ │ │ Pipelines │
└──────┬─────┘ └────────┬────────┘ └─────────────┘
┌────────────┐ ┌─────────────────┐ ┌─────────────┐
│ │ │ KubeRocketCI │ │ Tekton │
│ VCS(Git) ├──────────────► ├───────► │
│ │ │ Interceptor │ │ Pipelines │
└──────┬─────┘ └────────┬────────┘ └─────────────┘
│ │
┌──────┴─────┐ │ extract
│ Repo │ │
Expand All @@ -39,7 +39,7 @@ EDP Interceptor extracts information from VCS payload, like `repository_name`. T

The data, retrieved from the Codebase SPEC, is used in Tekton Pipelines logic.
The docker images for Interceptor are available on the [DockerHub](https://hub.docker.com/repository/docker/epamedp/edp-tekton).
The helm-chart for interceptor deployment is in the same repository by the [charts/interceptor](./charts/interceptor) directory.
The helm-chart for interceptor deployment is in the same repository by the [charts/interceptor](./charts/pipelines-library/values.yaml#L146) directory.

## Tekton Pipelines

Expand Down

0 comments on commit 9ff4ca9

Please sign in to comment.