-
-
Notifications
You must be signed in to change notification settings - Fork 9
Migrate readme yaml #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| # | ||
| # This is the canonical configuration for the `README.md` | ||
| # Run `make readme` to rebuild the `README.md` | ||
| # | ||
|
|
||
| # Name of this project | ||
| name: default-backend | ||
|
|
||
| # Logo for this project | ||
| #logo: docs/logo.png | ||
|
|
||
| # License of this project | ||
| license: "APACHE2" | ||
|
|
||
| # Canonical GitHub repo | ||
| github_repo: cloudposse/default-backend | ||
|
|
||
| # Badges to display | ||
| badges: | ||
| - name: "Build Status" | ||
| image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse" | ||
| url: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=default-backend&branch=master&pipelineName=default-backend&accountName=cloudposse" | ||
| - name: "Latest Release" | ||
| image: "https://img.shields.io/github/release/cloudposse/default-backend.svg" | ||
| url: "https://github.com/cloudposse/default-backend/releases/latest" | ||
| - name: "Slack Community" | ||
| image: "https://slack.cloudposse.com/badge.svg" | ||
| url: "https://slack.cloudposse.com" | ||
|
|
||
| related: | ||
| - name: "terraform-aws-alb" | ||
| description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic" | ||
| url: "https://github.com/cloudposse/terraform-aws-alb" | ||
| - name: "terraform-aws-alb-ingress" | ||
| description: "Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB using target groups" | ||
| url: "https://github.com/cloudposse/terraform-aws-alb-ingress" | ||
| - name: "terraform-aws-ecs-web-app" | ||
| description: "Terraform module that implements a web app on ECS and supporting AWS resources." | ||
| url: "https://github.com/cloudposse/terraform-aws-ecs-web-app" | ||
|
|
||
| # Short description of this project | ||
| description: |- | ||
| 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. | ||
|
|
||
| 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). | ||
|
|
||
| Basically, a default backend responds to two URLs: | ||
|
|
||
| - `/healthz` that returns 200 | ||
| - `/` that returns 404 | ||
|
|
||
| screenshots: | ||
| - name: "Demo" | ||
| description: "Example of the default 404 status page returned by backend" | ||
| url: "docs/demo.png" | ||
|
|
||
| # How to use this project | ||
| usage: |- | ||
| ``` | ||
| docker run -p 1234:80 clouposse/default-backend:latest | ||
| ``` | ||
|
|
||
|
|
||
| # Contributors to this project | ||
| contributors: | ||
| - name: "Erik Osterman" | ||
| github: "osterman" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add alb-ingress and ecs-web-app modules