kobs

module
Version: v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2021 License: MIT

README



kobs is an extensible observability platform for Kubernetes, which brings your metrics, logs, traces and Kubernetes resources into one place.

kobs brings your metrics, logs, traces and Kubernetes into one place, to provide a better observability for your applications running in your clusters. kobs provides various Custom Resource Definition with which you can describe and group your applications across multiple clusters. You can extend kobs via plugin, to customize it for your needs or you can use one of the available plugins to improve your developer experience.

Features

  • Multi-Cluster Support: kobs has built-in multi cluster support. The clusters are configured via the available providers.
  • Manage all your Kubernetes Resources: All major resources like Deployments, StatefulSets, DaemonSets, Pods, etc. are supported.
  • Custom Resource Definitions: View all Custom Resource Definitions and mange Custom Resources.
  • Modify Resources: Edit and delete all available resources or scale your Deployments and StatefulSets.
  • Resource Usage, Logs and Terminal: View the CPU and Memory usage and logs of your Pods or exec into them.
  • Topology: Add your applications, teams and users to kobs via the available Custom Resource Definitions or create dashboards to see how your applications are connected.
  • Extendible: Customize your kobs instance via plugins.
  • Prometheus: Access your Prometheus directly in kobs next to your Kubernetes resources.
  • Elasticsearch and Jaeger: View the logs from Elasticsearch and traces from Jaeger, where it matters.
  • Istio: Get the topology graph from Kiali for your Istio service mesh directly in kobs.
  • Authentication and Authorization: Manage the access to kobs via OAuth2-Proxy and provide your developers the permissions they need via Teams and Users CRs.

Usage

kobs can be installed via Helm or Kustomize, just run the following commands to install kobs via Helm:

helm repo add kobs https://helm.kobs.io
helm install kobs kobs/kobs

Or to install kobs via Kustomize run the following:

kubectl create namespace kobs
kustomize build github.com/kobsio/kobs/deploy/kustomize | kubectl apply -f -

More information regarding the installation and configuration of kobs can be found in the documentation at kobs.io.

You can also try the provided demo to have a first look at kobs. After your kobs instance is up and running your can start with creating Applications and Dashboards for your running services.

Contributing

Every contribution to kobs is welcome, whether it is reporting a bug, submitting a fix, proposing new features or becoming a maintainer. To make contributing to kobs as easy as possible you will find more details for the development flow in our Contribution Guideline.

Please also follow our Code of Conduct in all your interactions with the project.

Directories

Path Synopsis
cmd
pkg
api
api/clients/application/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
api/clients/application/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
api/clients/application/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
api/clients/application/clientset/versioned/typed/application/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
api/clients/application/clientset/versioned/typed/application/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
api/clients/dashboard/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
api/clients/dashboard/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
api/clients/dashboard/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
api/clients/dashboard/clientset/versioned/typed/dashboard/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
api/clients/dashboard/clientset/versioned/typed/dashboard/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
api/clients/team/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
api/clients/team/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
api/clients/team/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
api/clients/team/clientset/versioned/typed/team/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
api/clients/team/clientset/versioned/typed/team/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
api/clients/user/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
api/clients/user/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
api/clients/user/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
api/clients/user/clientset/versioned/typed/user/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
api/clients/user/clientset/versioned/typed/user/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
api/clusters/cluster/terminal
Package terminal implements the functions for all terminal interactions in the frontend.
Package terminal implements the functions for all terminal interactions in the frontend.
api/middleware/errresponse
Package errresponse implements a custom error renderer for the kobs api as it is described in the chi rest api example, which can be found here: https://github.com/go-chi/chi/blob/master/_examples/rest/main.go
Package errresponse implements a custom error renderer for the kobs api as it is described in the chi rest api example, which can be found here: https://github.com/go-chi/chi/blob/master/_examples/rest/main.go
api/middleware/httplog
Package httplog implements our custom http logger for kobs based on logrus.
Package httplog implements our custom http logger for kobs based on logrus.
app
plugins
rss
sql

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL