--- reviewers: - bprashanth - liggitt - thockin title: Configure Service Accounts for Pods content_template: templates/task weight: 90 --- {{% capture overview %}} A service account provides an identity for processes that run in a Pod. *This is a user introduction to Service Accounts. See also the [Cluster Admin Guide to Service Accounts](/docs/reference/access-authn-authz/service-accounts-admin/).* {{< note >}} This document describes how service accounts behave in a cluster set up as recommended by the Kubernetes project. Your cluster administrator may have customized the behavior in your cluster, in which case this documentation may not apply. {{< /note >}} When you (a human) access the cluster (for example, using `kubectl`), you are authenticated by the apiserver as a particular User Account (currently this is usually `admin`, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, `default`). {{% /capture %}} {{% capture prerequisites %}} {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} {{% /capture %}} {{% capture steps %}} ## Use the Default Service Account to access the API server. When you create a pod, if you do not specify a service account, it is automatically assigned the `default` service account in the same namespace. If you get the raw json or yaml for a pod you have created (for example, `kubectl get pods/ -o yaml`), you can see the `spec.serviceAccountName` field has been [automatically set](/docs/user-guide/working-with-resources/#resources-are-automatically-modified). You can access the API from inside a pod using automatically mounted service account credentials, as described in [Accessing the Cluster](/docs/user-guide/accessing-the-cluster/#accessing-the-api-from-a-pod). The API permissions of the service account depend on the [authorization plugin and policy](/docs/reference/access-authn-authz/authorization/#authorization-modules) in use. In version 1.6+, you can opt out of automounting API credentials for a service account by setting `automountServiceAccountToken: false` on the service account: ```yaml apiVersion: v1 kind: ServiceAccount metadata: name: build-robot automountServiceAccountToken: false ... ``` In version 1.6+, you can also opt out of automounting API credentials for a particular pod: ```yaml apiVersion: v1 kind: Pod metadata: name: my-pod spec: serviceAccountName: build-robot automountServiceAccountToken: false ... ``` The pod spec takes precedence over the service account if both specify a `automountServiceAccountToken` value. ## Use Multiple Service Accounts. Every namespace has a default service account resource called `default`. You can list this and any other serviceAccount resources in the namespace with this command: ```shell kubectl get serviceAccounts ``` The output is similar to this: ``` NAME SECRETS AGE default 1 1d ``` You can create additional ServiceAccount objects like this: ```shell kubectl apply -f - < Annotations: kubernetes.io/service-account.name=build-robot kubernetes.io/service-account.uid=da68f9c6-9d26-11e7-b84e-002dc52800da Type: kubernetes.io/service-account-token Data ==== ca.crt: 1338 bytes namespace: 7 bytes token: ... ``` {{< note >}} The content of `token` is elided here. {{< /note >}} ## Add ImagePullSecrets to a service account First, create an imagePullSecret, as described [here](/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod). Next, verify it has been created. For example: ```shell kubectl get secrets myregistrykey ``` The output is similar to this: ``` NAME TYPE DATA AGE myregistrykey   kubernetes.io/.dockerconfigjson   1       1d ``` Next, modify the default service account for the namespace to use this secret as an imagePullSecret. ```shell kubectl patch serviceaccount default -p '{"imagePullSecrets": [{"name": "myregistrykey"}]}' ``` Interactive version requires manual edit: ```shell kubectl get serviceaccounts default -o yaml > ./sa.yaml ``` The output of the `sa.yaml` file is similar to this: ```shell apiVersion: v1 kind: ServiceAccount metadata: creationTimestamp: 2015-08-07T22:02:39Z name: default namespace: default resourceVersion: "243024" selfLink: /api/v1/namespaces/default/serviceaccounts/default uid: 052fb0f4-3d50-11e5-b066-42010af0d7b6 secrets: - name: default-token-uudge ``` Using your editor of choice (for example `vi`), open the `sa.yaml` file, delete line with key `resourceVersion`, add lines with `imagePullSecrets:` and save. The output of the `sa.yaml` file is similar to this: ```shell apiVersion: v1 kind: ServiceAccount metadata: creationTimestamp: 2015-08-07T22:02:39Z name: default namespace: default selfLink: /api/v1/namespaces/default/serviceaccounts/default uid: 052fb0f4-3d50-11e5-b066-42010af0d7b6 secrets: - name: default-token-uudge imagePullSecrets: - name: myregistrykey ``` Finally replace the serviceaccount with the new updated `sa.yaml` file ```shell kubectl replace serviceaccount default -f ./sa.yaml ``` Now, any new pods created in the current namespace will have this added to their spec: ```yaml spec: imagePullSecrets: - name: myregistrykey ``` ## Service Account Token Volume Projection {{< feature-state for_k8s_version="v1.12" state="beta" >}} {{< note >}} This ServiceAccountTokenVolumeProjection is __beta__ in 1.12 and enabled by passing all of the following flags to the API server: * `--service-account-issuer` * `--service-account-signing-key-file` * `--service-account-api-audiences` {{< /note >}} The kubelet can also project a service account token into a Pod. You can specify desired properties of the token, such as the audience and the validity duration. These properties are not configurable on the default service account token. The service account token will also become invalid against the API when the Pod or the ServiceAccount is deleted. This behavior is configured on a PodSpec using a ProjectedVolume type called [ServiceAccountToken](/docs/concepts/storage/volumes/#projected). To provide a pod with a token with an audience of "vault" and a validity duration of two hours, you would configure the following in your PodSpec: {{< codenew file="pods/pod-projected-svc-token.yaml" >}} Create the Pod: ```shell kubectl create -f https://k8s.io/examples/pods/pod-projected-svc-token.yaml ``` The kubelet will request and store the token on behalf of the pod, make the token available to the pod at a configurable file path, and refresh the token as it approaches expiration. Kubelet proactively rotates the token if it is older than 80% of its total TTL, or if the token is older than 24 hours. The application is responsible for reloading the token when it rotates. Periodic reloading (e.g. once every 5 minutes) is sufficient for most usecases. {{% /capture %}}