Git Product home page Git Product logo

helm-charts's Introduction

Keep Helm Chart

The Keep Helm Chart provides a convenient way to deploy and manage Keep on Kubernetes using Helm, a package manager for Kubernetes applications.

Installation

The easiest way to install Keep with Helm is with the following command:

# add the Helm repository
helm repo add keephq https://keephq.github.io/helm-charts
# pull the latest version of the chart
helm pull keephq/keep
# install the chart
helm install keep keephq/keep

Uninstallation

helm uninstall keep

Configuration

Keep's Helm Chart supports the following values.yaml:

  • backend.image: the backend image (default: us-central1-docker.pkg.dev/keephq/keep/keep-api)
  • frontend.image: the frontend image (default: us-central1-docker.pkg.dev/keephq/keep/keep-ui)
  • frontend.publicApiUrl: the frontend will use this URL as a backend from your browser ("client components"). default: http://localhost:8080. for production environment this should be the backend DNS/external IP.
  • frontend.internalApiUrl: the frontend will use this URL as a backend from the container ("server components") default: http://keep-backend:8080 frontend.env: development

Openshift

Keep's Helm Chart also supports installation on Openshift. Simply set up the keys under frontend(/backend).route:

  • route.host: your desired hostname

Local Kubernetes

For local kubernetes without external IP (such as NodePort or LoadBalancer), you'll need to run port forwarding:

Port forward

kubectl port-forward svc/keep-frontend 3000:3000 & \
kubectl port-forward svc/keep-websocket 6001:6001 &

helm-charts's People

Contributors

pehlicd avatar shahargl avatar ztzxt avatar rvgud avatar jackrh avatar

Stargazers

Andrew Newdigate avatar avatar avatar avatar Tal avatar

Watchers

avatar avatar

Forkers

pehlicd jackrh silverlee425 dmarshaltu rvgud ztzxt

helm-charts's Issues

[BUG]: Can't connect Prometheus provider on k8s/Kind

Description of the bug

Unable to add Prometheus provider.
Error: An error occurred while fetching the data.

Steps To Reproduce

Setup Kind docker
kind create cluster --name=keep-kind
Install kube-state-metrics Helm Chart
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update
helm install monitoring prometheus-community/kube-state-metrics
Install Keep Helm Chart
helm repo add keephq https://keephq.github.io/helm-charts
helm pull keephq/keep
helm install keep keephq/keep
Port forward frontend
k port-forward svc/keep-frontend 3000
Try to setup Prometheus provider
From http://localhost:3000/providers select Prometheus

Additional Information

No response

[BUG]: Helm chart missing websocket ingress template

Description of the bug

If you add an ingress to websocket in your values.yaml it will never render the necessary yaml because the websocket template file is missing.

Steps To Reproduce

  1. Add ingress to values.yaml file for websocket
websocket:
  enabled: true
  ingress:
    enabled: true
    hosts:
      - host: keep-websocket.${SECRET_DOMAIN}
        paths:
          - path: /
            pathType: Prefix
    tls:
      - hosts:
          - keep-websocket.${SECRET_DOMAIN}
  1. Install helm chart
  2. Verify no ingress is created

Additional Information

No response

[BUG]: Can't use PSQL database as an option because of hardcoded mysql db test

Description of the bug

While you can override the connection string and Keep will now succesfully create and use a PSQL DB it will never connect on the backend unless you override or remove the init container check for mysql.

This line here has a hard coded value for DB name and port (mysql)
command: ['sh', '-c', 'until nc -z keep-database 3306; do sleep 1; done;']

Steps To Reproduce

  1. Configure keep-backend to use PSQL DB Connection string
  2. Observe keep-backend init container hangs trying to connect to non existent mysql database.

Additional Information

No response

[BUG]: Main components (backend, frontend, db, etc) to not respect enabled state

Description of the bug

If you try and use a values.yaml file to set a component to disabled it does not actually disable it -
database:
enabled: false #still proceeds with installing the DB

Steps To Reproduce

  1. Create values.yaml file
database:
  enabled: false #still proceeds with installing the DB
  1. Deploy helm chart
  2. Verify mysql container was created

Additional Information

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.