Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
BretFisher committed Dec 4, 2024
0 parents commit d85adff
Show file tree
Hide file tree
Showing 9 changed files with 490 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
13 changes: 13 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# MD013/line-length - Line length
MD013:
# Number of characters, default is 80
# I'm OK with long lines. All editors now have wordwrap
line_length: 9999
# Number of characters for headings
heading_line_length: 100
# check code blocks?
code_blocks: false
# MD033/no-inline-html - Inline HTML
MD033:
# Allowed elements
allowed_elements: ['img']
53 changes: 53 additions & 0 deletions .github/linters/.yaml-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
###########################################
# These are the rules used for #
# linting all the yaml files in the stack #
# NOTE: #
# You can disable line with: #
# # yamllint disable-line #
###########################################
rules:
braces:
level: warning
min-spaces-inside: 0
max-spaces-inside: 0
min-spaces-inside-empty: 0
max-spaces-inside-empty: 5
brackets:
level: warning
min-spaces-inside: 0
max-spaces-inside: 0
min-spaces-inside-empty: 0
max-spaces-inside-empty: 5
colons:
level: warning
max-spaces-before: 0
max-spaces-after: 1
commas:
level: warning
max-spaces-before: 0
min-spaces-after: 1
max-spaces-after: 1
comments: disable
comments-indentation: disable
document-end: disable
document-start: disable
empty-lines:
level: warning
max: 2
max-start: 0
max-end: 0
hyphens:
level: warning
max-spaces-after: 1
indentation:
level: warning
spaces: consistent
indent-sequences: true
check-multi-line-strings: false
key-duplicates: enable
line-length: disable
new-line-at-end-of-file: disable
new-lines:
type: unix
trailing-spaces: disable
29 changes: 29 additions & 0 deletions .github/workflows/awesome-lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# source: https://github.com/sindresorhus/awesome-lint

name: Awesome Lint

on:

push:
branches: [main]

pull_request:

jobs:

Awesome_Lint:

name: Awesome Lint

permissions:
contents: read # clone the repo to lint

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4
with:
fetch-depth: 0

- run: npx awesome-lint
37 changes: 37 additions & 0 deletions .github/workflows/call-super-linter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# template source: https://github.com/bretfisher/super-linter-workflow/blob/main/templates/call-super-linter.yaml
name: Lint Code Base

on:

push:
branches: [main]

pull_request:

jobs:
call-super-linter:

name: Call Super-Linter

permissions:
contents: read # clone the repo to lint
statuses: write #read/write to repo custom statuses

### use Reusable Workflows to call my workflow remotely
### https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
### you can also call workflows from inside the same repo via file path

#FIXME: customize uri to point to your own linter repository
uses: bretfisher/super-linter-workflow/.github/workflows/reusable-super-linter.yaml@main

### Optional settings examples

# with:
### For a DevOps-focused repository. Prevents some code-language linters from running
### defaults to false
# devops-only: false

### A regex to exclude files from linting
### defaults to empty
# filter-regex-exclude: html/.*
121 changes: 121 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<!--lint disable awesome-contributing awesome-git-repo-age awesome-toc awesome-list-item-->
# Awesome DevOps Demo Apps [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

> An awesome list of example server apps used for learning and demoing DevOps, cloud, and distributed computing technologies.
These apps are not for learning to code, but rather how to build, test, and deploy code to servers and the cloud. They are often used in workshops, courses, and conference talks for demoing something else in DevOps and infrastructure management.

This Awesome List is maintained by [@BretFisher](https://github.com/BretFisher). This is a curated list of *working* and *awesome* sample server apps.

## Contents<!-- omit from toc -->

- [Other lists of apps](#other-lists-of-apps)
- [Simple Apps (1-3 independent services/apps in solution)](#simple-apps-1-3-independent-servicesapps-in-solution)
- [Complex Apps (4+ independent services/apps in solution)](#complex-apps-4-independent-servicesapps-in-solution)
- [Serverless Functions (might be purely serverless)](#serverless-functions-might-be-purely-serverless)
- [IOT and Edge Computing](#iot-and-edge-computing)
- [LLMs and Machine Learning](#llms-and-machine-learning)
- [Chat and Forums](#chat-and-forums)
- [Related Awesome Lists](#related-awesome-lists)
- [Contributing](#contributing)

## Other lists of apps

- [DevOps Demo Apps](https://github.com/devopsdemoapps)
- [AWS Samples](https://github.com/aws-samples)

## Simple Apps (1-3 independent services/apps in solution)

- [RealWorld example apps](https://github.com/gothinkster/realworld) - A collection of example Medium.com clones that adhere to the RealWorld API spec
- [Worthsmith](https://github.com/dockersamples/wordsmith) - A traditional Web + API + DB app for randmoly generating words. Has Docker Compose and Kubernetes example YAML.
- [Browncoat](https://github.com/BretFisher/browncoat) - A server app designed to fail in various ways for testing orchestration, healthchecks, and recovery. "It aims to misbehave"
- [Stress](https://github.com/BretFisher/stress) - A simple set of container images for stressing CPU and memory. Useful for testing autoscaling and monitoring.

## Complex Apps (4+ independent services/apps in solution)

- [Google Online Boutique](https://github.com/GoogleCloudPlatform/microservices-demo) - A cloud-native microservices demo app for Google Cloud Platform (GCP). Has Dockerfiles, Kubernetes manifests, and Helm charts.
- [Sock Shop](https://github.com/microservices-demo/microservices-demo) - A microservices demo application that was maintained by Weaveworks. It's now deprecated, but should still work. Has Docker Compose and Kubernetes example YAML. Also has logging and monitoring YAML.
- [Voting App](https://github.com/dockersamples/example-voting-app) - A distributed application that runs across multiple Docker containers. Has Docker Compose and Kubernetes example YAML.
- [Azure Microservices Reference Implementation](https://github.com/mspnp/microservices-reference-implementation) - A reference implementation, along with additional demos like [AKS Fabrikam Drone Delivery demo](https://github.com/mspnp/aks-fabrikam-dronedelivery) that demonstrates a microservices architecture based on Azure Kubernetes Service (AKS).

## Serverless Functions (might be purely serverless)


## IOT and Edge Computing


## LLMs and Machine Learning


## Chat and Forums

- [Discord - Cloud Native DevOps](https://discord.gg/devops) - Maintained by [@BretFisher](https://github.com/BretFisher) and friends.<!--lint ignore double-link-->

## Related Awesome Lists

While this list is focused on Docker Swarm resources, general resources such as ones for Docker or Docker Compose can be helpful. The following keeps track of related awesome lists focused on this.

- [awesome-docker](https://github.com/veggiemonk/awesome-docker) - A list of awesome Docker tools.
- [awesome-compose](https://github.com/docker/awesome-compose) - A list of awesome Docker Compose samples.


## Contributing

This list thrives on contributions from the community. The Maintainers can't do it alone. We need DevOps/Cloud fans to help us find the best demo apps.

Want to contribute? Please read the [contribution guidelines](contributing.md). You can also ask questions in the [GitHub Discussions](./discussions), or our [Discord - Cloud Native DevOps](https://discord.gg/devops).

Guidelines for submitting demos to this list:

- Must be a working example app that can be deployed to a server or cloud
- Must have a public repo with a open source license
- Must and instructions on how to build and run
- Ideally, has a deployment tutorial with it (but not required)
- Can exist in multiple categories if it fits
Loading

0 comments on commit d85adff

Please sign in to comment.