script type

Points to a script file (typically a Bash script) to be run during customization.

Scripts are run within the chroot of the target OS. The working directory is set to the target OS’s root directory (/).

When a script is running, there is a bind mount to the config file’s parent directory mounted at /_imageconfigs within the target OS. This can be used to both access resources on the build host in the scripts, and to output information (by writing files) to the build host during customization.

WARNING: Custom scripts are not considered to be on security boundary. Only use config files that you trust (or run image customizer in a security sandbox).

Added in v0.3.

path [string]

The path of the script.

This must be in the same directory or a sub-directory that the config file is located in.

Only one of path or content may be specified.

Example:

scripts:
  postCustomization:
  - path: scripts/a.sh

Added in v0.3.

content [string]

The contents of the script to run.

The script is written to a temporary file under the customized OS’s /tmp directory.

Only one of path or content may be specified.

Example:

scripts:
  postCustomization:
  - content: |
      echo "Hello, World"

Added in v0.3.

interpreter [string]

The program to run the script with.

If not specified, then the script is run by /bin/sh.

Example:

scripts:
  postCustomization:
  - content: |
      print("Hello, World")
    interpreter: python3

Added in v0.3.

arguments [string[]]

Additional arguments to pass to the script.

Example:

scripts:
  postCustomization:
  - path: scripts/a.sh
    arguments:
    - abc

Added in v0.3.

environmentVariables [map<string, string>]

Additional environment variables to set on the program.

Example:

scripts:
  postCustomization:
  - content: |
      echo "$a $b"
    environmentVariables:
      a: hello
      b: world

Added in v0.3.

name [string]

The name of the script.

This field is only used to refer to the script in the logs. It is particularly useful when content is used.

Example:

scripts:
  postCustomization:
  - content: |
      echo "Hello, World"
    name: greetings

Added in v0.3.