Configure RunAsUserName for Windows pods and containers
Kubernetes Docs · نسخهٔ f284a9e7c87f · CC BY 4.0 برای مستندات و مجوزهای همراه
<!-- overview -->
{{< feature-state for_k8s_version="v1.18" state="stable" >}}
This page shows how to use the runAsUserName setting for Pods and containers that will run on Windows nodes. This is roughly equivalent of the Linux-specific runAsUser setting, allowing you to run applications in a container as a different username than the default.
{{% heading "prerequisites" %}}
You need to have a Kubernetes cluster and the kubectl command-line tool must be configured to communicate with your cluster. The cluster is expected to have Windows worker nodes where pods with containers running Windows workloads will get scheduled.
<!-- steps -->
Set the Username for a Pod
To specify the username with which to execute the Pod's container processes, include the securityContext field ([PodSecurityContext](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#podsecuritycontext-v1-core)) in the Pod specification, and within it, the windowsOptions ([WindowsSecurityContextOptions](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#windowssecuritycontextoptions-v1-core)) field containing the runAsUserName field.
The Windows security context options that you specify for a Pod apply to all Containers and init Containers in the Pod.
Here is a configuration file for a Windows Pod that has the runAsUserName field set:
{{% code_sample file="windows/run-as-username-pod.yaml" %}}
Create the Pod:
kubectl apply -f https://k8s.io/examples/windows/run-as-username-pod.yamlVerify that the Pod's Container is running:
kubectl get pod run-as-username-pod-demoGet a shell to the running Container:
kubectl exec -it run-as-username-pod-demo -- powershellCheck that the shell is running user the correct username:
echo $env:USERNAMEThe output should be:
ContainerUserSet the Username for a Container
To specify the username with which to execute a Container's processes, include the securityContext field ([SecurityContext](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#securitycontext-v1-core)) in the Container manifest, and within it, the windowsOptions ([WindowsSecurityContextOptions](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#windowssecuritycontextoptions-v1-core)) field containing the runAsUserName field.
The Windows security context options that you specify for a Container apply only to that individual Container, and they override the settings made at the Pod level.
Here is the configuration file for a Pod that has one Container, and the runAsUserName field is set at the Pod level and the Container level:
{{% code_sample file="windows/run-as-username-container.yaml" %}}
Create the Pod:
kubectl apply -f https://k8s.io/examples/windows/run-as-username-container.yamlVerify that the Pod's Container is running:
kubectl get pod run-as-username-container-demoGet a shell to the running Container:
kubectl exec -it run-as-username-container-demo -- powershellCheck that the shell is running user the correct username (the one set at the Container level):
echo $env:USERNAMEThe output should be:
ContainerAdministratorWindows Username limitations
In order to use this feature, the value set in the runAsUserName field must be a valid username. It must have the following format: DOMAIN\USER, where DOMAIN\ is optional. Windows user names are case insensitive. Additionally, there are some restrictions regarding the DOMAIN and USER:
- The
runAsUserNamefield cannot be empty, and it cannot contain control characters (ASCII values:0x00-0x1F,0x7F) - The
DOMAINmust be either a NetBios name, or a DNS name, each with their own restrictions: - NetBios names: maximum 15 characters, cannot start with
.(dot), and cannot contain the following characters:\ / : * ? " < > | - DNS names: maximum 255 characters, contains only alphanumeric characters, dots, and dashes, and it cannot start or end with a
.(dot) or-(dash). - The
USERmust have at most 20 characters, it cannot contain *only* dots or spaces, and it cannot contain the following characters:" / \ [ ] : ; | = , + * ? < > @.
Examples of acceptable values for the runAsUserName field: ContainerAdministrator, ContainerUser, NT AUTHORITY\NETWORK SERVICE, NT AUTHORITY\LOCAL SERVICE.
For more information about these limitations, check here and here.
{{% heading "whatsnext" %}}
- Guide for scheduling Windows containers in Kubernetes
- Managing Workload Identity with Group Managed Service Accounts (GMSA)
- Configure GMSA for Windows pods and containers