# GCP Cloud Run ## GCP Project GCP projects serve as a "container" to organize and manage GCP services and applications. 1. Navigate to the [**GCP Console**](https://console.cloud.google.com/)**.** 2. **Log in** or **Create** an account. 3. Click the Project dropdown and select **Create New Project.**

4. Input a **Project name** for your project. 5. Select (or create) an **Organization.** 6. Click the **Create** button.

## MongoDB Atlas Before a deployment can be created, a database is required to store the Form.io deployment data. [**MongoDB Atlas**](https://cloud.google.com/mongodb) is a NoSQL database solution that will be used in this example within the GCP project to store projects, forms, and submissions. ### Creating a MongoDB Atlas Project 1. Within the GCP Project, search and select **MongoDB Atlas.**

2. Click the **Manage On Provider** button, which will open *cloud.mongodb.com* in a new tab.

3. **Log in** or **create** a MongoDB account. 4. Select **MongoDB Atlas** from the Cloud Service options. If there is no organization, a new organization should be created. 5. Give the Organization a **name** and select a **Cloud Service.** 6. Add **Members** to the organization and click the **Create Organization** button.

5. Within the Organization, click the **New Project** button.

6. Select **MongoDB Atlas** from the Cloud Service options. 7. Give the MongoDB Project a **Name.** 8. Add any additional users to MongoDB Project through **Add members.** 9. Click the **Create Project** button.

### Create a Cluster A **MongoDB Atlas cluster** is a collection of MongoDB servers that work together to store and manage Form.io data. 1. Click the **+Create** cluster button within the MongoDB Overview page.

2. Select the desired Cluster Template. For this example, the **M0** option will be selected. 3. Give the Cluster a **name.** 4. Select **Google Cloud** as the **Provider.** 5. Click the **Create Deployment** button.

### Connect to FormioCluster Complete the following steps to connect the cluster to all required IP addresses and configure the database users. #### Set up connection security

1. By default, the current IP address should be added. Click the **Network Access** button to add any additional IP addresses. This example is set to allow any IP address to connect to the database \ E.g. `0.0.0.0`

2. Set the **Username** and **Password** for any users that will have access to the project. 3. Click **Create Database User.** 4. Click the **Choose a connection method** button. #### Choose a connection method 1. Select **Drivers** as the connection option.

2. Ensure **Node.js** is selected for the **Driver** option. 3. Copy the connection string. This string will be used later as an environment variable within GCP. {% hint style="info" %} The MongoDB Cluster may take some time to build before a Connection String can be copied. {% endhint %} 4. Click **Done** to finalize the database.

### Create Database Create a database to connect to the cluster by completing the following steps: 1. Navigate to the **Cluster** tab. 2. Click the **Browse Collections** for the cluster.

3. Click **Add My Own Data** button to create database. 4. Set a **Database Name**, **Collection Name**, then click **Create.** {% hint style="info" %} Take note of the **Database Name.** It will be required in the connection string for GCP deployments. MongoDB Atlas will create a database by default called `test`if a Database is not created manually. {% endhint %}

## Google Cloud File Storage Create a Google File Storage bucket to store file uploads and PDFs: 1. Navigate to the [**GCP Console**](https://console.cloud.google.com/)**.** 2. Select the GCP **Project.** 3. Search and select **Cloud Storage** within the search bar.

4. Click **+Create** to create a bucket.

5. Set a **name** for the Bucket 6. Click the **Create** button

7. Check the **Enforce public access** setting. 8. Click **Confirm.**

9. Within the bucket settings, click the **Settings** button on the left-hand side bar. 10. Select the **Interoperability** tab.

11. Scroll down to the **Access keys for your user account** section and click **Create a Key.** 12. Record the **Access key** and **Secret** somewhere safe. They will be needed later.

## GCP Cloud Run Set up a GCP Cloud Run to deploy and run the containerized Form.io application in a serverless environment. 1. Navigate to the [**GCP Console**](https://console.cloud.google.com/)**.** 2. Select your **GCP Project.** 3. Search and select **Cloud Run** within the search bar.

{% hint style="info" %} You may need to enable the Cloud Run Admin API. If so, click **Enable.** {% endhint %} 4. Ensure **Cloud Run** is **enabled.** ### Enterprise Server Deployment 1. Within GCP Cloud Run, click the **Create Service** button. \ This will display the service configuration screen.

2. Enter the formio-enterprise.io Docker container image URL within the **Container image URL** setting field:\ \&#xNAN;*`docker.io/formio/formio-enterprise:9.3.0`* {% hint style="info" %} For this tutorial, the container tag being utilized is the formio-enterprise docker image tag 9.3.0. [**Click Here**](https://hub.docker.com/r/formio/formio-enterprise/tags) for a list of available formio-enterprise server version tags .\ \ For the latest version, replace the version number with *latest*\ \ *docker.io/formio/formio-enterprise:latest* {% endhint %} 3. Set a **Service Name.** 4. Set the **Authentication** method.

5. Set the **Service Autoscaling** number, the minimum recommendation is **1**.

6. Open the **Container(s), Volumes, Networking, Security** tab. 7. Set the **Container Port** to **3000.**

8. Within the Container(s), Volumes, Networking, Security settings, click the **Variables and Secrets** tab. 9. Click the **+Add Variable** button.

10. Enter the following **environment** **variables:** {% hint style="info" %} For the **MONGO** **variable**, copy and paste the connection string from the [**database configuration**](#connect-to-formiocluster) step.\ \ Update this string to include the database name of the MongoDB Cluster; in this example, the database name is **`formio`**. \ \ MongoDB Atlas will create a database by default called `test`if a Database was not created in the [**previous steps**](#create-database). Verify the database name by navigating to the MongoDB Cluster and viewing the Collections (see screenshot below) {% endhint %}

| MONGO | The MongoDB connection string to connect to your remote database. This is the value we copied in the cluster deployment step. Ensure the correct MongoDB username, password, and database name is included in the string. | mongodb+srv://mongouser:/**formio**?retryWrites=true\&w=majority\&appName=FormioCluster | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | LICENSE\_KEY | The[ **license key**](https://help.form.io/licenses/license-management#accessing-license-management) for your deployment. You will get this when you upgrade a project to Enterprise. | <—YOUR LICENSE—> | | DEBUG | Application Logging Settings. | \*.\* | | PORTAL\_ENABLED | Used to enable the Self-Hosted Portal. | 1 | | ADMIN\_EMAIL | An admin account you would like to use as the first Admin user authenticating into the deployed environment. | | | ADMIN\_PASS | A password for the first Admin user. | CHANGEME | | DB\_SECRET | A secure secret that you will pick that is used to encrypt the project settings. | CHANGEME | | JWT\_SECRET | A secure secret that you will pick that is used to establish secure JWT tokens. | CHANGEME | | PDF\_SERVER | The endpoint of the GCP PDF Server deployment (created in the next section). | | {% hint style="warning" %} Add the **`PDF_SERVER`** variable after completing the PDF deployment in GCP in the following section. {% endhint %} 11. Scroll down and set the **Maximum number of instances**. \ For this example, the instance number will be set to **3**.

12. Click the **Create** button. The screen should proceed to a progress screen showing the service being deployed.\ Once completed, the service will be deployed and will show a green checkmark.

### PDF Server Deployment 1. Within GCP Cloud Run, click +**Deploy Service**, and select **Service.**\ This will display the service configuration screen. 2. Enter the Form.io pdf-server Docker container image URL in the URL settings field:\ \&#xNAN;*`docker.io/formio/pdf-server:5.6.0`*

For this example, the container tag being utilized is the pdf-server docker image tag 5.6.0. Click Here for a list of available pdf-server version tags

For the latest PDF version, replace with docker.io/formio/pdf-server:latest

3. Input a **Service Name.** 4. Set the **Authentication** method.

5. Set the **Service Autoscaling** number. The minimum suggested setting is **1**.

6. Open the **Container(s), Volumes, Networking, Security** tab. 7. Set the **Container Port.**

8. Within the Container(s), Volumes, Networking, Security settings, click the **Variables and Secrets** tab. 9. Click the **+Add Variable** button

10. Enter the **following Environment Variables:**

For the MONGO variable, copy and paste the connection string from the database configuration step. Update this string to include the name of the MongoDB Atlas database used by the cluster; in this example, the database name is formio.

MongoDB Atlas will create a database by default called testif a database was not created manually in the previous steps. Verify the database name by navigating to the MongoDB Cluster and viewing the Collections (see screenshot below)
For the FORMIO_S3 variables, enter the credentials from the Google Storage Step
The application sets the FORMIO_S3_PORT variable to 9000 by default. In this example, where FORMIO_S3_SERVER is set to https://storage.googleapis.com, the FORMIO_S3_PORT environment variable should be left empty

Setting	Description	Example
MONGO	The MongoDB connection string to connect to your remote database. This is the value we copied before.	mongodb+srv://user:mypassword@formiocluster.apgbu.mongodb.net/formio?retryWrites=true&w=majority&appName=FormioCluster
LICENSE_KEY	The license key for your deployment. You will get this when you upgrade a project to Enterprise.	<—YOUR LICENSE—>
DEBUG		.
FORMIO_S3_SERVER	Storage URI of the File Storage bucket.	https://storage.googleapis.com
FORMIO_S3_BUCKET	Name of the Google bucket.	mybucket-name
FORMIO_S3_KEY	The Access Key of the Google Cloud storage bucket, found within the Interoperability tab.	ABCD1234
FORMIO_S3_SECRET	The Secret of the Google Cloud storage bucket, found within the Interoperability tab.	abc+123+def+L+ghiJKLmno
FORMIO_S3_REGION	Region of the bucket.	us-central1
FORMIO_S3_PORT

11. Under **Billing** select the **Instance-based** option (This is a puppeteer requirement. [Find out more here](https://pptr.dev/troubleshooting#running-puppeteer-on-google-cloud-run))

12. Scroll down and set the **Maximum number of instances**. \ For this example, the instance number will be set to **3**.

13. Click the **Create** button. The screen should navigate to a progress screen showing the service being deployed.\ Once completed, the service will be deployed and will show a green checkmark. 14. Copy the **PDF Server URL**

15. Within the GCP Cloud Run, add the following **environment** **variable** to the **Enterprise API Deployment** | Environment Variable | Description | Value | | -------------------- | -------------------------------------- | --------------------------------------------- | | PDF\_SERVER | The GCP PDF Server deployment endpoint | |

## Access Deployment The Cloud Run service provides a URL to access the Form.io deployment 1. Navigate to the [**GCP Console**](https://console.cloud.google.com/) 2. Select your **Google Cloud Project** 3. Search and select **Cloud Run** within the search bar 4. Click on the Form.io Enterprise Server **service**

5. Click the **URL** link next to the service name

6. Login using the **username** and **password** specified in the environment variables

7. Create a Project. {% hint style="info" %} For more information on next steps, visit the [**Getting Started**](https://help.form.io/master/form.io-beginners-walkthrough) guide {% endhint %}