Skip to content

Commit

Permalink
Add -no-color flag to readme cmds (#18)
Browse files Browse the repository at this point in the history 
* Add -no-color flag to readme cmds

* Generated README.md from build_harness

Co-authored-by: Erik Osterman <[email protected]>
  • Loading branch information
@osterman
Chris Every and osterman authored Jul 1, 2020
1 parent cc54476 commit 8550034
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 47 deletions.
141 changes: 97 additions & 44 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,43 @@
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
<!--
** DO NOT EDIT THIS FILE
**
** This file was automatically generated by the `build-harness`.
** 1) Make all changes to `README.yaml`
** 2) Run `make init` (you only need to do this once)
** 3) Run`make readme` to rebuild this file.
**
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
**
-->
[![README Header][readme_header_img]][readme_header_link]

[![Cloud Posse][logo]](https://cpco.io/homepage)
Expand Down Expand Up @@ -60,6 +99,8 @@ __NOTE__: `tfmask` will preserve the name of the nodes in the graph
## Usage




__NOTE__: The utility supports a number of configuration settings which can be passed via environment variables.

| Environment Variable | Description | Default |
Expand All @@ -73,7 +114,7 @@ __IMPORTANT__: Pass `-no-color` to `terraform plan` and `terraform apply` for pr
The basic usage looks like this. We're going to run `terraform plan` and filter it through `tfmask`:

```sh
terraform plan | tfmask
terraform plan -no-color | tfmask
```

### Direnv
Expand All @@ -85,7 +126,7 @@ Example `.envrc`:
```sh
# Export terraform environment
export TFMASK_CHAR="#"
export TFMASK_VALUES_REGEX="(?i)^.*(secret|password|oauth|token|key).*$"
export TFMASK_VALUES_REGEX="(?i)^.*(oauth|secret|token|password|key|result).*$"
```

<details>
Expand Down Expand Up @@ -140,7 +181,7 @@ make go/build
Using `tfmask`, the output from `terraform plan` will be masked like this:

```sh
terraform plan | tfmask
terraform plan -no-color | tfmask
```

<details>
Expand Down Expand Up @@ -183,7 +224,7 @@ Many terraform providers unintentionally leak sensitive information when running
Using `tfmask`, the output from `terraform apply` will be masked like this:

```sh
terraform apply | tfmask
terraform apply -no-color | tfmask
```
<details>
<summary>Example of Masked Terraform Apply Output</summary>
Expand Down Expand Up @@ -223,38 +264,51 @@ Check out these related projects.

## Help

**Got a question?**
**Got a question?** We got answers.

File a GitHub [issue](https://github.com/cloudposse/tfmask/issues), send us an [email][email] or join our [Slack Community][slack].

[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]

## Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.
## DevOps Accelerator for Startups

We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

[![E-Mail](https://img.shields.io/badge/[email protected])][email]
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

- **Questions.** We'll use a Shared Slack channel between your team and ours.
- **Troubleshooting.** We'll help you triage why things aren't working.
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
- **Training.** You'll receive hands-on training so your team can operate what we build.
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
- **Troubleshooting.** You'll get help to triage when things aren't working.
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.

## Slack Community

Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.

## Discourse Forums

Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

## Newsletter

Signup for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

## Office Hours

[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!

[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]

## Contributing

Expand All @@ -279,7 +333,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

## Copyright

Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)



Expand Down Expand Up @@ -339,35 +393,34 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply


[osterman_homepage]: https://github.com/osterman
[osterman_avatar]: https://github.com/osterman.png?size=150


[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png

[![README Footer][readme_footer_img]][readme_footer_link]
[![Beacon][beacon]][website]

[logo]: https://cloudposse.com/logo-300x69.svg
[docs]: https://cpco.io/docs
[website]: https://cpco.io/homepage
[github]: https://cpco.io/github
[jobs]: https://cpco.io/jobs
[hire]: https://cpco.io/hire
[slack]: https://cpco.io/slack
[linkedin]: https://cpco.io/linkedin
[twitter]: https://cpco.io/twitter
[testimonial]: https://cpco.io/leave-testimonial
[newsletter]: https://cpco.io/newsletter
[email]: https://cpco.io/email
[commercial_support]: https://cpco.io/commercial-support
[we_love_open_source]: https://cpco.io/we-love-open-source
[module_development]: https://cpco.io/module-development
[terraform_modules]: https://cpco.io/terraform-modules
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/tfmask
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/tfmask
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/tfmask
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/tfmask
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/tfmask
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/tfmask
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=docs
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=website
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=github
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=jobs
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=hire
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=slack
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=linkedin
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=twitter
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=testimonial
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=office_hours
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=newsletter
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=discourse
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=email
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=commercial_support
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=we_love_open_source
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=terraform_modules
[readme_header_img]: https://cloudposse.com/readme/header/img
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_header_link
[readme_footer_img]: https://cloudposse.com/readme/footer/img
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_footer_link
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_commercial_support_link
[share_twitter]: https://twitter.com/intent/tweet/?text=tfmask&url=https://github.com/cloudposse/tfmask
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=tfmask&url=https://github.com/cloudposse/tfmask
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/tfmask
Expand Down
6 changes: 3 additions & 3 deletions README.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ usage: |-
The basic usage looks like this. We're going to run `terraform plan` and filter it through `tfmask`:
```sh
terraform plan | tfmask
terraform plan -no-color | tfmask
```
### Direnv
Expand Down Expand Up @@ -152,7 +152,7 @@ examples: |-
Using `tfmask`, the output from `terraform plan` will be masked like this:
```sh
terraform plan | tfmask
terraform plan -no-color | tfmask
```
<details>
Expand Down Expand Up @@ -195,7 +195,7 @@ examples: |-
Using `tfmask`, the output from `terraform apply` will be masked like this:
```sh
terraform apply | tfmask
terraform apply -no-color | tfmask
```
<details>
<summary>Example of Masked Terraform Apply Output</summary>
Expand Down

0 comments on commit 8550034

Please sign in to comment.