Merge pull request #10 from JupiterOne/INT-1356-document-deploy-process

Helm chart and documentation

.github/workflows/build-image.yml

@@ -31,7 +31,6 @@ jobs:
         with:
           images: jupiterone/graph-kubernetes
           tags: |
-            type=schedule
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{version}}

.github/workflows/release-chart.yml

@@ -0,0 +1,27 @@
+name: Release Chart
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Fetch history
+        run: git fetch --prune --unshallow
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          charts_dir: configs/helm
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

configs/helm/.gitignore

@@ -0,0 +1,2 @@
+requirements.lock
+Chart.lock

configs/helm/.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
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

configs/helm/Chart.yaml

@@ -0,0 +1,7 @@
+apiVersion: v2
+name: graph-kubernetes
+description:
+  Converts K8s resources into a graph model for ingestion into JupiterOne.
+type: application
+version: 0.1.0
+appVersion: '0.1.0'

configs/helm/README.md

@@ -0,0 +1,81 @@
+# JupiterOne Graph Kubernetes
+
+This chart bootstraps a
+[graph-kubernetes](https://github.com/JupiterOne/graph-kubernetes) deployment on
+a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh)
+package manager.
+
+## Prerequisites
+
+- Kubernetes 1.16+
+- Helm 3+
+
+## Quickstart
+
+If you're ok with the defaults and just want to set your account specific
+information run the following commands with your account information:
+
+```console
+helm repo add jupiterone https://graph-kubernetes.github.io/helm-charts
+helm repo update
+helm install [RELEASE_NAME] jupiterone/graph-kubernetes --set secrets.jupiteroneAccountId="some-account-id" --set secrets.jupiteroneApiKey="some-api-key" --set secrets.jupiteroneIntegrationInstanceId="some-integration-instance-id"
+```
+
+## Get Repo Info
+
+```console
+helm repo add jupiterone https://graph-kubernetes.github.io/helm-charts
+helm repo update
+```
+
+_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command
+documentation._
+
+## Install Chart
+
+```console
+$ helm install [RELEASE_NAME] jupiterone/graph-kubernetes
+```
+
+_See [configuration](#configuration) below._
+
+_See [helm install](https://helm.sh/docs/helm/helm_install/) for command
+documentation._
+
+## Uninstall Chart
+
+```console
+$ helm uninstall [RELEASE_NAME]
+```
+
+This removes all the Kubernetes components associated with the chart and deletes
+the release.
+
+_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command
+documentation._
+
+## Upgrading Chart
+
+```console
+$ helm upgrade [RELEASE_NAME] jupiterone/graph-kubernetes --install
+```
+
+## Configuration
+
+See
+[Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
+To see all configurable options with detailed comments, visit the chart's
+[values.yaml](./values.yaml), or run these configuration commands:
+
+```console
+$ helm show values jupiterone/graph-kubernetes
+```
+
+### RBAC Configuration
+
+To manually setup RBAC you need to set the parameter `rbac.create=false` and
+specify the service account to be used by setting the parameters:
+`serviceAccount.create` to `false` and `serviceAccount.name` to the name of a
+pre-existing service account.
+
+Roles and RoleBindings resources will be created automatically.