diff options
| author | Douwe Maan <douwe@gitlab.com> | 2017-11-13 09:44:05 +0000 |
|---|---|---|
| committer | Douwe Maan <douwe@gitlab.com> | 2017-11-13 09:44:05 +0000 |
| commit | 95661d7b6220d6b0608f2582b3a89b5b743c1b0e (patch) | |
| tree | 68931f9973a6b156df3a2d0ea27e84edc936c2d5 | |
| parent | 00a212de2bd1dd430a18ea9813a5982b72f8b78e (diff) | |
| parent | 01e717e7bab7a09730003c570d0d366773faa59a (diff) | |
| download | gitlab-ce-95661d7b6220d6b0608f2582b3a89b5b743c1b0e.tar.gz | |
Merge branch 'update-services-api-docs-for-kubernetes' into 'master'
Update Services API documentation for Kubernetes service
See merge request gitlab-org/gitlab-ce!15343
| -rw-r--r-- | doc/api/services.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/api/services.md b/doc/api/services.md index 08a2bee1518..08df26db3ec 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -490,6 +490,41 @@ Remove all previously JIRA settings from a project. DELETE /projects/:id/services/jira ``` +## Kubernetes + +Kubernetes / Openshift integration + +### Create/Edit Kubernetes service + +Set Kubernetes service for a project. + +``` +PUT /projects/:id/services/kubernetes +``` + +Parameters: + +- `namespace` (**required**) - The Kubernetes namespace to use +- `api_url` (**required**) - The URL to the Kubernetes cluster API, e.g., https://kubernetes.example.com +- `token` (**required**) - The service token to authenticate against the Kubernetes cluster with +- `ca_pem` (optional) - A custom certificate authority bundle to verify the Kubernetes cluster with (PEM format) + +### Delete Kubernetes service + +Delete Kubernetes service for a project. + +``` +DELETE /projects/:id/services/kubernetes +``` + +### Get Kubernetes service settings + +Get Kubernetes service settings for a project. + +``` +GET /projects/:id/services/kubernetes +``` + ## Slack slash commands Ability to receive slash commands from a Slack chat instance. |