Build Dataproc custom images

This page describes how to generate a custom Dataproc image.

Note that custom image will expire in 60 days.

Requirements

Python 2.7+.
gcloud >= 181.0.0 (2017-11-30)
- gcloud beta components is required. Use gcloud components install beta or sudo apt-get install google-cloud-sdk.
A GCE project with billing, Google Cloud Dataproc API, Google Compute Engine API, and Google Cloud Storage APIs enabled.
Use gcloud config set project <your-project> to specify which project to use to create and save your custom image.
(Optional) Daisy, from GoogleCloudPlatform/compute-image-tools
- Please make sure the daisy binary have execution permission: chmod +x daisy.

Generate custom image

To generate a custom image, you can run the following command:

python generate_custom_image.py \
    --image-name <new_custom_image_name> \
    --dataproc-version <Dataproc version> \
    --customization-script <custom script to install custom packages> \
    --zone <zone to create instance to build custom image> \
    --gcs-bucket <gcs bucket to write logs>

For backwards compatiblity, you can also use the deprecated Daisy workflow to generate the image by specifying the --daisy-path flag:

python generate_custom_image.py \
    --image-name <new_custom_image_name> \
    --dataproc-version <Dataproc version> \
    --customization-script <custom script to install custom packages> \
    --daisy-path <path to local daisy binary> \
    --zone <zone to create instance to build custom image> \
    --gcs-bucket <gcs bucket to write logs>

Arguments

--image-name: The name for custom image.
--dataproc-version: The Dataproc version for this custom image to build on. Examples: 1.4.5-debian9, 1.4.0-RC10-debian9, 1.4.5-ubuntu18. For a complete list of Dataproc image versions, please refer to Dataproc release notes. To understand Dataproc versioning, please refer to documentation. This argument is mutually exclusive with --base-image-uri.
--base-image-uri: The full image URI for the base Dataproc image. The customiziation script will be executed on top of this image instead of an out-of-the-box Dataproc image. This image must be a valid Dataproc image. This argument is mutually exclusive with --dataproc-version.
--customization-script: The script used to install custom packages on the image.
--zone: The GCE zone for running your GCE instance.
--gcs-bucket: A GCS bucket to store the logs of building custom image.

Optional Arguments

--daisy-path: The path to Daisy binary. If specified, Daisy workflow will be used to create the image; otherwise, shell script will be used.
--family: The family of the source image. This will cause the latest non-deprecated image in the family to be used as the source image.
--project-id: The project Id of the project where the custom image is created and saved. The default project Id is the current project id specified in gcloud config get-value project.
--oauth: The OAuth credential file used to call Google Cloud APIs. The default OAuth is the application-default credentials from gcloud.
--machine-type: The machine type used to build custom image. The default is n1-standard-1.
--no-smoke-test: This parameter is used to disable smoke testing the newly built custom image. The smoke test is used to verify if the newly built custom image can create a functional Dataproc cluster. Disabling this step will speed up the custom image build process; however, it is not advised. Note: The smoke test will create a Dataproc cluster with the newly built image, runs a short job and deletes the cluster in the end.
--network: This parameter specifies the GCE network to be used to launch the GCE VM instance which builds the custom Dataproc image. The default network is 'global/networks/default'. If the default network does not exist in your project, please specify a valid network interface. For more information on network interfaces, please refer to (GCE VPC documentation)[https://cloud.google.com/vpc/docs/vpc].
--subnetwork: This parameter specifies the subnetwork that is used to launch the VM instance that builds the custom Dataprocimage. A full subnetwork URL is required. The default subnetwork is None. For more information, please refer to (GCE VPC documentation)[https://cloud.google.com/vpc/docs/vpc].
--no-external-ip: This parameter is used to disables external IP for the image build VM. The VM will not be able to access the internet, but if Private Google Access is enabled for the subnetwork, it can still access Google services (e.g., GCS) through internal IP of the VPC. This flag is ignored when --daisy-path is specified.
--service-account: The service account that is used to launch the VM instance that builds the custom Dataproc image. The scope of this service account is defaulted to "/auth/cloud-platform", which authorizes VM instance the access to all cloud platform services that is granted by IAM roles. Note: IAM role must allow the VM instance to access GCS bucket in order to access scripts and write logs.
--extra-sources: Additional files/directories uploaded along with customization script. This argument is evaluated to a json dictionary. Read more about (sources in daisy)[https://googlecloudplatform.github.io/compute-image-tools/daisy-workflow-config-spec.html#sources]
--disk-size: The size in GB of the disk attached to the VM instance used to build custom image. The default is 15 GB.
--base-image-uri: The partial image URI for the base Dataproc image. The customization script will be executed on top of this image instead of an out-of-the-box Dataproc image. This image must be a valid Dataproc image. The format of the partial image URI is the following: "projects/<project_id>/global/images/<image_name>".
--dry-run: Dry run mode which only validates input and generates workflow script without creating image. Disabled by default.

Examples

Create a custom image without Daisy (recommended)

Create a custom image with name custom-image-1-4-5 with Dataproc version 1.4.5-debian9:

python generate_custom_image.py \
    --image-name custom-image-1-4-5 \
    --dataproc-version 1.4.5-debian9 \
    --customization-script ~/custom-script.sh \
    --zone us-central1-f \
    --gcs-bucket gs://my-test-bucket

Create a custom image with Daisy (deprecated)