Editing a deployed Axon in Algoreus

Beginning with Algoreus, the ability to modify a deployed axon is available. The process generates a new version of the axon, preserving its original name, and labels it as the most recent version. This feature allows iterative development of axons without the need for duplication, which would necessitate the creation of a new axon under a different name.

Please note that while deployed batch axons can be edited, deployed streaming axons or deployed clone jobs cannot be.


The advantages of editing a deployed axon

  • Incremental additions to a deployed axon are possible without the need to duplicate it. You can add, remove, or alter nodes within a axon and redeploy it. This action results in a new version of the same axon, whereas duplication creates an entirely new axon with a different name.

  • All versions of the deployed axon, created by the editing function, are preserved, providing a comprehensive history of the axon's development.

  • Access to and restoration of older versions of a deployed axon from the History list is possible.

  • You're allowed to modify the complete specifications of the axon, including its structure, configuration, Engram (metadata), axon preferences, and comments. Edited JSON for a deployed axon can be imported.


Steps to modify a deployed axon

  1. From the Axon List page, select 'Deployed'. Locate the axon you wish to modify.

  2. Click on the three-dot menu and select 'Edit'. A new draft version of the axon, bearing the same name, will appear in the Genesis, displaying the draft axon status.

  3. Implement any desired changes to the axon, such as adding nodes or editing node properties.

  4. If you wish to continue editing the axon at a later time, click 'Save'.

  5. Once your modifications are complete, click 'Deploy'. You'll be prompted with the 'Enter Change Summary' window.

  6. Provide a description detailing the changes you've made to the axon and click 'Deploy'. The modified axon will appear on the 'Deployed Axon' page.

  7. Optionally, you can edit any existing triggers, add new ones, modify the axon configuration and runtime arguments, and edit or add a schedule.

When it comes to viewing the version history of a deployed axon, you can view the axon or restore an older version of it to the most recent version. The version history also includes version change summaries.

To export an axon, either the most recent or older versions, the system will save the axon configuration as a JSON file on your local drive. This can be useful when sharing axons with other developers, adding them to version control, or deploying them from a development environment to a test or production environment.

When importing an edited version of a deployed axon, all axons are imported in 'DRAFT' mode.

When deleting the latest version of a deployed axon, all versions of that deployed axon are deleted. Draft versions are not deleted.

Restoring an older version of a deployed axon creates a new axon, which becomes the most recent version.


Axon status

  • In-Progress: This status appears when you are editing a axon version in 'DRAFT' mode and you click 'Save' in the axon Genesis canvas.

  • Orphaned: This status is seen when the latest axon was deleted. Axon drafts are marked as Orphaned.

  • Obsolete: This status is given when a teammate deployed a newer version while you were editing the axon. This status is equivalent to 'Draft Out of Date' that appears on the axon Genesis canvas.


Last updated