Skip to content
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

Move helm chart out of the source tree #3338

Merged
merged 1 commit into from
Feb 4, 2025
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
4 changes: 2 additions & 2 deletions .github/workflows/publish_helm_chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
# It replaces the line that starts with "version: " with "version: <tag version>"
- name: Add tag version to Chart.yaml
run: |
sed -i "s/version: .*/version: \"${{ github.ref_name }}\"/" src/zenml/zen_server/deploy/helm/Chart.yaml
sed -i "s/version: .*/version: \"${{ github.ref_name }}\"/" helm/Chart.yaml
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v2
with:
Expand All @@ -48,5 +48,5 @@ jobs:
REGISTRY_ALIAS: zenml
REPOSITORY: zenml
run: |-
helm package src/zenml/zen_server/deploy/helm
helm package ./helm
helm push $REPOSITORY-${{ github.ref_name }}.tgz oci://$REGISTRY/$REGISTRY_ALIAS
4 changes: 2 additions & 2 deletions .github/workflows/release_prepare.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ jobs:
# Update the README, pyproject.toml, version and helm files
- name: Update main files
run: |
sed -i "s/${{ needs.fetch-versions.outputs.old_version }}/${{ needs.fetch-versions.outputs.new_version }}/g" README.md pyproject.toml src/zenml/VERSION src/zenml/zen_server/deploy/helm/Chart.yaml src/zenml/zen_server/deploy/helm/README.md
git add README.md pyproject.toml src/zenml/VERSION src/zenml/zen_server/deploy/helm/Chart.yaml src/zenml/zen_server/deploy/helm/README.md
sed -i "s/${{ needs.fetch-versions.outputs.old_version }}/${{ needs.fetch-versions.outputs.new_version }}/g" README.md pyproject.toml helm/Chart.yaml helm/README.md
git add README.md pyproject.toml src/zenml/VERSION helm/Chart.yaml helm/README.md
# Update the Quickstart references
- name: Replace the references in the quickstart example
run: |
Expand Down
28 changes: 15 additions & 13 deletions docs/book/how-to/manage-zenml-server/upgrade-zenml-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,32 @@ Optionally also perform a backup before the upgrade.
{% endtab %}

{% tab title="Kubernetes with Helm" %}
To upgrade your ZenML server Helm release to a new version, follow the steps below:
To upgrade your ZenML server Helm release to a new version, follow the steps below.

* Pull the latest version of the Helm chart from the ZenML GitHub repository, or a version of your choice, e.g.:
## Simple in-place upgrade

If you don't need to change any configuration values, you can perform a simple in-place upgrade that reuses your existing configuration:

```bash
# If you haven't cloned the ZenML repository yet
git clone https://github.com/zenml-io/zenml.git
# Optional: checkout an explicit release tag
# git checkout 0.21.1
git pull
# Switch to the directory that hosts the helm chart
cd src/zenml/zen_server/deploy/helm/
helm -n <namespace> upgrade zenml-server oci://public.ecr.aws/zenml/zenml --version <VERSION> --reuse-values
```

* Simply reuse the `custom-values.yaml` file that you used during the previous installation or upgrade. If you don't
have it handy, you can extract the values from the ZenML Helm deployment using the following command:
## Upgrade with configuration changes

If you need to modify your ZenML server configuration during the upgrade, follow these steps instead:

* Extract your current configuration values to a file:

```bash
helm -n <namespace> get values zenml-server > custom-values.yaml
```
* Upgrade the release using your modified values file. Make sure you are in the directory that hosts the helm chart:

* Make the necessary changes to your `custom-values.yaml` file (make sure they are compatible with the new version)

* Upgrade the release using your modified values file:

```bash
helm -n <namespace> upgrade zenml-server . -f custom-values.yaml
helm -n <namespace> upgrade zenml-server oci://public.ecr.aws/zenml/zenml --version <VERSION> -f custom-values.yaml
```

{% hint style="info" %}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading