https://step.dev/knowledgebase/31/categories/maintenance/ Recent content in Maintenance on Step Documentation Hugo -- gohugo.io en Wed, 22 Jul 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/releasestrategy/step-release/ Tue, 14 Oct 2025 00:00:00 +0000 https://step.dev/knowledgebase/31/releasestrategy/step-release/ Overview The Step platform follows a structured versioning and release strategy to ensure stability and predictable updates for users. This page describes the versioning scheme, release cadence, and upgrade path for the core Step platform. Versioning Scheme Step uses a distinctive versioning format: Major.Minor (e.g., 27.4, 28.3, 29.0) Major version: The first number (e.g., 27, 28, 29) - Incremented for significant releases containing new features and major enhancements Minor version: The second number (e. https://step.dev/knowledgebase/31/setup/configuration/important-settings/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/important-settings/ Controller settings Main properties The main configuration file of the Controller is step.properties. Installation from archive When installing Step manually from the archives, the file is located in the conf folder of the controller. The main parameters to be updated in order to start the Controller are listed below : port=<port_to_access_controller_gui> grid.port=<port_for_agents_to_access_the_controller> datasource.mongo.properties.host=<mongo_hostname_or_ip> datasource.mongo.properties.port=<mongo_port> datasource.mongo.properties.username=<step_database_username> (if any) datasource.mongo.properties.password=<step_database_password> (if any) For example : port=8080 -> Controller GUI will be accessible on port 8080 grid. https://step.dev/knowledgebase/31/setup/configuration/logging/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/logging/ This page describes how to configure the logging in the different component of Step. To customize the logback configuration using our Helm chart, refer to this documentation Controller logs By default, the controller logs are written to the file log/controller.log. The default logging settings can be changed in the file bin/logback.xml. Verbosity You can easily change the logging verbosity by tweaking the “root” log level present in the file bin/logback.xml. You can also tweak the verbosity for specific features. https://step.dev/knowledgebase/31/setup/configuration/file-cache-sizing/ Wed, 22 Jul 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/file-cache-sizing/ To execute a Keyword, an agent needs the files that belong to it: the Automation Package, the Keyword package (JAR, DLL), or the script. These files originate from the controller and are transferred to the agent on demand. Every component along that path keeps a local copy in a file cache so the same file does not have to be transferred again for the next execution. Their size is driven by your automation content, not by the number of executions. https://step.dev/knowledgebase/31/admindocs/maintenance/ Tue, 25 Oct 2022 06:08:01 +0100 https://step.dev/knowledgebase/31/admindocs/maintenance/ https://step.dev/knowledgebase/31/userdocs/executions/execution-housekeeping/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/executions/execution-housekeeping/ If Automatic housekeeping is ON, you may want to flag the executions to be retained by the housekeeping job. To do that, toggle the Retain this execution and provide the information about your execution in the Description textbox - for example, information about a referenced execution that’s part of an overall test release. On the other hand, if you don’t want to retain this specific execution, you may directly delete it within the same pane: https://step.dev/knowledgebase/31/admindocs/maintenance/backup/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/admindocs/maintenance/backup/ Data Model Step data are organized as collections into MongoDB. Each collection contains a specific type of data, which are explained below. Collections marked (EE) only exist in the Enterprise Edition, and a collection may only be created once the corresponding feature is used for the first time. Automation plans : the Plan definitions functions : the Keyword definitions parameters : the Parameters plansversions, functionsversions, parametersversions (EE) : the version history of Plans, Keywords and Parameters automationPackages : the deployed Automation Packages resources : the files uploaded or deployed in Step (Automation Package archives, libraries, datasets, attachments etc…) resourceRevisions : the revisions of these files tasks : the Scheduler tasks Executions and reporting https://step.dev/knowledgebase/31/admindocs/maintenance/housekeeping/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/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/31/admindocs/maintenance/migration/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/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/31/admindocs/maintenance/migration-chart/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/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/31/admindocs/admin-views/ Fri, 03 Apr 2020 09:25:01 +0100 https://step.dev/knowledgebase/31/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/31/admindocs/maintenance/troubleshooting/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/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/31/admindocs/maintenance/agent-runtime-image-migration/ Fri, 21 Nov 2025 14:00:00 +0000 https://step.dev/knowledgebase/31/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. https://step.dev/knowledgebase/31/admindocs/ Thu, 28 Mar 2019 00:00:00 +0000 https://step.dev/knowledgebase/31/admindocs/ This space is dedicated to the administration and operation of Step. For the installation of Step follow the set up documentation.