Skip to content

Commit f6086ba

Browse files
vadim-gleifvadim-gleif
authored
Migrate readme yaml (#3)
* Migrate readme yaml
1 parent 71c119a commit f6086ba

File tree

2 files changed

+164
-30
lines changed

2 files changed

+164
-30
lines changed

‎README.md‎

Lines changed: 96 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,86 @@
1-
![Cloud Posse](https://cloudposse.com/logo-300x69.png)
1+
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
3+
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
4+
5+
# default-backend [![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse)](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse) [![Latest Release](https://img.shields.io/github/release/cloudposse/default-backend.svg)](https://github.com/cloudposse/default-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
26

3-
# default-backend ![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
47

58
This is a default-backend server powered by Nginx. It's purpuse is to serve as a default backend for an ALB default target group with the [`terraform-aws-alb`](https://github.com/cloudposse/terraform-aws-alb) module , much the way a [`nginx-default-backend`](https://github.com/cloudposse/charts/blob/master/incubator/nginx-default-backend/) is used with ingress controllers for kubernetes.
69

710
The default backend is an HTTP service that handles all URL paths and hosts that the ALB does not understand (i.e., all the requests that are not mapped with an Ingress).
811

9-
Basically, a default backend reponds to two URLs:
12+
Basically, a default backend responds to two URLs:
1013

1114
- `/healthz` that returns 200
1215
- `/` that returns 404
1316

14-
## Demo
1517

16-
![Screenshot](docs/demo.png)
18+
---
19+
20+
This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.
21+
22+
23+
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
24+
25+
26+
27+
28+
## Screenshots
29+
30+
31+
![Demo](docs/demo.png)
32+
*Example of the default 404 status page returned by backend*
33+
1734

1835
## Usage
1936

2037
```
2138
docker run -p 1234:80 clouposse/default-backend:latest
2239
```
2340

41+
42+
43+
44+
45+
46+
47+
48+
## Related Projects
49+
50+
Check out these related projects.
51+
52+
- [terraform-aws-alb](https://github.com/cloudposse/terraform-aws-alb) - Terraform module to provision a standard ALB for HTTP/HTTP traffic
53+
- [terraform-aws-alb-ingress](https://github.com/cloudposse/terraform-aws-alb-ingress) - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups
54+
- [terraform-aws-ecs-web-app](https://github.com/cloudposse/terraform-aws-ecs-web-app) - Terraform module that implements a web app on ECS and supporting AWS resources.
55+
56+
57+
2458
## Help
2559

2660
**Got a question?**
2761

28-
File a GitHub [issue](https://github.com/cloudposse/default-backend/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Slack](https://slack.cloudposse.com).
62+
File a GitHub [issue](https://github.com/cloudposse/default-backend/issues), send us an [email][email] or join our [Slack Community][slack].
63+
64+
## Commerical Support
65+
66+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
67+
68+
We provide *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 fulltime engineer.
69+
70+
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com)
71+
72+
- **Questions.** We'll use a Shared Slack channel between your team and ours.
73+
- **Troubleshooting.** We'll help you triage why things aren't working.
74+
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
75+
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
76+
- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
77+
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
78+
- **Implementation.** We'll provide hands on support to implement our reference architectures.
79+
80+
81+
## Community Forum
82+
83+
Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join 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 *sweet* infrastructure.
2984

3085
## Contributing
3186

@@ -35,22 +90,28 @@ Please use the [issue tracker](https://github.com/cloudposse/default-backend/iss
3590

3691
### Developing
3792

38-
If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
93+
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
3994

4095
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
4196

4297
1. **Fork** the repo on GitHub
4398
2. **Clone** the project to your own machine
4499
3. **Commit** changes to your own branch
45100
4. **Push** your work back up to your fork
46-
5. Submit a **Pull request** so that we can review your changes
101+
5. Submit a **Pull Request** so that we can review your changes
102+
103+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
104+
105+
106+
## Copyright
47107

48-
**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
108+
Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
49109

50110

51-
## License
52111

53-
[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
112+
## License
113+
114+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
54115

55116
See [LICENSE](LICENSE) for full details.
56117

@@ -62,7 +123,7 @@ See [LICENSE](LICENSE) for full details.
62123
"License"); you may not use this file except in compliance
63124
with the License. You may obtain a copy of the License at
64125

65-
http://www.apache.org/licenses/LICENSE-2.0
126+
https://www.apache.org/licenses/LICENSE-2.0
66127

67128
Unless required by applicable law or agreed to in writing,
68129
software distributed under the License is distributed on an
@@ -72,34 +133,39 @@ See [LICENSE](LICENSE) for full details.
72133
under the License.
73134

74135

136+
## Trademarks
137+
138+
All other trademarks referenced herein are the property of their respective owners.
139+
75140
## About
76141

77-
This project is maintained and funded by [Cloud Posse, LLC][website].
142+
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
78143

79-
![Cloud Posse](https://cloudposse.com/logo-300x69.png)
144+
[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
80145

81-
Like it? Please let us know at <hello@cloudposse.com>
146+
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
82147

83-
We love [Open Source Software](https://github.com/cloudposse/)!
148+
We offer paid support on all of our projects.
84149

85-
See [our other projects][community]
86-
or [hire us][hire] to help build your next cloud platform.
150+
Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
87151

152+
[docs]: https://docs.cloudposse.com/
88153
[website]: https://cloudposse.com/
89-
[community]: https://github.com/cloudposse/
154+
[github]: https://github.com/cloudposse/
155+
[jobs]: https://cloudposse.com/jobs/
90156
[hire]: https://cloudposse.com/contact/
157+
[slack]: https://slack.cloudposse.com/
158+
[linkedin]: https://www.linkedin.com/company/cloudposse
159+
[twitter]: https://twitter.com/cloudposse/
160+
[email]: mailto:hello@cloudposse.com
161+
162+
163+
### Contributors
91164

165+
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] |
166+
|---|
92167

93-
## Contributors
168+
[osterman_homepage]: https://github.com/osterman
169+
[osterman_avatar]: https://github.com/osterman.png?size=150
94170

95-
| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |[![Igor Rodionov][igor_img]][igor_web]<br/>[Igor Rodionov][igor_img]|[![Sarkis Varozian][sarkis_img]][sarkis_web]<br/>[Sarkis Varozian][sarkis_web] |
96-
|-------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|
97171

98-
[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
99-
[erik_web]: https://github.com/osterman/
100-
[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
101-
[andriy_web]: https://github.com/aknysh/
102-
[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
103-
[igor_web]: https://github.com/goruha/
104-
[sarkis_img]: https://avatars3.githubusercontent.com/u/42673?s=144&v=4
105-
[sarkis_web]: https://github.com/sarkis/

‎README.yaml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
#
3+
# This is the canonical configuration for the `README.md`
4+
# Run `make readme` to rebuild the `README.md`
5+
#
6+
7+
# Name of this project
8+
name: default-backend
9+
10+
# Logo for this project
11+
#logo: docs/logo.png
12+
13+
# License of this project
14+
license: "APACHE2"
15+
16+
# Canonical GitHub repo
17+
github_repo: cloudposse/default-backend
18+
19+
# Badges to display
20+
badges:
21+
- name: "Build Status"
22+
image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse"
23+
url: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse"
24+
- name: "Latest Release"
25+
image: "https://img.shields.io/github/release/cloudposse/default-backend.svg"
26+
url: "https://github.com/cloudposse/default-backend/releases/latest"
27+
- name: "Slack Community"
28+
image: "https://slack.cloudposse.com/badge.svg"
29+
url: "https://slack.cloudposse.com"
30+
31+
related:
32+
- name: "terraform-aws-alb"
33+
description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic"
34+
url: "https://github.com/cloudposse/terraform-aws-alb"
35+
- name: "terraform-aws-alb-ingress"
36+
description: "Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups"
37+
url: "https://github.com/cloudposse/terraform-aws-alb-ingress"
38+
- name: "terraform-aws-ecs-web-app"
39+
description: "Terraform module that implements a web app on ECS and supporting AWS resources."
40+
url: "https://github.com/cloudposse/terraform-aws-ecs-web-app"
41+
42+
# Short description of this project
43+
description: |-
44+
This is a default-backend server powered by Nginx. It's purpuse is to serve as a default backend for an ALB default target group with the [`terraform-aws-alb`](https://github.com/cloudposse/terraform-aws-alb) module , much the way a [`nginx-default-backend`](https://github.com/cloudposse/charts/blob/master/incubator/nginx-default-backend/) is used with ingress controllers for kubernetes.
45+
46+
The default backend is an HTTP service that handles all URL paths and hosts that the ALB does not understand (i.e., all the requests that are not mapped with an Ingress).
47+
48+
Basically, a default backend responds to two URLs:
49+
50+
- `/healthz` that returns 200
51+
- `/` that returns 404
52+
53+
screenshots:
54+
- name: "Demo"
55+
description: "Example of the default 404 status page returned by backend"
56+
url: "docs/demo.png"
57+
58+
# How to use this project
59+
usage: |-
60+
```
61+
docker run -p 1234:80 clouposse/default-backend:latest
62+
```
63+
64+
65+
# Contributors to this project
66+
contributors:
67+
- name: "Erik Osterman"
68+
github: "osterman"

0 commit comments

Comments
 (0)