Release Notes

The following release notes are for the Business Edition of Portainer. For Community Edition release notes, refer to the GitHub releases page.

Release 2.19.5

April 22, 2024

Portainer

  • Resolved CVE-2024-29296 by creating uniform response time for login attempts

Release 2.19.4

December 6, 2023

Swarm

  • Resolved the inability to change the replica set for a swarm service, addressing errors related to invalid CredentialSpec (A refresh of your browser cache may be required) portainer/portainer#10702

Release 2.19.3

November 22, 2023

Portainer

Release 2.19.2

November 13, 2023

Breaking changes

  • Deprecation notice of Nomad support in next minor release.

Edge

  • Fixed bug around Update and Rollback menu showing when Edge Compute feature is disabled.

  • Resolved an issue where edge group details were missing from the update and rollback table.

  • Resolved an issue where searching on the Update & Rollback page caused the screen to go blank

  • Resolved an issue where users were unable to delete any failed remote update scheduler entries.

  • Resolved an issue where edge stack rollback and pause updates remained stuck in the pending state

  • Resolved an issue where the update scheduler would stay in a "pending" state indefinitely, even when some edge agents were already running the latest version in the target edge group.

  • Added a deprecation notice to inform users about the upcoming removal of Nomad support in next minor release.

Swarm

  • Resolved an issue where the Docker service page could not load correctly when the deployment was created using the GMSA credential spec parameter. portainer/portainer#10571

Kubernetes

  • Introduced the ability for Helm chart repository searching and registry browsing to operate behind a forward proxy. portainer/portainer#10432

Portainer

  • Improved security around non-admin user environment information access. portainer/portainer#10434

  • Fixed 'unable to upgrade' error that could potentially occur when upgrading from CE to BE.

  • Resolved an issue where stacks that were initially deployed from a template could not be modified. portainer/portainer#10563

  • Resolved an issue where users couldn't define a proxy for the agent and edge agent when their network relied on a proxy for internet access. portainer/portainer#10564

  • Resolved an issue where pulling and redeploying Git stacks took longer than expected. portainer/portainer#10565

  • Resolved an issue where stacks triggered from webhooks were marked as inactive status, even though they were running as expected portainer/portainer#10567

  • Improved storage efficiency by retaining only one copy of Git repositories for versioning, preventing excessive disk usage.

  • Fixed an issue where authentication failures occurred when editing stacks deployed from Git repositories created with version 2.19.0 or 2.19.1.

  • Fixed an issue introduced in 2.19.0 when deploying from a custom template that was set up via API, where defined mustache variables are not always being prompted for.

  • Resolved an issue where users could interact with a console even after logging out from another tab in the browser portainer/portainer#10568

  • Resolved an issue where there was no warning for version mismatch between the server and edge agent, now UI clearly indicates matching server and edge agent versions are required for feature availability. portainer/portainer#10569

  • Resolved an issue where containers were not deleted when users removed them from asynchronous environments by browsing snapshots.

Rest API Changes

New Endpoints: 1
  • POST /edge_update_schedules/{id}

Modified Endpoints: 3
  • POST /auth/logout

    • Description changed from 'Access policy: authenticated' to 'Access policy: public'

  • POST /edge_update_schedules

    • Responses changed

      • New response: 200

      • Deleted response: 204

  • GET /edge_update_schedules/previous_versions

    • New query param: environmentIds

    • Deleted query param: skipScheduleID

Release 2.19.1

September 20, 2023

Breaking changes

  • Changes to API format and checking of some requests - See REST API Changes below for more details.

Edge

  • Resolved an issue with snapshots between Edge Agent versions 2.18.2 and Portainer Server 2.19.0, which caused dropping of remote commands in async mode due to mismatches.

  • Database migration for edge URLs now includes a check to verify if the edge feature is enabled. This fix ensures a more accurate and controlled upgrade process.

  • Fixed an issue where the migration of Edge Tunnel URLs was broken when the Portainer API URL did not contain a port.

  • We've improved the transparency of Edge Agent update scheduler and rollback statuses. Now, you'll have clear explanations for each status, simplifying monitoring and management.

  • We've added a info notice to clarify that the option to update edge agent from a private registry is exclusively available in Edge Agent version 2.18.1 or newer.

  • Fixed an issue where edge devices in the waiting room were incorrectly counted as part of the dynamic edge group.

Kubernetes

  • Fixed an issue introduced in 2.19.0 where standard and read-only users could no longer view node stats on a Kubernetes cluster.

  • Fixed an issue introduced in 2.19.0 where the Kubernetes Create Application screen no longer showed in the bottom of page summary when a Deployment would be created.

MicroK8s

  • Fixed an issue introduced in 2.19.0 where MicroK8s cluster creation would fail if the SSH access used a passworded login and sudo access required the password.

Portainer

  • Fixed an issue where backup files were missing the Chisel private key. This could have disrupted communication between the Portainer server and agent after a restoration from backup. portainer/portainer#10335

  • Improved the upgrade process for the Portainer server, upgrade process now halts on database migration errors, preventing database version mismatches for a more stable environment. portainer/portainer#10336

  • Fixed an issue when chatbot integration was enabled globally, where a user who then set a chatbot key could not subsequently clear out their key to turn off the feature for themselves.

  • Fixed an issue introduced in 2.19.0 when the chatbot integration feature was enabled for a user, where container logs did not display in the log viewer unless in full-screen mode.

  • Fixed an issue where webhooks were failing when updating a stack deployed from a private Git repository.

  • We've added a backup reminder for in-app updates, ensuring data safety during the update process.

  • Resolved issue where failed stack status persists after incorrect compose from Git. Now auto-recovers with the next successful update.

  • Fixed an issue where usernames and passwords were being stored along with Git stack configurations when Git credentials were used.

  • Fixed an issue where using spaces in an Organizational Unit (OU) or Common Name (CN) name caused incorrect data to be displayed in the Active Directory configuration.

  • Fixed an issue where toggles could be activated outside of their intended component area, potentially leading to inadvertent toggling. portainer/portainer#10324

REST API Changes

  • Fixed API endpoints that were broken in the 2.19.0 release, ensuring that they retain their previous functionality. portainer/portainer#10337

  • Fixed an issue introduced in 2.19.0 when Kubernetes environment metrics API features were enabled, where these features would return an 'Unable to reach metrics API' error.

  • Introduced new format around the change of a user's password via API. portainer/portainer#10326

  • Updated the checking around change of a user via API. portainer/portainer#10326

Release 2.19.0

August 31, 2023

Breaking changes

  • Introduced the ability for admins and environment admins to enable/disable community addons on a MicroK8s cluster created via Portainer. Note: On upgrade to this release, existing MicroK8s clusters created via Portainer are set to allow community addons.

  • A number of components/views have been migrated from Angular to React.

  • Helm, eksctl, and docker-compose have been updated to newer versions.

  • Internal versioning on stacks feature has introduced file structure changes in 2.19.

  • We have addressed an API issue in which an incorrect parameter was being used for API endpoint /edge_groups. Users relying on the HasEdgeGroup parameter should now use HasEdgeJob to achieve the intended functionality.

  • Select API endpoints are broken and will be restored in the next release:- see REST API changes for specific details.

Resolved CVEs

Edge

  • Fixed an issue where the edge agent was getting disconnected due to user updates to their remote update scheduler.

  • Resolved an issue where users were unable to create a rollback and subsequently edit it from the scheduler.

  • Introduced visual enhancement of dynamic progress bar for clearer edge stack status tracking. Get real-time deployment progress at a glance.

  • Fixed an issue where deploying a large volume edge stack triggered a 'URI too large' error. portainer/portainer#10128

  • Resolved an issue where edge devices were not fully shown in the waiting room when the total amount exceeded 100

  • Introducing new statuses - 'Running', 'Deploying', and 'Partially running' - for increased transparency in edge stack monitoring.

  • Introduced staggered deployment & rollback for edge stacks. Update in stages, reduce risks & revert failed updates seamlessly.

  • Introduced internal versioning & Git commit ID as edge stack version. Clearer version tracking for Git-deployed stacks.

  • Added support for relative paths in Git-deployed edge stacks.

  • Resolved an issue where the 'change windows setting' option was shifting outside of the div when a user was using a smaller screen

  • Fixed an API issue where the incorrect parameter HasEdgeGroup was being used instead of HasEdgeJob for endpoint /edge_groups. Users relying on the HasEdgeGroup parameter should now use HasEdgeJob to achieve the intended functionality.

  • Introducing the ability to use environment variables for edge stack.

  • Introducing a new feature: GitOps Edge Configurations, which simplify edge device configurations with GitOps. Effortlessly manage settings via version-controlled Git repositories for enhanced configuration control.

  • Introducing the latest commit ID display in edge stacks. Perfect for GitOps updates, this feature lets you easily track your running version. Stay informed and up-to-date effortlessly.

  • Introduced ability to push per-device configurations effortlessly. Bundle settings in a zip package, Portainer matches and delivers to edge devices. Simplify management, enhance precision.

  • Fixed an issue where the count of edge stack deployments was incorrect when dealing with asynchronous devices exceeding 100.

  • Fixed an issue where the order of the list changed while logs were being retrieved, and where previously cleared logs were reappearing after retrieving logs for a different environment.

  • Improved logging for edge agent when polling fails. This enhancement provides more informative and detailed logs when polling encounters failures, aiding in quicker identification and resolution of issues. portainer/portainer#10143

  • Introduced a feature that empowers you to associate edge devices with newly selected or dynamically generated meta values. Enhance flexibility and precision in device management with this innovative addition.

  • Introduced an informative enhancement to the waiting room experience. With the addition of the 'Last Check-In' field, users now have valuable insights into when edge devices last communicated with the Portainer server.

  • Introduced ability to remove edge devices that you no longer want sitting in the waiting room. This feature empowers you with streamlined waiting room management, enabling you to maintain a dynamic and optimised edge environment.

  • Resolved an issue where editing an existing scheduler caused an error due to a missing edge stack on a related endpoint.

  • Resolved an issue where users were able to create schedulers with an empty edge group, which is no longer allowed to ensure proper functionality and avoid potential errors portainer/portainer#10149

  • Resolved an issue with Portainer tunnel server address validation error during migration. This fix ensures that when migrating, tunnel server addresses are validated correctly.

  • Fixed an issue where Edge groups were incorrectly marked as 'in use' after a scheduler was executed.

  • Addressed an issue where snapshot information was not reliable when the environment was offline. This fix ensures that snapshot information is now accurately presented even when the environment is offline.

  • Resolved an issue where the count for acknowledged edge stacks was dropping after deployment.

  • Resolved an issue where the edge agent default poll frequency selector was not lining up correctly portainer/portainer#10150

  • Resolved an issue where users were unable to create an edge group when there were no members present in that group. Edge groups can now be created without requiring initial members, offering greater flexibility in edge device and configuration management. portainer/portainer#10153

  • Introduce an enhancement to our snapshot creation process for edge devices which streamlines the snapshot creation experience, providing users with a more efficient and user-friendly way to capture snapshots on edge devices. portainer/portainer#10154

  • Introduced ability to seamlessly browse snapshots for your asynchronous environment and access detailed stack information.

  • Fixed an issue where environment files were not functioning properly in Git deployments for edge stacks. portainer/portainer#10171

  • Introduced webhooks for edge stack, you can now set up webhooks for your edge stacks, enabling automated polling for GitOps updates. portainer/portainer#10178

Docker

  • Addressed an issue where the Docker client was not utilizing version negotiation. portainer/portainer#10125

  • Resolved an issue where the image name was displayed incorrectly when a user tried to duplicate or edit a container portainer/portainer#10126

  • Fixed an issue in the API where sending files to a Docker endpoint resulted in a panic. portainer/portainer#10129

  • Resolved an issue with Docker Proxy's performance, resulting in improved overall performance and responsiveness when using the Docker Proxy feature. portainer/portainer#10131

  • Resolved an issue in the Docker Container List where searching by published ports was no longer working. portainer/portainer#6656

  • Resolved an issue where '.' was not allowed in the image name (but should be) when building a Docker image via the UI. portainer/portainer#8047

  • Resolved some minor UI issues in Docker Services-related screens. portainer/portainer#10117

Swarm

  • Fixed an issue in Docker Swarm version 24.0.0 where image tags were not being displayed. portainer/portainer#10134

  • Resolved an issue where clicking into the details page of a Swarm stack would redirect users to the service section instead of the top of the page portainer/portainer#10151

Kubernetes

  • Resolved an issue around Operator role users not being able to perform rolling restart, redeploy and rollback to previous version for Deployment, DaemonSet and StatefulSet resources.

  • Resolved an issue introduced in 2.18 that prevented the use of Amazon EKS provisioning of a Kubernetes as a Service (KaaS) cluster.

  • Fixed a Kubernetes environment issue when restricting access to the default namespace, where any other namespace with a resource quota may have the resource reservations of its apps incorrectly calculated, preventing standard users from editing the apps.

  • Amended the path for the eksctl binary (used by Amazon EKS KaaS cluster provisioning functionality) to a new expected location.

  • Adjusted Kubernetes Cluster setup screen's ingress settings to be clearer and to give info on ingress defaults. portainer/portainer#10101

  • Resolved an issue with Kubernetes ECR image pull where the secret token was not updating on manifest deployment. portainer/portainer#10119

  • Resolved an issue on use of the 'Restrict Proc Mount Types' Kubernetes pod security constraint where the restriction was not being applied.

  • Resolved an issue in the Kubernetes Advanced deployment screen, where a backend panic could occur when deploying some invalid YAML manifests.

  • Updated the link to Portainer documentation (following docs reorganization) for Kubernetes Add Environment via kubeconfig Import.

  • Resolved an issue where Node stats for a Google Kubernetes Engine (GKE) cluster gave an error 'unable to retrieve node metrics'.

  • Migrated the Kubernetes Add/Edit Application screen's Services section from Angular to React. portainer/portainer#9235

  • Reintroduced the ability to specify and use (via Add/Edit Application) ingress defaults (hostname and annotations). portainer/portainer#10030

  • Reintroduced the ability to publish via ingress from the Add/Edit Application screen. portainer/portainer#10103

  • Introduced the ability to force setting of a note when creating/editing a Kubernetes application (via form), so it can immediately be labelled with its intended use.

  • Introduced correct redirecting of the user, following deployment of a Kubernetes manifest. Previously the user was always returned to the Applications List but will now arrive back at the screen from which they accessed the Advanced Deployment function. portainer/portainer#10115

  • Migrated the Kubernetes Application Details screen's Summary and Details sections from Angular to React. portainer/portainer#10102

  • Introduced a loading spinner to the Add/Edit ingress screen's ingress class dropdown, to indicate that available options are still being retrieved. portainer/portainer#10000

  • Resolved an issue that was occurring on the exposing of Portainer over a subpath, where Kubernetes Cluster Setup and other screens failed to load and reported an error. portainer/portainer#10112

  • Resolved an issue around limiting of Kubernetes pod security constraints updates.

  • Split the Kubernetes ConfigMaps & Secrets functionality in order to provide better performance and a clearer user experience. We now have separate tabs in the list screen and separate add/edit functions. portainer/portainer#9222

  • Introduced the ability to set annotations against Kubernetes Services, so they can be configured for service meshes and other tools.

  • Resolved an issue with Kubernetes pages where a warning showed in the browser console ('findDOMNode is deprecated in StrictMode') when resource assignment was first toggled on for the namespace. portainer/portainer#10111

  • Updated BE Kubernetes Add/Edit Ingress screen to allow use of NodePort or LoadBalancer service types (in addition to existing ClusterIP).

  • Updated Kubernetes ConfigMaps & Secrets terminology that was previously shown as Configurations, so as to align more clearly with Kubernetes. portainer/portainer#10025

  • Introduced the ability to specify a manifest to be auto deployed to a Kubernetes cluster when connecting or provisioning one. This allows the environment to be initialized with users, namespaces, secrets, etc., as required.

  • In the Dashboard screen of Kubernetes environments, Ingresses and Services panels have now been introduced, providing a count of these resources and an easy means to click through and access their list screens. portainer/portainer#9223

  • Introduced showing of the error that occurs when a Kubernetes deployment is prevented by any pod security constraints that have been enabled.

  • Migrated Kubernetes Application console page from Angular to React. portainer/portainer#9177

  • Resolved a Node details issue where nodes showed incorrect role of 'Worker' due to deprecated 'node-role.kubernetes.io/master' K8s label (now 'control-plane'). Also where MicroK8s cluster nodes were incorrectly identified (though not due to labels). portainer/portainer#10104

KaaS

  • Ensured Kubernetes 1.27 is supported with Google Kubernetes Engine (GKE) provisioning of KaaS clusters.

  • Ensured Kubernetes 1.26 is supported with Google Kubernetes Engine (GKE) provisioning of KaaS clusters.

  • Ensured Kubernetes 1.27 is supported with Azure Kubernetes Service (AKS) provisioning of KaaS clusters.

  • Ensured Kubernetes 1.27 is supported with Digital Ocean Kubernetes (DOKS) provisioning of KaaS clusters.

  • Ensured Kubernetes 1.26 is supported with Linode Kubernetes Engine (LKE) provisioning of KaaS clusters.

  • Applied updates and ensured Kubernetes 1.27 is supported with Amazon Elastic Kubernetes Service (EKS) provisioning of KaaS clusters.

MicroK8s

  • Added Beta support for MicroK8s version 1.28 when creating and managing MicroK8s clusters. Note that 1.27 is still the default option for now, as only limited testing of 1.28 has been performed.

  • Introduced the ability for admins to enable the nfs addon (that has prerequisites) for a MicroK8s cluster, and for admins and environments admins to enable or disable the nfs addon for a MicroK8s cluster, after is has been provisioned.

  • Introduced the ability for admins to enable the openebs addon (that has prerequisites) for a MicroK8s cluster, and for admins and environments admins to enable or disable the openebs addon for a MicroK8s cluster, after is has been provisioned.

  • Introduced the ability for admins and environment admins to retrieve a status report on each control plane node of a MicroK8s cluster.

  • Introduced the ability for admins and environment admins to enable and disable addons that require arguments and generally specify arguments for addons for a MicroK8s cluster.

  • Introduced the ability for admins and environment admins to connect via SSH console to nodes in a MicroK8s cluster.

  • Introduced the ability for admins and environment admins to enable/disable community addons on a MicroK8s cluster created via Portainer. Note: On upgrade to this release, existing MicroK8s clusters created via Portainer are set to allow community addons.

  • Introduced the ability for admins and environment admins to enable or disable addons for a MicroK8s cluster, after it has been provisioned.

  • Introduced the ability for admins, when removing a MicroK8s environment, to also delete the cluster on the nodes, leaving them in a fresh state, ready to begin again.

  • Introduced the ability for admins and environment admins to horizontally scale up or down a MicroK8s cluster (i.e. add or remove nodes), after it has been provisioned.

  • Introduced the ability for admins and environment admins to upgrade the version of a MicroK8s cluster.

  • Added support for MicroK8s version 1.27 when creating MicroK8s clusters and removed warnings in the UI around a Metrics Server issue with MicroK8s 1.25 and 1.26, now that they've been patched to resolve the issue.

  • Fixed an issue in Environment and Cluster Details screens for a MicroK8s cluster that failed to provision via Portainer. In this scenario, the display of enabled addons no longer triggers (whereas, it would previously still attempt it, causing a problem).

  • Added info text to Kubernetes MicroK8s functionality to inform that nodes must be internet routable and open on certain ports.

Portainer

  • Fixed an issue where a bad gateway response occurred when updating an environment with an empty URL. portainer/portainer#10123

  • Resolved an issue where users were unable to deploy a stack when utilising an image from a private GitLab registry. portainer/portainer#10124

  • To identify Portainer submenus more clearly, their sub-options are now indented. portainer/portainer#9216

  • Added a link to the Portainer Assistant/Chatbot settings taking you to an explanatory blogpost.

  • Fixed an issue where the Portainer Assistant/Chatbot icon could eclipse list table screens' pagination.

  • Introducing a new feature that enhances version tracking and clarity for stacks deployed from Git repositories.

  • Resolved an issue around orphaned environments being included in the total count of nodes.

  • Renamed "Automatic updates" in Git deployment section to "GitOps Updates" to clarify the feature at first glance for users. Please note this is a name change only and no functionality has been altered. portainer/portainer#10175

  • Resolved an issue with the App Templates screen, where a Kubernetes icon was incorrectly showing for Docker Swarm stacks. Also updated the Swagger API documentation to detail the existence of a 'Compose edge stack' App Template (numbered 4) type. portainer/portainer#10028

  • Fixed an issue where saving Git credentials and subsequently redeploying a stack resulted in an error.

  • Resolved a minor UI issue where warning icons were smaller in size in multi-line warning messages. portainer/portainer#10118

  • Fixed an issue where standard users were unable to create Azure Container Instances (ACI) resources. portainer/portainer#10152

  • Fixed an issue where line break HTML tags were showing in some pop-up dialogs instead of actual line breaks. portainer/portainer#9226

  • Improved App Templates page with enhanced cursor icon and tile highlighting portainer/portainer#10136

  • Improved rolling back to CE from a CE to BE migration, by providing better logging and performing a check that the db file exists. portainer/portainer#9225

  • Fixed an issue where edge devices were incorrectly counted as nodes while in the waiting room. Now, waiting room devices are excluded from node count, ensuring accurate resource allocation and adherence to policy.

  • Fixed an issue where the primary environment remained permanently down after restoring from backup. portainer/portainer#10137

  • Introduced validation to prevent the use of invalid names when creating or editing Kubernetes or Docker Custom Templates. portainer/portainer#10113

  • Fixed an issue where the 'Skip TLS Verification' option was not functioning properly for custom templates. portainer/portainer#10138

  • Resolved a minor UI issue where multi-line text-tip and form-error icons were incorrectly vertically center-aligned rather than top-aligned. portainer/portainer#10118

  • Fixed an issue where the hover interaction for the environment tile on the homepage was missing portainer/portainer#10136

  • Fixed a security issue where usernames and passwords were displayed in responses. portainer/portainer#10140

  • Improved error logging in libhttp to provide more useful context. portainer/portainer#10142

  • Addressed an issue where TLS handshake error messages were being logged, which should only occur when using the DEBUG log level. portainer/portainer#10144

  • Fixed an issue where using spaces in an Organizational Unit (OU) or Common Name (CN) name caused incorrect data to be displayed in the Active Directory configuration.

  • Fixed an issue where Git deployment did not synchronize authentication status.

  • Resolved an issue where unnecessary snapshots were being loaded on the home page, leading to improved loading times and a smoother user experience portainer/portainer#10147

  • Resolved an issue where users were not being notified about the proper referencing of their uploaded .env files, requiring them to now utilize "stack.env" for appropriate referencing portainer/portainer#10148

  • Introduced a 'copy to clipboard' button to web editors within the Portainer UI. portainer/portainer#10116

  • Introduced the ability to manage time in seconds or milliseconds for container logs, expanding your time management options beyond seconds for more insightful troubleshooting. portainer/portainer#10176

  • Resolved a logging issue with database migrations, where, if an error occurred causing a rollback to the pre-upgrade version of the database, that error was no longer output to the console. portainer/portainer#10110

  • Provided icons for 'image up to date' indicators (in place of the previous colored circles) shown in Docker Stacks, Services and Containers list screens. This improves accessibility for color-blind users.

  • Resolved an issue that prevented users from stopping stacks with invalid project names during their upgrade from versions 2.6 or 2.7 to 2.13, 2.14, 2.15, 2.16, and subsequent versions. portainer/portainer#10163

  • Resolved an issue that prevented users from deleting stacks with invalid project names during their upgrade from versions 2.6 or 2.7 to 2.13, 2.14, 2.15, 2.16, and subsequent versions. portainer/portainer#10164

  • Resolved an issue where users were unable to browse image tags in a private Sonatype registry.

  • Resolved an issue where mouse clicks were not functioning within the "Display Users" section of Active Directory under authentication settings.

  • Resolved an issue where users were encountering difficulties when attempting to push images using a service principal account on Azure Registry. portainer/portainer#10155

  • Fixed an issue where delete confirmation modals were absent for edge stacks, Docker images, environment groups, and tags. portainer/portainer#10156

  • Fixed an issue where the creation of manifest file paths slice was incorrect. portainer/portainer#10170

  • Resolved a minor grammatical issue with a log line recorded when the Docker image up to date indicator check runs but there are no registries defined.

  • Community contribution - The enhancement ensures that the response rewrite operation is properly wrapped with a valid status check, contributing to a more robust and reliable system behavior. portainer/portainer#2705

  • Fixed an issue where enabling GPU support on existing containers resulted in errors. portainer/portainer#10174

  • Addressed an issue where users were unable to update the TLS certificate for the Docker API environment. portainer/portainer#10166

  • Resolved an issue where incorrect AWS ECR icon was used when creating registry portainer/portainer#10162

  • Added a feature that allows users to update to the latest Portainer Business Edition version directly from within the app

  • Improved the way ANSI escape codes are handled in logs. With this enhancement, logs will now provide clearer and more readable information by effectively stripping out ANSI escape codes.

  • Fixed a user interface issue where only up to 100 groups were being displayed. portainer/portainer#10160

  • Addressed an issue where using incorrect Azure registry credentials resulted in errors, even after updating with correct credentials, the issue persisted. portainer/portainer#10159

  • Resolved an issue where custom templates created from Git were not being pulled again at deploy time. This improvement has also been extended to Kubernetes custom templates. portainer/portainer#10157

Development

  • Resolved an issue with new React version list screens where filter icons were not positioned next to the correct column heading but were abutting the next heading along. portainer/portainer#10098

  • Applied changes to the helper-reset-password utility to prevent it being accidentally used with the Docker Desktop Extension version of Portainer (where it could break access to the Portainer instance). portainer/portainer#10109

  • Replaced archived gorilla/securecookie library with just the function that we need extracted out. portainer/portainer#10008

  • Transitioned Edge stack environments table to React, delivering a more dynamic user experience with modernized interface, improved performance, and interactive management. portainer/portainer#10210

REST API Changes

  • Corrected API method from 'GET' to 'POST' and path for generate edge key in Swagger API docs

  • Documented 'excludeSnapshots' in Swagger API docs portainer/portainer#10130

  • Documented webhook types in Swagger API docs portainer/portainer#9121

  • Resolved a 2.0 validation error in our Swagger API documentation portainer/portainer#10135

  • Corrected an error in our Swagger API documentation where 'EdgeTunnelServerAddress' was marked as required. It is now correctly marked as optional

  • We have updated the response for /endpoint to correctly reference 'EdgeCheckinInterval' in line with the accurate API Swagger documentation portainer/portainer#10139

  • Corrected missing type and 'file' to 'File' in Swagger API documentation for custom templates portainer/portainer#10141

  • Added descriptions to the Swagger API documentation for Kubernetes API endpoints that were previously missing from the docs. portainer/portainer#10106

  • Fixed an API issue where requests to create edge stacks with invalid deployment types were erroneously accepted portainer/portainer#10168

  • Addressed an issue in the 'edgeStackCreate' API where sending an incorrect request resulted in a 500 error response instead of the expected 400 error. portainer/portainer#10169

  • Fixed an issue in Swagger API documentation where 'endpointId' was incorrectly marked as optional. It is now correctly set as a required field portainer/portainer#10173

  • Removed the incorrect documentation for the DELETE method on the license API, as it is not supported. Documented the correct way to perform the operation using the POST method on the license API in Swagger API documentation.

  • Corrected Swagger API documentation for starting or stopping stacks portainer/portainer#8001

  • Corrected 'ResourceId' and 'endpointId' as required instead of optional in Swagger API documentation for webhooks portainer/portainer#9121

  • Fixed the Swagger API documentation to require 'endpointId' when updating a stack portainer/portainer#10161

  • Corrected 'Endpoints' to be listed in alphabetical order in Swagger API docs portainer/portainer#10158

Broken endpoints: 10
  • GET /cloud/microk8s/addons

  • POST /cloud/{provider}

  • GET /cloudcredentials

  • POST /cloudcredentials

  • PUT /cloudcredentials

  • POST /custom_templates

  • POST /edge_jobs

  • POST /edge_stacks

  • GET /endpoints/{id}/edge/generate-key

  • POST /stacks

New endpoints: 70
  • GET /cloud/credentials

  • POST /cloud/credentials

  • PUT /cloud/credentials

  • GET /cloud/endpoints/{endpointid}/nodes/nodestatus

  • GET /cloud/endpoints/{environmentid}/addons

  • POST /cloud/endpoints/{environmentid}/addons

  • POST /cloud/endpoints/{environmentid}/nodes/add

  • POST /cloud/endpoints/{environmentid}/nodes/remove

  • POST /cloud/endpoints/{environmentid}/upgrade

  • GET /cloud/endpoints/{environmentid}/version

  • POST /cloud/testssh

  • POST /custom_templates/file

  • POST /custom_templates/repository

  • POST /custom_templates/string

  • PUT /custom_templates/{id}/git_fetch

  • GET /edge_configurations

  • POST /edge_configurations

  • PUT /edge_configurations

  • DELETE /edge_configurations/{id}

  • GET /edge_configurations/{id}

  • GET /edge_configurations/{id}/files

  • PUT /edge_configurations/{id}/{state}

  • POST /edge_jobs/create/file

  • POST /edge_jobs/create/string

  • POST /edge_stacks/create/file

  • POST /edge_stacks/create/repository

  • POST /edge_stacks/create/string

  • POST /edge_stacks/webhooks/{webhookID}

  • PUT /edge_stacks/{id}/git

  • GET /edge_stacks/{id}/stagger/status

  • POST /endpoints/edge/generate-key

  • PUT /endpoints/relations

  • POST /gitops/repo/file/preview

  • GET /kubernetes/{endpointId}/opa

  • GET /kubernetes/{id}/ingresscontrollers

  • PUT /kubernetes/{id}/ingresscontrollers

  • POST /kubernetes/{id}/ingresses/delete

  • GET /kubernetes/{id}/metrics/nodes

  • GET /kubernetes/{id}/metrics/nodes/{name}

  • GET /kubernetes/{id}/metrics/pods/{namespace}

  • GET /kubernetes/{id}/metrics/pods/{namespace}/{name}

  • GET /kubernetes/{id}/namespaces

  • DELETE /kubernetes/{id}/namespaces/{namespace}

  • GET /kubernetes/{id}/namespaces/{namespace}

  • POST /kubernetes/{id}/namespaces/{namespace}

  • PUT /kubernetes/{id}/namespaces/{namespace}

  • GET /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers

  • PUT /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers

  • GET /kubernetes/{id}/namespaces/{namespace}/ingresses

  • POST /kubernetes/{id}/namespaces/{namespace}/ingresses

  • PUT /kubernetes/{id}/namespaces/{namespace}/ingresses

  • GET /kubernetes/{id}/namespaces/{namespace}/services

  • POST /kubernetes/{id}/namespaces/{namespace}/services

  • PUT /kubernetes/{id}/namespaces/{namespace}/services

  • PUT /kubernetes/{id}/opa

  • POST /kubernetes/{id}/services/delete

  • POST /stacks/create/kubernetes/repository

  • POST /stacks/create/kubernetes/string

  • POST /stacks/create/kubernetes/url

  • POST /stacks/create/standalone/file

  • POST /stacks/create/standalone/repository

  • POST /stacks/create/standalone/string

  • POST /stacks/create/swarm/file

  • POST /stacks/create/swarm/repository

  • POST /stacks/create/swarm/string

  • POST /system/update

  • POST /webhooks/{id}

  • DELETE /webhooks/{token}

  • PUT /webhooks/{token}

  • GET /websocket/microk8s-shell

Modified endpoints: 56
  • GET /cloud/{provider}/info

    • New path param: provider

    • Deleted query param: credentialId

  • PUT /custom_templates/{id}

  • GET /docker/{environmentId}/containers/{containerID}/image_status

    • New path param: containerId

    • New path param: environmentId

  • GET /docker/{environmentId}/services/{serviceID}/image_status

    • New path param: environmentId

    • New path param: serviceId

  • GET /docker/{environmentId}/snapshot/containers/{containerId}

    • New path param: containerId

  • GET /docker/{environmentId}/stacks/{id}/images_status

    • New path param: environmentId

    • New path param: id

  • PUT /edge_stacks/{id}

  • GET /edge_stacks/{id}/file

    • New query param: commitHash

    • New query param: version

  • PUT /edge_stacks/{id}/status

  • DELETE /edge_stacks/{id}/status/{endpoint_id}

    • New path param: environmentId

    • Deprecated changed from false to true

  • GET /edge_update_schedules/previous_versions

    • New query param: skipScheduleID

  • DELETE /edge_update_schedules/{id}

    • New path param: id

  • GET /edge_update_schedules/{id}

    • New path param: id

  • GET /endpoints

    • New query param: edgeCheckInPassedSeconds

    • New query param: edgeStackStatus

    • New query param: excludeSnapshots

  • POST /endpoints

  • POST /endpoints/edge/async

    • Deleted path param: id

  • DELETE /endpoints/{id}

    • Responses changed

      • New response: 403

  • PUT /endpoints/{id}

  • GET /endpoints/{id}/edge/stacks/{stackId}

    • New query param: version

  • PUT /endpoints/{id}/pools/{rpn}/access

    • Description changed from 'update the access on the resource pool in the current environment Access policy: restricted' to 'update the access on the namespace in the current environment Access policy: restricted'

  • POST /fdo/configure/{guid}

    • New path param: guid

  • DELETE /fdo/profiles/{id}

    • New path param: id

  • GET /fdo/profiles/{id}

    • New path param: id

  • PUT /fdo/profiles/{id}

    • New path param: id

  • POST /fdo/profiles/{id}/duplicate

    • New path param: id

  • POST /gitops/repo/files/search

  • GET /kubernetes/config

    • Description changed from 'Generates kubeconfig file enabling client communication with k8s api server Access policy: authenticated' to 'Generate a kubeconfig file enabling client communication with k8s api server Access policy: authenticated'

  • PUT /kubernetes/{endpointId}/opa

    • New path param: environmentId

    • Deleted path param: id

  • GET /kubernetes/{id}/namespaces/{namespace}/applications

    • New path param: namespace

    • Deleted query param: namespace

  • GET /kubernetes/{id}/opa

    • Modified path param: id

      • Description changed from 'Environment(Endpoint) identifier' to 'Environment identifier'

  • GET /nomad/endpoints/{endpointID}/allocation/{id}/events

    • New path param: environmentId

    • New path param: id

  • GET /nomad/endpoints/{endpointID}/allocation/{id}/logs

    • New path param: environmentId

    • New path param: id

  • GET /nomad/endpoints/{endpointID}/dashboard

    • New path param: environmentId

  • GET /nomad/endpoints/{endpointID}/jobs

    • New path param: environmentId

  • DELETE /nomad/endpoints/{endpointID}/jobs/{id}

    • New path param: environmentId

    • New path param: id

  • GET /nomad/endpoints/{endpointID}/leader

    • New path param: environmentId

  • POST /open_amt/{id}/activate

    • Modified path param: id

      • Description changed from 'Environment(Endpoint) identifier' to 'Environment identifier'

  • POST /open_amt/{id}/devices/{deviceId}/action

    • New path param: deviceId

    • New path param: id

  • POST /open_amt/{id}/devices_features/{deviceId}

    • New path param: deviceId

    • New path param: id

  • GET /open_amt/{id}/info

    • New path param: id

  • DELETE /registries/{id}/ecr/repositories/{repositoryName}/tags

    • New path param: repositoryName

  • PUT /settings

  • PUT /ssl

  • POST /stacks/webhooks/{webhookID}

  • DELETE /stacks/{id}

    • Modified query param: endpointId

      • Description changed from 'Environment(Endpoint) identifier used to remove an external stack (required when external is set to true)' to 'Environment identifier'

      • Required changed from false to true

  • PUT /stacks/{id}

    • Modified query param: endpointId

      • Description changed from 'Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack.' to 'Environment identifier'

      • Required changed from false to true

  • PUT /stacks/{id}/associate

    • Modified query param: endpointId

      • Description changed from 'Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack.' to 'Environment identifier'

  • GET /stacks/{id}/file

    • New query param: commitHash

    • New query param: version

  • POST /stacks/{id}/start

    • New query param: endpointId

  • POST /stacks/{id}/stop

    • New query param: endpointId

  • POST /tags

  • GET /webhooks

    • Modified query param: EndpointID

      • Required changed from false to true

    • Modified query param: ResourceID

      • Required changed from false to true

  • POST /webhooks

  • PUT /webhooks/{id}

    • New path param: id

  • PUT /webhooks/{id}/reassign

    • New path param: id

  • POST /webhooks/{token}

    • Modified path param: token

Release 2.18.4

July 7, 2023

This release includes an experimental ChatGPT integration. Although it promises exciting possibilities, it's in the early stages of development. We recommend its use for testing and development, and urge caution in production environments. We greatly appreciate your feedback and understanding during this phase. portainer/portainer#9116

Resolved CVEs

Portainer dependencies

Docker

Swarm

Portainer

  • Resolved an issue where the static IP addresses in a macvlan were unexpectedly changed. portainer/portainer#9101

  • Enhanced the user experience of the 'Skip TLS Verification' feature by adding a confirmation modal. portainer/portainer#9098

  • Resolved an issue where recreate containers fail when it has a shared and external volumes. portainer/portainer#9102

  • Fixed issue where registry credential does not sync between registry configuration page and registry details page.

  • Fixed an issue around prompting for a new license.

  • Improved the way node count shows for trial licenses.

  • Resolved an issue where update or rollback was only executed when connection was re-established.

  • Introduced a change to allow removal of all Portainer licenses.

  • Fixed an issue where a warning banner was not always showing in the Homepage or Licenses page when licenses were close to expiring.

REST API Changes

  • Resolved an issue where the response from the API was inconsistent when querying all endpoints and a specific endpoint. portainer/portainer#9096

  • Corrected 'container' to 'containers' in Swagger API docs (Business Edition).

Release 2.18.3

May 22, 2023

In this release, we introduce an experimental ChatGPT integration. Although it promises exciting possibilities, it's in the early stages of development. We recommend its use for testing and development, and urge caution in production environments. We greatly appreciate your feedback and understanding during this phase.

Edge

  • Fixed issue preventing configuration of Portainer authentication settings with an alternative mTLS certificate

  • Resolved issue causing edge agent to skip command processing during full snapshot resend

Kubernetes

  • Restored options and wording in the Kubernetes Advanced deployment screen's Automatic updates section, following regression from changes in 2.17. (portainer/portainer#8950)

Docker

  • Resolved issue preventing correct display of network details when containers are running on an unexpected Docker swarm node. (portainer/portainer#8981)

Portainer

  • Introduced ChatGPT integration as an experimental feature, currently not recommended for production environment use

  • Fixed issue preventing LDAP server from creating a connection when using TLS 1.2. (portainer/portainer#8980)

  • Implemented minor UI changes to clarify existing experimental and beta features, ensuring accurate icon and wording display. (portainer/portainer#8951)

  • Corrected an issue causing the polling indicator to float incorrectly in UI when pulling Git repo list on the stack creation page. (portainer/portainer#8982)

  • Resolved syntax styling display issue in web editor. (portainer/portainer#8984)

  • Improved button color contrast in web editor. (portainer/portainer#8985)

  • Fixed visual hierarchy in web editor selection behavior. (portainer/portainer#8986)

REST API Changes

Release 2.18.2

May 1, 2023

Upgrade notice

  • Users upgrading from 2.16.x should note that a bug was introduced then which prevented enforcing of TLS verifications. This has now been fixed but, in circumstances where certificates were not set up correctly and appeared to work due to the bug, you may now need to resolve the certificate issue or deliberately set the new ‘Skip verification’ toggle.

Edge

  • Fixed issue where users were unable to update their Edge Agent to the latest version because the corresponding option was not available when creating a scheduled update

Kubernetes

  • Increased potential success rate of updating Portainer with larger databases by changing Kubernetes manifest and Helm chart for Portainer to have initialDelaySeconds of 45 (sec) and failureThreshold of 3. portainer/portainer#8860

Docker

Portainer

  • Fixed issue where the option to skip TLS verification was missing when editing a stack created from git. Additionally, to adhere to security best practices, the option’s default value has been corrected to be set to off during migration portainer/portainer#8853

  • Fixed issue where TLS verification was being skipped when creating / editing stacks created from git in version 2.16.x portainer/portainer#8853

  • Fixed issue where the port number in the displayed webhook link was incorrect when Portainer was running behind a reverse proxy

  • Resolved an issue with the updated web editor component, where it was not loading long YAML files correctly portainer/portainer#8848

Release 2.18.1

April 18, 2023

Please note 2.18.0 is not publicly available. This release is 2.18.1 and is our next GA release since "2.17.x". This was done due to the need to provide an upgradeable preview image to a customer.

Breaking changes

  • For breaking changes in the API, please see the REST API changes section.

  • The Kompose functionality in Kubernetes has been removed since 2.17.0. Compose yaml can no longer be deployed on Kubernetes.

  • Moved edge devices to the homepage view and removed edge devices menu option under edge compute.

  • Add devices button is replaced with new UX in environment wizard.

Resolved CVEs

Portainer dependencies
  • SNYK-JS-BOOTBOX-174704

  • SNYK-JS-FASTJSONPATCH-3182961

  • SNYK-JS-MINIMATCH-3050818

  • SNYK-JS-SANITIZEHTML-2957526

  • SNYK-JS-XMLDOMXMLDOM-3042243

  • SNYK-JS-XMLDOMXMLDOM-3092934

  • CVE-2022-23471

  • CVE-2021-41092

  • CVE-2022-41717

  • CVE-2022-32149

  • CVE-2022-27664

  • SNYK-GOLANG-GOLANGORGXNETHTTP2-3160322

Agent dependencies
  • CVE-2022-41717

  • SNYK-GOLANG-GOLANGORGXNETHTTP2-3160322

Upgrade notice

  • Since release 2.17.x we have added the ability to upgrade Edge Agents from Portainer when running on Docker Standalone / Docker Swarm / Nomad. Before using this feature we strongly advise to test this on a non-production environment first and have an alternative method available to connect to the Edge Device.

  • Any clusters connected to Portainer of version 1.23 Kubernetes and above will have their Pod Security Policies (if they have any and are using the pod security constraints feature) updated to the Pod Security Standards

Edge

  • Introduced a retry policy for edge stack deployment to improve success rate

  • Fixed issue where browse snapshot button was clickable for Kubernetes and Nomad edge agents in async mode

  • Fixed issue where upgrading edge agent from ECR private registry using certificates failed

  • Fixed issue when browsing async edge agents before first snapshot is received.

  • Provide feature flag for FDO feature to be shown in UI portainer/portainer#8696

  • Fixed issue when browsing non-existent async agent snapshot cause backend panic

  • Fixed issue for remote update schedules error incorrectly displaying for non admin users

  • Fixed the issue where the edge stack is not removed from edge agent when it has been deleted while edge agent is offline

  • Fixed issue where live connect button is clickable for async environment when it shouldn't be portainer/portainer#8697

  • Fixed issue where edge agent panics with malformed edge key

  • Introduced ability to view container's environment variable when browsing snapshot

  • Removed "Add Edge devices" from Edge Compute and introduced to Environment wizard by renaming Edge Agent to Edge Agent Standard and introduced Edge Agent Async UI options portainer/portainer#8783

  • Fixed an issue where "copy token" button was missing from edge agent environment wizard portainer/portainer#8554

  • Introduced remote updating edge agent from a private registry for docker standalone environment

  • Introduced ability to assign group, edge groups and tags to edge environment when using AEEC script

  • Fixed issue where live connect button is clickable for async environment when it shouldn't be portainer/portainer#8697

  • Fixed issue where edge job logs was not retrieved correctly when edge groups contain async devices

  • Changed default value for async check-in intervals from disabled to 1 minute to improve success rate of initial edge agent connection

  • Renamed AEEC to "Auto onboarding" for better user understanding

Kubernetes

  • Introduced a new feature to allow creating of a MicroK8s Kubernetes cluster on existing machines.

  • Improved performance of Kubernetes screens by adjusting rate limiting of Kubernetes go client. portainer/portainer#8682

  • Fixed an issue when provisioning a Civo Kubernetes cluster with the Kubernetes version left as the latest, due to Civo introducing Talos as a new Kubernetes cluster type (instead of K3s on Alpine) which then only applied to the latest Kubernetes version.

  • Improved Kubernetes Applications page performance by introducing a namespace filter. portainer/portainer#8637

  • Improved Kubernetes Dashboard page performance. portainer/portainer#8635

  • Improved the load time of various Kubernetes pages by removing existing API calls that retrieve namespace resource quota information, where they are not needed. portainer/portainer#8571

  • Introduced the ability to set annotations against various different Kubernetes objects via the existing form pages.

  • Introduced a new Services screen in Kubernetes environments to improve the visibility of all services that may exist in a cluster, and enable removing where they've inadvertently been left behind after manual removal of applications/deployments. portainer/portainer#8613

  • Introduced the ability to upload an internal SSL/TLS certificate which can then be used to access a Helm repository hosted on a private server.

  • Updated the pod security constraints feature to use newer OPA Gatekeeper 2.9 and moved the feature away from using Pod Security Policy resources with Kubernetes clusters of 1.23 and above (as they are now removed in Kubernetes 1.25 and above).

  • Added migration to ensure existing pod security constraints work on environments with new Pod Security Standards of updated OPA Gatekeeper 2.9. This includes migrating edge environments on post-upgrade connect that may occur on clicking into via Homepage.

  • Resolved an issue where pod security constraints were not being enforced (since 2.16).

Docker

  • Fixed issue where users are not able to re-create container with multiple networks

  • Fixed issue with relative path not working when private registry is used, due to private registry credentials not passing to unpacker

  • Resolved an issue where default storage detection logic that runs on Kubernetes environment connection was incorrectly running on Docker environment connection, and was therefore causing an error to be output to the logs (but was otherwise benign). portainer/portainer#8606

  • Improved the existing UI around GPU support for Docker Standalone environments, introduced an overall toggle to turn this on or off and generally improved performance in Docker Containers and Stacks screens where GPU columns may show. portainer/portainer#8646

  • Defaulted the image up to date indicator to on for new Docker environments added, or on upgrade from CE to BE for all Docker environments (now that caching and Ajax load performance improvements have been applied to this feature).

  • Fixed an issue where stack name validation was missing, causing deployments to fail portainer/portainer#8629

Nomad

  • Fixed issue where Nomad Edge Agent install script causes error when using environment variables

  • Introduced ability to upgrade edge agent in Nomad environment from within portainer UI

Portainer

  • Fixed issue where container log not showing when logs contain NULL value

  • Added form validation for S3 compatible host field

  • Resolved a minor UI issue with the Container details page's container health panel alignment and content label wrapping. portainer/portainer#8636

  • Fixed a typo in the placeholder text for the access control component's Authorized users dropdown where it said 'teams' but should have said 'users'. portainer/portainer#8565

  • Fixed issue where stack can not be deleted if relative path is removed from the mount point

  • Fixed issue where logs in JSON format displayed incorrectly in log viewer portainer/portainer#8787

  • Resolved an issue with slow performance of certain actions (such as bulk removing of unused container volumes or adding of Kubernetes ingresses) when a user has a long list of notifications (shown via the bell icon in the page header). portainer/portainer#8604

  • Fixed issue where you can not connect or configure Azure private registry from Portainer while registry is empty

  • Added release testing of ARM32 architecture for Portainer Agent

  • Resolved an issue that occurred when updating user preferences. portainer/portainer#8570

  • Introduced UI mechanism for automatic retrying of tunnel connection when it fails due to high latency portainer/portainer#8784

  • Added certificate support of AWS IAM Role Anywhere authentication for Agent and Edge Agent portainer/portainer#8789

  • Updated hide internal authentication prompt option to default to off

  • Fixed issue where searching is not functional in associated edge environment when creating edge group portainer/portainer#8589

  • Fixed issue with Docker Swarm environment where containers count weren't displaying correctly in homepage. portainer/portainer#8695

  • Fixed issue where skipping https verification was default to true for Azure git deployment portainer/portainer#8698

  • Fixed issue where TLS Min Version was not fully enforced portainer/portainer#8788

  • Fixed a minor issue on restarting a container where the toaster pop-up message shown had an extraneous slash in front of the container name. portainer/portainer#8563

  • Introduced ability to use different certificate for mTLS communication between Portainer server and agent.

  • Fixed an issue while in dark mode, where, with any auto-filled text in fill-ins, the cursor completely disappeared until you started typing again. portainer/portainer#8564

  • Resolved a minor issue in the Browse Registry screen on Kubernetes environments, where the Registries breadcrumb link would take non-admin users back to the Homepage instead of the Registries list screen.

  • Provide feature flag for FDO feature to be shown in UI portainer/portainer#8696

  • Fixed issue of missing requirement of TLS definition for endpoint creation and correct tagids parameter in swagger API portainer/portainer#8780

  • Improved Edge Agent Health status indicator and keep consistency with API response portainer/portainer#8781

  • Fixed issue where git deployment failed to edit or redeploy when compose path begin with slash portainer/portainer#8782

  • Fixed an issue in the restore from backup function, where a timeout error can occur and Portainer does not restart with the backup restored. portainer/portainer#8792

Development

REST API Changes

  • Fixed the API Swagger/OpenAPI documentation for some IDs that were defined as strings but should be integers. portainer/portainer#8794

  • Added to the API Swagger/OpenAPI documentation that you can upload a file to a Docker Standalone host when the host management feature is enabled. portainer/portainer#8793

New Endpoints: 2
  • GET /edge_update_schedules/previous_versions

  • POST /sshkeygen

Deleted Endpoints: 2
  • GET /system/info

  • POST /system/upgrade

Modified Endpoints: 39
  • POST /cloud/{provider}

  • POST /cloudcredentials

    • Description changed from 'Create a cloud credential Access policy: authenticated' to 'delete delete a cloud credential by ID Access policy: authenticated'

    • New query param: id

  • POST /custom_templates

  • PUT /custom_templates/{id}

  • POST /edge_groups

  • PUT /edge_groups/{id}

  • POST /edge_jobs

  • POST /edge_jobs/{id}

  • POST /edge_stacks

  • PUT /edge_stacks/{id}

  • POST /edge_update_schedules

  • GET /edge_update_schedules/active

  • GET /edge_update_schedules/agent_versions

  • POST /endpoint_groups

  • PUT /endpoint_groups/{id}

  • GET /endpoints

    • New query param: edgeAsync

    • Deleted query param: edgeDevice

    • Modified query param: edgeDeviceUntrusted

      • Description changed from 'if true, show only untrusted endpoints, if false show only trusted (relevant only for edge devices, and if edgeDevice is true)' to 'if true, show only untrusted edge agents, if false show only trusted edge agents (relevant only for edge agents)'

  • POST /endpoints

  • PUT /endpoints/{id}

  • POST /endpoints/{id}/docker/v2/browse/put

    • Description changed from 'Upload a file under a specific path on the file system of an environment (endpoint). Access policy: authenticated' to 'Use this environment(endpoint) to upload TLS files. Access policy: administrator'

    • Responses changed

      • New response: 204

      • Deleted response: 200

  • GET /endpoints/{id}/kubernetes/helm

    • Modified query param: filter

      • Required changed from true to false

    • Modified query param: namespace

      • Required changed from true to false

    • Modified query param: selector

      • Required changed from true to false

  • DELETE /endpoints/{id}/kubernetes/helm/{release}

    • Modified query param: namespace

      • Required changed from true to false

  • PUT /endpoints/{id}/registries/{registryId}

  • PUT /endpoints/{id}/settings

  • POST /gitops/repo/files/search

  • POST /gitops/repo/refs

  • POST /ldap/admin-groups

  • POST /ldap/check

  • POST /ldap/groups

  • POST /ldap/test

  • POST /ldap/users

  • POST /registries

  • PUT /registries/{id}

  • POST /resource_controls

  • PUT /settings

  • POST /stacks

  • POST /team

  • POST /webhooks

  • PUT /webhooks/{id}

  • PUT /webhooks/{id}/reassign

Release 2.17.1

February 22, 2023

Resolved CVEs

Docker

  • Fixed issue with recreating containers in the Portainer UI if they have been originally created via the CLI. portainer/portainer#8507

Portainer

  • Fixed an issue where upgrading to Business Edition leaves behind limited stack. portainer/portainer#8516

  • Fixed an issue where Edge Agent updater leaves behind limited stack.

  • Fixed grammar of placeholder for region field in S3 backup configuration. portainer/portainer#8515

  • Fixed an issue where an error occurred for upgrading Portainer to 2.17.0 version when Docker engine version is 19.03. portainer/portainer#8514

  • Fixed an issue where node enforcement message displayed incorrectly for trial license users.

  • Fixed an issue where git credentials are not selected when editing stack deployed from git repository.

Release 2.17.0

February 7, 2023

Known issues

  • Running Portainer with Docker Engine <= 19.03 (Docker API <= 1.40) will cause a fatal error similar to failed initializing upgrade service | error="failed to determine container platform: failed to retrieve docker info: Error response from daemon: client version 1.41 is too new. Maximum supported API version is 1.40"

Breaking changes

  • For breaking changes in the API, please see the REST API changes section

  • The Kompose functionality in Kubernetes has been removed. Compose yaml can no longer be deployed on Kubernetes.

  • Moved Edge Devices to the homepage view and removed Edge Devices menu option under Edge Compute

  • Add devices button is temporarily located on the Edge Compute Settings page

Resolved CVEs

Portainer dependencies

Agent dependencies

Upgrade notice

  • This release has added the ability to upgrade Edge Agents from Portainer when running on Docker Standalone. Before using this feature we strongly advise to test this on a non-production environment first and have an alternative method available to connect to the Edge Device.

Edge

  • Introduced the ability to remotely update edge agents from within Portainer

  • Moved Edge Devices to the homepage view: portainer/portainer#8333

  • Introduced the ability to browse snapshots of async edge environments from homepage view: portainer/portainer#8336

  • Optimized performance for scaling large numbers of edge agents: portainer/portainer#8349

  • Introduced option for pre-pull of images for edge stack deployment to increase deployment success rate

  • Added edge group support in edge jobs to allow execution across many devices

  • Introduce the ability to edit edge agent tunnel URL and API server URL from within Portainer

  • Introduced improved environment tile layout to address consistency when edge devices moved to homepage: portainer/portainer#8334

  • Clarified UX around polling intervals and poll frequency option in edge compute settings between async and normal edge agents.

  • Added info text to waiting room view

  • Fixed issue where edge stack incorrectly deployed to default namespace when there is a specified namespace defined in the manifest: portainer/portainer#8346

  • Fixed issue where select all checkbox is missing for edge stack and edge job tables: portainer/portainer#8029

  • Fixed issue with Edge device tags not showing on Create Edge Group screen: portainer/portainer#7936

  • Fixed issue where delete edge device does not remove it from the edge groups mapping: portainer/portainer#8348

  • Fixed issue where edge stack failed to deploy with private registry in async mode

  • Fixed issue where actions icon under edit edge stack page is not consistent

Kubernetes

  • Introduced new log viewer to Portainer Business Edition

  • Introduced the ability to edit the YAML manifest of Kubernetes objects and apply the changes via the Kubernetes patch function

  • Introduced global and cluster-level options to allow enforcing of code-based deployment of Kubernetes objects, preventing the use of Portainer forms and other less easy-to-repeat workflows

  • Introduced a new setting in the Cluster setup screen of a Kubernetes environment to allow enforcing of admin-only deploying of ingresses

  • Introduced the ability to specify updates to existing environment variables of a deployment via query string parameters on the Kubernetes application redeploy webhook

  • Added a rolling restart button to the Kube application UI

  • Introduced a new rollout-restart parameter to Kube application redeploy webhooks to allow remote initiating of zero-downtime deployment rolling restarts

  • Introduced an alternate means of authenticating connections to the Google Cloud platform (used by our KaaS provisioning of Google Kubernetes Engine environments), following their deprecation of the gcp auth plugin in Kubernetes v1.22 and removal in v1.26

  • Introduced experimental Kubernetes functionality (behind a feature flag) to allow installing of MicroK8s to existing machines

  • The Kubernetes deployment option for docker-compose format manifests and the Kompose conversion tool that enabled this have now been removed due to long-standing Common Vulnerabilities and Exposures (CVEs) in Kompose: portainer/portainer#8355

  • Improved the explanatory tooltips and info text for Kube application automatic updates functionality: portainer/portainer#8223

  • Updated Kubernetes as a Service (KaaS) cluster provisioning to use the latest eksctl tool for the AWS EKS platform, and support up to v1.23 of Kubernetes (use of this version was previously failing)

  • Resolved an issue where Kubernetes secrets were no longer shown in an expand panel for each application listed in the Applications list screen: portainer/portainer#8118

  • Improved config setting defaults when connecting clusters: ingress controllers (with a class) are auto detected/set as allowed, metrics API features setting is on (if metrics server is deployed), and storage classes with the 'default' annotation are on: portainer/portainer#8240

  • The Kubernetes Operator role is not intended to have secrets update permission and hence, as a security consideration, this permission is now removed from Portainer

  • Corrected the look of the fallback icon used for Helm charts that don't have their own icon: portainer/portainer#8116

  • Made a change to default the resource quota's resource assignment setting to off for new Kubernetes namespaces but always show the toggle (although it can be disabled for change if the cluster's (BE only) allow over-commit setting is off): portainer/portainer#8122

  • In the Kubernetes Add ingress screen, corrected the namespace selection dropdown to only show those that the user has access to: portainer/portainer#8150

  • Added a check in Kube Cluster setup and Namespace -> Manage access to see if Kube RBAC addon is enabled in the cluster, and if not, show a warning that Portainer RBAC functionality will be limited. Warning also gives info on enabling RBAC in the cluster: portainer/portainer#8171

  • Resolved an issue that was causing an 'Unable to get k8s environment access' error on deleting of a Kubernetes edge environment

  • When connecting a Kubernetes environment to Portainer via kubeconfig import, stop deleting of any extant 'portainer' namespace in the cluster

  • When using Kubernetes (KaaS) cluster provisioning and choosing the Azure Kubernetes Service (AKS) option, only node size options that are valid for provisioning now show. Previously, there was at least one option which gave an error on use

  • Resolved two scenarios where importing of the kubeconfig of a Kubernetes cluster raised an error that caused a stuck 'Deploying' status

  • In Kube Create namespace and Namespace details screens, made the resource assignment toggle always visible - even when the cluster's resource over-commit option is off (when it will show but be disabled for change)

  • Fixed an issue introduced in 2.16, where deploying of an ingress via the Portainer Add ingress form does not label the ingress object in the cluster with a Portainer 'internal' deployment label. Any deployment of ingress via Portainer should have this: portainer/portainer#8337

  • Fixed an issue introduced in 2.16, where, when attaching a ConfigMap to an application being deployed via the Portainer Add application form, the ConfigMap is wrongly included as a Secret in the manifest and the deployment could therefore fail: portainer/portainer#8323

  • Fixed an incorrect mention in the UI of a 'docker-compose file' which was showing when editing a Kube application deployed from git: portainer/portainer#8228

  • Fixed an issue preventing adding of a Helm repo that has a redirect: portainer/portainer#7892

  • Fixed an issue where the kubectl shell does not work when Istio Proxy is installed in the cluster: portainer/portainer#8321

  • Fixed an issue introduced in 2.16 where the Kube Create namespace screen's CPU and Memory resource allocation max limits did not have other namespaces' resource amounts subtracted when the cluster's allow resource over-commit option was turned off

Docker

  • Introduced support of relative paths for volumes when creating a Docker Standalone or Swarm stack that uses a git repository. Support in edge stacks is excluded at present: portainer/portainer#6390

  • Introduced new log viewer to Portainer Business Edition

  • Introduced pull image param for stack webhook to turn pull-image on and off

  • Introduced 24 hour caching for new image notification

  • Upgraded docker compose to v2.13.0: portainer/portainer#8289

  • Provided clarification and rewording in the UI around the 'Pull latest image' toggle in Stacks, Swarm Services and Service details update and Container recreate: portainer/portainer#8226

  • Updated embedded docker binaries in Portainer and agent from 20.10.13 to 20.10.18: portainer/portainer#8290

  • Fixed issue of not been able to associate stack created from other docker environments: portainer/portainer#8030

  • Fixed issue where content overlap edge of screen and left column becomes too narrow: portainer/portainer#8161

  • Fixed issue where default option for access control is not selected when editing public resource: portainer/portainer#8162

  • Fixed incorrect wording for private box selector under user access control: portainer/portainer#7969

  • Fixed issue where text input jumps to the end of the input box in repository form: portainer/portainer#8214

  • Fixed issue where scrollbar always visible in web editor form regardless contents of web editor: portainer/portainer#7968

  • Fixed issue where number of stopped container does not display in dashboard correctly: portainer/portainer#7925

  • Fixed an issue where deleting a network, config or secret did not show a confirmation warning modal: portainer/portainer#7920

  • Fixed an issue where a user cannot upload a stack file as a custom template: portainer/portainer#7921

  • Fixed an issue where the old-style UI was still being used in a Docker template-related page: portainer/portainer#7950

  • Fixed issue where container webhook URL always changed on each recreation

  • Fixed issue where new image notification only relies on checking first digest which is not always accurate: portainer/portainer#7148

Portainer

  • Introduced support for S3 compatible hosts for backup and restore: portainer/portainer#6555

  • Introduced support for GitHub container registry as a registry type

  • On the header context sensitive help icon, the red dot notification has been removed. This was put there to highlight the new feature in 2.16: portainer/portainer#8167

  • Updated Portainer dependencies of Business Edition

  • Upgraded version of golang.org/x/net from v0.0.0 to v0.1.0 for agent: portainer/portainer#8073

  • Upgraded jwt version to 4.4.2: portainer/portainer#7970

  • Improved Portainer tooltips to allow them to stay open long enough for clicking of links and selecting of text in them. Also left-justified them for better readability: portainer/portainer#8224

  • Resolved an issue related to revoking of user permissions: portainer/portainer#8338

  • Fixed issue where password could be leaked to the log files when errors occur: portainer/portainer#8343

  • Fixed issue when navigating to the login page log as a unique visitor in Matomo: portainer/portainer#8344

  • Fixed an svg attribute height error in the page (visible via the browser console): portainer/portainer#8105

  • Fixed typo where "occured" is used in error message instead of "occurred": portainer/portainer#8027

  • Fixed issue where long notification is pushed out of table making it hard to read: portainer/portainer#8215

  • Fixed incorrect link for other settings and agent setup: portainer/portainer#8347

  • Fixed issue where deleted environment does not clear in table and sidebar when deleting current selected environment: portainer/portainer#8291

  • Fixed issue where standard users were not able to change ownership to their own team: portainer/portainer#8216

  • Fixed issue where user encountered an error by deleting tags associated to deleted environments: portainer/portainer#8089

  • Fixed an issue where the 'hide for all users' button styling behaves differently in dark mode: portainer/portainer#7926

  • Fixed a minor issue where the pages and items per page elements in data table pagination controls did not quite vertically align with each other: portainer/portainer#8227

  • Fixed issue where team lead feature is unexpectedly enabled when external authentication is enabled with team sync: portainer/portainer#7972

  • Fixed issue where response from API when creating edge environments wasn't clearly specifying that URL is compulsory: portainer/portainer#7997

  • Fixed issue where internal authentication setting is not saved when switch from other authentication method without refreshing browser manually: portainer/portainer#8028

  • Fixed issue where admin users are not able to delete expired or revoked license

  • Fixed issue where user unable to remove group configuration with active directory authentication: portainer/portainer#7558

  • Fixed issue where user is not removed from team when removed from LDAP group

Nomad

  • Fixed issue around task logs not loading if they are empty

  • Fixed issue where old UI components were still being used for Nomad related pages

Development

  • Replaced Feather svg icon set with Lucide, a Feather fork that is actively maintained and has a larger and improved range of icons: portainer/portainer#8121

  • Removed Font Awesome and all remaining references to it. All icons are now svg-based: portainer/portainer#8120

  • Redesigned Portainer database migration versioning to improve the robustness of the upgrade process: portainer/portainer#8153

  • Replaced aws-sdk-go with aws-sdk-go-v2

  • Fixed issue where random number generator is not seeded causing predictable outputs: portainer/portainer#8342

  • Resolved issues building Portainer (caused by third-party deletion of the github.com/rkl-/digest package) by replacing the package with imported code. This provides HTTP Digest Authentication for Portainer's FIDO Device Onboard (FDO) protocol support: portainer/portainer#8177

  • Corrected a minor UI issue around a corrupted file-code.svg icon: portainer/portainer#8117

  • Removed the Go experimental module golang.org/x/exp, replacing the small amount of functionality that we use from it with direct code: portainer/portainer#8176

  • Deprecated the github.com/portainer/libhelm Helm wrapper and moved the code into CE, since EE can now share from CE. This is used by Portainer's Helm functionality: portainer/portainer#8178

  • Fixed issue where struct tag is malformed with incorrect blank space in template_file.go: portainer/portainer#7923

  • (swagger) fix licenses attach route

REST API changes

New Endpoints

  • GET /docker/{environmentId}/containers/{containerID}/image_status

  • GET /docker/{environmentId}/services/{serviceID}/image_status

  • GET /docker/{environmentId}/stacks/{id}/images_status

  • GET /kubernetes/{id}/namespaces/{namespace}/applications

  • GET /kubernetes/{id}/namespaces/{namespace}/applications/{kind}/{name}

  • GET /kubernetes/{id}/rbac_enabled

  • GET /nomad/endpoints/{endpointID}/leader

  • GET /system/info

  • GET /system/nodes

  • GET /system/status

  • POST /system/upgrade

  • GET /system/version

  • PUT /webhooks/{id}/reassign

Deleted Endpoints

  • GET /nomad/endpoints/{endpointID}/status

Deprecated Endpoints

  • GET /status - Deprecated: use the /system/status endpoint instead to retrieve the Portainer status.

  • GET /status/nodes - Deprecated: use the /system/nodes endpoint instead.

  • GET /status/version - Deprecated: use the /system/version endpoint instead to check if portainer has an update available.

Modified Endpoints

  • POST /backup/s3/execute

  • POST /backup/s3/restore

  • POST /backup/s3/settings

  • POST /edge_jobs

  • POST /edge_jobs/{id}

  • POST /edge_stacks

  • PUT /edge_stacks/{id}

  • POST /edge_update_schedules

  • GET /edge_update_schedules/active

  • PUT /endpoints/{id}

  • PUT /endpoints/{id}/settings

  • POST /registries

  • PUT /registries/{id}

  • PUT /settings

  • POST /stacks

Release 2.16.2

November 21, 2022

Edge

  • Fixed issue where the Git repository section is missing when creating an Edge Stack via the Git repository option. portainer/portainer#8072

Portainer

  • Fixed issue where the effective viewer is not showing the correct user access role of environments they have access to. portainer/portainer#8070

Release 2.16.1

November 9, 2022

Kubernetes

  • Fixed an issue with view/edit of an external application (i.e. one originally added to the cluster outside of Portainer) where a 'cannot read properties' error was shown.

  • Fixed an issue with view/edit of Kubernetes namespaces where memory and CPU resource limit sliders were positioned incorrectly and erroneous warnings were shown.

Docker

  • Fixed issue of update stack button being disabled when updating an existing stack.

Portainer

  • Fixed license key issue where node counts were not updated when environments are deleted.

  • Fixed issue with JSON formatted logs failing in 2.16.0.

Release 2.16.0

October 31, 2022

Deprecation notice

  • Proposing to deprecate ACI (Azure Container Instances) and remove the functionality to connect to ACI, view existing containers and deploy new containers.

Upgrade notice

  • portainer/portainer:latest moved to portainer/portainer:2.16.

React migration

  • Migrated from Angular to React: Tag selector for Environment Details view.

  • Migrated from Angular to React: Teams view.

Kubernetes

  • When upgrading to 2.16, if you already have ingress controllers in a Kubernetes cluster/environment linked to Portainer and used Portainer to set them at the cluster and namespace level, and if these ingress controllers were not used by any ingresses, after the upgrade, you may end up with dummy ingresses visible in the new Ingresses screen in Portainer (that are not actually used for any deployment). This is simply an artifact of how we retained information about ingress controllers in earlier Portainer releases. If you find these kinds of dummy ingresses, you can safely delete them.

  • Introduced the ability to auto-detect ingress classes in the environment. portainer/portainer#7827

  • Added an Ingress menu option in the sidebar that lists all Ingresses in the cluster. portainer/portainer#7839

  • Introduced the ability to set the type of a Kubernetes secret (e.g. TLS or a user-defined/custom type). Existing secrets were previously always of type Opaque (which remains the default). portainer/portainer#7842

  • Improved ingress options on the cluster setup page, allowing admins to define ingresses without assigning them to a namespace. portainer/portainer#7832

  • Introduce TLS and HTTPS support for ingresses. portainer/portainer#7843

  • Moved the Ingress management from the Application details page to a new Ingress section. portainer/portainer#7828

  • Resolved an issue when OAuth is in use and Kubernetes updates are deployed via manifest from git. The user email address used in labels/annotations for Kube objects now has disallowed characters (such as the at symbol) replaced with a dot (period symbol). portainer/portainer#7720

  • The Homepage's kubeconfig download dialog now only includes those environments that show on the Homepage. Those with a connection error or provisioning error (these states were introduced in recent releases) are now excluded.

  • Resolved an issue where Node stats would not work for Google Kubernetes Engine (GKE) clusters. portainer/portainer#7668

  • Fixed the issue of missing Kubernetes definition for Kubernetes application deployment in the swagger API documentation. portainer/portainer#7741

  • Fixed issue with deploying custom templates on Kubernetes that are using mustache variables.

Docker

  • Updated the Compose version to 2.10.2. portainer/portainer#7838

  • Added support for shared memory when creating or editing a container by allowing to set --shm-size from portainer. portainer/portainer#4992

  • Introduced support for uploading of local files to be included in a Docker image when using Portainer to build an image. portainer/portainer#7796

  • Set notification of new image for docker default to off.

  • Introduced a setting to turn on/off per host showing of out-of-date image indicators. portainer/portainer#7219

  • Resolved an issue in Docker Services, Containers, and Stacks, where loading of the recently added out-of-date image indicator delayed showing of a row's action icons.

  • Added information for rebuilding images from stacks on docker standalone environments. portainer/portainer#7829

  • Added information to the build image from the URL page, including a link to additional documentation. portainer/portainer#7771

  • Fixed an issue where environment variables for stacks could not be set to empty. portainer/portainer#7780

  • Fixed an issue where assigning user access to a stack, showed users that don't have access to the Environment. portainer/portainer#7695

  • Fixed the issue of missing agent deployment script for the docker standalone environment. portainer/portainer#7757

  • Fixed the issue of the misconfigured stack being saved and subsequently can not be deleted. portainer/portainer#7798

  • Fixed an issue where the Swarm secret values incorrectly were being trimmed. portainer/portainer#7772

  • Fixed the issue where the container webhook toggle was not being saved.

  • Fixed an issue where the Docker API section in the add environment wizard incorrectly was showing the docker.sock code block. portainer/portainer#7650

  • Fixed an issue where a console error was showing for GPU when using Swarm because GPU is not supported on Swarm.

  • Fixed an issue where renaming a deployed container resulted in an error. portainer/portainer#7778

  • Fixed an issue where the image pull limits weren't being shown for standard users.

  • Fixed error message when adding new docker environments with invalid CA certs for TLS. portainer/portainer#7934

  • Adjusted the "remove" buttons as per the UI guidelines that were introduced in the 2.15 release. portainer/portainer#7739

Gitops

  • Introduced the offering of auto-suggestions retrieved from the git repo when entering the Compose path.

  • Added the ability to store git credentials in user settings.

Portainer

  • Introduced a new section that shows past toaster notifications, which are stored in the browser's local storage. portainer/portainer#7756

  • Introduced a context sensitive help button that links to the relevant documentation based on the current page. portainer/portainer#7744

  • Introduced login screen banner to the login page.

  • Added banner for "new version available" in portainer business edition.

  • Updated dependencies of PCIDB/GHW for the portainer agent. portainer/portainer#7705

  • Updated version of chart.js to 2.9.4 and moment to 2.29.4. portainer/portainer#7681

  • Update golang and image dependencies for API and portainer binary ( EE ).

  • Updated binary version for docker-compose and helm (to v3.9.3). portainer/portainer#7704

  • Updated the agent library dependencies. portainer/portainer#7420

  • Fixed an issue where the Microsoft OAuth information was not being retrieved correctly when editing the settings.

  • Fixed select all behavior in environments page.

  • Fixed the issue of handling images built by buildx or buildkit in the registry browser.

  • Fixed an issue where the browser tab title did not update with the actually selected environment. portainer/portainer#7651

  • Fixed issue with text color and text background color on auto-filled text.

  • Fixed issue where the dropdown menu has incorrect background color in dark mode. portainer/portainer#7678

  • Fixed styling issues in the Runtime & Resources tab. portainer/portainer#7779

  • Fixed an issue where the new styling wasn't being applied to links. portainer/portainer#7740

  • Adjusted the warning text color as per the UI guidelines that were introduced in the 2.15 release. portainer/portainer#7667

  • Introduced UI info components while browsing snapshots.

Edge

  • Introduced the ability to run remote commands on edge environments connected via Async using mTLS.

  • Introduced UI info components while browsing snapshots.

Nomad

  • Fixed issue around Home page loading time when you have Nomad environments connected.

  • Removed extension validation from compose path field. portainer/portainer#7652

  • Fixed an issue where the Group and Tag could not be set for Nomad environments when adding it via the wizard. portainer/portainer#7703

  • Fixed an issue where Nomad system jobs would prevent other jobs from being shown. portainer/portainer#7229

Development

Release 2.15.1

September 16, 2022

Docker

Portainer

Release 2.15.0

September 6, 2022

Deprecation notice

  • Proposing to deprecate Kompose and remove the functionality to deploy compose yaml on Kubernetes. portainer/portainer#7514

Breaking changes

  • Breaking change in API where the endpoint filter edgeDeviceFilter has been replaced by edgeDevice and edgeDeviceUntrusted.

Browser cache

  • Improved caching to prepare a resolution for an issue where certain browsers need a manual browser refresh for new version assets to load. The change only takes effect for upgrades subsequent to migration to 2.15. portainer/portainer#7443

React migration

  • Migrated docker/containers/list views to React.

  • Migrated the Docker console.

  • Migrated Azure Container Instances views to React.

  • Migrated the sidebar menu and adjusted the Settings page.

  • Migrated the Kubectl shell window.

  • Migrated tooltip into react component.

  • Migrated page header into React component.

Kubernetes

  • Introduced the ability to define pod security constraints per Kubernetes cluster.

  • Introduced an option to forcibly remove a Kubernetes namespace that's in a 'Terminating' state. portainer/portainer#4580

  • Improved the kubeconfig download dialog by providing pagination (including choosing of the number of items per page), an option to 'select all in page' and selection across multiple pages. portainer/portainer#7261

  • Resolved an issue where the link shown for an application that is exposed via an ingress was including an incorrect port (the servicePort). portainer/portainer#7337

  • Resolved some errors and wording issues in recent KaaS cluster provisioning and import kubeconfig functionality.

  • When using Kubernetes (KaaS) cluster provisioning and choosing the DigitalOcean option, only node size options that are valid for provisioning now show. Previously, there was at least one option which gave an 'invalid droplet size' error on use.

Docker

  • Added GPU support to Docker containers. portainer/portainer#3143

  • Introduced the ability to disable use of the anonymous Docker Hub registry option via the Portainer UI for all users.

  • Added support to read value from .env in subfolder for git deployment in Docker Standalone Environment. portainer/portainer#7265

  • Added message explaining that changed env values only take effect after redeployment or auto update via webhook. portainer/portainer#7242

  • Provided prune option for stack deployment from Git. portainer/portainer#7224

  • Removed "Show Container Template" toggle on App templates page and introduced filter and sort by dropdown options. portainer/portainer#7394

  • Fixed recreate of container so it pulls the image using the SHA256 hash if its tag no longer exists, and if the image is still inaccessible (as it no longer exists or the tag or name is now incorrect) warn the user and disable 'Pull latest image' option. portainer/portainer#6566

  • Introduced support for checking images held in private registries to the recently added functionality that shows a visual image indication on stacks, services and containers that are running with an out-of-date image.

  • Introduced improved validation to the Docker build image function, to prevent invalid image names. portainer/portainer#7463

  • Fixed host info being sent when host management feature is turned off. portainer/portainer#7277

  • Following the introduction of v2 Docker Compose, changed any front-end wording that mentions 'docker-compose' to say 'docker compose', to clarify and bring in line with official documentation. portainer/portainer#7141

Portainer

  • Introduced license enforcement for 5 nodes free in business edition.

  • Introduced new styling for Portainer. portainer/portainer#7528

  • Introduced Portainer UI redesign with changes for common configuration pages. portainer/portainer#7527

  • Included build information in Portainer for easier debug. portainer/portainer#7317

  • Introduced the ability to show/hide the password you are entering on login. portainer/portainer#7461

  • Introduced CTRL+F (or CMD+F on MacOS) to search in web editors. portainer/portainer#6537

  • Introduced the ability to filter connection type and agent version on the home page. portainer/portainer#7468

  • Improved environment address entry to handle http:// or https:// prefixes when adding an environment via Docker or Kubernetes (agent) options. portainer/portainer#7462

  • Introduced a change to the Homepage's multi-select filters to keep the dropdown open after a single selection until the user closes it themselves, or the last remaining option is selected. portainer/portainer#7548

  • Added tips for entering Portainer license key.

  • Updated the agent library dependencies portainer/portainer#7420

  • Fixed issue where Automatic team membership did not always work for Azure.

  • Fixed an issue where auto populate team admins LDAP feature didn't work on upgrade from CE to BE.

  • Fixed issue of authentication logs not working behind reverse proxy. portainer/portainer#7120

  • Fixed license expiry message flashing even license is not expired or close to expiring.

  • Fixed a few typos in various locations. portainer/portainer#7243

  • Fixed issue with environment page table losing selection on table refresh. portainer/portainer#7395

  • Fixed missing BE feature indicators. portainer/portainer#7396

  • Fixed issue where certificate uploading is not functional for StartTLS/TLS in LDAP configuration. portainer/portainer#6271

  • Reworded error message for JWT token missing to more user-friendly message.

Edge

  • Introduced the ability to get logs for edge stacks of specific environments.

  • Fixed connection issue ("Environment is unreachable") after deploying Nomad environment with AEEC script.

  • Updated UI of Add devices page to match the Add environment page. portainer/portainer#7393

  • Fixed issue where editing edge jobs changed the configured cron expression. portainer/portainer#7432

  • Fixed known issue with manually adding an Edge Device environment through the edge device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.

  • Removed Beta label on Edge Jobs. portainer/portainer#7162

  • Improved image parsing for Kubernetes Edge Stacks that use private registries so that the same parsing as Docker ones is used.

Registry

  • Improved Registry details screen with better prompting for relevant fields. portainer/portainer#3015

  • Resolved an issue around not being able to add multiple Quay registries. portainer/portainer#7430

  • Improved the Registry details screen to show the registry provider and made the Add registry screen default to Docker Hub as the provider. portainer/portainer#7246

Nomad

  • Standardized the behavior of Nomad edge environments to be the same as non-Nomad edge environments.

Release 2.14.2

July 26, 2022

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.

  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.

Kubernetes

  • Fixed an issue where the kubeconfig downloadable from Portainer always had port 9443 in its URLs, even though the actual Portainer instance was being accessed via another port. portainer/portainer#7059

Docker

  • Fixed certificate file validation for .pem files portainer/portainer#7183

  • Fixed an issue when using a Mustache variable (e.g. {{service}}) multiple times in the YAML, where the UI should prompt for it only once and then reuse it (rather than prompting for it multiple times).

  • Fixed an issue when using a Mustache variable (e.g. {{path}}) with special characters in the value, where the resulting value would end up being HTML encoded.

  • Fixed issue around access control labels being ignored.

Portainer

  • Fixed an issue where the original admin user was unable to change their password when external authentication is enabled. portainer/portainer#7291

  • Fixed toggle state reset issue for custom logo and anonymous statistics. portainer/portainer#7278

  • Fixed issue with not being able to add users to teams while LDAP authentication is enabled without auto teams population. portainer/portainer#7252

  • Fixed an issue where auto populate team admins LDAP feature didn't work on upgrade from CE to BE.

  • Resolved an issue where new installs of recent Portainer releases had an extraneous (although innocuous) db version update on restart.

Edge

Release 2.14.1

July 12, 2022

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.

  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.

  • When using a Mustache variable (e.g. {{ service }}) multiple times in the YAML, the UI also prompts for it multiple times, rather than prompting for it a single time and then reusing it.

Kubernetes

  • Improved KaaS cluster provisioning's cluster name validation to enforce restrictions that Google GKE expects.

  • Fixed issue of variable inputs not showing on deployment view when using custom templates.

  • Improved Portainer logging to better record the output from eksctl, the CLI tool used for Amazon EKS (KaaS) cluster provisioning.

  • Fixed an issue where, upon initiating AWS KaaS cluster/environment provisioning and subsequently restarting Portainer in a short space of time, the requested environment would become stuck and unusable in Portainer, and couldn't be deleted.

Docker

  • Resolved an issue where users running Portainer with non-root access were receiving a 'Permission denied on docker-compose' error since the recent update to Docker Compose V2. portainer/portainer#6906

Portainer

  • Fix to improve LDAP, etc. authentication/login speed when there are many thousands of users.

  • Resolved an issue where users upgrading a Portainer install, where the portainer_data volume is stored on a network volume, receive a 'Permission denied' error when the upgrade attempts a backup of the database. portainer/portainer#7144

  • Fixed "Create user" button in disabled stage when external Auth enabled. portainer/portainer#7214

Edge

  • Fixed issue where the edge agent could not connect when running Portainer behind a reverse proxy only supporting TLS v1.2. portainer/portainer#7167

Release 2.14.0

June 28, 2022

Known issues

  • Known issue with manually adding an Edge Device environment through the Edge Device page when using Async mode, does not retain Async settings and needs to be manually added through the environment details page.

  • Image update notifications are currently not supported for private registries and private images in DockerHub. This is due to be fixed in our next major version.

Breaking changes

  • With the upgrade to Docker Compose V2, container names now use hyphens as separators instead of underscores. This may affect you if you are generating container names instead of explicitly defining them, then using them as references.

Kubernetes

  • Introduced ability to set up a new Kubernetes environment in Portainer via upload of a kubeconfig file for an existing on premises or on-cloud cluster.

  • Fixed issue around Git clone working with Main (in addition to existing Master) branch type. portainer/portainer#6002

  • Updated packaged components to recent stable release versions: Docker 20.10.9, Docker Compose plugin 2.5.1, kubectl 1.24.1, Helm 3.9.0. portainer/portainer#6074

  • Administrators can now set up cloud provider settings via a list page and separate add page in a similar way to other records in Portainer.

  • Introduced support for provisioning of a Kubernetes cluster on the Amazon (AWS) EKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal. The AWS eksctl binary is auto downloaded when first using this functionality.

  • Introduced support for provisioning of a Kubernetes cluster on the Microsoft Azure AKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal.

  • Introduced support for provisioning of a Kubernetes cluster on the Google Cloud GKE platform from within Portainer, alleviating the need to do so in the cloud provider's portal.

  • Fixed a typo in the Kubernetes -> Namespaces -> Create from manifest (advanced deployment) page. portainer/portainer#6968

  • Fixed an issue with cluster provisioning via Civo KaaS, where if the Civo account has an issue with its defined networks, the environment was stuck waiting to complete provisioning and never ultimately errored.

  • Introduced the ability to set the group and tags against the environment in Portainer when an admin provisions a Kubernetes as a Service cluster.

  • Introduced slight improvements to editing of sensitive cloud credentials values.

  • Fixed an issue in the Settings -> Environments page, where an environment that was disabled or still being provisioned could be selected for removal and then removed.

  • Added the ability to manually refresh pulling of Kubernetes as a Service cluster provisioning options from cloud providers.

  • Improved error handling around KaaS provisioning in the environment wizard.

  • Kubernetes as a Service (cloud) provisioned environments will now appear in the 'new environments' side panel in the environments wizard.

Docker

  • Introduced a visual indication of stacks, services and containers that are running with an out-of-date image. portainer/portainer#1304

  • Fixed issue around Git clone working with Main (in addition to existing Master) branch type. portainer/portainer#6002

  • Updated packaged components to recent stable release versions: Docker 20.10.9, Docker Compose plugin 2.5.1, kubectl 1.24.1, Helm 3.9.0. portainer/portainer#6074

  • Fixed issue for standard user having an empty network as default when creating containers on Windows environments portainer/portainer#6959

  • Introduced ability to pass environment variables on the webhooks in Docker stack deployment.

  • Provide a stack template for dokku deployment within portainer. portainer/portainer#7011

  • Resolved an issue when updating an application and changing its service from replicated to global, where an error occurs and the deployed application is deleted. portainer/portainer#7056

  • Third-party developer Inedo has fixed their ProGet registry software to resolve an intermittent error admins were experiencing in Portainer on retag or delete of a tagged image. This is planned to ship 10 June 2022 in ProGet 6.0.16, before Portainer 2.14.

  • Introduced support in the container webhook for pull/recreate of containers from images residing in private registries.

  • Fixed an issue in the Containers page, where choosing 'Recreate' enabled the webhook for the container, even though it was not currently turned on.

  • Fixed an issue where, when calling Swarm update API through Portainer, incorrect overriding of the registry authentication header occurred, preventing pull of an image. portainer/portainer#7095

Portainer

  • Redesigned team leader feature. portainer/portainer#7093

  • Fixed an issue where the delete environment confirmation dialog was positioned too low on-screen. portainer/portainer#6983

  • Fixed an issue where agent and edge agent install command instructions do not list the agent_secret option. portainer/portainer#6801

  • Fixed an issue where the home (environments) page no longer showed the words 'No tags' for environments without tags. portainer/portainer#6967

  • Introduced support for provisioning of a Kubernetes cluster on the Amazon (AWS) EKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal. The AWS eksctl binary is auto downloaded when first using this functionality.

  • The Add environment page and Environment wizard are now consolidated into a single consistent, improved wizard-style experience. portainer/portainer#7022

  • Introduced support for provisioning of a Kubernetes cluster on the Microsoft Azure AKS platform from within Portainer, alleviating the need to do so in the cloud provider's portal.

  • Introduced support for provisioning of a Kubernetes cluster on the Google Cloud GKE platform from within Portainer, alleviating the need to do so in the cloud provider's portal.

  • Fixed Go panic state for the environments list handler portainer/portainer#7047

  • Introduced ability for admin to set required password length. portainer/portainer#7055

  • Fixed an issue recently introduced in the environments page where the name of an environment that was down no longer linked through to its details page.