|
||
---|---|---|
.. | ||
cf | ||
README.md | ||
backend.tf.sample | ||
cloud-shell-readme.txt | ||
diagram.png | ||
main.tf | ||
outputs.tf | ||
variables.tf | ||
versions.tf |
README.md
Cloud Asset Inventory feeds for resource change tracking and remediation
This blueprint shows how to leverage Cloud Asset Inventory feeds to stream resource changes in real time, and how to programmatically react to changes by wiring a Cloud Function to the feed outputs.
The Cloud Function can then be used for different purposes:
- updating remote data (eg a CMDB) to reflect the changed resources
- triggering alerts to surface critical changes
- adapting the configuration of separate related resources
- implementing remediation steps that enforce policy compliance by tweaking or reverting the changes.
A companion Medium article has been published for this blueprint, refer to it for more details on the context and the specifics of running the blueprint.
This blueprint shows a simple remediation use case: how to enforce policies on instance tags and revert non-compliant changes in near-real time, thus adding an additional measure of control when using tags for firewall rule scoping. Changing the monitored asset and the function logic allows simple adaptation to other common use cases:
- enforcing a centrally defined Cloud Armor policy in backend services
- creating custom DNS records for instances or forwarding rules
The blueprint uses a single project for ease of testing, in actual use a few changes are needed to operate at the resource hierarchy level:
- the feed should be set at the folder or organization level
- the custom role used to assign tag changing permissions should be defined at the organization level
- the role binding that grants the custom role to the Cloud Function service account should be set at the same level as the feed (folder or organization)
The resources created in this blueprint are shown in the high level diagram below:
![](/zecfoundation/cloud-foundation-fabric/media/commit/303b51a0a99454e978a1dfea05f50c4aa079c2ec/blueprints/cloud-operations/asset-inventory-feed-remediation/diagram.png)
Running the blueprint
Clone this repository or open it in cloud shell, then go through the following steps to create resources:
terraform init
terraform apply -var project_id=my-project-id
Once done testing, you can clean up resources by running terraform destroy
. To persist state, check out the backend.tf.sample
file.
Testing the blueprint
The terraform outputs generate preset gcloud
commands that you can copy and run in the console, to complete configuration and test the blueprint:
subscription_pull
shows messages in the PubSub queue, to check feed message format if the Cloud Function is disabledcf_logs
shows Cloud Function logs to check that remediation workstag_add
adds a non-compliant tag to the test instance, and triggers the Cloud Function remediation processtag_show
displays the tags currently set on the test instance
Run the subscription_pull
command until it returns nothing, then run the following commands in order to test remediation:
- the
tag_add
command - the
cf_logs
command until the logs show that the change has been picked up, verified, and the compliant tags have been force-set on the instance - the
tag_show
command to verify that the function output matches the resource state
Variables
name | description | type | required | default |
---|---|---|---|---|
project_id | Project id that references existing project. | string |
✓ | |
bundle_path | Path used to write the intermediate Cloud Function code bundle. | string |
"./bundle.zip" |
|
name | Arbitrary string used to name created resources. | string |
"asset-feed" |
|
project_create | Create project instead of using an existing one. | bool |
false |
|
region | Compute region used in the example. | string |
"europe-west1" |
Outputs
name | description | sensitive |
---|---|---|
cf_logs | Cloud Function logs read command. | |
subscription_pull | Subscription pull command. | |
tag_add | Instance add tag command. | |
tag_show | Instance add tag command. |