This version is under construction, please use an official release version

Using Service Accounts

This document describes how to use a Service Accounts in Kubermatic Kubernetes Platform (KKP). The main Service Account concept you can find here .

Managing Service Accounts and Tokens

A service account is a special type of user account that belongs to the KKP project. Once you decide that you need a service account, you can add one in Kubermatic dashboard.

Service Account

Users can create many Service Accounts (SA) with unique names in the project scope.

Create Service Account

Over time, as you create more and more SA, you might lose track of which SA is used for what purpose. The display name of a SA is a good way to capture additional information about the service account, such as the purpose of the SA.

The service account can have multiple tokens with unique names. The service account token is visible to the user during creation.

Create Service Account

Note: Make sure to save this token at a safe place on your own device. It cannot be displayed again after closing the dashboard window.

Users can manage tokens. At any time, you can revoke any personal access token by clicking the respective Regenerate Service Account Token button under the Token area. You can also change a token name. It is possible to delete a service account token and then create a new with the same name.

Manage Service Account

You can see when a token was created and when will expire.

Using service accounts with KKP

You can control service account access in your project by provided groups. There are three basic access level groups:

  • viewers
  • editors
  • project managers

Viewers

A viewer can:

  • list projects
  • get project details
  • get project SSH keys
  • list clusters
  • get cluster details
  • get cluster resources details

Permissions for read-only actions that do not affect state, such as viewing.

  • viewers are not allowed to interact with service accounts (User)
  • viewers are not allowed to interact with members of a project (UserProjectBinding)

Editors

All viewer permissions, plus permissions to create, edit & delete cluster

  • editors are not allowed to delete a project
  • editors are not allowed to interact with members of a project (UserProjectBinding)
  • editors are not allowed to interact with service accounts (User)

Project managers

The project managers is service account specific group. Which allows

  • create, edit & delete projects
  • manage members in project (UserProjectBinding)
  • mange service accounts

Project managers are not allowed to interact with clusters.

Accessing API via Service Account Token

A client that wants to authenticate itself with a server can then do so by including an Authorization request header field with the service account token:

For getting project cluster list you can use:

GET http://localhost:8080/api/v2/projects/jnpllgp66z/clusters
Accept: application/json
Authorization: Bearer aaa.bbb.ccc

You can also use curl command to reach API endpoint:

curl -i -H "Accept: application/json" -H "Authorization: Bearer aaa.bbb.ccc" -X GET http://localhost:8080/api/v2/projects/jnpllgp66z/clusters