Stay organized with collections
Save and categorize content based on your preferences.
You can install additional components like Zeppelin when you create a Dataproc
cluster using the
Optional components
feature. This page describes the Zeppelin component.
The Zeppelin Notebook
component is a Web-based notebook for interactive data analytics. The Zeppelin
Web UI is available on port 8080 on the cluster's first master node.
By default, notebooks are saved in Cloud Storage
in the Dataproc staging bucket, which is specified by the user or
auto-created
when the cluster is created. The location can be changed at cluster creation
time via the
zeppelin:zeppelin.notebook.gcs.dir property.
Install the component
Install the component when you create a Dataproc cluster.
Components can be added to clusters created with
Dataproc version 1.3
and later.
To create a Dataproc cluster that includes the Zeppelin component,
use the
gcloud dataproc clusters createcluster-name
command with the --optional-components flag.
See Viewing and Accessing Component Gateway URLs
to click Component Gateway links on the Google Cloud console to open the
Zeppelin notebook UI running on the cluster's master node in your local
browser.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThe Zeppelin component, a web-based notebook for interactive data analytics, can be installed as an optional component when creating a Dataproc cluster.\u003c/p\u003e\n"],["\u003cp\u003eZeppelin notebooks are saved in a Cloud Storage staging bucket by default, but this location can be customized during cluster creation using a specific property.\u003c/p\u003e\n"],["\u003cp\u003eThe Zeppelin Web UI is accessible on port 8080 of the cluster's first master node, and the Component Gateway can be enabled to provide secured connections to the UI.\u003c/p\u003e\n"],["\u003cp\u003eTo install Zeppelin, use the \u003ccode\u003egcloud dataproc clusters create\u003c/code\u003e command with the \u003ccode\u003e--optional-components=ZEPPELIN\u003c/code\u003e flag, and the \u003ccode\u003e--enable-component-gateway\u003c/code\u003e flag to enable secure connections when creating the cluster with an image version of 1.3.29 or later.\u003c/p\u003e\n"],["\u003cp\u003eYou can install the Zeppelin component through the Google cloud console by selecting it in the optional components section, and also selecting to enable the component gateway when creating a new cluster.\u003c/p\u003e\n"]]],[],null,["# Dataproc optional Zeppelin component\n\nYou can install additional components like Zeppelin when you create a Dataproc\ncluster using the\n[Optional components](/dataproc/docs/concepts/components/overview#available_optional_components)\nfeature. This page describes the Zeppelin component.\n\nThe [Zeppelin Notebook](https://zeppelin.apache.org/)\ncomponent is a Web-based notebook for interactive data analytics. The Zeppelin\nWeb UI is available on port `8080` on the cluster's first master node.\n\nBy default, notebooks are saved in Cloud Storage\nin the Dataproc staging bucket, which is specified by the user or\n[auto-created](/dataproc/docs/guides/create-cluster#auto-created_staging_bucket)\nwhen the cluster is created. The location can be changed at cluster creation\ntime via the\n[`zeppelin:zeppelin.notebook.gcs.dir` property](/dataproc/docs/concepts/configuring-clusters/cluster-properties#dataproc-properties).\n| - Zeppelin can be configured by providing `zeppelin` and `zeppelin-env` prefixed [cluster properties](/dataproc/docs/concepts/configuring-clusters/cluster-properties#formatting).\n| - To reduce the risk of remote code execution over unsecured notebook server APIs, the default `zeppelin:zeppelin.server.addr` cluster property setting for image versions 1.3+ is `127.0.0.1`, which restricts connections to `localhost` when [Component Gateway](/dataproc/docs/concepts/accessing/dataproc-gateways) is enabled.\n\nInstall the component\n---------------------\n\nInstall the component when you create a Dataproc cluster.\nComponents can be added to clusters created with\nDataproc [version 1.3](/dataproc/docs/concepts/versioning/dataproc-release-1.3)\nand later.\n\nSee\n[Supported Dataproc versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions)\nfor the component version included in each Dataproc image release. \n\n### gcloud command\n\nTo create a Dataproc cluster that includes the Zeppelin component,\nuse the\n[gcloud dataproc clusters create](/sdk/gcloud/reference/dataproc/clusters/create) \u003cvar translate=\"no\"\u003ecluster-name\u003c/var\u003e\ncommand with the `--optional-components` flag.\nWhen creating the cluster (image version 1.3.29 or later), use [gcloud dataproc clusters create](/sdk/gcloud/reference/dataproc/clusters/create) command with the `--enable-component-gateway` flag, as shown below, to enable connecting to the Zeppelin notebook Web UI using the [Component Gateway](/dataproc/docs/concepts/accessing/dataproc-gateways). \n\n```\ngcloud dataproc clusters create cluster-name \\\n --optional-components=ZEPPELIN \\\n --region=region \\\n --enable-component-gateway \\\n ... other flags\n```\n\n### REST API\n\nThe Zeppelin component can be specified through the Dataproc API using [SoftwareConfig.Component](/dataproc/docs/reference/rest/v1/ClusterConfig#Component) as part of a [clusters.create](/dataproc/docs/reference/rest/v1/projects.regions.clusters/create) request. Using the [Dataproc `v1` API](/dataproc/docs/reference/rest), set the [EndpointConfig.enableHttpPortAccess](/dataproc/docs/reference/rest/v1/ClusterConfig#endpointconfig) property to `true` as part of the clusters.create request to enable connecting to the Zeppelin notebook Web UI using the [Component Gateway](/dataproc/docs/concepts/accessing/dataproc-gateways).\n\n### Console\n\n1. Enable the component and component gateway.\n - In the Google Cloud console, open the Dataproc [Create a cluster](https://console.cloud.google.com/dataproc/clustersAdd) page. The Set up cluster panel is selected.\n - In the Components section:\n - Under Optional components, select Zeppelin and other optional components to install on your cluster.\n - Under Component Gateway, select Enable component gateway (see [Viewing and Accessing Component Gateway URLs](/dataproc/docs/concepts/accessing/dataproc-gateways#viewing_and_accessing_component_gateway_urls)).\n\nOpen the Zeppelin notebook\n--------------------------\n\nSee [Viewing and Accessing Component Gateway URLs](/dataproc/docs/concepts/accessing/dataproc-gateways#viewing_and_accessing_component_gateway_urls)\nto click Component Gateway links on the Google Cloud console to open the\nZeppelin notebook UI running on the cluster's master node in your local\nbrowser."]]
