https://step.dev/knowledgebase/30/categories/maintenance/ Recent content in Maintenance on Step Documentation Hugo -- gohugo.io en Fri, 21 Nov 2025 14:00:00 +0000 https://step.dev/knowledgebase/30/setup/download/ Wed, 25 Sep 2024 00:00:00 +0000 https://step.dev/knowledgebase/30/setup/download/ This page provides an overview of the available downloads for the various Step components. Step CLI The Step CLI (Command Line Interface) provides an interface for building, executing, and deploying automation packages within Step. CLI for Step Open Source The CLI of Step Open Source can be downloaded from the GitHub releases page of Step. Following binaries are available, depending on your platform: Windows: step.exe Linux and Mac: step After download, put the executable corresponding to your platform in your PATH. https://step.dev/knowledgebase/30/setup/requirements/ Mon, 29 Nov 2021 14:08:01 +0100 https://step.dev/knowledgebase/30/setup/requirements/ On-premise requirements Below is a list of minimal hardware, system, and software requirements to set up Step. The specified versions of third-party software correspond to the ones officially tested and supported. Step Controller Step DB per Step Agent OS Redhat, SLES, Debian, Windows 7 to 10, Windows Server 2012 to 2022 Redhat, SLES, Debian, Windows 7 to 10, Windows Server 2012 to 2022 Redhat, SLES, Debian, Windows 7 to 10, Windows Server 2012 to 2022 Software: Oracle/Hotspot JDK 21 to 25 installed MongoDB 5. https://step.dev/knowledgebase/30/setup/download/material_request/ Mon, 29 Nov 2021 14:08:01 +0100 https://step.dev/knowledgebase/30/setup/download/material_request/ Enterprise customer credentials Enterprise customers receive their credentials to access to the Step Enterprise artifacts (Enterprise release, Docker images and Helm Chart) from the Step support upon request. Main point of contact for any issue related to access request is support@exense.ch. Nexus and Docker private repository Nexus access Step Enterprise artifacts are now published to our Nexus in the ‘distribution’ repository. The Enterprise repository can be accessed via https, preferably using a Web browser at https://nexus-enterprise. https://step.dev/knowledgebase/30/admindocs/maintenance/backup/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/admindocs/maintenance/backup/ Data Model Step data are organized as collections into MongoDB. Each collections contains a specific type of data, which are explained below : artefacts : the test plans definitions functions : the keyword definitions parameters : the user defined parameters resources : the uploaded files (datasheet, keyword jars etc…) executions : the executions entries, tab Executions > Execution list reports : the detailed executions steps of an execution measurements : any measurements registered during an execution views : additional information about executions (tab Performance, Error etc…) screenInputs : entries defined under the Admin > Settings > Screens users : the registered users into Step controllerlogs : some startup logs Backup Complete backup Assuming you are running MongoDB with the default settings (host localhost, port 27017, no authentication), you can perform backups following below instructions. https://step.dev/knowledgebase/30/admindocs/maintenance/housekeeping/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/admindocs/maintenance/housekeeping/ Automatic housekeeping Automatic housekeeping is provided as part of a standard Enterprise package only. As a Community user, please refer to the manual purge guide. Main concept Automatic Housekeeping allows the controller to automatically delete executions based on a configurable Time To Live (TTL) value, which defines the maximum retention period. This reduces manual maintenance, ensures consistent cleanup of related data, and prevents the accumulation of orphaned entities in the system. https://step.dev/knowledgebase/30/admindocs/maintenance/migration/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/admindocs/maintenance/migration/ After upgrading Step to a new version, some additional tasks may be required. General migration process Before starting the migration Stop existing controller and agents Stop the related services if they were installed as such or terminate directly the corresponding Java processes otherwise. Backup Database: before any migration task, make sure to backup your database following this instructions. Controller: if you intend to reuse the same data folders of the step’s controller, we recommend to backup them as well. https://step.dev/knowledgebase/30/admindocs/maintenance/migration-chart/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/admindocs/maintenance/migration-chart/ The Helm Chart of Step is versioned independently of Step itself. This page contains information related to the upgrade of the Helm chart of Step itself. For the upgrade of Step refer to Upgrade / Migration General migration process Migration to a newest version of the Chart usually requires nothing more than a Helm upgrade, unless some specific migration tasks are mentioned on that page. For instance, upgrading from version 0. https://step.dev/knowledgebase/30/admindocs/admin-views/ Fri, 03 Apr 2020 09:25:01 +0100 https://step.dev/knowledgebase/30/admindocs/admin-views/ Grid Agents views You can check the current capacity and usage of the entire platform at any given time by browsing the Grid view, which is accessed from the Status menu. Detailed views The other menu items in the Status menu allow to get in-detail information of current grid capacity and usage. For instances, by tokens: Agent pools view This is an advanced view which will be part of our cloud offering. https://step.dev/knowledgebase/30/admindocs/maintenance/troubleshooting/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/30/admindocs/maintenance/troubleshooting/ General troubleshooting guidelines Controller Startup issues If you encounter any startup issues, please make sure to check the following : An instance is not already running (address already bound to port) Nothing is running on ports you defined in the step.properties configuration file (default port 8080 for the http application and 8081 for the grid endpoint) A MongoDB instance is running on the server and port you defined in the step. https://step.dev/knowledgebase/30/admindocs/maintenance/agent-runtime-image-migration/ Fri, 21 Nov 2025 14:00:00 +0000 https://step.dev/knowledgebase/30/admindocs/maintenance/agent-runtime-image-migration/ Overview Starting with Step 29, we are introducing a new naming convention for all agent runtime Docker images. This change improves consistency, clarity, and maintainability across the Agent runtime images. Important: This change affects ALL Step agent runtime images, not just specific ones. Plan your migration accordingly. What’s Changing New Naming Convention All agent runtime images will follow a new, more structured naming pattern: Base Runtime Image (Java + Chromium) Old Image Name New Image Name docker.