Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add logging stack #33

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,27 @@ For Amazon
For Azure
`helm install openstudio-server ./openstudio-server --set provider.name=azure`

## Installing optional logging stack

The helm chart contains optional subcharts for advanced logging features. This includes the Elastic logging stack with a GUI dashboard called Kibana. It allows users to access the web GUI Kibana and investigate container logs and resource consumption such as cpu, memory, disk utilization, network I/O. To enable this optional logging feature, first you will need to install the dependencies (command below starting in the root of the repo)

```bash
cd openstudio-server
helm repo add elastic https://helm.elastic.co
helm dependency update
```

Once the dependencies ares installed, pass in the optional arg `tags.log_stack=true` to helm (examples below) to enable this feature.

For Google
`helm install openstudio-server ./openstudio-server --set provider.name=google--set tags.log_stack=true`

For Amazon
`helm install openstudio-server ./openstudio-server --set provider.name=aws --set tags.log_stack=true`

For Azure
`helm install openstudio-server ./openstudio-server --set provider.name=azure --set tags.log_stack=true`

## Uninstalling the Chart

To uninstall/delete the `openstudio-server` helm chart:
Expand Down
21 changes: 21 additions & 0 deletions openstudio-server/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,24 @@ appVersion: 3.3.0
# - name: nfs-server-provisioner
# version: 1.0.0
# repository: "@stable"
dependencies:
- name: elasticsearch
version: 7.16.3
repository: https://helm.elastic.co
tags:
- log_stack
- name: filebeat
version: 7.16.3
repository: https://helm.elastic.co
tags:
- log_stack
- name: kibana
version: 7.16.3
repository: https://helm.elastic.co
tags:
- log_stack
- name: metricbeat
version: 7.16.3
repository: https://helm.elastic.co
tags:
- log_stack
5 changes: 5 additions & 0 deletions openstudio-server/templates/loadbalancer/loadbalancer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,9 @@ spec:
- name: {{ .Values.load_balancer.ports.https_name }}
protocol: {{ .Values.load_balancer.ports.https_protocol }}
port: {{ .Values.load_balancer.ports.https_port }}
- name: {{ .Values.load_balancer.ports.kibana_name }}
protocol: {{ .Values.load_balancer.ports.kibana_protocol }}
port: {{ .Values.load_balancer.ports.kibana_port }}



30 changes: 30 additions & 0 deletions openstudio-server/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
provider:
name: ""

tags:
log_stack: false

cluster:
name: "openstudio-server"

Expand Down Expand Up @@ -55,6 +58,33 @@ load_balancer:
https_name: "https"
https_port: 443
https_protocol: "TCP"
kibana_name: "kibana"
kibana_port: 5601
kibana_protocol: "TCP"
loadBalancerSourceRanges: 0.0.0.0/0


elastic_job:
name: "elastic-job"
label: "elastic-job"
container:
name: "elastic-job"
image: "elasticdump/elasticsearch-dump"
resources:
limits:
cpu: 0.25
memory: "512Mi"
requests:
cpu: 0.1
memory: "256Mi"

elasticsearch:
replicas: 1
persistence:
enabled: true
esConfig:
elasticsearch.yml: |
xpack.security.enabled: false

nfs:
name: "nfs"
Expand Down