|
1 | | -# tailpipe-mod-gcp |
| 1 | +# GCP Audit Log Detections Mod for Powerpipe |
| 2 | + |
| 3 | +[Tailpipe](https://tailpipe.io) is an open-source CLI tool that allows you to collect logs and query them with SQL. |
| 4 | + |
| 5 | +[GCP](https://cloud.google.com) provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis. |
| 6 | + |
| 7 | +The [GCP Audit Log Detections Mod](https://hub.powerpipe.mods/turbot/tailpipe-mod-gcp-audit-log-detections) contains pre-built dashboards and detections, which can be used to monitor and analyze activity across your GCP projects. |
| 8 | + |
| 9 | +Run detection benchmarks: |
| 10 | + |
| 11 | + |
| 12 | +View insights in dashboards: |
| 13 | + |
| 14 | + |
| 15 | +## Documentation |
| 16 | + |
| 17 | +- **[Dashboards →](https://hub.powerpipe.io/mods/turbot/tailpipe-mod-gcp-audit-log-detections/dashboards)** |
| 18 | +- **[Benchmarks and detections →](https://hub.powerpipe.io/mods/turbot/tailpipe-mod-gcp-audit-log-detections/benchmarks)** |
| 19 | + |
| 20 | +## Getting Started |
| 21 | + |
| 22 | +Install Powerpipe from the [downloads](https://powerpipe.io/downloads) page: |
| 23 | + |
| 24 | +```sh |
| 25 | +# MacOS |
| 26 | +brew install turbot/tap/powerpipe |
| 27 | +``` |
| 28 | + |
| 29 | +```sh |
| 30 | +# Linux or Windows (WSL) |
| 31 | +sudo /bin/sh -c "$(curl -fsSL https://powerpipe.io/install/powerpipe.sh)" |
| 32 | +``` |
| 33 | + |
| 34 | +This mod also requires GCP audit logs to be collected using [Tailpipe](https://tailpipe.io) with the [GCP plugin](https://hub.tailpipe.io/plugins/turbot/gcp): |
| 35 | +- [Get started with the GCP plugin for Tailpipe →](https://hub.tailpipe.io/plugins/turbot/gcp#getting-started) |
| 36 | + |
| 37 | +Install the mod: |
| 38 | + |
| 39 | +```sh |
| 40 | +mkdir dashboards |
| 41 | +cd dashboards |
| 42 | +powerpipe mod install github.com/turbot/tailpipe-mod-gcp-audit-log-detections |
| 43 | +``` |
| 44 | + |
| 45 | +### Browsing Dashboards |
| 46 | + |
| 47 | +Start the dashboard server: |
| 48 | + |
| 49 | +```sh |
| 50 | +powerpipe server |
| 51 | +``` |
| 52 | + |
| 53 | +Browse and view your dashboards at **http://localhost:9033**. |
| 54 | + |
| 55 | +### Running Benchmarks in Your Terminal |
| 56 | + |
| 57 | +Instead of running benchmarks in a dashboard, you can also run them within your |
| 58 | +terminal with the `powerpipe benchmark` command: |
| 59 | + |
| 60 | +List available benchmarks: |
| 61 | + |
| 62 | +```sh |
| 63 | +powerpipe benchmark list |
| 64 | +``` |
| 65 | + |
| 66 | +Run a benchmark: |
| 67 | + |
| 68 | +```sh |
| 69 | +powerpipe benchmark run gcp_audit_log_detections.benchmark.mitre_attack_v161 |
| 70 | +``` |
| 71 | + |
| 72 | +Different output formats are also available, for more information please see |
| 73 | +[Output Formats](https://powerpipe.io/docs/reference/cli/benchmark#output-formats). |
| 74 | + |
| 75 | +## Open Source & Contributing |
| 76 | + |
| 77 | +This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you! |
| 78 | + |
| 79 | +[Tailpipe](https://tailpipe.io) and [Powerpipe](https://powerpipe.io) are products produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source). |
| 80 | + |
| 81 | +## Get Involved |
| 82 | + |
| 83 | +**[Join #tailpipe and #powerpipe on Slack →](https://turbot.com/community/join)** |
| 84 | + |
| 85 | +Want to help but don't know where to start? Pick up one of the `help wanted` issues: |
| 86 | + |
| 87 | +- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted) |
| 88 | +- [Tailpipe](https://github.com/turbot/tailpipe/labels/help%20wanted) |
| 89 | +- [GCP Audit Log Detections Mod](https://github.com/turbot/tailpipe-mod-gcp-audit-log-detections/labels/help%20wanted) |
0 commit comments