Skip to content
Merged
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
13 changes: 11 additions & 2 deletions .github/workflows/sync-docs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
name: Sync Docs to GH Pages

# Publishes this branch's docs under 0.8/docs, next to main's docs/ on gh-pages.
on:
push:
branches:
- main
- release-0.8

# A later push's deploy carries every earlier change, so a queued one can be dropped.
concurrency:
group: sync-docs-${{ github.ref }}

jobs:
release:
Expand All @@ -26,4 +31,8 @@ jobs:
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs
target-folder: docs
target-folder: 0.8/docs
# Rebase onto gh-pages instead of force-pushing: main's docs deploy and
# chart-releaser also push there, and a force-push from a deploy that
# started before theirs would drop their commits.
force: false
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Currents Self-Hosted Documentation

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

Currents on-premise installation is a series of microservices provided as container images that are installed into a Kubernetes Cluster using the Currents Helm Chart.

The Currents Helm Chart is stateless, so depends on being connected to stateful services like a Database and Object Storage. These connected stateful services can be deployed inside the Kubernetes cluster alongside Currents, or outside the cluster.
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Configuration Reference

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

![Version: 0.8.1](https://img.shields.io/badge/Version-0.8.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2026-07-26-006](https://img.shields.io/badge/AppVersion-2026--07--26--006-informational?style=flat-square)

## Requirements
Expand Down Expand Up @@ -261,4 +263,4 @@ The following table lists the configurable parameters of the `currents` chart an
| redis.sysctl.resourcesPreset | string | `"none"` | |
| maintenance.clickhouseRestoreMode | bool | `false` | Suppress change-stream-driven ClickHouse sync while an organization's ClickHouse data is restored from an external export (see scripts/org-import in the currents repo). Enable it together with `toolbox.enabled` for a Mongo + ClickHouse restore, then turn both off again. Without it, restoring documents into Mongo makes change-streams re-derive ClickHouse rows on top of the ones the import writes directly, permanently double-counting the hourly materialized views. Leave this OFF for a Mongo-only restore: there, change-streams re-deriving the restored documents is exactly how ClickHouse gets populated. NOTE: while this is on, NO org gets new ClickHouse metrics — the install keeps recording to Mongo while dashboards quietly stop updating. It is not a setting to leave enabled. |

[values.yaml]: https://github.com/currents-dev/helm-charts/blob/main/charts/currents/values.yaml
[values.yaml]: https://github.com/currents-dev/helm-charts/blob/release-0.8/charts/currents/values.yaml
5 changes: 4 additions & 1 deletion docs/configuration.md.gotmpl
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Configuration Reference

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

{{ template "chart.deprecationWarning" . }}

{{ template "chart.badgesSection" . }}
Expand All @@ -11,4 +14,4 @@ The following table lists the configurable parameters of the `currents` chart an

{{ template "chart.valuesSection" . }}

[values.yaml]: https://github.com/currents-dev/helm-charts/blob/main/charts/currents/values.yaml
[values.yaml]: https://github.com/currents-dev/helm-charts/blob/release-0.8/charts/currents/values.yaml
2 changes: 2 additions & 0 deletions docs/developer-guide/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install for local development

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

## Setup Namespace

Create namespace (easier to cleanup resources in a custom namespace)
Expand Down
2 changes: 2 additions & 0 deletions docs/eks/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Installing the Currents Helm Chart on EKS

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

- [Quickstart](./quickstart.md)
- [Upgrading](./upgrading.md)
- [Configuration Reference](../configuration.md)
2 changes: 2 additions & 0 deletions docs/eks/dependencies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Currents Service Dependencies

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

Currents depends on several third-party services that are not bundled with the Helm chart. You are responsible for allocating resources, installing, and maintaining these services. During the installation process, you’ll need to provide credentials so Currents can configure these services as needed.

We provide a quick reference of how to create those services for your convenience. The documented configuration for the connected stateful services (mongo, clickhouse) are not definitive, and may not be adequate for all production setups.
Expand Down
4 changes: 3 additions & 1 deletion docs/eks/iam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# IAM Resources

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

## IAM Resources for Accessing Currents Docker Images

Currents Docker images are hosted in a private ECR registry. To gain access, follow these steps:
Expand Down Expand Up @@ -235,7 +237,7 @@ apply to both transports.
Apply it:

```shell
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ -f currents-helm-config.yaml
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ --version 0.8.1 -f currents-helm-config.yaml
```

**4. Confirm the Pods Picked Up the Change**
Expand Down
8 changes: 5 additions & 3 deletions docs/eks/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Quickstart: Installing Currents on EKS

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

The QuickStart for installing the Currents Helm Chart on EKS runs through the commands to get the Currents App setup. This includes installing dependencies like MongoDB, ClickHouse, and RustFS into your Kubernetes namespace.

## Accessing Currents Docker Images
Expand Down Expand Up @@ -186,11 +188,11 @@ Configure and install the Currents Helm Chart once all the services are ready.
enabled: true
```

See the full available configuration values here: https://github.com/currents-dev/helm-charts/blob/main/charts/currents/values.yaml
See the full available configuration values here: https://github.com/currents-dev/helm-charts/blob/release-0.8/charts/currents/values.yaml

3. Install the chart
```sh
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ -f currents-helm-config.yaml
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ --version 0.8.1 -f currents-helm-config.yaml
```

## Configure Service Account Access
Expand Down Expand Up @@ -255,7 +257,7 @@ Delegate sign-in to your SAML 2.0 identity provider (Okta, Microsoft Entra ID, e

4. **Apply:**
```sh
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ -f currents-helm-config.yaml
helm upgrade --install currents currents --repo https://currents-dev.github.io/helm-charts/ --version 0.8.1 -f currents-helm-config.yaml
```

Sign in from the dashboard by entering your email — you'll be redirected to your IdP. New SSO users join your organization automatically with the role from `defaultRole` (default `member`); the root admin continues to sign in with email + password.
Expand Down
11 changes: 8 additions & 3 deletions docs/eks/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Upgrading Currents on EKS

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

This guide covers upgrading an existing Currents deployment installed with the Helm chart on EKS.

For reference, the Docker Compose environment has a separate upgrade flow: [Upgrading Currents On-Prem](https://github.com/currents-dev/docker/blob/main/docs/upgrading.md).
For reference, the Docker Compose environment has a separate upgrade flow: [Upgrading Currents On-Prem](https://github.com/currents-dev/docker/blob/on-prem/2026-07-26-006/docs/upgrading.md).

## Before You Begin

Expand All @@ -18,7 +20,7 @@ Two versions matter during upgrades:
- **Chart version** (`version` in `Chart.yaml`) controls chart templates and defaults.
- **App image version** (`appVersion` / `currents.imageTag`) controls Currents service container images.

By default, `helm upgrade --install` without `--version` upgrades to the latest published chart. You can pin the chart version with `--version`.
By default, `helm upgrade --install` without `--version` upgrades to the latest published chart, which is `1.0` or later. The commands here pin `--version 0.8.1` to stay on `0.8.x`.

## Upgrade Types

Expand All @@ -31,6 +33,7 @@ kubectl config set-context --current --namespace=currents

helm upgrade --install currents currents \
--repo https://currents-dev.github.io/helm-charts/ \
--version 0.8.1 \
-f currents-helm-config.yaml
```

Expand All @@ -48,7 +51,7 @@ helm upgrade --install currents currents \
Use this when release notes mention new or renamed values:

1. Compare your `currents-helm-config.yaml` with the latest chart values reference:
- [Currents values.yaml](https://github.com/currents-dev/helm-charts/blob/main/charts/currents/values.yaml)
- [Currents values.yaml](https://github.com/currents-dev/helm-charts/blob/release-0.8/charts/currents/values.yaml)
- [Configuration Reference](../configuration.md)
2. Add/update required values in your `currents-helm-config.yaml`.
3. Run `helm upgrade --install` with the updated file.
Expand All @@ -70,6 +73,7 @@ kubectl config set-context --current --namespace=currents

helm upgrade --install currents currents \
--repo https://currents-dev.github.io/helm-charts/ \
--version 0.8.1 \
-f currents-helm-config.yaml
```

Expand All @@ -78,6 +82,7 @@ Optional: if you use the Helm diff plugin, preview changes first:
```bash
helm diff upgrade currents currents \
--repo https://currents-dev.github.io/helm-charts/ \
--version 0.8.1 \
-f currents-helm-config.yaml
```

Expand Down
6 changes: 4 additions & 2 deletions docs/org-data-import.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Importing Organization Data (Cloud → Self-Hosted Migration)

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

When you migrate an organization from Currents Cloud to your self-hosted install,
Currents support runs a one-off export of that org's data and sends you a single
small file, **`download.json`**, over a secure channel (usually Slack).
Expand Down Expand Up @@ -64,7 +66,7 @@ from the data being restored. You turn that on in step 1 and off in step 4.
This enables the toolbox pod and puts change-streams into restore mode:

```bash
helm upgrade <release> currents/currents --reuse-values \
helm upgrade <release> currents/currents --version 0.8.1 --reuse-values \
--set toolbox.enabled=true \
--set maintenance.clickhouseRestoreMode=true
```
Expand Down Expand Up @@ -133,7 +135,7 @@ see [Troubleshooting](#troubleshooting) to resume.
Only after the import reports success:

```bash
helm upgrade <release> currents/currents --reuse-values \
helm upgrade <release> currents/currents --version 0.8.1 --reuse-values \
--set toolbox.enabled=false \
--set maintenance.clickhouseRestoreMode=false
```
Expand Down
2 changes: 2 additions & 0 deletions docs/support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Currents Support & Maintenance Policy

> These docs are for chart `0.8.x`. For the current chart, see the [current docs](https://currents-dev.github.io/helm-charts/docs/). To upgrade to `1.0`, follow [Upgrading to Chart 1.0](https://currents-dev.github.io/helm-charts/docs/eks/upgrade-1.0.html).

## Introduction

This document outlines Currents’ support and maintenance policy for customers deploying Currents in self-managed (on-premises) environments. It clearly defines our responsibilities, delineates the components we fully support, and sets expectations for areas where support is advisory or out of scope.
Expand Down
Loading