Skip to content

Commit bd40150

Browse files
committed
update dockerfile entrypoint and readme (#30)
* fix(docker): entrypoint on Dockerfile * docs: improve readme default docs * docs(readme): improvements
1 parent 2455a7b commit bd40150

File tree

2 files changed

+29
-57
lines changed

2 files changed

+29
-57
lines changed

Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ RUN \
1212
go build -o bin/aws-nuke main.go
1313

1414
FROM base AS goreleaser
15+
ENTRYPOINT ["/usr/local/bin/aws-nuke"]
1516
COPY aws-nuke /usr/local/bin/aws-nuke
1617
USER aws-nuke
1718

1819
FROM base
20+
ENTRYPOINT ["/usr/local/bin/aws-nuke"]
1921
COPY --from=build /src/bin/aws-nuke /usr/local/bin/aws-nuke
2022
USER aws-nuke

README.md

Lines changed: 27 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/ekristen/aws-nuke)](https://goreportcard.com/report/github.com/ekristen/aws-nuke)
66
[![Maintainability](https://api.codeclimate.com/v1/badges/bf05fb12c69f1ea7f257/maintainability)](https://codeclimate.com/github/ekristen/aws-nuke/maintainability)
77

8-
**Forked from [rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke)**
9-
108
## Overview
119

1210
Remove all resources from an AWS account.
@@ -16,8 +14,9 @@ resources and create a Pull Request or to create an [Issue](https://github.com/e
1614

1715
## Documentation
1816

19-
All documentation is in the [docs/](docs/) directory and is built using [MkDocs](https://www.mkdocs.org/). However,
20-
all the documentation is hosted at [https://ekristen.github.io/aws-nuke/](https://ekristen.github.io/aws-nuke/).
17+
All documentation is in the [docs/](docs) directory and is built using [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/).
18+
19+
It is hosted at [https://ekristen.github.io/aws-nuke/](https://ekristen.github.io/aws-nuke/).
2120

2221
## History of this Fork
2322

@@ -34,72 +33,43 @@ Azure, but I didn't want to have to maintain multiple copies of the same code, s
3433
[libnuke](https://github.com/ekristen/libnuke) to abstract all the code that was common between the two tools and write
3534
proper unit tests for it.
3635

36+
## Attribution, License, and Copyright
37+
38+
The rewrite of this tool to use [libnuke](https://github.com/ekristen/libnuke) would not have been posssible without the
39+
hard work that came before me on the original tool by the team and contributors over at [rebuy-de](https://github.com/rebuy-de)
40+
and their original work on [rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke).
41+
42+
This tool is licensed under the MIT license. See the [LICENSE](LICENSE) file for more information. The bulk of this
43+
tool was rewritten to use [libnuke](https://github.com/ekristen/libnuke) which was in part originally sourced from
44+
[rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke).
45+
46+
## Contribute
47+
48+
You can contribute to *aws-nuke* by forking this repository, making your changes and creating a Pull Request against
49+
this repository. If you are unsure how to solve a problem or have other questions about a contributions, please create
50+
a GitHub issue.
51+
3752
## Version 3
3853

39-
Version 3 is a rewrite of this tool using [libnuke](https://github.com/ekristen/libnuke) with a focus on improving a
40-
number of the outstanding things that I couldn't get done with the original project without separating out the core
41-
code into a library.
54+
Version 3 is a rewrite of this tool using [libnuke](https://github.com/ekristen/libnuke) with a focus on improving a number of the outstanding things
55+
that I couldn't get done with the original project without separating out the core code into a library. See Goals
56+
below for more.
4257

4358
### Changes
4459

45-
- The root command will result in help now on v3, the primary nuke command moved to `nuke`.
46-
- CloudFormation Stacks now support a hold and wait for parent deletion process.
47-
- Nested CloudFormation Stacks are now eligible for deletion and no longer omitted.
60+
- The root command will result in help now on v3, the primary nuke command moved to `nuke`. **Breaking**
61+
- CloudFormation Stacks now support a hold and wait for parent deletion process. **Quasi-Breaking**
62+
- Nested CloudFormation Stacks are now eligible for deletion and no longer omitted. **Quasi-Breaking**
4863
- The entire resource lister format has changed and requires a struct.
4964
- Context is passed throughout the entire library now, including the listing function and the removal function.
65+
- This is in preparation for supporting AWS SDK Go v2
5066

5167
### Goals
5268

5369
- Adding additional tests
5470
- Adding additional resources
55-
- Adding Documentation for adding resources and using the tool
71+
- Adding documentation for adding resources and using the tool
5672
- Consider adding DAG for dependencies between resource types and individual resources
5773
- This will improve the process of deleting resources that have dependencies on other resources and reduce
5874
errors and unnecessary API calls.
5975

60-
## Documentation
61-
62-
The project is built to have the documentation right alongside the code in the `docs/` directory leveraging
63-
[Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/)
64-
65-
In the root of the project exists mkdocs.yml which drives the configuration for the documentation.
66-
67-
This README.md is currently copied to `docs/index.md` and the documentation is automatically published to the GitHub
68-
pages location for this repository using a GitHub Action workflow. It does not use the `gh-pages` branch.
69-
70-
71-
## Use Cases
72-
73-
- We are testing our [Terraform](https://www.terraform.io/) code with Jenkins. Sometimes a Terraform run fails during development and
74-
messes up the account. With *aws-nuke* we can simply clean up the failed account, so it can be reused for the next
75-
build.
76-
- Our platform developers have their own AWS Accounts where they can create their own Kubernetes clusters for testing
77-
purposes. With *aws-nuke* it is very easy to clean up these account at the end of the day and keep the costs low.
78-
79-
80-
### Feature Flags
81-
82-
There are some features, which are quite opinionated. To make those work for
83-
everyone, *aws-nuke* has flags to manually enable those features. These can be
84-
configured on the root-level of the config, like this:
85-
86-
```yaml
87-
---
88-
feature-flags:
89-
disable-deletion-protection:
90-
RDSInstance: true
91-
EC2Instance: true
92-
CloudformationStack: true
93-
force-delete-lightsail-addons: true
94-
```
95-
96-
## Contact Channels
97-
98-
For now GitHub issues, may open a Slack or Discord if warranted.
99-
100-
## Contribute
101-
102-
You can contribute to *aws-nuke* by forking this repository, making your
103-
changes and creating a Pull Request against our repository. If you are unsure
104-
how to solve a problem or have other questions about a contributions, please
105-
create a GitHub issue.

0 commit comments

Comments
 (0)