Skip to content

Commit

Permalink
Merge pull request #35 from turbot/release/v1.0.1
Browse files Browse the repository at this point in the history
Release/v1.0.1
  • Loading branch information
misraved authored Nov 28, 2024
2 parents 171f680 + 06058fd commit cb7bf07
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## v1.0.1 (2024-11-28)

_Enhancements_

- Updated the README to include the latest mod installation instructions. ([#34](https://github.com/turbot/flowpipe-mod-aws-tags/pull/34))

## v1.0.0 (2024-10-22)

_Breaking changes_
Expand Down
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,12 @@ connection_import "aws" {

For more information on connections in Flowpipe, please see [Managing Connections](https://flowpipe.io/docs/run/connections).

Clone the mod:
Install the mod:

```sh
mkdir aws-tags
cd aws-tags
git clone git@github.com:turbot/flowpipe-mod-aws-tags.git
```

Install the dependencies:

```sh
flowpipe mod install
flowpipe mod install github.com/turbot/flowpipe-mod-aws-tags
```

### Configuration
Expand Down Expand Up @@ -442,7 +436,7 @@ flowpipe pipeline list | grep "detect_and_correct"

Then run your chosen pipeline, for example if we wish to remediate tags on our `S3 buckets`:
```sh
flowpipe pipeline run detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars
flowpipe pipeline run aws_tags.pipeline.detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars
```

This will then run the pipeline and depending on your configured running mode; perform the relevant action(s), there are 3 running modes:
Expand Down Expand Up @@ -470,7 +464,7 @@ base_tag_rules = ... # omitted for brevity
or pass the `approvers` and `default_action` arguments on the command-line.

```sh
flowpipe pipeline run detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars --arg='default_action=notify' --arg='approvers=[]'
flowpipe pipeline run aws_tags.pipeline.detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars --arg='default_action=notify' --arg='approvers=[]'
```

#### Automatic
Expand All @@ -488,7 +482,7 @@ base_tag_rules = ... # omitted for brevity
or pass the `default_action` argument on the command-line.

```sh
flowpipe pipeline run detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars --arg='default_action=apply'
flowpipe pipeline run aws_tags.pipeline.detect_and_correct_s3_buckets_with_incorrect_tags --var-file flowpipe.fpvars --arg='default_action=apply'
```

To further enhance this approach, you can enable the pipelines corresponding [query trigger](#running-query-triggers) to run completely hands-off.
Expand Down

0 comments on commit cb7bf07

Please sign in to comment.