Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-09-14 21:09:48 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-09-14 21:09:48 +0300
commita8caa9ce4922947ba057f259bccd017c2177e1b5 (patch)
treec2d3e86b3c0336630edc7604ea575ca605fd1dd0 /doc/development/internal_api.md
parenta483e9271bccdd2cb98cb4f3874fff5d3264d07d (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/internal_api.md')
-rw-r--r--doc/development/internal_api.md22
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md
index bfd1b838e72..4b46787c2c3 100644
--- a/doc/development/internal_api.md
+++ b/doc/development/internal_api.md
@@ -371,7 +371,23 @@ Example response:
}
```
-## Kubernetes agent information
+## Kubernetes agent endpoints
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/41045) in GitLab 13.4.
+> - This feature is not deployed on GitLab.com
+> - It's not recommended for production use.
+
+The following endpoints are used by the GitLab Kubernetes Agent Server (kas)
+for various purposes.
+
+These endpoints are all authenticated using JWT. The JWT secret is stored in a file
+specified in `config/gitlab.yml`. By default, the location is in the root of the
+GitLab Rails app in a file called `.gitlab_kas_secret`.
+
+CAUTION: **Caution:**
+The Kubernetes agent is under development and is not recommended for production use.
+
+### Kubernetes agent information
Called from GitLab Kubernetes Agent Server (kas) to retrieve agent
information for the given agent token. This returns the Gitaly connection
@@ -388,7 +404,7 @@ Example Request:
curl --request GET --header "Gitlab-Kas-Api-Request: <JWT token>" --header "Authorization: Bearer <agent token>" "http://localhost:3000/api/v4/internal/kubernetes/agent_info"
```
-## Kubernetes agent project information
+### Kubernetes agent project information
Called from GitLab Kubernetes Agent Server (kas) to retrieve project
information for the given agent token. This returns the Gitaly
@@ -413,7 +429,7 @@ Example Request:
curl --request GET --header "Gitlab-Kas-Api-Request: <JWT token>" --header "Authorization: Bearer <agent token>" "http://localhost:3000/api/v4/internal/kubernetes/project_info?id=7"
```
-## Kubernetes agent usage metrics
+### Kubernetes agent usage metrics
Called from GitLab Kubernetes Agent Server (kas) to increase the usage
metric counters.