https://step.dev/knowledgebase/31/admindocs/maintenance/ Recent content in Maintenance on Step Documentation Hugo -- gohugo.io en Tue, 25 Oct 2022 06:08:01 +0100 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/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.