Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekristen/gcp-nuke
Nuke Everything in GCP Project
https://github.com/ekristen/gcp-nuke
gcp gcp-nuke libnuke
Last synced: about 1 month ago
JSON representation
Nuke Everything in GCP Project
- Host: GitHub
- URL: https://github.com/ekristen/gcp-nuke
- Owner: ekristen
- License: mit
- Created: 2023-12-31T04:41:08.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T03:27:52.000Z (about 1 month ago)
- Last Synced: 2024-11-08T04:24:51.839Z (about 1 month ago)
- Topics: gcp, gcp-nuke, libnuke
- Language: Go
- Homepage: https://ekristen.github.io/gcp-nuke/
- Size: 247 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# gcp-nuke
[](https://github.com/ekristen/gcp-nuke/blob/main/LICENSE)
[](https://github.com/ekristen/gcp-nuke/releases)
[](https://goreportcard.com/report/github.com/ekristen/gcp-nuke)
[](https://codeclimate.com/github/ekristen/gcp-nuke/maintainability)
**This is potentially very destructive! Use at your own risk!**
**Status:** Beta. Tool is stable, but could experience odd behaviors with some resources.
## Overview
Remove all resources from a GCP Project.
**gcp-nuke** is in beta, but it is likely that not all GCP resources are covered by it. Be encouraged to add missing
resources and create a Pull Request or to create an [Issue](https://github.com/ekristen/gcp-nuke/issues/new).
## Documentation
All documentation is in the [docs/](docs) directory and is built using [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/).
It is hosted at [https://ekristen.github.io/gcp-nuke/](https://ekristen.github.io/gcp-nuke/).
## Attribution, License, and Copyright
This tool was written using [libnuke](https://github.com/ekristen/libnuke) at it's core. It shares similarities and commonalities with [aws-nuke](https://github.com/ekristen/aws-nuke)
and [azure-nuke](https://github.com/ekristen/azure-nuke). These tools would not have been possible without the hard work
that came before me on the original tool by the team and contributors over at [rebuy-de](https://github.com/rebuy-de) and their original work
on [rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke).
This tool is licensed under the MIT license as well. See the [LICENSE](LICENSE) file for more information. Reference
was made to [dshelley66/gcp-nuke](https://github.com/dshelley66/gcp-nuke) during the creation of this tool therefore I
included them in the license copyright although no direct code was used.
## Usage
**Note:** all cli flags can also be expressed as environment variables.
**By default, no destructive actions will be taken.**
### Example - Dry Run only
```bash
gcp-nuke run \
--config test-config.yaml \
--project-id playground-12345
```
### Example - No Dry Run (DESTRUCTIVE)
To actually destroy you must add the `--no-dry-run` cli parameter.
```bash
gcp-nuke run \
--config=test-config.yaml \
--project-id playground-12345 \
--no-dry-run
```
## Authentication
Authentication is only supported via a Service Account either by Key or via Workload Identity.
### Service Account Key
```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account-key.json
```
### Federated Token (Kubernetes)
**coming soon**
## Configuring
The entire configuration of the tool is done via a single YAML file.
### Example Configuration
**Note:** you must add at least one entry to the blocklist.
```yaml
regions:
- global
- eastus
blocklist:
- 00001111-2222-3333-4444-555566667777
accounts: # i.e. projects but due to the commonality of libnuke, it's accounts here universally between tools
playground-12345:
presets:
- common
filters:
IAMRole:
- property: Name
type: contains
value: CustomRole
IAMServiceAccount:
- property: Name
type: contains
value: custom-service-account
presets:
common:
filters:
VPC:
- default
```