Be aware that Mainframe Connector uses Google Analytics
to collect usage data. This helps us improve the software and provide a
better user experience. By default, Google Analytics is enabled.
However, you can opt out by configuring an environment variable when
running Mainframe Connector.
The use of Google Analytics is subject to the Google Analytics
Terms of Service and Privacy Policy.
By downloading Mainframe Connector, you acknowledge that you have
read, understood, and accepted the terms and conditions.
The main.tf and vars.tf files are extracted from
deployment tar file.
Review and edit the variables in the vars.tf file. Most of the
variables already have default values. The only mandatory variables you need
to set are project and connector_service_account_email.
project: The Google Cloud project in which you want to
install Mainframe Connector.
connector_service_account_email: The service account that
has all the permissions for the operations you want to perform using
Mainframe Connector.
You can also set the network configuration using the
connector_service_ingress and connector_service_vpc_access
variables.
Run the terraform init
command with a Cloud Storage bucket and prefix as
arguments. Using a Cloud Storage bucket and prefix helps you save the
deployment state in the bucket. You can also reuse the same bucket and prefix
when you upgrade Mainframe Connector.
DEPLOYMENT_STATE_BUCKET: The name of the Cloud Storage bucket.
BUCKET_PREFIX: The prefix that you want to use in the
Cloud Storage bucket.
Create a .tfvars file to define variables that you want
Terraform to use during the Mainframe Connector deployment.
Open the .tfvars file and define the following variables as
key-value pairs.
instance_id: Define an instance_id to
separate different workloads when you want to have multiple instances of
Mainframe Connector, or to use different service accounts.
project: The project in which you want to deploy
Mainframe Connector.
connector_service_ingress: The ingress type.
additional_labels: Additional labels if you want to test
the deployment.
connector_service_account_email: The service account email
ID of Mainframe Connector.
Save your changes and close the file.
Deploy Mainframe Connector.
terraform apply -var-file=VARIABLE_FILE_NAME
Replace VARIABLE_FILE_NAME with the variables file you created in
the previous step.
(Optional) To check if Mainframe Connector is deployed and running,
go to the Cloud Run page, and select the Services tab. You
should see your deployment listed in the table.
Deploy multiple instances of the Mainframe Connector
To limit access for specific jobs, you might need to deploy multiple instances
of the Mainframe Connector. You can do this by deploying the
Mainframe Connector multiple times with different variables and service
accounts. Since the Mainframe Connector remote service is based on
Cloud Run, you will only be billed when each service is actually running.
You also don't need to set up high availability (HA) as each instance is already
load balanced and highly available.
[[["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-09-04 UTC."],[],[],null,["# Deploy Mainframe Connector on Cloud Run\n\nThis page discusses how you can deploy Mainframe Connector on\nCloud Run as a remote service using [Terraform](https://www.terraform.io/).\nYou can then use the Mainframe Connector remote service to transcode,\nstore, and export mainframe data on Google Cloud. You can trigger this service\nfrom your mainframe to [perform remote transcoding](/mainframe-connector/docs/remote-transcoding),\nor as a [standalone instance that is integrated with an existing extract, transfer, and load (ETL) workflow](/mainframe-connector/docs/standalone-mode).\n\nYou can also deploy multiple instances of the Mainframe Connector\nremote service. For more information, see [Deploy multiple instances of the Mainframe Connector](#deploy-multiple-instances).\n\nTo deploy Mainframe Connector on Cloud Run using\n[Terraform](https://www.terraform.io/), use the following steps:\n\n1. Download the [Mainframe Connector deployment tar file]().\n\n ### Important\n\n Be aware that Mainframe Connector uses Google Analytics\n to collect usage data. This helps us improve the software and provide a\n better user experience. By default, Google Analytics is enabled.\n However, you can opt out by configuring an [environment variable](/mainframe-connector/docs/environment-variables#disable_analytics) when\n running Mainframe Connector.\n\n\n \u003cbr /\u003e\n\n\n The use of Google Analytics is subject to the Google Analytics\n [Terms of Service and Privacy Policy](https://www.google.com/analytics/terms).\n By downloading Mainframe Connector, you acknowledge that you have\n read, understood, and accepted the terms and conditions. \n [Download](https://storage.googleapis.com/mainframe-connector-release/latest/deployment.tar) Cancel\n2. Extract the files in the deployment tar file.\n\n ```\n tar -xvf ./deployment.tar\n ```\n\n The `main.tf` and `vars.tf` files are extracted from\n deployment tar file.\n3. Review and edit the variables in the `vars.tf` file. Most of the\n variables already have default values. The only mandatory variables you need\n to set are `project` and `connector_service_account_email`.\n\n - **`project`:** The Google Cloud project in which you want to install Mainframe Connector.\n - **`connector_service_account_email`:** The service account that has all the permissions for the operations you want to perform using Mainframe Connector.\n\n You can also set the network configuration using the\n `connector_service_ingress` and `connector_service_vpc_access`\n variables.\n4. Run the [`terraform init`](https://developer.hashicorp.com/terraform/cli/commands/init)\n command with a Cloud Storage *bucket* and *prefix* as\n arguments. Using a Cloud Storage bucket and prefix helps you save the\n deployment state in the bucket. You can also reuse the same bucket and prefix\n when you upgrade Mainframe Connector.\n\n ```\n terraform init \\\n -backend-config bucket=DEPLOYMENT_STATE_BUCKET \\\n -backend-config prefix=BUCKET_PREFIX\n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eDEPLOYMENT_STATE_BUCKET\u003c/var\u003e: The name of the Cloud Storage bucket.\n - \u003cvar translate=\"no\"\u003eBUCKET_PREFIX\u003c/var\u003e: The prefix that you want to use in the Cloud Storage bucket.\n5. Create a `.tfvars` file to define variables that you want\n Terraform to use during the Mainframe Connector deployment.\n\n6. Open the `.tfvars` file and define the following variables as\n key-value pairs.\n\n - **`instance_id`:** Define an `instance_id` to separate different workloads when you want to have multiple instances of Mainframe Connector, or to use different service accounts.\n - **`project`:** The project in which you want to deploy Mainframe Connector.\n - **`connector_service_ingress`:** The ingress type.\n - **`additional_labels`:** Additional labels if you want to test the deployment.\n - **`connector_service_account_email`:** The service account email ID of Mainframe Connector.\n\n Save your changes and close the file.\n7. Deploy Mainframe Connector.\n\n ```\n terraform apply -var-file=VARIABLE_FILE_NAME\n ```\n\n Replace \u003cvar translate=\"no\"\u003eVARIABLE_FILE_NAME\u003c/var\u003e with the variables file you created in\n the previous step.\n8. (Optional) To check if Mainframe Connector is deployed and running,\n go to the Cloud Run page, and select the **Services** tab. You\n should see your deployment listed in the table.\n\n [Go to Cloud Run](https://console.cloud.google.com/run?enableapi=true)\n\nDeploy multiple instances of the Mainframe Connector\n----------------------------------------------------\n\nTo limit access for specific jobs, you might need to deploy multiple instances\nof the Mainframe Connector. You can do this by deploying the\nMainframe Connector multiple times with different variables and service\naccounts. Since the Mainframe Connector remote service is based on\nCloud Run, you will only be billed when each service is actually running.\nYou also don't need to set up high availability (HA) as each instance is already\nload balanced and highly available.\n\nWhat's next\n-----------\n\n- [Transcode mainframe data remotely on Google Cloud](/mainframe-connector/docs/remote-transcoding)\n- [Transcode mainframe data moved to Google Cloud using a virtual tape library](/mainframe-connector/docs/vtl-transcoding)\n- [Run Mainframe Connector as a standalone job](/mainframe-connector/docs/standalone-mode)"]]