Skip to content

Commit 993d01a

Browse files
authored
Update README.md and docs
1 parent 622f819 commit 993d01a

File tree

1 file changed

+38
-157
lines changed

1 file changed

+38
-157
lines changed

README.md

+38-157
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# bastion [![Latest Release](https://img.shields.io/github/release/cloudposse/bastion.svg)](https://github.com/cloudposse/bastion/releases/latest) [![Build & Test Status](https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4+
# bastion <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
<a href="https://github.com/cloudposse/bastion/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/bastion.svg" alt="Latest Release"/></a><a href="https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml"><img src="https://github.com/cloudposse/bastion/actions/workflows/integration-tests.yml/badge.svg" alt="Build & Test Status"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
46
<!-- markdownlint-restore -->
57

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
108
<!--
119
1210
1311
1412
1513
** DO NOT EDIT THIS FILE
1614
**
17-
** This file was automatically generated by the `build-harness`.
15+
** This file was automatically generated by the `cloudposse/build-harness`.
1816
** 1) Make all changes to `README.yaml`
1917
** 2) Run `make init` (you only need to do this once)
2018
** 3) Run`make readme` to rebuild this file.
@@ -51,30 +49,6 @@ We recommend using Slack notifications for self-reporting.
5149
* A "buddy" should approve the login by adding a reaction (e.g. ✅).
5250
* If no one approves the login, it should trigger an *incident response* to track down the unauthorized access.
5351

54-
---
55-
56-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
57-
[<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]
58-
[<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]
59-
[<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]
60-
[<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]
61-
[<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]
62-
[<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]
63-
64-
65-
66-
67-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
68-
69-
70-
71-
72-
73-
74-
75-
76-
77-
7852

7953

8054

@@ -83,8 +57,6 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
8357

8458
## Usage
8559

86-
87-
8860
### Running
8961

9062
Refer to the [Environment Variables](#environment-variables) section below to tune how the `bastion` operates.
@@ -207,6 +179,7 @@ You can extend the enforcement policies by adding shell scripts to `etc/enforce.
207179
- [@duo](https://duo.com/docs/duounix), for providing excellent documentation
208180
- [@google](https://github.com/google/google-authenticator-libpam) for contributing Google Authenticator to the Open Source community
209181

182+
210183
## Quick Start
211184

212185

@@ -233,86 +206,53 @@ The first time you connect, you'll be asked to setup your MFA device. Subsequent
233206

234207

235208

236-
## Help
237-
238-
**Got a question?** We got answers.
239-
240-
File a GitHub [issue](https://github.com/cloudposse/bastion/issues), send us an [email][email] or join our [Slack Community][slack].
241-
242-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
243-
244-
## DevOps Accelerator for Startups
245-
246-
247-
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.
248-
249-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
250-
251-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
252-
253-
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.
209+
## ✨ Contributing
254210

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

266-
## Slack Community
267213

268-
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.
269214

270-
## Discourse Forums
215+
Many thanks to our outstanding contributors:
271216

272-
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.
217+
<a href="https://github.com/cloudposse/bastion/graphs/contributors">
218+
<img src="https://contrib.rocks/image?repo=cloudposse/bastion&max=24" />
219+
</a>
273220

274-
## Newsletter
275-
276-
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.
277-
278-
## Office Hours
279-
280-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
281-
282-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
283-
284-
## Contributing
285-
286-
### Bug Reports & Feature Requests
287-
288-
Please use the [issue tracker](https://github.com/cloudposse/bastion/issues) to report any bugs or file feature requests.
289-
290-
### Developing
291-
292-
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].
221+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/bastion/issues).
293222

294223
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
295-
296-
1. **Fork** the repo on GitHub
297-
2. **Clone** the project to your own machine
298-
3. **Commit** changes to your own branch
299-
4. **Push** your work back up to your fork
300-
5. Submit a **Pull Request** so that we can review your changes
224+
1. Review our [Code of Conduct](https://github.com/cloudposse/bastion/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
225+
2. **Fork** the repo on GitHub
226+
3. **Clone** the project to your own machine
227+
4. **Commit** changes to your own branch
228+
5. **Push** your work back up to your fork
229+
6. Submit a **Pull Request** so that we can review your changes
301230

302231
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
303232

233+
### 🌎 Slack Community
304234

305-
## Copyright
235+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=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.
306236

307-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
237+
### 📰 Newsletter
308238

239+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
240+
Dropped straight into your Inbox every week — and usually a 5-minute read.
309241

242+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=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" /></a>
310243

244+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
245+
It's **FREE** for everyone!
311246
## License
312247

313-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
248+
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
314249

315-
See [LICENSE](LICENSE) for full details.
250+
<details>
251+
<summary>Preamble to the Apache License, Version 2.0</summary>
252+
<br/>
253+
<br/>
254+
255+
Complete license is available in the [`LICENSE`](LICENSE) file.
316256

317257
```text
318258
Licensed to the Apache Software Foundation (ASF) under one
@@ -332,76 +272,17 @@ KIND, either express or implied. See the License for the
332272
specific language governing permissions and limitations
333273
under the License.
334274
```
335-
336-
337-
338-
339-
340-
341-
342-
275+
</details>
343276

344277
## Trademarks
345278

346279
All other trademarks referenced herein are the property of their respective owners.
347280

348-
## About
349-
350-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
351-
352-
[![Cloud Posse][logo]][website]
353-
354-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
355-
356-
We offer [paid support][commercial_support] on all of our projects.
357-
358-
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.
359-
360281

282+
---
283+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
361284

362-
### Contributors
363285

364-
<!-- markdownlint-disable -->
365-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Marji Cermak][marji_avatar]][marji_homepage]<br/>[Marji Cermak][marji_homepage] |
366-
|---|---|
367-
<!-- markdownlint-restore -->
286+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
368287

369-
[osterman_homepage]: https://github.com/osterman
370-
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
371-
[marji_homepage]: https://github.com/marji
372-
[marji_avatar]: https://img.cloudposse.com/150x150/https://github.com/marji.png
373-
374-
[![README Footer][readme_footer_img]][readme_footer_link]
375-
[![Beacon][beacon]][website]
376-
<!-- markdownlint-disable -->
377-
[logo]: https://cloudposse.com/logo-300x69.svg
378-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=docs
379-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=website
380-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=github
381-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=jobs
382-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=hire
383-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=slack
384-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=linkedin
385-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=twitter
386-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=testimonial
387-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=office_hours
388-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=newsletter
389-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=discourse
390-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=email
391-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=commercial_support
392-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=we_love_open_source
393-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=terraform_modules
394-
[readme_header_img]: https://cloudposse.com/readme/header/img
395-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_header_link
396-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
397-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_footer_link
398-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
399-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/bastion&utm_content=readme_commercial_support_link
400-
[share_twitter]: https://twitter.com/intent/tweet/?text=bastion&url=https://github.com/cloudposse/bastion
401-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=bastion&url=https://github.com/cloudposse/bastion
402-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/bastion
403-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/bastion
404-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/bastion
405-
[share_email]: mailto:?subject=bastion&body=https://github.com/cloudposse/bastion
406-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/bastion?pixel&cs=github&cm=readme&an=bastion
407-
<!-- markdownlint-restore -->
288+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/bastion?pixel&cs=github&cm=readme&an=bastion"/>

0 commit comments

Comments
 (0)