Install

This guide explains how to install Forseti Security.


Before you begin

Before you set up Forseti Security, you will need:

  • A Google Cloud Platform (GCP) organization you want to deploy Forseti for.
  • An Organization Administrator Cloud Identity and Access Management (Cloud IAM) role so the script can assign the Forseti service account roles on the organization Cloud IAM policy.
  • A GCP project dedicated to Forseti. You can reuse the same project that has Forseti 1.0 installed in it.
  • Enable billing on the project.

Setting up Forseti Security

The Forseti Terraform module is the only supported method of installing Forseti Security. The default infrastructure for Forseti is Google Compute Engine. This module also supports installing Forseti on Google Kubernetes Engine (GKE), and at some point in the future will become the default. For more information on installing Forseti on-GKE, please see the detailed guide on setting up Forseti on-GKE.

Google Cloud Shell Walkthrough

A Google Cloud Shell walkthrough has been setup to make it easy for users who are new to Forseti and Terraform. This walkthrough provides a set of instructions to get a default installation of Forseti setup that can be used in a production environment.

If you are familiar with Terraform and would like to run Terraform from a different machine, you can skip this walkthrough and move onto the How to Deploy section below.

Open in Google Cloud Shell

How to Deploy

In order to run this module you will need to be authenticated as a user that has access to the project and can create/authorize service accounts at both the organization and project levels. To login to GCP from a shell:

gcloud auth login

Install Terraform

Terraform version 0.12 is required for this module, which can be downloaded from the Terraform website.

Create the Service Account and enable required APIs

Service Account

Terraform uses an IAM Service Account to deploy and configure resources on behalf of the user. The Service Account and required APIs can be setup automatically with a provided script on the Forseti Terraform Github repository. The Service Account and required APIs can also be configured manually by reviewing the Requirements to deploy Forseti with Terraform. Alternatively, if you are an Org Admin, you can use your own credentials to install Forseti.

git clone --branch module-release-5.0.0 --depth 1 https://github.com/forseti-security/terraform-google-forseti.git
cd terraform-google-forseti
. ./helpers/setup.sh -p PROJECT_ID -o ORG_ID

This will create a service account called cloud-foundation-forseti-<suffix>, assign it the proper roles, and download the service account credentials to ${PWD}/credentials.json.

Utilizing a shared VPC via a host project is supported with the -f flag:

. ./helpers/setup.sh -p PROJECT_ID -f HOST_PROJECT_ID -o ORG_ID

If you are using the Real-Time Enforcer, you will need to generate a service account with a few extra roles. This can be enabled with the -e flag:

. ./helpers/setup.sh -p PROJECT_ID -o ORG_ID -e

APIs

For this module to work, you need the following APIs enabled on the Forseti project:

  • cloudresourcemanager.googleapis.com
  • compute.googleapis.com
  • serviceusage.googleapis.com

The setup script above will enable the API’s for you.

Terraform Configuration

Example configurations are included in the examples directory on the Forseti Terraform Github repository. You can copy these examples or use the snippet below as a starting point to your own custom configuration.

Create a file named main.tf in an empty directory and copy the contents below into the file.

module "forseti" {
  source  = "terraform-google-modules/forseti/google"
  version = "~> 5.0.0"

  gsuite_admin_email = "superadmin@yourdomain.com"
  domain             = "yourdomain.com"
  project_id         = "my-forseti-project"
  org_id             = "2313934234"
}

Forseti provides many optional settings for users to customize for their environment and security requirements.

The default Forseti Server VM machine type and Cloud SQL machine type have been set to n1-standard-8 and db-n1-standard-4 to account for larger GCP environments. These can be changed by providing the server_type and cloudsql_type variables.

The following variables have been listed as a sample to help you identify and set any customized values. There may be other variables with customized values that will need to be set.

View the list of inputs here to see all of the available options and default values.

Name Description Type Default
composite_root_resources A list of root resources that Forseti will monitor. This supersedes the root_resource_id when set. list(string) <list>
cscc_source_id Source ID for CSCC Beta API string ""
cscc_violations_enabled Notify for CSCC violations bool "false"
excluded_resources A list of resources to exclude during the inventory phase. list(string) <list>
forseti_email_recipient Email address that receives Forseti notifications string ""
forseti_email_sender Email address that sends the Forseti notifications string ""
gsuite_admin_email G-Suite administrator email address to manage your Forseti installation string ""
inventory_email_summary_enabled Email summary for inventory enabled bool "false"
inventory_gcs_summary_enabled GCS summary for inventory enabled bool "true"
sendgrid_api_key Sendgrid.com API key to enable email notifications string ""
violations_slack_webhook Slack webhook for any violation. Will apply to all scanner violation notifiers. string ""

Run Terraform

Forseti is ready to be installed! First you will need to initialize Terraform to download any of the module dependencies.

terraform init

The configuration can now be applied which will determine the necessary actions to perform on the GCP project.

terraform apply

Review the Terraform plan and enter yes to perform these actions.

Cleanup

Remember to cleanup the service account used to install Forseti either manually or by running the command:

./scripts/cleanup.sh -p PROJECT_ID -o ORG_ID -s cloud-foundation-forseti-<suffix>

This will deprovision and delete the service account, and then delete the credentials file.

If the service account was provisioned with the roles needed for the real time policy enforcer, you can set the -e flag to clean up those roles as well:

./scripts/cleanup.sh -p PROJECT_ID -o ORG_ID -S cloud-foundation-forseti-<suffix> -e

Forseti Configuration

Now that Forseti has been deployed, there are additional steps that you can follow to further configure Forseti. Some of the commonly used features are listed below:

Requirements

This section describes in detail the requirements necessary to deploy Forseti. The setup helper script automates the service account creation and enabling the APIs for you. Read through this section if you are not using the setup script or want to understand these details.

  1. Install Terraform.
  2. A GCP project to deploy Forseti into. The Google Project Factory Terraform module can be used to provision the project with the required APIs enabled, along with a Shared VPC connection.
  3. The Service Account used to execute this module has the right permissions.
  4. Enable the required GCP APIs to allow the Terraform module to deploy Forseti.

Software Dependencies

Terraform and Plugins

Service Account

In order to execute this module you must have a Service Account with the following IAM roles assigned.

IAM Roles

For this module to work, you need the following roles enabled on the Service Account.

On the organization:

  • roles/resourcemanager.organizationAdmin
  • roles/securityReviewer

On the project:

  • roles/owner
  • roles/compute.instanceAdmin
  • roles/compute.networkViewer
  • roles/compute.securityAdmin
  • roles/iam.serviceAccountAdmin
  • roles/serviceusage.serviceUsageAdmin
  • roles/iam.serviceAccountUser
  • roles/storage.admin
  • roles/cloudsql.admin

On the host project (when using shared VPC)

  • roles/compute.securityAdmin
  • roles/compute.networkAdmin

Outputs

When completed, the Terraform deployment will output a list of values on the terminal that can help users identify important resources that have been created by the Forseti installation. View the list of outputs here.

What’s next