From 95a8e9968ba72f6e13db227c0b5695f6d12e388a Mon Sep 17 00:00:00 2001 From: moonrailgun Date: Mon, 10 Jun 2024 15:39:09 +0800 Subject: [PATCH] docs: #68 add document to how to install with helm --- .github/workflows/deploy-helm-charts.yml | 46 ------------------- k8s/helm/cr.yaml | 2 - .../docs/install/kubernetes/_category_.json | 4 ++ website/docs/install/kubernetes/helm.md | 31 +++++++++++++ 4 files changed, 35 insertions(+), 48 deletions(-) delete mode 100644 .github/workflows/deploy-helm-charts.yml delete mode 100644 k8s/helm/cr.yaml create mode 100644 website/docs/install/kubernetes/_category_.json create mode 100644 website/docs/install/kubernetes/helm.md diff --git a/.github/workflows/deploy-helm-charts.yml b/.github/workflows/deploy-helm-charts.yml deleted file mode 100644 index 268c3a3..0000000 --- a/.github/workflows/deploy-helm-charts.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Deploy Helm Charts - -on: - push: - branches: - - master - paths: - - "k8s/helm/**" - workflow_dispatch: - -jobs: - release: - # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions - # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token - permissions: - contents: write - 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 "$GITHUB_ACTOR@users.noreply.github.com" - - - name: Install Helm - uses: azure/setup-helm@v4 - env: - GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" - - - name: Update Helm Deps - run: | - helm repo add bitnami https://charts.bitnami.com/bitnami - cd k8s/helm - helm dependency update - - - name: Run chart-releaser - uses: helm/chart-releaser-action@v1.6.0 - with: - charts_dir: k8s - config: k8s/helm/cr.yaml - env: - CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/k8s/helm/cr.yaml b/k8s/helm/cr.yaml deleted file mode 100644 index 7882bd5..0000000 --- a/k8s/helm/cr.yaml +++ /dev/null @@ -1,2 +0,0 @@ -owner: msgbyte -git-repo: charts diff --git a/website/docs/install/kubernetes/_category_.json b/website/docs/install/kubernetes/_category_.json new file mode 100644 index 0000000..845c71a --- /dev/null +++ b/website/docs/install/kubernetes/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Kubernetes", + "position": 2 +} diff --git a/website/docs/install/kubernetes/helm.md b/website/docs/install/kubernetes/helm.md new file mode 100644 index 0000000..cffc2a1 --- /dev/null +++ b/website/docs/install/kubernetes/helm.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 1 +--- + +# Install in Helm + +Helm is a tool that streamlines installing and managing Kubernetes applications. Although helm you can easy and quickly enjoy tianji in kubernetes. + +## Add repo + +At first, you should add msgbyte charts registry into helm repo list. + +```bash +helm repo add msgbyte https://msgbyte.github.io/charts +``` + +Now you can search tianji with `helm search` command. + +```bash +helm search repo tianji +``` + +## Install + +Then, feel free to install with one command: + +```bash +helm install tianji msgbyte/tianji +``` + +Its will bring you a pg database and tianji.