Merge pull request #1 from pehlicd/main

chore: init helm-charts repo

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# CODEOWNERS info: https://help.github.com/en/articles/about-code-owners
+# Owners are automatically requested for review for PRs that changes code
+# that they own.
+
+* @shahargl
+* @talboren

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint Charts
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint-chart:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.10.3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Set up chart-testing
+        uses: helm/[email protected]
+
+      - name: Run chart-testing (lint)
+        run: ct lint --config ct.yaml

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          CR_SKIP_EXISTING: true

.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Test Charts
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-chart:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.10.3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Set up chart-testing
+        uses: helm/[email protected]
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --config ct.yaml)
+          if [[ -n "$changed" ]]; then
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create kind cluster
+        uses: helm/[email protected]
+        with:
+          wait: 600s
+        if: steps.list-changed.outputs.changed == 'true'
+
+      - name: Run chart-testing (install)
+        run: ct install --config ct.yaml --namespace default
+        if: steps.list-changed.outputs.changed == 'true'

.gitignore

@@ -0,0 +1,11 @@
+# .DS_STORE
+.DS_Store
+**/.DS_Store
+
+# .idea
+.idea
+**/.idea
+
+# .vscode
+.vscode
+**/.vscode

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.13.0
+    hooks:
+      - id: helm-docs
+        args:
+          - --chart-search-root=charts
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v2.1.1
+    hooks:
+      - id: conventional-pre-commit
+        stages: [ commit-msg ]
+        args: [ ] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Keep
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,39 @@
-# helm-charts
+# 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:
+
+```bash
+# 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
+```bash
+kubectl port-forward svc/keep-frontend 3000:3000 & \
+kubectl port-forward svc/keep-websocket 6001:6001 &
+```

charts/keep/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.vscode
+.project
+.idea/
+*.tmproj
+OWNERS

charts/keep/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: keep
+version: 0.0.1
+description: Keep Helm Chart
+type: application
+icon: https://platform.keephq.dev/_next/image?url=%2Fkeep.png&w=48&q=75
+appVersion: 0.2.1
+deprecated: false
+annotations:
+  app: keep
+keywords:
+  - alerting
+  - monitoring
+  - monitoring-tool
+home: https://platform.keephq.dev/
+sources:
+  - https://github.com/keephq/helm-charts
+maintainers:
+  - name: Shahar Glazner
+    email: [email protected]
+    url: https://github.com/shahargl
+  - name: Tal Borenstein
+    email: [email protected]
+    url: https://github.com/talboren