support setting pipeline env vars from the config

This allows one to specify:

```
env:
  VAR: value
```

In the config. The VAR=value will then be set in the pod created
by k8s/OpenShift AND in any multi-arch builder remote sessions.
IOW the env var/value should be available anywhere a COSA command
will be run.

Since this solution is more generic we'll drop the use_osbuild
pipeline knob here too in favor of `env: COSA_USE_OSBUILD: true`.

Author: dustymabe

docs/config.yaml

@@ -99,14 +99,20 @@ streams:
       skip_cloud_uploads: true
       # OPTIONAL: dont perform Brew uploads
       skip_brew_upload: true
-      # Use newly added support for building images using OSBuild
-      use_osbuild: true
+      # Set the COSA_USE_OSBUILD environment variable to force use of OSBuild
+      # for image building.
+      env:
+        COSA_USE_OSBUILD: true
       # OPTIONAL: require kernel + kernel-rt versions to match
       check_kernel_rt_mismatch_rhcos: true
 
 # REQUIRED: architectures to build for other than x86_64
 additional_arches: [aarch64, ppc64le, s390x]
 
+# OPTIONAL: environment variables to set inside the COSA container
+env:
+  VAR: value
+
 # OPTIONAL: S3 bucket and key to which to upload build artifacts. For reference,
 # the builds.json file will be located at
 # `${s3.bucket}/${s3.builds_key}/builds/builds.json`.

jobs/build-arch.Jenkinsfile

@@ -76,8 +76,8 @@ def stream_info = pipecfg.streams[params.STREAM]
 
 def cosa_controller_img = stream_info.cosa_controller_img_hack ?: cosa_img
 
-// Determine if we should use osbuild for image building
-def use_osbuild = pipeutils.get_use_osbuild_for_stream(pipecfg, params.STREAM)
+// Grab any environment variables we should set
+def container_env = pipeutils.get_env_vars_for_stream(pipecfg, params.STREAM)
 
 // If we are a mechanical stream then we can pin packages but we
 // don't maintain complete lockfiles so we can't build in strict mode.
@@ -113,6 +113,7 @@ lock(resource: "build-${params.STREAM}-${basearch}") {
     cosaPod(cpu: "${ncpus}",
             memory: "${cosa_memory_request_mb}Mi",
             image: cosa_controller_img,
+            env: container_env,
             serviceAccount: "jenkins") {
     timeout(time: timeout_mins, unit: 'MINUTES') {
     try {
@@ -142,6 +143,7 @@ lock(resource: "build-${params.STREAM}-${basearch}") {
         // performs garbage collection on the remote if we fail to clean up.
         pipeutils.withPodmanRemoteArchBuilder(arch: basearch) {
         def session = pipeutils.createCosaRemoteSession(
+            env: container_env,
             expiration: "${timeout_mins}m",
             image: cosa_img,
             workdir: WORKSPACE,
@@ -287,7 +289,7 @@ lock(resource: "build-${params.STREAM}-${basearch}") {
 
         // Build QEMU image
         stage("Build QEMU") {
-            shwrap("cosa shell -- env COSA_USE_OSBUILD=${use_osbuild} cosa buildextend-qemu")
+            shwrap("cosa buildextend-qemu")
         }
 
         // This is a temporary hack to help debug https://github.com/coreos/fedora-coreos-tracker/issues/1108.

jobs/build.Jenkinsfile

@@ -83,8 +83,8 @@ if (params.ADDITIONAL_ARCHES != "none") {
 
 def stream_info = pipecfg.streams[params.STREAM]
 
-// Determine if we should use osbuild for image building
-def use_osbuild = pipeutils.get_use_osbuild_for_stream(pipecfg, params.STREAM)
+// Grab any environment variables we should set
+def container_env = pipeutils.get_env_vars_for_stream(pipecfg, params.STREAM)
 
 // If we are a mechanical stream then we can pin packages but we
 // don't maintain complete lockfiles so we can't build in strict mode.
@@ -153,6 +153,7 @@ lock(resource: "build-${params.STREAM}") {
     cosaPod(cpu: "${ncpus}",
             memory: "${cosa_memory_request_mb}Mi",
             image: cosa_img,
+            env: container_env,
             serviceAccount: "jenkins") {
     timeout(time: timeout_mins, unit: 'MINUTES') {
     try {
@@ -352,7 +353,7 @@ lock(resource: "build-${params.STREAM}") {
 
         // Build QEMU image
         stage("Build QEMU") {
-            shwrap("cosa shell -- env COSA_USE_OSBUILD=${use_osbuild} cosa buildextend-qemu")
+            shwrap("cosa buildextend-qemu")
         }
 
         // This is a temporary hack to help debug https://github.com/coreos/fedora-coreos-tracker/issues/1108.

jobs/bump-lockfile.Jenkinsfile

@@ -45,8 +45,8 @@ def s3_stream_dir = pipeutils.get_s3_streams_dir(pipecfg, params.STREAM)
 
 def stream_info = pipecfg.streams[params.STREAM]
 
-// Determine if we should use osbuild for image building
-def use_osbuild = pipeutils.get_use_osbuild_for_stream(pipecfg, params.STREAM)
+// Grab any environment variables we should set
+def container_env = pipeutils.get_env_vars_for_stream(pipecfg, params.STREAM)
 
 def getLockfileInfo(lockfile) {
     def pkgChecksum, pkgTimestamp
@@ -67,7 +67,7 @@ def ncpus = ((cosa_memory_request_mb - 512) / 1536) as Integer
 def timeout_mins = 240
 
 lock(resource: "bump-lockfile") {
-    cosaPod(image: cosa_img,
+    cosaPod(image: cosa_img, env: container_env,
             cpu: "${ncpus}", memory: "${cosa_memory_request_mb}Mi",
             serviceAccount: "jenkins") {
     timeout(time: timeout_mins, unit: 'MINUTES') {
@@ -111,6 +111,7 @@ lock(resource: "bump-lockfile") {
                 if (arch != "x86_64") {
                     pipeutils.withPodmanRemoteArchBuilder(arch: arch) {
                         archinfo[arch]['session'] = pipeutils.createCosaRemoteSession(
+                            env: container_env,
                             expiration: "${timeout_mins}m",
                             image: cosa_img,
                             workdir: WORKSPACE,

jobs/debug-pod.Jenkinsfile

@@ -42,6 +42,9 @@ cosa_img = cosa_img ?: pipeutils.get_cosa_img(pipecfg, params.STREAM)
 
 def stream_info = pipecfg.streams[params.STREAM]
 
+// Grab any environment variables we should set
+def container_env = pipeutils.get_env_vars_for_stream(pipecfg, params.STREAM)
+
 // We'll just always use latest for the controller image here.
 def cosa_controller_img = "quay.io/coreos-assembler/coreos-assembler:main"
 
@@ -57,6 +60,7 @@ podName += UUID.randomUUID().toString().substring(0, 8)
 cosaPod(cpu: "${ncpus}",
         memory: "${cosa_memory_request_mb}Mi",
         image: cosa_controller_img,
+        env: container_env,
         serviceAccount: "jenkins",
         name : podName) {
     timeout(time: params.TIMEOUT as Integer, unit: 'HOURS') {
@@ -73,6 +77,7 @@ cosaPod(cpu: "${ncpus}",
         // performs garbage collection on the remote if we fail to clean up.
         pipeutils.withPodmanRemoteArchBuilder(arch: params.ARCH) {
         def session = pipeutils.createCosaRemoteSession(
+            env: container_env,
             expiration: "${params.TIMEOUT}h",
             image: cosa_img,
             workdir: WORKSPACE,

utils.groovy

@@ -123,8 +123,18 @@ def get_source_config_ref_for_stream(pipecfg, stream) {
     }
 }
 
-def get_use_osbuild_for_stream(pipecfg, stream) {
-    return pipecfg.streams[stream].use_osbuild ? '1' : ''
+def get_env_vars_for_stream(pipecfg, stream) {
+    def x = [:]
+    // Grab the globally configured env vars first
+    if (pipecfg.env) {
+        x.putAll(pipecfg.env)
+    }
+    // Values in stream specific env vars override
+    // the global ones.
+    if (pipecfg.streams[stream].env) {
+        x.putAll(pipecfg.streams[stream].env)
+    }
+    return x
 }
 
 // Parse and handle the result of Kola
@@ -221,6 +231,7 @@ def bump_builds_json(stream, buildid, arch, s3_stream_dir, acl) {
 // build on a different architecture.
 //
 // Available parameters:
+//    env: (optional) map of key/val pairs of environment variables to set
 //    expiration: string that represents a golang duration for how
 //                long the container should last (i.e. 4h, 30m)
 //    image: string that represents the container image to pull
@@ -229,9 +240,13 @@ def createCosaRemoteSession(params = [:]) {
     def expiration = params['expiration']
     def image = params['image']
     def workdir = params['workdir']
+    def envArgs = []
+    if (params['env']) {
+        envArgs = params['env'].collect { k, v -> "--env ${k}=${v}" }
+    }
     def session = shwrapCapture("""
     cosa remote-session create --image ${image} \
-        --expiration ${expiration} --workdir ${workdir}
+        ${envArgs.join(" ")} --expiration ${expiration} --workdir ${workdir}
     """)
     return session
 }