Documentation: when jenkins job is executed in a container

[sdarwin]

Describe your use-case which is not covered by existing documentation.

Imagine a Jenkins pipeline job that begins this way:

pipeline {
    agent {
        docker {
          image 'ubuntu:24.04'
          }
    stages {
        stage('Preclean Workspace') {
             // etc
    }

In other words, it is executing inside a docker container. That is common enough, right? We are always using customized containers for Jenkins jobs.

What's the issue...

There is no mention of "docker", "container", "containers" in the docs.
Correct me if this is wrong.

And... there is something peculiar about s3Upload and likely the other plugin commands. s3Upload sees the filesystem from the perspective of the Jenkins host's "real filesystem", and not the "container", even though the job was supposed to be running inside a container.

Usually that might not be important. But in the situations where it is relevant, then it matters. Perhaps the workspace folder is the same. It was mounted. But otherwise, the files in the container are often different from the files on the host.

SOLUTION:

Mention in the docs: "container" "docker" "The files in the container are often quite different from the files on the host. You are supposedly running a Jenkins job inside a container. s3upload sees the files as they exist on the Jenkins host, and not what is in the container. They may overlap in exactly the workspace folder, but not elsewhere. This is something to be aware of, if you copy files outside the workspace folder, or need to access files from elsewhere. s3upload's 'view of the world' will be the Jenkins host's view, and not the container where the job was executed."

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Are you interested in contributing to the documentation?

No response