This guide explains how to upgrade your Forseti instance.
For version 2.0.0 and later, we will provide upgrade instructions from one minor version to the next minor version. This means, if you want to upgrade from version 2.2.0 to 2.4.0, you should follow the upgrade instruction for version 2.2.0 to 2.3.0 first, and then follow the upgrade instruction for version 2.3.0 to 2.4.0. This ensures the upgrade process is easier to manage and to test.
If you used the Forseti installer to deploy, the deployment template is in your
Cloud Storage bucket for the Forseti instance under the deployment_templates
folder.
The filename will be in the following format: deploy-forseti-{forseti_instance_type}-{hash}.yaml
,
for example, deploy-forseti-server-79c4374.yaml
.
Review deploy-forseti-server.yaml.in
and deploy-forseti-client.yaml.in
for any new properties that you need to copy to your previous deployment template. To compare what’s changed, use
the git diff
command. For example, to see the diff between v2.1.0 and v2.2.0, run:
$ git diff v2.1.0..v2.2.0 -- deployment-templates/deploy-forseti-server.yaml.in
Edit deploy-forseti-{forseti_instance_type}-{hash}.yaml
and update the field forseti-version:
under
section Compute Engine
to the newest tag. For more information, see the latest release.
Run the following update command:
$ gcloud deployment-manager deployments update DEPLOYMENT_NAME \
--config path/to/deploy-forseti-{forseti_instance_type}-{HASH}.yaml
If you changed the properties in the deploy-forseti-{forseti_instance_type}-{hash}.yaml
Compute Engine
section or the startup script in forseti-instance.py
, you need to reset the instance for changes
to take effect:
$ gcloud compute instances reset COMPUTE_ENGINE_INSTANCE_NAME
The Compute Engine instance will restart and perform a fresh installation of Forseti. You won’t need to SSH to the instance to run all the git clone or Python install commands.
Some resources can’t be updated in a deployment. If an error displays that you can’t change a certain resource, you’ll need to create a new deployment of Forseti.
Learn more about Updating a Deployment.
You can upgrade from 2.13.0 to 2.14.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.14.0
to checkout version v2.14.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-14-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-14-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.14.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-14-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-14-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-14-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-14-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.forseti_conf_server.yaml
updates: inventory:
...
api_quota:
...
groupssettings:
max_calls: 5
period: 1.1
disable_polling: False
...
Scanner
scanner:
...
scanners:
- name: config_validator
enabled: false
- name: groups_settings
enabled: true
...
Notifier
notifier:
...
resources:
- resource: config_validator_violations
should_notify: true
notifiers:
# Email violations
- name: email_violations
# Upload violations to GCS.
- name: gcs_violations
configuration:
data_format: csv
# gcs_path should begin with "gs://"
gcs_path: gs://<FORSETI_SERVER_BUCKET>/scanner_violations
- resource: groups_settings_violations
should_notify: true
notifiers:
# Email violations
- name: email_violations
# Upload violations to GCS.
- name: gcs_violations
configuration:
data_format: csv
# gcs_path should begin with "gs://"
gcs_path: gs://<FORSETI_SERVER_BUCKET>/scanner_violations
...
violation:
cscc:
enabled: true
# Cloud SCC Beta API uses a new source_id. It is unique per
# organization and must be generated via a self-registration process.
# The format is: organizations/ORG_ID/sources/SOURCE_ID
source_id: <YOUR_SOURCE_ID>
rules/
in your Forseti server GCS bucket to include sample rules according to CIS benchmark.rules/
in your Forseti server GCS bucket to include Groups Settings rules.https://www.googleapis.com/auth/apps.groups.settings
to your Forseti server service
account to allow it to obtain GSuite groups settings data during the inventory process.version
inside main.tf
file to 1.4.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.rules/
in your Forseti server GCS bucket to include sample rules according to CIS benchmark.You can upgrade from 2.14.0 to 2.15.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.15.0
to checkout version v2.15.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-15-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-15-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.15.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-15-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-15-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-15-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-15-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.forseti_conf_server.yaml
updates: inventory:
...
cai:
...
#asset_types:
# - compute.googleapis.com/GlobalForwardingRule
# - compute.googleapis.com/RegionBackendService
...
rules/
in your Forseti server GCS bucket to exclude gmail as a
default whitelisted groupversion
inside main.tf
file to 1.6.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.15.0 to 2.16.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.16.0
to checkout version v2.16.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-16-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-16-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.16.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-16-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-16-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-16-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-16-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.version
inside main.tf
file to 2.1.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.16.0 to 2.17.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.17.0
to checkout version v2.17.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-17-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-17-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.17.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-17-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-17-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-17-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-17-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.roles/monitoring.metricWriter
to the service account on the project level.
gcloud projects add-iam-policy-binding {ORGANIZATION_ID} --member=serviceAccount:{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com --role=roles/monitoring.metricWriter
Example:
gcloud projects add-iam-policy-binding 1234567890 --member=serviceAccount:forseti-server-gcp-ea370bd@my_gcp_project.iam.gserviceaccount.com --role=roles/monitoring.metricWriter
forseti_conf_server.yaml
updates:
Inventory
inventory:
...
cai:
...
#asset_types:
# - k8s.io/Namespace
# - k8s.io/Node
# - k8s.io/Pod
# - rbac.authorization.k8s.io/ClusterRole
# - rbac.authorization.k8s.io/ClusterRoleBinding
# - rbac.authorization.k8s.io/Role
# - rbac.authorization.k8s.io/RoleBinding
...
version
inside main.tf
file to 2.2.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.17.0 to 2.18.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.18.0
to checkout version v2.18.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-18-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-18-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.18.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-18-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-18-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-18-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-18-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.rules/
in your Forseti server GCS bucket to include the latest vulnerable ke versions.version
inside main.tf
file to 2.3.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.rules/
in your Forseti server GCS bucket to include the latest vulnerable ke versions.You can upgrade from 2.18.0 to 2.19.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.19.0
to checkout version v2.19.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-19-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-19-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.19.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-19-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-19-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-19-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-19-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.version
inside main.tf
file to 4.0.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.19.0 to 2.20.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.20.0
to checkout version v2.20.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-20-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-20-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.20.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-20-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-20-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-20-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-20-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.forseti_conf_server.yaml
updates: inventory:
...
cai:
...
#asset_types:
# - compute.googleapis.com/Address
# - compute.googleapis.com/GlobalAddress
# - compute.googleapis.com/ComputeInterconnect
# - compute.googleapis.com/ComputeInterconnectAttachment
...
version
inside main.tf
file to 4.1.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.20.0 to 2.21.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.21.0
to checkout version v2.21.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-21-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-21-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.21.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-21-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-21-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-21-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-21-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.forseti_conf_server.yaml
updates: inventory:
...
cai:
...
#asset_types:
# - bigtableadmin.googleapis.com/Cluster
# - bigtableadmin.googleapis.com/Instance
# - bigtableadmin.googleapis.com/Table
...
version
inside main.tf
file to 4.2.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.You can upgrade from 2.21.0 to 2.22.0 using Deployment Manager or Terraform.
rm -rf forseti-security
to delete the folder.git clone https://github.com/forseti-security/forseti-security.git
to
clone the forseti-security directory to cloud shell.cd forseti-security
to navigate to the forseti-security directory.git checkout tags/v2.22.0
to checkout version v2.22.0
of Forseti Security.forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp gs://YOUR_FORSETI_GCS_BUCKET/deployment_templates/deploy-forseti-server-<LATEST_TEMPLATE>.yaml
deployment-templates/deploy-forseti-server-xxxxx-2-22-0.yaml
.deployment-templates/deploy-forseti-server-xxxxx-2-22-0.yaml
for edit.Update the forseti-version
inside the deployment template to tags/v2.22.0
.
deployment-templates/deploy-forseti-server-xxxxx-2-22-0.yaml
back to the GCS bucket
(forseti-server-xxxxxx/deployment_templates
) by running command
gsutil cp deployment-templates/deploy-forseti-server-xxxxx-2-22-0.yaml gs://YOUR_FORSETI_GCS_BUCKET/
deployment_templates/deploy-forseti-server-xxxxx-2-22-0.yaml
.gcloud deployment-manager deployments update DEPLOYMENT_NAME --config deployment-templates/deploy-forseti-server-xxxxx-2-22-0.yaml
If you see errors while running the deployment manager update command, please refer to below section
Error while running deployment manager
for details on how to workaround the error.gcloud compute instances reset MY_FORSETI_SERVER_INSTANCE --zone MY_FORSETI_SERVER_ZONE
Example command: gcloud compute instances reset forseti-server-vm-70ce82f --zone us-central1-c
3-9
for Forseti client.forseti_conf_server.yaml
updates: inventory:
...
cai:
...
#asset_types:
# - compute.googleapis.com/SecurityPolicy
...
version
inside main.tf
file to 4.3.0
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.If your Forseti deployment was previously deployed with Deployment Manager, please see the migration documentation on migrating to Terraform. Following these steps will also result in an upgraded deployment of Forseti.
A Cloud Shell walkthrough is provided to assist with upgrading Forseti previously deployed with Terraform. Completing this guide will also result in a Forseti deployment upgraded to the most recent version.
version
inside main.tf
file to 5.1.4
.terraform init
to initialize terraform.terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.version
inside main.tf
file to 5.1.4
.terraform init
to initialize terraform. config_validator_enabled = true
git_sync_private_ssh_key_file = ""
policy_library_repository_url = ""
You will need to specify an additional value in your main.tf
to maintain the periodic git-sync feature for the library:
policy_library_sync_enabled = true
terraform plan
to see the infrastructure plan.terraform apply
to apply the infrastructure build.If you get the following error while running the deployment manager:
The fingerprint of the deployment is .....
Waiting for update [operation-xxx-xxx-xxx-xxx]...failed.
ERROR: (gcloud.deployment-manager.deployments.update) Error in Operation [operation-xxx-xxx-xxx-xxx]: errors:
- code: NO_METHOD_TO_UPDATE_FIELD
message: No method found to update field 'networkInterfaces' on resource 'forseti-server-vm-xxxxx'
of type 'compute.v1.instance'. The resource may need to be recreated with the
new field.
You can follow the following steps to workaround this deployment manager problem:
gcloud deployment-manager deployments update DEPLOYMENT_NAME --config forseti_server_v2_x_x.yaml
gcloud deployment-manager deployments update DEPLOYMENT_NAME --config forseti_server_v2_x_x.yaml