diff options
| author | Athar Hameed <atharh@gmail.com> | 2017-11-13 09:42:31 +0300 |
|---|---|---|
| committer | Athar Hameed <atharh@gmail.com> | 2017-11-13 09:42:31 +0300 |
| commit | 01e717e7bab7a09730003c570d0d366773faa59a (patch) | |
| tree | 9b3ab7bb13cfc988036e04f67f75e35ab4801484 /doc | |
| parent | c6a48f3f92ce4b9a7e15f6e7e4845612233ae7e5 (diff) | |
Update Services API documentation for Kubernetes service
Diffstat (limited to 'doc')
| -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. |