Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Initial commit for the BigBitBus Kubernetes Automation Toolkit
  • Loading branch information
bigbitbus committed Dec 18, 2020
0 parents commit 8209e81
Show file tree
Hide file tree
Showing 106 changed files with 18,744 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# How to Contribute

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

## Contributor License Agreement

You (or your employer) retain the copyright to your contribution.

All code and configuration in the BigBitBus KAT repository (code files contained in this directory and all subdirectories) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0), unless explicitly mentioned in the corresponding file or subdirectory location.

All documentation, media and images in the BigBitBus KAT repository (non-code files contained in this directory and all subdirectories) are licensed under the [CC BY-NC License](https://creativecommons.org/licenses/by-nc/4.0/), unless explicitly mentioned in the corresponding file or subdirectory location.

## Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Community Guidelines

Comming soon!
5 changes: 5 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
All code and configuration in the BigBitBus KAT repository (code files contained in this directory and all subdirectories) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

All documentation, media and images in the BigBitBus KAT repository (non-code files contained in this directory and all subdirectories) are licensed under the [CC BY-NC License](https://creativecommons.org/licenses/by-nc/4.0/).

Please click the license links for details.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Introduction

Welcome to the BigBitBus Kubernetes Automation Toolkit (KAT).

KAT is a set of software code and documentation to help understand the big picture of how a web application is developed for and deployed into a Kubernetes environment.


Most components of the Kubernative cloud native ecosystem are extremely well documented, but its hard to find end-to-end examples that illustrate how these components work together in the context of an application. The main idea is to show you the breadth of several cloud-native technologies working together to support an application deployed on Kubernetes. We provide links to high quality documentation for deep dives on the concepts our examples illustrate. Our examples will show you how it all comes together so you can get productive, fast. You can then choose to learn more about specific parts of the cloud native stack as your situation demands.

From here, we recommend you start with a [review of some Kubernetes and related concepts](./documentation/README.md) we have put together. Or, if you want to directly go to the code and examples you can navigate the folders in the repository, the table below will launch you right in.

<center>
<img src="documentation/images/kubernetes-application.svg" alt="BigBitBus KAT components" width="400"/>
</center>

**Components of the BigBitBus KAT application code. Click on the diagram to enlarge, or follow [this link](documentation/README.md) for detailed documentation**


# What is where?

| Category | File or Directory | Description |
|---|---|---|
| Documentation | [documentation/README.md](./documentation/README.md) | Start here for an overview and links to other documents |
| Todo Django API | [code/app-code/api/todo-python-django](code/app-code/api/todo-python-django) | Django Python todo backend; includes Helm chart deployed using Skaffold |
| Postgresql DB | [code/k8s-common-code/postgres-db](code/k8s-common-code/postgres-db) | Installing and configuring Postgresql database into the Kubernetes cluster using Helm charts |
| Vuejs Todo Single Page Application | [code/app-code/frontend/todo-vuejs](code/app-code/frontend/todo-vuejs) | Todo application implemented in Vuejs; includes Helm chart deployed using Skaffold |
| Monitoring | [code/k8s-common-code/monitoring](code/k8s-common-code/monitoring) |Installing and configuring monitoring with Prometheus and Grafana into the Kubernetes cluster using standard Helm charts created by the Prometheus community |
| Kubernetes Dashboard | [code/k8s-common-code/k8sdashboard](code/k8s-common-code/k8sdashboard) | Deploying the Kubernetes dashboard, a browser-based GUI view of the Kubernetes cluster |

# License

All code and configuration in the BigBitBus KAT repository (code files contained in this directory and all subdirectories) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

All documentation, media and images in the BigBitBus KAT repository (non-code files contained in this directory and all subdirectories) are licensed under the [CC BY-NC License](https://creativecommons.org/licenses/by-nc/4.0/).

Please click the license links for details.






6 changes: 6 additions & 0 deletions code/app-code/api/todo-python-django/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kubecode/
docker-compose.yaml
.env
Dockerfile
*.pyc
.venv/
4 changes: 4 additions & 0 deletions code/app-code/api/todo-python-django/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
POSTGRES_PORT=5432
POSTGRES_PASSWORD=B1gB1tBu5
POSTGRES_DB=todo-postgres-database
POSTGRES_USER=dbuser
2 changes: 2 additions & 0 deletions code/app-code/api/todo-python-django/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.venv
config/static
26 changes: 26 additions & 0 deletions code/app-code/api/todo-python-django/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Copyright 2020 BigBitBus
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

FROM python:3

ENV PYTHONUNBUFFERED 1
RUN mkdir /app
WORKDIR /app
RUN mkdir static_root
COPY ./requirements.txt /app
RUN pip install -r requirements.txt
COPY . /app
RUN chmod +x start.sh
EXPOSE 8000
CMD ["./start.sh"]
21 changes: 21 additions & 0 deletions code/app-code/api/todo-python-django/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 William S. Vincent

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 8209e81

Please sign in to comment.