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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## [currents-0.7.0](https://github.com/currents-dev/helm-charts/releases/tag/currents-0.7.0) - 2026-07-15


### Features
- [`ad3c86d`](https://github.com/currents-dev/helm-charts/commit/ad3c86d398787e36f790457c8a72edbde2acbe5c) [ENG-715] feat: Update workflows and add SAML SSO support (#42)
- Bump to the July 15 2026 image release of Currents


## [currents-0.6.0](https://github.com/currents-dev/helm-charts/releases/tag/currents-0.6.0) - 2026-03-26


Expand Down
2 changes: 1 addition & 1 deletion charts/currents/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: application
version: 0.7.0
# Version number of the application being deployed.
# Versions are not expected to follow Semantic Versioning. They should reflect the version the application is using.
appVersion: "2026-01-26-001"
appVersion: "2026-07-15-001"
maintainers:
- name: Currents-dev
url: https://currents.dev
Expand Down
2 changes: 1 addition & 1 deletion charts/currents/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ currents:
# @section -- Frequently Used
key: password
# -- The image tag to use for the Currents images
imageTag: 2026-01-26-001
imageTag: 2026-07-15-001
email:
smtp:
# -- The SMTP server port to use
Expand Down
6 changes: 3 additions & 3 deletions cliff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ footer = ""
trim = false

[git]
conventional_commits = true
conventional_commits = false
filter_unconventional = true
commit_parsers = [
{ message = "^feat", group = "Features" },
{ message = "^fix", group = "Bug Fixes" },
{ message = "^(\\[.*\\]\\s*)?feat", group = "Features" },
{ message = "^(\\[.*\\]\\s*)?fix", group = "Bug Fixes" },
]
filter_commits = true
tag_pattern = "currents-[0-9].*"
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The Currents Helm Chart is stateless, so depends on being connected to stateful
## Resources

- [🚀 Start Here: EKS Quickstart](./eks/quickstart.md)
- [EKS Upgrade Guide](./eks/upgrading.md)
- [Development Guide](./developer-guide/README.md)
- [Support Policy](./support.md)
- [Configuration Reference](configuration.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration Reference

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

## Requirements

Expand Down Expand Up @@ -88,7 +88,7 @@ The following table lists the configurable parameters of the `currents` chart an
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| currents.rootUser.email | string | `"admin@{{ .Values.currents.domains.appHost }}"` | The email address of the root user |
| currents.imageTag | string | `"2026-01-26-001"` | The image tag to use for the Currents images |
| currents.imageTag | string | `"2026-07-15-001"` | The image tag to use for the Currents images |
| currents.email.smtp.port | int | `587` | The SMTP server port to use |
| currents.email.smtp.from | tpl/string | `"Currents Report <report@{{ .Values.currents.domains.appHost }}>"` | The email address to send from |
| currents.email.smtp.tls | bool | `false` | Whether the SMTP server uses TLS |
Expand Down
1 change: 1 addition & 0 deletions docs/eks/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Installing the Currents Helm Chart on EKS

- [Quickstart](./quickstart.md)
- [Upgrading](./upgrading.md)
- [Configuration Reference](../configuration.md)
4 changes: 4 additions & 0 deletions docs/eks/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,10 @@ For example:
CURRENTS_API_URL=https://currents-record.eks.example.com npx pwc --key <your-key> --project-id <your projectid>
```

## Upgrade Existing Installations

When you need to move to a newer Currents release, follow the dedicated [EKS Upgrade Guide](./upgrading.md).

## Enable SAML SSO (optional)

Delegate sign-in to your SAML 2.0 identity provider (Okta, Microsoft Entra ID, etc.). Users sign in **email-first** — they enter their email, are redirected to your IdP to authenticate, and are auto-provisioned into your organization on return. SMTP must be configured (used for provisioning and invitations).
Expand Down
178 changes: 178 additions & 0 deletions docs/eks/upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
# Upgrading Currents on EKS

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).

## Before You Begin

1. Check the chart [CHANGELOG](https://github.com/currents-dev/helm-charts/blob/main/CHANGELOG.md) for the target release.
2. Review any breaking changes and required values or secrets updates.

Infrastructure backups and third-party dependencies are customer-managed. See [Currents Service Dependencies](./dependencies.md) and [Support Policy](../support.md).

## How Versioning Works

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`.

## Upgrade Types

### Chart/Image Updates (No Config Changes)

Use this when release notes do not require values or secret changes:

```bash
kubectl config set-context --current --namespace=currents

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

To target a specific chart version:

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

### Updates with Values File Changes

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)
- [Configuration Reference](../configuration.md)
2. Add/update required values in your `currents-helm-config.yaml`.
3. Run `helm upgrade --install` with the updated file.

### Updates with New Secrets

Use this when release notes require new secrets:

1. Create any required Kubernetes secrets before the upgrade (for example auth, SMTP, SSO, storage).
2. Ensure your values file references those secret names and keys.
3. Run `helm upgrade --install`.

## Running the Upgrade

Recommended upgrade command:

```bash
kubectl config set-context --current --namespace=currents

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

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/ \
-f currents-helm-config.yaml
```

Watch rollout:

```bash
kubectl get pods
kubectl rollout status deploy -l app.kubernetes.io/instance=currents --timeout=5m
```

## Version Checking

Check installed chart and app version:

```bash
helm list -n currents
```

Check applied values:

```bash
helm get values currents -n currents
```
Comment thread
twk3 marked this conversation as resolved.

Check running container images:

```bash
kubectl get pods -n currents -o custom-columns=NAME:.metadata.name,IMAGE:.spec.containers[*].image
```

## Database Migrations and Startup Tasks

The scheduler component runs startup tasks (including migrations) on startup.

Check scheduler logs during/after upgrades:

```bash
kubectl logs -n currents deploy/currents-scheduler --tail=200
```

## Rollback

If you need to rollback:

```bash
helm history currents -n currents
helm rollback currents <revision> -n currents
Comment thread
twk3 marked this conversation as resolved.
```

Then verify pod health:

```bash
kubectl get pods -n currents
```

## Troubleshooting

### Pods Do Not Start (CrashLoopBackOff / Pending)

```bash
kubectl get pods -n currents
kubectl describe pod <pod-name> -n currents
kubectl logs <pod-name> -n currents --all-containers --tail=200
```

### Connection Errors in Logs

If services report MongoDB/ClickHouse/Redis/object storage connection errors, dependencies may still be initializing. Restart the affected deployment:

```bash
kubectl rollout restart deploy/<deployment-name> -n currents
```

### Missing Secrets or Config

If pods fail with missing env var or secret errors:

```bash
kubectl get secrets -n currents
helm get values currents -n currents
```

Confirm secret names/keys match the values in [Configuration Reference](../configuration.md).

### Image Pull Errors

If pods fail with ECR pull errors, verify EKS IAM access for image pulls:

- [IAM Resources](./iam.md)

## Out of Scope

This guide covers upgrading Currents Helm chart releases and application images.

Upgrading third-party infrastructure (MongoDB operators, ClickHouse operators, storage platform, cluster components) is customer-managed. See:

- [Currents Service Dependencies](./dependencies.md)
- [Support Policy](../support.md)
Loading