A standard runtime environment for Kubernetes
Clone or download
sameersbn docs: adds install/build guide (#228)
* docs: adds install/build guide

Signed-off-by: Sameer Naik <sameer@bitnami.com>

* address review comments

Signed-off-by: Sameer Naik <sameer@bitnami.com>
Latest commit dcc311a Nov 15, 2018

README.md

Bitnami Kubernetes Production Runtime

Description

The Bitnami Kubernetes Production Runtime (BKPR) is a collection of services that makes it easy to run production workloads in Kubernetes.

Think of Bitnami Kubernetes Production Runtime as a curated collection of the services you would need to deploy on top of your Kubernetes cluster to enable logging, monitoring, certificate management, automatic discovery of Kubernetes resources via public DNS servers and other common infrastructure needs.

BKPR

BKPR is available for Google Kubernetes Engine (GKE) and Azure Kubernetes Service (AKS) clusters.

License

BKPR is licensed under the Apache License Version 2.0.

Requirements

BKPR has been tested to work on a bare-minimum Kubernetes cluster with three kubelet nodes with 2 CPUs and 8GiB of RAM each.

Kubernetes version support matrix

The following matrix shows which Kubernetes versions and platforms are supported:

BKPR release Kubernetes versions AKS GKE
0.3 1.8-1.9 Yes No
1.0 1.9-1.10 Yes Yes

Installation

Please follow the installation guide to install BKPR on your cluster.

Frequently Asked Questions (FAQ)

Please read the FAQ.

Versioning

The versioning used in BKPR is described here.

Components

BKPR leverages the following components to achieve its mission. For more in-depth documentation about them please read the components documentation.

Logging stack

  • Elasticsearch: A distributed, RESTful search and analytics engine
  • Fluentd: A data collector for unified logging layer
  • Kibana: A visualization tool for Elasticsearch data

Monitoring stack

Ingress stack

  • NGINX Ingress Controller: A Controller to satisfy requests for Ingress objects
  • cert-manager: A Kubernetes add-on to automate the management and issuance of TLS certificates from various sources
  • OAuth2 Proxy: A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group
  • ExternalDNS: A component to synchronize exposed Kubernetes Services and Ingresses with DNS providers

Release compatibility

Components version support

The following matrix shows which versions of each component are used and supported in the most recent releases of BKPR:

Component BKPR 1.0
Prometheus 2.3.2
Kibana 5.6.12
Elasticsearch 5.6.12
cert-manager 0.3.2
Alertmanager 0.15.2
ExternalDNS 0.5.4
nginx-ingress 0.19.0
oauth2_proxy 0.20180625.74543
Heapster 1.5.2
Fluentd 1.2.2

Contribute code

If you would like to become an active contributor to this project please follow the instructions provided in contribution guidelines.