Skip to content

Commit 7241e73

Browse files
authored
Update README.md and docs
1 parent 71a267b commit 7241e73

File tree

1 file changed

+48
-152
lines changed

1 file changed

+48
-152
lines changed

README.md

Lines changed: 48 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,7 @@ __CodePipeline__ will:
6161
---
6262

6363
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
64-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
65-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
66-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
67-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
68-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
69-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
70-
71-
72-
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules]
73-
64+
<a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
7465

7566

7667
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -88,37 +79,18 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are
8879

8980

9081

91-
## Security & Compliance [<img src="https://cloudposse.com/wp-content/uploads/2020/11/bridgecrew.svg" width="250" align="right" />](https://bridgecrew.io/)
92-
93-
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
94-
95-
| Benchmark | Description |
96-
|--------|---------------|
97-
| [![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=INFRASTRUCTURE+SECURITY) | Infrastructure Security Compliance |
98-
| [![CIS KUBERNETES](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=CIS+KUBERNETES+V1.5) | Center for Internet Security, KUBERNETES Compliance |
99-
| [![CIS AWS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=CIS+AWS+V1.2) | Center for Internet Security, AWS Compliance |
100-
| [![CIS AZURE](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=CIS+AZURE+V1.1) | Center for Internet Security, AZURE Compliance |
101-
| [![PCI-DSS](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=PCI-DSS+V3.2) | Payment Card Industry Data Security Standards Compliance |
102-
| [![NIST-800-53](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=NIST-800-53) | National Institute of Standards and Technology Compliance |
103-
| [![ISO27001](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=ISO27001) | Information Security Management System, ISO/IEC 27001 Compliance |
104-
| [![SOC2](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=SOC2)| Service Organization Control 2 Compliance |
105-
| [![CIS GCP](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=CIS+GCP+V1.1) | Center for Internet Security, GCP Compliance |
106-
| [![HIPAA](https://www.bridgecrew.cloud/badges/github/cloudposse/terraform-aws-jenkins/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=cloudposse%2Fterraform-aws-jenkins&benchmark=HIPAA) | Health Insurance Portability and Accountability Compliance |
107-
108-
10982

11083
## Usage
11184

11285

113-
**IMPORTANT:** We do not pin modules to versions in our examples because of the
114-
difficulty of keeping the versions in the documentation in sync with the latest released versions.
115-
We highly recommend that in your code you pin the version to the exact version you are
116-
using so that your infrastructure remains stable, and update versions in a
117-
systematic way so that they do not catch you by surprise.
11886

119-
Also, because of a bug in the Terraform registry ([hashicorp/terraform#21417](https://github.com/hashicorp/terraform/issues/21417)),
120-
the registry shows many of our inputs as required when in fact they are optional.
121-
The table below correctly indicates which inputs are required.
87+
> **Important**
88+
> We do not pin modules to versions in our examples because of the
89+
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
90+
> We highly recommend that in your code you pin the version to the exact version you are
91+
> using so that your infrastructure remains stable, and update versions in a
92+
> systematic way so that they do not catch you by surprise.
93+
12294

12395

12496
For a complete example, see [examples/complete](examples/complete).
@@ -370,15 +342,6 @@ Available targets:
370342
<!-- markdownlint-restore -->
371343

372344

373-
374-
## Share the Love
375-
376-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-jenkins)! (it helps us **a lot**)
377-
378-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
379-
380-
381-
382345
## Related Projects
383346

384347
Check out these related projects.
@@ -391,81 +354,70 @@ Check out these related projects.
391354
- [terraform-aws-cicd](https://github.com/cloudposse/terraform-aws-cicd) - Terraform Module for CI/CD with AWS Code Pipeline and Code Build
392355
- [terraform-aws-codebuild](https://github.com/cloudposse/terraform-aws-codebuild) - Terraform Module to easily leverage AWS CodeBuild for Continuous Integration
393356

394-
## Help
357+
## ✨ Contributing
395358

396-
**Got a question?** We got answers.
359+
This project is under active development, and we encourage contributions from our community.
360+
Many thanks to our outstanding contributors:
397361

398-
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-jenkins/issues), send us an [email][email] or join our [Slack Community][slack].
362+
<a href="https://github.com/cloudposse/terraform-aws-jenkins/graphs/contributors">
363+
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-jenkins&max=24" />
364+
</a>
399365

400-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
366+
### 🐛 Bug Reports & Feature Requests
401367

402-
## DevOps Accelerator for Startups
368+
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-jenkins/issues) to report any bugs or file feature requests.
403369

370+
### 💻 Developing
404371

405-
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.
406-
407-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
372+
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
408373

409-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
374+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
410375

411-
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.
376+
1. **Fork** the repo on GitHub
377+
2. **Clone** the project to your own machine
378+
3. **Commit** changes to your own branch
379+
4. **Push** your work back up to your fork
380+
5. Submit a **Pull Request** so that we can review your changes
412381

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

424-
## Slack Community
384+
### 🌎 Slack Community
425385

426386
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.
427387

428-
## Discourse Forums
429-
430-
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.
431-
432-
## Newsletter
388+
### 📰 Newsletter
433389

434390
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.
435391

436-
## Office Hours
392+
### 📆 Office Hours <img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" />
437393

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

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

442-
## Contributing
443-
444-
### Bug Reports & Feature Requests
445-
446-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-jenkins/issues) to report any bugs or file feature requests.
447-
448-
### Developing
449-
450-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
451-
452-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
453-
454-
1. **Fork** the repo on GitHub
455-
2. **Clone** the project to your own machine
456-
3. **Commit** changes to your own branch
457-
4. **Push** your work back up to your fork
458-
5. Submit a **Pull Request** so that we can review your changes
459-
460-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
398+
This project is maintained and funded by [Cloud Posse, LLC][website].
399+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
461400

401+
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.
462402

463-
## Copyright
403+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
464404

465-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
405+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
466406

407+
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.
467408

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

420+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
469421
## License
470422

471423
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -491,58 +443,11 @@ specific language governing permissions and limitations
491443
under the License.
492444
```
493445

494-
495-
496-
497-
498-
499-
500-
501-
502446
## Trademarks
503447

504448
All other trademarks referenced herein are the property of their respective owners.
505-
506-
## About
507-
508-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
509-
510-
[![Cloud Posse][logo]][website]
511-
512-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
513-
514-
We offer [paid support][commercial_support] on all of our projects.
515-
516-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
517-
518-
519-
520-
### Contributors
521-
522-
<!-- markdownlint-disable -->
523-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Ivan Pinatti][ivan-pinatti_avatar]][ivan-pinatti_homepage]<br/>[Ivan Pinatti][ivan-pinatti_homepage] | [![Sergey Vasilyev][s2504s_avatar]][s2504s_homepage]<br/>[Sergey Vasilyev][s2504s_homepage] | [![RB][nitrocode_avatar]][nitrocode_homepage]<br/>[RB][nitrocode_homepage] |
524-
|---|---|---|---|---|---|
525-
<!-- markdownlint-restore -->
526-
527-
528-
[osterman_homepage]: https://github.com/osterman
529-
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
530-
531-
[aknysh_homepage]: https://github.com/aknysh/
532-
[aknysh_avatar]: https://img.cloudposse.com/150x150/https://github.com/aknysh.png
533-
534-
[goruha_homepage]: https://github.com/goruha/
535-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
536-
537-
[ivan-pinatti_homepage]: https://github.com/ivan-pinatti/
538-
[ivan-pinatti_avatar]: https://img.cloudposse.com/150x150/https://github.com/ivan-pinatti.png
539-
540-
[s2504s_homepage]: https://github.com/s2504s/
541-
[s2504s_avatar]: https://img.cloudposse.com/150x150/https://github.com/s2504s.png
542-
543-
[nitrocode_homepage]: https://github.com/nitrocode/
544-
[nitrocode_avatar]: https://img.cloudposse.com/150x150/https://github.com/nitrocode.png
545-
449+
---
450+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
546451
[![README Footer][readme_footer_img]][readme_footer_link]
547452
[![Beacon][beacon]][website]
548453
<!-- markdownlint-disable -->
@@ -553,12 +458,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
553458
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=jobs
554459
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=hire
555460
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=slack
556-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=linkedin
557461
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=twitter
558-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=testimonial
559462
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=office_hours
560463
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=newsletter
561-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=discourse
562464
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=email
563465
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=commercial_support
564466
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=we_love_open_source
@@ -569,11 +471,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
569471
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=readme_footer_link
570472
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
571473
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-jenkins&utm_content=readme_commercial_support_link
572-
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-aws-jenkins&url=https://github.com/cloudposse/terraform-aws-jenkins
573-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-aws-jenkins&url=https://github.com/cloudposse/terraform-aws-jenkins
574-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-aws-jenkins
575-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/terraform-aws-jenkins
576-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/terraform-aws-jenkins
577-
[share_email]: mailto:?subject=terraform-aws-jenkins&body=https://github.com/cloudposse/terraform-aws-jenkins
578474
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-jenkins?pixel&cs=github&cm=readme&an=terraform-aws-jenkins
579475
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)