Installation

This quickstart explains how to use the Forseti setup wizard, which helps to automate some of the Forseti installation and setup on GCP.

If you are trying to install Forseti in a developer environment, please refer to the Development Environment Setup.

Setup wizard is not available prior to version 1.1.0.

Before you begin

Prior to running the setup wizard, you will need:

  • A GCP organization for which you want to deploy Forseti.
  • Org Admin IAM role in order for the script to assign the Forseti service account roles on the organization IAM policy.
  • A GCP project dedicated to Forseti.
  • Enable billing on the project.

Setting up Forseti Security

The setup wizard automatically determines setup information, generates a deployment template, and creates a Forseti deployment.

Activate Google Cloud Shell

It’s recommended to use Cloud Shell to run the Forseti setup wizard. This ensures you’re using the latest version of Cloud SDK since it’s included in Cloud Shell. To prepare to run the Forseti setup wizard, follow the steps below:

  1. Access the Cloud Platform Console.
  2. In the Select a project drop-down list at the top of the console, select the project where you want to deploy Forseti.
  3. On the top right of the console, click the icon to Activate Google Cloud Shell. The Cloud Shell panel opens at the bottom of the page.

Run setup

  1. Once you’ve started Cloud Shell, download Forseti. The setup wizard is included. Getting master branch will install the latest version of Forseti.

     git clone -b master --single-branch https://github.com/GoogleCloudPlatform/forseti-security
    

    To get a particular release, e.g. 1.1.7, use the following command (note the “v”):

     git clone -b v1.1.7 --single-branch https://github.com/GoogleCloudPlatform/forseti-security
    
  2. Navigate to the setup wizard directory:

     cd forseti-security/scripts/gcp_setup
    
  3. Invoke the setup:

     python setup_forseti.py
    

    To see additional configurations for the setup:

     python setup_forseti.py -h
    
  4. Setup will infer the necessary information to install Forseti.

    If you ran the setup_forseti.py without extra flags, you will be prompted to enter the following:

    • SendGrid API key: Optional, used for sending email via SendGrid. Refer to setting up email notifications).
    • Email recipient: If a SendGrid API key is provided, you will also be asked to whom Forseti should send the email notifications.
    • G Suite super admin email: This is part of the G Suite Google Groups collection and is necessary for running IAM Explain. Ask your G Suite Admin if you don’t know what the super admin email is.
  5. If you previously used Cloud Shell to SSH to a Compute Engine instance and you set an SSH passphrase, setup prompts you to enter the passphrase. The Forseti setup uses secure copy (SCP) to copy the auto-generated G Suite service account key as well as the Forseti configuration files to the Forseti Compute Engine instance .

  6. After the setup wizard successfully completes Forseti setup and deployment, complete the steps to enable G Suite Google Groups collection. This is a required step if you also plan to deploy IAM Explain.

What’s next