How to pass docker container arguments when running the image in a Jenkinsfile

Question

I have a Dockerfile that ends with

ENTRYPOINT ["node", "index.js"]
CMD ["--help"]

The index.js can take a couple different arguments and I also need to expose a port for the container so if I run it manually I do something like:

docker run -p 3000:3000 my_container:latest --arg1 somearg --arg2 anotherarg

How do I do this in a Jenkinsfile? My test will communicate with this container so it needs to be running before I run the test. I use withRun() get it running before the test runs but I don't see how to specify the --arg1 somearg --arg2 anotherarg

stage('TestMicroservice') {
    //
    // HOW DO I SPECIFY '--arg1 somearg --arg2 anotherarg'?
    //
    docker.image("my_container:latest").withRun('-p 3000:3000') {
        sh 'npm run test-microservice'
    }
}

Tarun Lalwani · Accepted Answer · 2017-09-13 22:34:37Z

22

You can use the second argument of withRun

.withRun('-p 3000:3000', '--arg1 somearg --arg2 anotherarg')

answered Sep 13, 2017 at 22:34

Tarun Lalwani

147k11 gold badges217 silver badges278 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Sean Lynch Over a year ago

Perfect!!! I looked around for a long time trying to find a proper reference for this command and others. Do you know where I'd find that? How did you know about the second argument for withRun()?

Tarun Lalwani Over a year ago

I looked it up in issues issues.jenkins-ci.org/browse/JENKINS-33063

Sean Lynch Over a year ago

Maybe they should put the documentation in a more straight forward location.. Just sayin

seenickcode Over a year ago

There's like no documentation on this. Anyone find any?

Sheshtawy · Accepted Answer · 2018-11-29 13:36:40Z

5

Use .withRun('-p 3000:3000', '--arg1 arg1 --arg2 arg2'). The documentation for this is in the docker-workflow-plugin here.

answered Nov 29, 2018 at 13:36

Sheshtawy

511 silver badge2 bronze badges

1 Comment

seanf Over a year ago

I think the plugin docs are here now: docs.cloudbees.com/docs/admin-resources/latest/plugins/…

Moses · Accepted Answer · 2019-01-24 09:59:17Z

3

Another way you pass container arguments is by using the inside method. Below is an example taken from https://jenkins.io/doc/book/pipeline/docker/#caching-data-for-containers (click on the Toggle Scripted Pipeline link to view it)

node {
    /* Requires the Docker Pipeline plugin to be installed */
    docker.image('maven:3-alpine').inside('-v $HOME/.m2:/root/.m2') {
        stage('Build') {
            sh 'mvn -B'
        }
    }
}

answered Jan 24, 2019 at 9:59

Moses

7311 gold badge6 silver badges22 bronze badges

1 Comment

C.J. Over a year ago

Now how to do this using the declarative syntax?

Seba Vasile · Accepted Answer · 2020-07-23 11:57:31Z

1

I leave this post because it was asked in a comment above: The documentation for Docker Pipeline plugin can be accessed like this:

Go to any Pipeline Job, and on the bottom click on the link [Pipeline Syntax]
One the left menu choose Global variable Reference. The plugin has the docker variable (with supported methods)

answered Jul 23, 2020 at 11:57

Seba Vasile

191 bronze badge

Collectives™ on Stack Overflow

How to pass docker container arguments when running the image in a Jenkinsfile

4 Answers 4

4 Comments

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

4 Comments

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related