Skip to main content

Add USER instruction

org.openrewrite.docker.AddUserInstruction

Adds a USER instruction to run the container as a non-root user (CIS Docker Benchmark 4.1). By default, adds to the final stage only and skips if a USER instruction already exists.

Recipe source​

GitHub: AddUserInstruction.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringuserNameThe username to run as.appuser
StringgroupNameOptional. The group name. If specified, the USER instruction will be USER user:group.appgroup
StringstageNameOptional. Only add the USER instruction to this build stage. If null, adds to the final stage only.final
BooleanskipIfUserExistsOptional. If true (default), skip adding USER if the stage already has a USER instruction. If false, always add the USER instruction at the end of the stage.

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
userNameappuser
groupNamenull
stageNamenull
skipIfUserExistsnull
Before​
FROM ubuntu:22.04
RUN apt-get update
After​
FROM ubuntu:22.04
RUN apt-get update
USER appuser

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddUserInstructionExample
displayName: Add `USER` instruction example
recipeList:
  - org.openrewrite.docker.AddUserInstruction:
      userName: appuser
      groupName: appgroup
      stageName: final

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe AddUserInstruction --recipe-option "userName=appuser" --recipe-option "groupName=appgroup" --recipe-option "stageName=final"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-docker:8.73.2

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.