Skip to content
0fc09d5
Compare
Choose a tag to compare

These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
  • For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".

IMPORTANT: ZenHub Enterprise 3.3.3 supports GitHub Enterprise versions: 3.3, 3.4

What's new in ZenHub Enterprise 3.3.3

Features

  • No new features in this patch release.

Security Fixes

  • Package security updates.

Bug Fixes

  • Fixed Firefox extension installation for Firefox v100 and greater.

Changes

  • No changes in this patch release.

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
  • The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
  • 'Manage organizations' dashboard does not have dark-mode theming.
  • The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
  • Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
  • When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
  • If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.

VM Embedded Component Versions

Component Version
Ubuntu 20.04.4
K3s v1.20.13+k3s1
Kubernetes v1.20.13
Kustomize v3.9.4
Fluentd v1.6-debian-1
Postgresql 11.14
MongoDB 4.4.9
RabbitMQ 3.8
Redis 6.2
PgBouncer 1.15.0

Important Upgrade Instructions for Administrators

ZenHub Enterprise for Virtual Machine

⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.

  • You must be running either ZHE 3.2 or 3.3 to perform the upgrade to ZHE 3.3.3.

  • For users currently running ZenHub Enterprise 3.2 or 3.3, look for an email from our team which will include a download link for the 3.3.3 upgrade package. The upgrade process is detailed in our documentation.

ZenHub Enterprise for Kubernetes

  • Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:

⚠️ NOTE: The upgrade from ZHE 3.2 -> ZHE 3.3 will require a service outage, due to the underlying data migration being performed. Make sure to back up your data and test your backups prior to performing the upgrade. For large datasets allocate an appropriate amount of time for the migration.

⚠️ NOTE: Amazon DocumentDB 3.6 can be used for the ZHE 3.2->3.3 upgrade if not using TLS with DocumentDB. Otherwise, DocumentDB 3.6 must be upgraded to 4.0 before the ZHE 3.2->3.3 upgrade. Please see the AWS documentation and reach out to support@zenhub.com if you have any questions.

1. Prepare
  • You need to get the kustomization.yaml you configured to setup ZenHub
  • Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-

It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.

  • Make a copy of your existing kustomization.yaml and keep it handy for the next step
2. Update kustomization.yaml
  • Check out the zenhub-enterprise repository at the tag of this release
  • Populate the new kustomization.yaml with your existing configuration values

Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.

  • If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
  • Run the script found in k8s-cluster/update/zhe-upgrade.sh via the commands below:

If you use the ZenHub registry

cd update
./zhe-upgrade.sh yourNamespace

If you use your own registry

cd update
./zhe-upgrade.sh yourNamespace yourRegistryName
4. Application updates

In your new kustomization.yaml, update the cluster image tags to use the new images for this release:

If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's

images:
  - name: kraken-webapp
    newName: us.gcr.io/zenhub-public/kraken-webapp
    newTag: zhe-3.3.3
  - name: kraken-extension
    newName: us.gcr.io/zenhub-public/kraken-extension
    newTag: zhe-3.3.3
  - name: kraken-zhe-admin
    newName: us.gcr.io/zenhub-public/kraken-zhe-admin
    newTag: zhe-3.3.3
  - name: raptor-backend
    newName: us.gcr.io/zenhub-public/raptor-backend
    newTag: zhe-3.3.3
  - name: toad-backend
    newName: us.gcr.io/zenhub-public/toad-backend
    newTag: zhe-3.3.3
  - name: sanitycheck
    newName: us.gcr.io/zenhub-public/sanitycheck
    newTag: zhe-3.3.3
  - name: busybox
    newName: docker.io/library/busybox
    newTag: latest
  - name: nginx
    newName: docker.io/library/nginx
    newTag: latest
  • Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your kustomization.yaml
kustomize build . | kubectl diff -f-
  • If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-
5. Finalize
  • Securely store the updated kustomization.yaml
8aa9f65
Compare
Choose a tag to compare

These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
  • For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".

IMPORTANT: ZenHub Enterprise 3.3.2 supports GitHub Enterprise versions: 3.3, 3.4

What's new in ZenHub Enterprise 3.3.2

Features

  • No new features in this patch release.

Security Fixes

  • Updated to Ubuntu 20.04.4 LTS.
  • Package security updates.

Bug Fixes

  • Fixed package version upgrade that could cause issues with upgrades, data backups, and data restores.
  • Fixed file downloads on ZHE for K8s.
  • Fixed release report data migration for upgrades from 3.2 to 3.3

Changes

  • Improved logrotation of application logs for ZHE for VM.
  • Updated websocket routing configuration for ZHE for K8s deployments, allowing for better performing horizontal application scaling in high load environments.
  • Enhanced ZHE version compatibility check for ZHE for VM upgrades.

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
  • The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
  • 'Manage organizations' dashboard does not have dark-mode theming.
  • The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
  • Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
  • When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
  • If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.

VM Embedded Component Versions

Component Version
Ubuntu 20.04.4
K3s v1.20.13+k3s1
Kubernetes v1.20.13
Kustomize v3.9.4
Fluentd v1.6-debian-1
Postgresql 11.14
MongoDB 4.4.9
RabbitMQ 3.8
Redis 6.2
PgBouncer 1.15.0

Important Upgrade Instructions for Administrators

ZenHub Enterprise for Virtual Machine

⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.

  • You must be running either ZHE 3.2.0, 3.2.1, or 3.3.0 to perform the upgrade to ZHE 3.3.2.

  • For users currently running ZenHub Enterprise 3.2 or 3.3.0, look for an email from our team which will include a download link for the 3.3.2 upgrade package. The upgrade process is detailed in our documentation.

ZenHub Enterprise for Kubernetes

  • Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:

⚠️ NOTE: The upgrade from ZHE 3.2 -> ZHE 3.3 will require a service outage, due to the underlying data migration being performed. Make sure to back up your data and test your backups prior to performing the upgrade. For large datasets allocate an appropriate amount of time for the migration.

⚠️ NOTE: Amazon DocumentDB 3.6 can be used for the ZHE 3.2->3.3 upgrade if not using TLS with DocumentDB. Otherwise, DocumentDB 3.6 must be upgraded to 4.0 before the ZHE 3.2->3.3 upgrade. Please see the AWS documentation and reach out to support@zenhub.com if you have any questions.

1. Prepare
  • You need to get the kustomization.yaml you configured to setup ZenHub
  • Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-

It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.

  • Make a copy of your existing kustomization.yaml and keep it handy for the next step
2. Update kustomization.yaml
  • Check out the zenhub-enterprise repository at the tag of this release
  • Populate the new kustomization.yaml with your existing configuration values

Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.

  • If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
  • Run the script found in k8s-cluster/update/zhe-upgrade.sh via the commands below:

If you use the ZenHub registry

cd update
./zhe-upgrade.sh yourNamespace

If you use your own registry

cd update
./zhe-upgrade.sh yourNamespace yourRegistryName
4. Application updates

In your new kustomization.yaml, update the cluster image tags to use the new images for this release:

If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's

images:
  - name: kraken-webapp
    newName: us.gcr.io/zenhub-public/kraken-webapp
    newTag: zhe-3.3.2
  - name: kraken-extension
    newName: us.gcr.io/zenhub-public/kraken-extension
    newTag: zhe-3.3.2
  - name: kraken-zhe-admin
    newName: us.gcr.io/zenhub-public/kraken-zhe-admin
    newTag: zhe-3.3.2
  - name: raptor-backend
    newName: us.gcr.io/zenhub-public/raptor-backend
    newTag: zhe-3.3.2
  - name: toad-backend
    newName: us.gcr.io/zenhub-public/toad-backend
    newTag: zhe-3.3.2
  - name: sanitycheck
    newName: us.gcr.io/zenhub-public/sanitycheck
    newTag: zhe-3.3.2
  - name: busybox
    newName: docker.io/library/busybox
    newTag: latest
  - name: nginx
    newName: docker.io/library/nginx
    newTag: latest
  • Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your kustomization.yaml
kustomize build . | kubectl diff -f-
  • If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-
5. Finalize
  • Securely store the updated kustomization.yaml
6f27feb
Compare
Choose a tag to compare

These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
  • For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".

IMPORTANT: ZenHub Enterprise 3.3 supports GitHub Enterprise versions: 3.2, 3.3

What's new in ZenHub Enterprise 3.3.0

Features

Planning poker

Team members can now estimate issues individually and record a history of who estimated what. No more guessing who was part of the process or where the estimate came from.

We've added the ability to optionally alert a teammate that they've been added to planning poker for an issue. This feature automatically posts an issue comment tagging a team mate which notifies them that an estimate is needed.

You can also request estimates from your whole team at once via Planning Poker Groups! When requesting estimates during a round of Planning Poker, users will be grouped based on your previous selections. This means you can choose your entire team in just one click rather than selecting them one-by-one.

Quick issue creation

A new [+] button has been added to the top of each of each of your pipelines to quickly create issues within the respective pipeline. Click, type, submit. It's as easy as that!

To quickly create an epic, click the new [+] button on any pipeline and then click on the issue icon to see it transform into an epic.

quick-create-epic

Remove epic start and end dates

You can now remove the start and end dates for an epic directly from the date selection widget.

Export and share roadmaps

You can now export roadmaps to an SVG file via the Share button.

GitHub Projects Importer

For those who want to break away from GitHub Projects and come over to ZenHub, you now have an easy way to import your project and issues over with just a couple of clicks.

Sprint Insights Beta

Right from your Board you’ll be able to: see ZenHub Sprint progress, understand changes in scope, see average velocity and compare to last period, add unfinished Issues to your next Sprint, and more.

A Toast to Completed Sprints

We've added a Sprint Completed toast that provides a short summary of your team's progress over the last sprint. Use this as a way to glean sprint information, update your team on progress or as a reminder to celebrate a completed sprint.

Dark mode has arrived in ZenHub!

Dark mode lovers attest to its ability to reduce eye strain in low light conditions. Most importantly, we think it happens to look especially snazzy! Available on both the ZenHub web app and the ZenHub browser extension for GitHub.

Enabling dark mode can be done in just one simple step, no matter where you use ZenHub!

  • For those using the browser extension in GitHub, ZenHub’s dark mode will automatically update based on your GitHub preferences. In other words, if you use dark mode in GitHub, you’ll have dark mode in ZenHub!
  • For those that use the web app, dark mode can be conveniently activated by clicking the up arrow on your profile on the bottom left, and toggling on dark mode. That’s it, you’ve got dark mode!

Security Fixes

  • Updated to Ubuntu 20.04.3 LTS.
  • Updated embedded Kubernetes in ZHE for VM.
  • Updated embedded backend databases in ZHE for VM.
  • Added TLS support for external MongoDB in ZHE for K8s.

Bug Fixes

  • File uploads in the web application are no longer limited to 1MB in size.
  • A page refresh is no longer needed to view ZenHub properties when opening a GitHub issue with the ZenHub browser extension installed with newer versions of GitHub Enterprise.
  • Dragging PRs with long names on the Board no longer clips the previous issue.
  • Two byte characters in input fields no longer prematurely entered.
  • Increased pod liveness check start delay for ZenHub backend K8s pods, resolving rough pod startup.

Changes

  • Increased default minimum disk size from 80GB to 90GB, increasing root filesystem from 20GB to 30GB for new installations.
  • Fine tuned log rotation to decrease log sizes in ZHE for VM.
  • Adding default backend to ingress.
  • Optimized memory allocation for small deployments.
  • Added zhe-config --update-tls command to enable updating TLS certificates without a full application restart.
  • Added zhe-config --update-license command for updating your ZenHub license without bringing down the application.

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
  • The version of runc embedded in the K3s installation contains a logging bug which can potentially fill up containerd logs.
  • 'Manage organizations' dashboard does not have dark-mode theming.
  • The alignment of the license management options in the 'Manage organizations' dashboard is too close to the radio buttons.
  • Partial username search does not return any users in the Team members section of the 'Manage organizations' dashboard, only an exact search works.
  • When using the browser extension and logged into GitHub Enterprise as an administrator, the black enterprise version banner at the top of the page sits over ZenHub elements.
  • If a user accesses ZenHub and is not part of any repos, the button prompting them to create a repository redirects to GitHub Cloud.

VM Embedded Component Versions

Component Version
Ubuntu 20.04.3
K3s v1.20.13+k3s1
Kubernetes v1.20.13
Kustomize v3.9.4
Fluentd v1.6-debian-1
Postgresql 11.14
MongoDB 4.4.9
RabbitMQ 3.8
Redis 6.2
PgBouncer 1.15.0

Important Upgrade Instructions for Administrators

ZenHub Enterprise for Virtual Machine

⚠️ NOTE: Specifically for the upgrade from ZHE 3.2 -> ZHE 3.3, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.2 for any reason.

  • You must be running either ZHE 3.2.0 or ZHE 3.2.1 to perform the upgrade to ZHE 3.3.0.

  • For users currently running ZenHub Enterprise 3.2.0 or 3.2.1, look for an email from our team which will include a download link for the 3.3.0 upgrade package. The upgrade process is detailed in our documentation.

ZenHub Enterprise for Kubernetes

  • Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:

⚠️ NOTE: The upgrade from ZHE 3.2 -> ZHE 3.3 will require a service outage, due to the underlying data migration being performed. Make sure to back up your data and test your backups prior to performing the upgrade. For large datasets allocate an appropriate amount of time for the migration.

⚠️ NOTE: Amazon DocumentDB 3.6 can be used for the ZHE 3.2->3.3 upgrade if not using TLS with DocumentDB. Otherwise, DocumentDB 3.6 must be upgraded to 4.0 before the ZHE 3.2->3.3 upgrade. Please see the AWS documentation and reach out to support@zenhub.com if you have any questions.

1. Prepare
  • You need to get the kustomization.yaml you configured to setup ZenHub
  • Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-

It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.

  • Make a copy of your existing kustomization.yaml and keep it handy for the next step
2. Update kustomization.yaml
  • Check out the zenhub-enterprise repository at the tag of this release
  • Populate the new kustomization.yaml with your existing configuration values

Be sure to replace any additional customized configuration (such as ingress, TLS configuration) with your original configuration from before as well.

  • If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
  • Run the script found in k8s-cluster/update/zhe-upgrade.sh via the commands below:

If you use the ZenHub registry

cd update
./zhe-upgrade.sh yourNamespace

If you use your own registry

cd update
./zhe-upgrade.sh yourNamespace yourRegistryName
4. Application updates

In your new kustomization.yaml, update the cluster image tags to use the new images for this release:

If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's

images:
  - name: kraken-webapp
    newName: us.gcr.io/zenhub-public/kraken-webapp
    newTag: zhe-3.3.0
  - name: kraken-extension
    newName: us.gcr.io/zenhub-public/kraken-extension
    newTag: zhe-3.3.0
  - name: kraken-zhe-admin
    newName: us.gcr.io/zenhub-public/kraken-zhe-admin
    newTag: zhe-3.3.0
  - name: raptor-backend
    newName: us.gcr.io/zenhub-public/raptor-backend
    newTag: zhe-3.3.0
  - name: toad-backend
    newName: us.gcr.io/zenhub-public/toad-backend
    newTag: zhe-3.3.0
  - name: sanitycheck
    newName: us.gcr.io/zenhub-public/sanitycheck
    newTag: zhe-3.3.0
  - name: busybox
    newName: docker.io/library/busybox
    newTag: latest
  - name: nginx
    newName: docker.io/library/nginx
    newTag: latest
  • Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your kustomization.yaml
kustomize build . | kubectl diff -f-
  • If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-
5. Finalize
  • Securely store the updated kustomization.yaml
a9cd72b
Compare
Choose a tag to compare

These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
  • For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".

IMPORTANT: ZenHub Enterprise 3.2 supports GitHub Enterprise versions: 2.22, 3.0, 3.1, and 3.2

What's new in ZenHub Enterprise 3.2.1

Features

  • None

Security Fixes

  • None

Bug Fixes

  • Fixed race condition that would occur during a restore from database backups, which also affected upgrades from ZHE 3.1 to ZHE 3.2.0
  • Upgrade bundle for VM now performs more preliminary checks to ensure the environment meets upgrade requirements

Changes

  • Increased timeout duration for backups and restores to better handle a large amount of data
  • URL redirect setup to point IP requests to the hostname

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround is present in the documentation.
  • File uploads in the web application (not extension) are limited to 1MB in size.
  • On more recent versions of GitHub Enterprise, when viewing a GitHub issue from the GitHub issues list the ZenHub extension may require a page refresh to display ZenHub props such as Estimate and Epic

VM Embedded Component Versions

Component Version
Ubuntu 20.04.2
K3s v1.20.8+k3s1
Kubernetes v1.20.8
Kustomize v3.9.4
Fluentd v1.6-debian-1
Postgresql 11.12.0
MongoDB 4.4.6
RabbitMQ 3.8
Redis 6.2
PgBouncer 1.15.0

Important Upgrade Instructions for Administrators

ZenHub Enterprise for Virtual Machine

⚠️ NOTE: Specifically for the upgrade from ZHE 3.1 -> ZHE 3.2.1, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.1 for any reason.

  • For users currently running ZenHub Enterprise 2.44, you must first migrate to 3.1.1 prior to upgrading to 3.2.1
  • For users currently running ZenHub Enterprise 3.1.0 or 3.1.1, look for an email from our team which will include a download link for the 3.2.1 upgrade package. The upgrade process is detailed in our documentation.

If you have previously performed a restore while using ZenHub Enterprise 3.1 (via zhe-config --restore), we have released a patch file that must be applied before performing the upgrade to ZenHub Enterprise 3.2.1. Follow the steps below to apply and then upgrade (we recommend all customers perform steps 1 and 2 before the upgrade):

  1. Download the patch to your VM
  2. Run the patch via bash zhe_31x_restore_patch.run
  3. Perform a restore from a snapshot using zhe-config --restore
  4. Take a machine level backup of the VM
  5. Run the 3.2.1 upgrade as per our documentation

ZenHub Enterprise for Kubernetes

  • Upgrading from 3.2.0 -> 3.2.1 is possible, but not necessary. No changes have been made to the app, as this release only contains fixes to the upgrade path for ZenHub for VM. If you would still like to upgrade your ZenHub cluster from 3.2.0 to 3.2.1, you can follow the regular application upgrade steps.
a6bba25
Compare
Choose a tag to compare

These release notes are for ZenHub Enterprise for Virtual Machine and ZenHub Enterprise for Kubernetes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.
  • For administrators planning upgrades, please refer to the section "Important Upgrade Instructions for Administrators".

IMPORTANT: ZenHub Enterprise 3.2 supports GitHub Enterprise versions: 2.22, 3.0 and 3.1

What's new in ZenHub Enterprise 3.2.0

Features

Select all in a pipeline

Today we're thrilled to ship a feature that will surely help with sprint planning and organizing your Board. Once in multi-select mode, you can now select up to 50 Issues in a pipeline!

With this initial release, we're limiting the amount of selected Issues to 50 as we scale up and improve the queuing system to handle a greater number of requests.

A large performance improvement

We released another large piece of our new backend, "Raptor". We saw performance improvements across the app, up to 96%! With this release, we've also removed the 500 closed Issue limit (self-imposed to stay within GitHub's rate limit) on both the Cumulative flow and Control chart. These two charts have also been updated from being able to query a maximum of 6 months in the past to 24 months!

New tutorials and customized onboarding

ZenHub’s new tutorials and onboarding experience gives new users the basics, and helps existing users level up.

We’ll show you in-app tutorials personalized for you, whether you’re a developer focused on committing and tracking your code changes, or a project manager looking for a better way to prioritize and collaborate on your work.

Looking to brush up on your ZenHub knowledge? Access our new personalized tutorials via the “View Tutorials” section in your sidebar.

Burndown Chart bug fix

The ideal completion slope of Burndown chart was a little bit too aggressive at the start of your sprint vs the end. Maybe we wanted you to push hard in the first half to enjoy a more relaxed second half or it was a math error on our side. Who knows but the Burndown chart now shows an equal ideal completion slope in the first half vs the second half (PS. It was a math error).

Brand new epic page

Our epic page has been revamped to offer a brand new design and much needed usability improvements. You can now work right out of your epic page and:

  • get issue insights
  • see estimates, labels and assignees for all your issues without the extra clicks
  • use issue options to remove issues from the epic, close issues or set as high priority
  • rearrange your issues (send to top/send to bottom)

Untitled(2)

Automated Workflows 🎉

We have launched Automated Workflows as a way for you to automate hand-offs, create aggregated Board views, and clean up Issue statuses and pipelines!

You will see detailed timeline events when an Issue is moved due to an automation. See who, what, where, and when an Issue was moved and be able to track it through your workflow.

Untitled(3)

Heads up! Board notifications will display when moving Issues between pipelines. You will now see where an Issue is moved in other Workspaces based connected through your workflow.

We've included in-context prompts when creating a new Workspace or manually moving Issues in another Workspace (PS. If you're still manually moving Issues in other Workspaces... click the "Workflows" link on the sidebar!)

More updates to Epics

Roadmaps and Epics start and end dates can now be set from the Epic page itself! Once dates have been set, a new [View on Roadmap] button will appear below the Issue list in order to see how the Epic fits within your team's bigger picture.

Untitled(6)

Authentication updates for the ZenHub browser extension

If you've needed to refresh your GitHub authentication tokens on the extension lately, you may have noticed a change in the process. Re-authorizing is now done through a small popup in order to keep you in context with what you're working on.

Load only the Issues that relate to your team

With the new Workspace Filter, your Board will only load Issues with the labels you’ve selected. All other Issues will still exist in the repo but won't show up in this Workspace, speeding up load times and reducing clutter.

Add a Workspace filter in the Edit Workspace modal in your sidebar. Keep in mind, unlike the regular Board filters — which only filter your view of the Board — Workspace Filter applies for everyone in your team.

Automatically sort Issues when setting up a new Workspace

It's like the Sorting Hat of Issues - except it's logic-powered, not magic-powered.

When you create a new Workspace, Issues will automatically be sorted into relevant Pipelines, reducing the amount of setup time required. Right now, Issues will be sorted according to these triggers:

  • Issues in the current Milestone will be moved to Sprint Backlog
  • Issues with no recent activity will be moved to Icebox
  • Issues with connected PRs will be moved to In progress

This will be a one-time sort, meaning Issues will only be moved once during the initial Workspace setup.

Burn Pipeline dropdown update

The Burn Pipeline dropdown on the Burndown report now selects all pipelines after the selection to better follow the workflow of sequential pipelines.

Badge and label style changes

All badges and labels have been updated to match GitHub’s UI. Round corners are in again!

Closed pipeline enhanced

Issue ←→ PR connections are now visible across all pipelines, including the Closed pipeline.

A plethora of small updates

  • Videos can be uploaded and viewed in issues and comments in the ZenHub webapp (support for the ZenHub extension is in progress).
  • To help you get up and running faster with a new Workspace, issues updated in the last 30 - 90 days will automatically be moved to the Sprint Backlog (note: this only happens the first time you create a Workspace).
  • When connecting a PR to an issue, the most recent issues you worked on will appear in the dropdown first.
  • Updated estimate selector in the Issue sidebar to make it easier to quickly estimate Issues

  • Added more filters to the Board by default (from 6 to 7)
  • Updated background colour for title + description inputs when editing an Issue
  • Added error state when an Issue doesn’t exist in the Workspace
  • Show search results (Issue and Story point count) during keyword search

See PR reviewers and review status on the Board

ZenHub now shows reviewers and review status on PR cards! Take a look at any PR card on your board and you’ll see the avatar of the reviewer(s), and a colourful dot that quickly indicates the status.

  • Red - requested changes
  • Green - approved changes
  • Grey - left review comments
  • Yellow - pending review

ZenHub Sprints are here!

ZenHub Sprints launched earlier this week so here's the TL;DR of what changed.

  • Sprints are scoped to a Workspace whereas Milestones are tied to a repo
  • Sprints are automatically created based on your set schedule
  • Sprints can be automatically built from your backlog based on velocity
  • Incomplete issues can be automatically rolled over to the next Sprint
  • Issues can now live in more than one Sprint, keeping current and past velocity reporting accurate (vs always showing 100% completion when moving incomplete issues to a new Sprint)
  • When turning on the Automatically build new sprints feature, a suggested average velocity will be displayed.

Connect multiple Issues to the same Pull Request

In addition to being able to link multiple PRs to one Issue, you can now link multiple Issues to one PR. Yep, we know that sounds pretty confusing. But don’t worry - the feature is very straightforward!

If several issues can be resolved with a single PR (for example, duplicate bug reports), you can connect all of those issues to the PR. As the PR moves through the board, the Issues will automatically follow - no need to update each individual ticket.

ZenHub support for GitHub keywords 🔗

No more pesky manual linking! For all new PRs you create, GitHub keywords (fixes, closes, resolves) will now automatically link the PR and Issue in the ZenHub Board!

As Issues move through the Board, the linked PR will travel with it. When the PR is closed, the Issue will close as well - plus they’ll remain linked in the Closed pipeline for future reference.

Please note - for now, keywords can only be used during PR creation, not editing (meaning they won’t appear linked on the Board if you edit a PR to add the keyword later).

Board loading speed

Through a series of optimizations and our new backend service, we were able to reduce 1 second from the average load time of the Board. A 20% improvement!

Use Shift + click for multi-select

You can now quickly select multiple Issues on the board by holding down the Shift key. Once selected, you can apply bulk changes to Issues, such as adding to an Epic, applying a label, or moving pipelines.

Cancel issue creation

A Cancel button will now be disabled during new Issue creation.

Assignee selector update

Hopefully this has gone (visually) unnoticed but we have quietly updated the assignee selector by caching assignees rather than pulling the data from GitHub. We've seen up to 10x performance improvements for teams with 100s to 1000s of users.

New Board UI

You may have noticed that the Board is looking sleeker and more modern! We made a few UI changes to help you focus on what’s important, such as:

  • Pipeline expand/collapse will now be hidden until hovering over a pipeline.
  • We’ve removed pipeline boarders to simplify the look of the Board.

Security Fixes

  • Updated embedded Kubernetes in ZHE for VM
  • Updated embedded backend databases in ZHE for VM
  • Added support for the latest 4.x version of MongoDB in ZHE for K8s

Bug Fixes

  • Setting static IP using zhe-config --staticip now works even if networking has not yet been configured in ZHE for VM

Changes

  • Added PgBouncer for backend PostgreSQL in ZHE for VM
  • Disabled TLS 1.0 and 1.1 in ZHE for VM
  • Moved location of Postgres TLS config in ZHE for K8s
  • Updated Ingress API version from v1beta1 to v1
  • Enabled network configuration with zhe-config for any hypervisor in ZHE for VM
  • Added command zhe-config --version to display ZHE version in ZHE for VM
  • Included documentation for configuring a staging or disaster recovery instance of ZHE for VM

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.
  • File uploads in the web application (not extension) are limited to 1MB in size.

VM Embedded Component Versions

Component Version
Ubuntu 20.04.2
K3s v1.20.8+k3s1
Kubernetes v1.20.8
Kustomize v3.9.4
Fluentd v1.6-debian-1
Postgresql 11.12.0
MongoDB 4.4.6
RabbitMQ 3.8
Redis 6.2
PgBouncer 1.15.0

Important Upgrade Instructions for Administrators

ZenHub Enterprise for Virtual Machine

⚠️ NOTE: For the upgrade from ZHE 3.1 -> ZHE 3.2, the regular rollback steps cannot be used. Please perform a machine level snapshot prior to upgrading to use as a backup in case you need to revert back to ZHE 3.1 for any reason.

  • For users currently running ZenHub Enterprise 2.44, you must first migrate to 3.1.1 prior to upgrading to 3.2.0
  • For users currently running ZenHub Enterprise 3.1.0 or 3.1.1, look for an email from our team which will include a download link for the 3.2 upgrade package. The upgrade process is detailed in our documentation.

ZenHub Enterprise for Kubernetes

  • Some extra upgrade instructions have been added specifically for this release due to some database changes that accompany the application updates. Please follow the upgrade instructions below for this release:

⚠️ NOTE: The upgrade from ZHE 3.0 -> ZHE 3.2 will require a service outage, due to the underlying data migration being performed. Make sure to back up your data and test your backups prior to performing the upgrade. For large datasets allocate an appropriate amount of time for the migration.

1. Prepare
  • You need to get the kustomization.yaml you configured with all the secrets to take into account
  • Perform a diff to make sure no outstanding changes are waiting to be applied
kustomize build . | kubectl diff -f-

It should exit 0 and only display a warning of unused variables. If changes are pending, apply them before starting the upgrade process.

  • Make a copy of your existing kustomization.yaml and keep it handy for the next step
2. Update kustomization.yaml
  • Check out the zenhub-enterprise repository at the tag of this release
  • Populate the new kustomization.yaml with your existing configuration values and add a value for the new configuration below:
secretGenerator:
  - name: configuration
    behavior: merge
    literals:
      ...

      - cable_redis_url=redis://<your_redis_url>:6379/1

An important label in the kustomization.yaml has changed from app.kubernetes.io/name to app.kubernetes.io/application, so please ensure that the common labels look like this:

commonLabels:
  app.kubernetes.io/part-of: zenhub-enterprise
  app.kubernetes.io/application: zenhub
  app.kubernetes.io/instance: zhe-for-k8s
  app.kubernetes.io/managed-by: kustomize

Be sure to replace any additional customized configuration (such as ingress) with your original configuration from before as well.

  • If you are using your own registry and not ZenHub's registry, upload the new images tagged with this release to your registry.
3. Database changes
  • Run the script found in k8s-cluster/update/zhe-upgrade.sh via the commands below:

If you use the ZenHub registry

cd update
./zhe-upgrade.sh yourNamespace

If you use your own registry

cd update
./zhe-upgrade.sh yourNamespace yourRegistryName
4. Application updates

In your new kustomization.yaml, update the cluster image tags to use the new images for this release:

If you are using your own registry, ensure that the newName fields are configured for that instead of ZenHub's

images:
  - name: kraken-webapp
    newName: us.gcr.io/zenhub-public/kraken-webapp
    newTag: enterprise-3.2.0
  - name: kraken-extension
    newName: us.gcr.io/zenhub-public/kraken-extension
    newTag: enterprise-3.2.0
  - name: kraken-zhe-admin
    newName: us.gcr.io/zenhub-public/kraken-zhe-admin
    newTag: enterprise-3.2.0
  - name: raptor-backend
    newName: us.gcr.io/zenhub-public/raptor-backend
    newTag: enterprise-3.2.0
  - name: toad-backend
    newName: us.gcr.io/zenhub-public/toad-backend
    newTag: enterprise-3.2.0
  - name: sanitycheck
    newName: us.gcr.io/zenhub-public/sanitycheck
    newTag: enterprise-3.2.0
  - name: busybox
    newName: docker.io/library/busybox
    newTag: latest
  - name: nginx
    newName: docker.io/library/nginx
    newTag: latest
  • Then perform a diff to check what the upgrade will do (this command must be run from the directory that contains your kustomization.yaml
kustomize build . | kubectl diff -f-
  • If everything looks correct, you can deploy the cluster via:
kustomize build . | kubectl apply -f-
5. Finalize
  • Securely store the updated kustomization.yaml
4a7804c
Compare
Choose a tag to compare

ZenHub Enterprise 3.1.2

These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.

  • For users currently running ZenHub Enterprise 2.44, you may migrate directly to 3.1.2 instead of 3.1.1 or 3.1.0
  • For users currently running ZenHub Enterprise 3.1.0 or 3.1.1, look for an email from our team which will include a download link for the 3.1.2 upgrade package. The upgrade process is detailed in our documentation.
  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.1.2 supports the following GitHub Enterprise versions: 2.22, and 3.0

What's new in ZenHub Enterprise 3.1.2 since ZenHub Enterprise 3.1.1

Security Fixes

Bug Fixes

  • MongoDB restore process for 2.44 -> 3.1.x migration now accounts for unsafe index values which caused migration failures for some customers.

Changes

  • Integrated the 31x_restore_patch into 3.1.2. The patch does not need to be applied on 3.1.2.

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.
  • Environments migrated from ZHE 2.44 that have not used the same CRYPTO_PASS will see a blank page in the Milestones view on the web app.
  • File uploads in the web application (not extension) are limited to 1MB in size.

That's all for now! Stay tuned for more updates coming soon! 🎉

4a7804c
Compare
Choose a tag to compare

ZenHub Enterprise 3.1.1

These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.

  • For users currently running ZenHub Enterprise 2.44, you may migrate directly to 3.1.1 instead of 3.1.0
  • For users currently running ZenHub Enterprise 3.1.0, look for an email from our team which will include a download link for the 3.1.1 upgrade package. The upgrade process is detailed in our documentation.
  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.1.1 supports the following GitHub Enterprise versions: 2.22, and 3.0

What's new in ZenHub Enterprise 3.1.1 since ZenHub Enterprise 3.1.0

Security Fixes

  • Hide nginx version in response headers

Bug Fixes

  • Fixed an issue that prevented the upload of files and images through the ZenHub web app

Changes

  • Added VM size recommendations
  • Deployment now scales itself to fit the VM size in which it's deployed
  • Users can resize the deployment after resizing the VM by running zhe-config --reload
  • Improved consistency and added missing content to the documentation in virtual-machine/README.md
  • Added a feature to zhe-config to import container images in the event they're deleted from containerd
  • Disk utilization threshold to begin kubelet image garbage collection increased from 85% to 95%
  • Disk utilization threshold to stop kubelet image garbage collection increased from 80% to 85%

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.
  • Environments migrated from ZHE 2.44 that have not used the same CRYPTO_PASS will see a blank page in the Milestones view on the web app.
  • File uploads in the web application (not extension) are limited to 1MB in size.

That's all for now! Stay tuned for more updates coming soon! 🎉

52faf43
Compare
Choose a tag to compare

ZenHub Enterprise 3.1.0

These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.1.0 supports the following GitHub Enterprise versions: 2.22, and 3.0

What's new in ZenHub Enterprise 3.1.0 since ZenHub Enterprise 3.1.0-beta1

Security Fixes

  • K3s version updated to v1.19.10
  • Added configuration to stop search engine indexing of ZenHub Enterprise pages
  • Hard capped SSH retries to 5 attempts

Bug Fixes

  • Fixed broken link in documentation for migrating from ZenHub
  • Added a wait condition for database sanity checks on ZenHub startup
  • Added support to use existing GitHub configuration variables from ZHE2 when migrating
  • Fixed some broken links in the README.md
  • Updated support email in the virtual machine login banner text
  • Resolved error thrown when setting a static IP using zhe-config --vmware-staticip
  • Support bundle name now correctly matches the name printed to the console upon bundle completion

Changes

  • Added additional information to support bundle contents
  • Snapshot timestamps now include hours and minutes
  • Added majorly automated solution to migrate data from ZHE2 to ZHE3.1
  • Added migration documentation for moving data from ZHE2 to ZHE3.1
  • Reformatted the zhe-config --help page
  • Added support for GCP images
  • Usage report now produces sum of active users instead of a list
  • Updated documentation regarding default user for AWS
  • Added configuration option to set custom NTP servers

Known Issues

  • Too many authentication failures may be reported when attempting to SSH into the VM, which can be caused by multiple SSH keys loaded in the connecting workstation's SSH agent. A workaround has been added to the documentation.
  • File uploads in the web application (not extension) are limited to 1MB in size.

What's new in ZenHub Enterprise 3.1.0 since ZenHub Enterprise 2.44

Release Date: May 20, 2021

3.1.0 is the first production release of the new ZHE3 VM, a new infrastructure platform that will unlock a host of features for ZenHub On-Premise customers.

Since this release is an infrastructure update, these release notes will focus on the infrastructure changes. For more details, please visit the README. Upgrading your infrastructure will prepare you to receive the massive feature updates that will be coming very soon!

Kubernetes inside a VM

Shared architecture with ZenHub SaaS and ZenHub Enterprise for Kubernetes

The biggest change with this release is the complete rebuild of the ZenHub Enterprise VM, which includes:

  • Ubuntu 20.04
  • Full containerization of services, orchestrated by a lightweight Kubernetes binary (K3s)
  • New command-line based configuration process

You will edit one file to provide variables and secrets specific to your deployment, before using the new zhe-config command-line tool to build and deploy the application within the VM.

Release deployment to the ZenHubHQ/zenhub-enterprise public repo

A new home for everything ZenHub Enterprise

  • Release notes
  • All of the kustomize infrastructure-as-code YAML (not relevant for virtual machine users)
  • Deployment documentation for virtual machine and K8s deployments
  • ZHE2->ZHE3 migration documentation
  • Operations and maintenance documentation

The public repo also helps give a voice to you, the system administrators running ZenHub Enterprise On-Premise. Feel free to submit an issue or PR if you have any requests or concerns!

New API Endpoint

Edit your scripts and OAuth App

With the changes in infrastructure, it was necessary to change the ZenHub Enterprise API root endpoint. Don't worry—the change is simple—just add /api to the end of your server's domain name.

This also means you will need to update the Authorization callback URL in the OAuth App in your GitHub Enterprise Server to https://<zenhub-domain-name>/api/auth/github/callback.

callbackURL.png

Note: We highly suggest communicating this to your internal users in advance of doing your production migration to v3.X so that they have a chance to update their scripts and tools.

Licensing Changes

ZHE2 made use of a .zhl file to manage licensing. ZHE3 now uses an environment variable called enterprise_license_token that accepts a license in the form of a JSON Web Token (JWT). All existing licenses will be recreated as JWTs and issued to customers when setting up their ZHE3 VM.

ZenHub Enterprise Admin UI

Simplified and secure

Our new admin UI is simplified and more reflective of ZenHub's new brand identity.

Screen Shot 2021-04-11 at 11 15 08 PM

The admin UI also runs on a separate URL from the main application (for VM, this is a separate port—8443), so you can lock it down allowing only your system administrators to have access.

To get started deploying ZenHub Enterprise 3.1.0, head over to the README!

That's all for now! Stay tuned for more updates coming soon! 🎉

48d3c4c
Compare
Choose a tag to compare

v3.1.0-beta

Pre-release
Pre-release

ZenHub Enterprise 3.1.0-beta

These release notes are for ZenHub Enterprise (On-Premise) Virtual Machine with GitHub Enterprise Server. 3.1.0-beta is intended to be used only by customers taking part in the closed beta. Beta participants will be contacted with instructions for obtaining the VM images and their ZHE3 beta license.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.1.0-beta supports the following GitHub Enterprise versions: 2.22, and 3.0

What's new in ZenHub Enterprise 3.1.0-beta since ZenHub Enterprise 2.44

Release Date: April 21, 2021

3.1.0-beta is the first beta release of the new ZHE3 VM, a new infrastructure platform that will unlock a host of features for ZenHub On-Premise customers.

Since this release is an infrastructure update, these release notes will focus on the infrastructure changes. For more details, please visit the README. Upgrading your infrastructure will prepare you to receive the massive feature updates that will be coming very soon!

Kubernetes inside a VM

Shared architecture with ZenHub SaaS and ZenHub Enterprise for Kubernetes

The biggest change with this release is the complete rebuild of the ZenHub Enterprise VM, which includes:

  • Ubuntu 20.04
  • Full containerization of services, orchestrated by a lightweight Kubernetes binary (K3s)
  • New command-line based configuration process

You will edit one file to provide variables and secrets specific to your deployment, before using the new zhe-config command-line tool to build and deploy the application within the VM.

Release deployment to the ZenHubHQ/zenhub-enterprise public repo

A new home for everything ZenHub Enterprise

  • Release notes
  • All of the kustomize infrastructure-as-code YAML (not relevant for virtual machine users)
  • Deployment documentation for virtual machine and K8s deployments
  • ZHE2->ZHE3 migration documentation
  • Operations and maintenance documentation

The public repo also helps give a voice to you, the system administrators running ZenHub Enterprise On-Premise. Feel free to submit an issue or PR if you have any requests or concerns!

New API Endpoint

Edit your scripts and OAuth App

With the changes in infrastructure, it was necessary to change the ZenHub Enterprise API root endpoint. Don't worry—the change is simple—just add /api to the end of your server's domain name.

This also means you will need to update the Authorization callback URL in the OAuth App in your GitHub Enterprise Server to https://<zenhub-domain-name>/api/auth/github/callback.

callbackURL.png

Note: We highly suggest communicating this to your internal users in advance of doing your production migration to v3.X so that they have a chance to update their scripts and tools.

Licensing changes

Instead of a .zhl file, in ZHE3 we will have an environment variable enterprise_license_token that accepts a JSON Web Token (JWT) that represents your license. All existing licenses will be recreated as JWTs and issued to customers.

ZenHub Enterprise Admin UI

Simplified and secure

Since we have moved the vast majority of the configuration into Kustomize, our new admin UI is simplified and more reflective of ZenHub's new brand identity.

Screen Shot 2021-04-11 at 11 15 08 PM

The admin UI also runs on a separate URL (for VM, this is a separate port—8443) from the main application, so you can lock it down allowing only your system administrators to have access.

To get started deploying ZenHub Enterprise 3.1.0-beta, head over to the README!

That's all for now! Stay tuned for more updates coming soon! 🎉

d1b8e1f
Compare
Choose a tag to compare

ZenHub Enterprise 3.0.0

These Release Notes are for ZenHub Enterprise (On-Premise), for customers using ZenHub for Kubernetes with GitHub Enterprise Server.

  • Beginning with ZenHub Enterprise 3.0.0, customers will be able to choose whether to deploy to a Kubernetes cluster or to a VM.

  • For all users wishing to deploy ZenHub Enterprise for VMs, ZenHub Enterprise 3.1 will provide support for this. Please wait until that version is available. For information about your current 2.x application, please visit the 2.x release notes.

  • For all users using ZenHub on github.com, please check out our new feature announcements on our product changelog.

IMPORTANT: ZenHub Enterprise 3.0.0 supports the following GitHub Enterprise versions: 2.22, and 3.0

What's new in ZenHub Enterprise 3.0.0 since 3.0.0-RC2

Release Date: April 13, 2021

New Features

  • Keypair for signing license keys has been rotated
  • Added documentation for enabling maintenance mode
  • Maintenance mode page has been updated
  • Lowered pod system requirements in smallest deployment configuration
  • Removed option to use local cluster storage (beta feature only)
  • Terraform module now includes AWS MQ RabbitMQ

Bug Fixes

  • Websocket pods no longer getting stuck in a restart loop

What's new in ZenHub Enterprise 3.0.0 since 2.44

Release Date: April 13, 2021

With this release, we have re-architected ZenHub Enterprise to be hosted in a Kubernetes cluster! This allows ZenHub to leverage all the benefits of running in a cluster and has paved the way for feature-parity with ZenHub's SaaS application, which contains some highly sought-after features like Workflows, Sprints and Planning Poker. As a result, we will be able to release updates much more quickly and seamlessly to our beloved on-premise enterprise customers.

Since this release is an infrastructure update, these release notes will focus on the infrastructure changes. For more details, please visit the README. Upgrading your infrastructure will prepare you to receive the massive feature updates that will be coming very soon!

Infrastructure-as-Code deployment to Kubernetes

Use kustomize to configure and deploy ZenHub

The biggest change with this release is moving from a VM-only platform to full containerization and deployment to Kubernetes (apart from the stateful data) with infrastructure-as-code. You will edit one file to provide variables and secrets specific to your deployment, before using kustomize and kubectl to build and deploy your application.

getpods

Our forthcoming VM-based platform will be based on the same system, using a lightweight embedded Kubernetes binary.

Ability to use externally managed databases

You're in control! ZenHub for Kubernetes makes use of externally managed databases. Deploy a Postgres database, Mongo database, and S3 API compatible object storage buckets in your data centre or public cloud environment to benefit from the scalability, availability, performance, and ease of administration that comes with managed databases!

Release deployment to the ZenHubHQ/zenhub-enterprise public repo

A new home for everything ZenHub Enterprise

  • Release notes
  • All of the kustomize infrastructure-as-code YAML
  • Deployment documentation for virtual machine and K8s deployments
  • ZHE2->ZHE3 migration documentation
  • Operations and maintenance documentation

The public repo also helps give a voice to you, the system administrators running ZenHub Enterprise On-Premise. Feel free to submit an issue or PR if you have any requests or concerns!

New API Endpoint

Edit your scripts and OAuth App

With the changes in infrastructure, it was necessary to change the ZenHub Enterprise API root endpoint. Don't worry—the change is simple—just add /api to the end of your server's domain name.

This also means you will need to update the Authorization callback URL in the OAuth App in your GitHub Enterprise Server to https://<zenhub-domain-name>/api/auth/github/callback.

callbackURL.png

Note: We highly suggest communicating this to your internal users in advance of doing your production migration to v3.0.0 so that they have a chance to update their scripts and tools.

Licensing changes

Instead of a .zhl file, in ZHE3 we will have an environment variable enterprise_license_token that accepts a JSON Web Token (JWT) that represents your license in the kustomization.yaml. All existing licenses will be recreated as JWTs and issued to customers.

ZenHub Enterprise Admin UI

Simplified and secure

Since we have moved the vast majority of the configuration into Kustomize, our new admin UI is simplified and more reflective of ZenHub's new brand identity.

Screen Shot 2021-04-11 at 11 15 08 PM

The admin UI also runs on a separate URL from the main application, so you can lock it down allowing only your system administrators to have access.

To get started deploying ZenHub Enterprise 3.0.0, head over to the README!

That's all for now! Stay tuned for more updates coming soon! 🎉