-
Notifications
You must be signed in to change notification settings - Fork 0
release: release 0.7.0 #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` | ||
|
|
||
| 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 | ||
|
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) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.