Stakater Playbook

Cerebro

Introduction

Cerebro is an open source (MIT License) elasticsearch web admin tool built using Scala, Play Framework, AngularJS and Bootstrap.

Chart

We use public helm charts to deploy cerebro on our cluster. Hereopen in new window is the public chart that we use. We use version 0.5.2 from public helm chart. We use umbrella charts to deploy cerebro on our cluster. Currently we are using thisopen in new window repository for cerebro deployment

Image

Currently we are using this lmenezes/cerebro:0.8.1 public image for cerebro in stakater.

Cherry Pickable

Yes

Single Sign-on

Yes. We use proxyinjector for achieving single sign on. Please refer to its documentation hereopen in new window

Installation

Installation Steps

Most of the times cerebro will be deployed from pipeline of thisopen in new window repository. It will have updated configurations and dependencies for cerebro. But we can also install it manually (not recommended). To install cerebro manually, clone thisopen in new window repo and you can run the make targets of repo containing latest used implementation of cerebro. This will install all dependencies and cerebro as well.

  1. Clone https://github.com/stakater/stakaterkubehelmLogging repository
  2. Update the hard coded values mentioned here in cerebro.yaml
  3. Run this command. make install CHART_NAME=logging
  4. Verify from UI that cerebro pod is running and accessible.

Dependencies

As Cerebro is an elasticsearch web admin tool, so it needs an elasticsearch instance to be running. The tool can be deployed separately.

Post Installation Configuration

No manual configuration is needed.

Web UI Access

You can access the Cerebro UI using this url: https://cerebro.logging.stakater.com

Char Info

name: cerebro
version: 0.5.2
repository: https://kubernetes-charts.storage.googleapis.com
alias: cerebro

Hard-coded-values

This document contains the hard coded values for Cerebro, and its dependencies.

config:
   secret: "ki:s:[[@=Ag?QIW2jMwkY:eqvrJ]JqoJyi2axj3ZvOv^/KavOT4ViJSv?6YY4[N"
   hosts:
     - host: "http://elasticsearch-stakater-logging-cluster.logging:9200"
       name: "elasticsearch-stakater-logging-cluster"

 deployment:
   annotations:
     authproxy.stakater.com/image-name: quay.io/gambol99/keycloak-proxy
     authproxy.stakater.com/image-tag: v2.1.1
     authproxy.stakater.com/enabled: "true"
     authproxy.stakater.com/upstream-url: "http://127.0.0.1:9000"
     authproxy.stakater.com/source-service-name: stakater-logging-cerebro
     authproxy.stakater.com/redirection-url: "https://cerebro.logging.stakater.com"
     authproxy.stakater.com/listen: "0.0.0.0:80"

 service:
   annotations:
     config.xposer.stakater.com/Domain: stakater.com
     config.xposer.stakater.com/IngressNameTemplate: '{{.Service}}-{{.Namespace}}'
     config.xposer.stakater.com/IngressURLTemplate: 'cerebro.{{.Namespace}}.{{.Domain}}'
     xposer.stakater.com/annotations: |-
       kubernetes.io/ingress.class: internal-ingress
       ingress.kubernetes.io/force-ssl-redirect: true
       forecastle.stakater.com/expose: true
       forecastle.stakater.com/icon: https://raw.githubusercontent.com/stakater/ForecastleIcons/master/cerebro.png
       forecastle.stakater.com/appName: Cerebro