Skip to content

Commit aac73b2

Browse files
committed
update unpack-api README
1 parent 31c91e8 commit aac73b2

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

unpack-api/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# Unpack API
22

3+
> **NOTE**
4+
>
5+
> This API works with both GitLab CI/CD Pipelines, and GitHub Actions workflows.
6+
> To keeps things simple, I'll refer to both simultaneously as a **workflow** in this document.
7+
38
This repository authenticates and forwards requests to unpack images into a CVMFS repository.
49

5-
This API accepts the name of an image to unpack along with a GitLab JWT token.
6-
This server then forwards that image, along with a pipeline trigger token, to another GitLab CI that performs the unpacking of the image into CVMFS.
10+
This API accepts the name of an image to unpack along with a workflow JWT token.
11+
This server then forwards that image, along with a pipeline trigger token, to another workflow that performs the unpacking of the image into CVMFS.
712

8-
1. Client sends request to this API from within a GitLab CI.
9-
1. This API authenticates the Client (ensures the pipeline was ran from within a specific GitLab instance).
10-
1. This API sends a request to a different GitLab CI to unpack the image.
13+
1. Client sends request to this API from within a workflow.
14+
1. This API authenticates the Client (ensures the pipeline was ran from within a specific GitLab/GitHub instance).
15+
1. This API sends a request to a different workflow to unpack the image.
1116

1217
## Install
1318

0 commit comments

Comments
 (0)