Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Hot swapping processes in Aura

Key processes that can be done over Aura without service outage

1. Update of locales: Hot swapping of POEditor texts

If locales belong to aura-bot (Generation or update of locales through POEditor when developing a use case):
Hot swapping is done through the aura-configuration-updater.
If locales belong to aura-groot, aura-authentication-api, aura-bridge, aura-bridge-outbound: Hot swapping is done through the guidelines Manage locales in Aura.

By doing so, the update of locales will be available without the need to wait for the next Aura Platform release.

Be aware of the impact of both processes over certain Aura components: Available hot swapping processes and associated impact - Item 1 in table.

2. Update of NLP packages

When developing a use case over Aura NLP, the understanding model including the trainings and test set files must be deployed.

If OBs are interested in the update of an NLP package through a hot swapping process, the local DevOps Team can execute two different procedures, which are equivalent in terms of outcome and impact on the system. Therefore, OBs have the freedom to choose whichever process they prefer.

Through aurak8s installer: Local NLP deployment
Through the use of Aura Operator: NlpTraining

By doing so, the updated NLP package will be available without the need to wait for the next Aura Platform release.

Be aware of the impact of both processes over certain Aura components: Available hot swapping processes and associated impact - Item 2 in table.

3. Modify TV use cases

Certain modifications in TV use cases (channels mapping, specific experiences, etc.) can be executed through a hot swapping process. They correspond to experiences that are managed by the User_helper component and, specifically, by the M+ Resolution module, that resolves TV use cases calling different APIs.

If OBs are interested in the update of a TV use case through a hot swapping process, the local DevOps Team can execute two different procedures, which are equivalent in terms of outcome and impact on the system. Therefore, OBs have the freedom to choose whichever process they prefer.

Through aurak8s installer: Local ResolutionResources deployment
Through the use of Aura Operator: ResolutionResources

Be aware of the impact of both processes over certain Aura components: Available hot swapping processes and associated impact - Item 3 in table.

4. Channels handling

The execution of changes in the configuration of channels can be done through a hot swapping process using the aura-configuration-api component.

This process is fully described in the document Update channels configuration.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 4 in table.

5. Skills handling

The hot swapping processes that can be executed in the framework of skills management are included in the document Hot swapping processes in Aura distributed architecture and include adding a new skill to aura-root, modifying it or deleting an existing one.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 5 in table.

6. Applications handling

The execution of changes in the configuration of applications, the components in charge of the communitation of a channel, service or skill with aura-gateway-api for the connection with an external service, can be done through a hot swapping process using the aura-configuration-api component. This process is fully described in the document Hot swapping processes in Aura Applications Configurations.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 7 in table.

7. Add new local dialog in aura-bot

The deployment of a new local dialog over a specific Aura Platform release can be done through a hot swapping process, following the guidelines Local modules deployment.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 8 in table.

8. Update of libraries and dialogs configuration

Aura allows making changes in certain aura-bot configuration related to libraries, dialogs and channels through hot swapping processes:

contextFilters of the intents in aura-bot dialogs
Scopes and purposes in aura-bot libraries and dialogs

These processes can be done using the aura-configuration-updater.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 9 in table.

9. Add static resources in a use case

When developing a use cases, aura response can include static resources such as visual components (cards), such as icons, images, diagrams, etc.

If required, the update of these resources can be done through a hot swapping process, following the guidelines included here.

These processes can also be done using the aura-configuration-updater.

Doing that, the updated static resources will be available in the period between one release and the consecutive one.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 10 in table.

10. Review indexes definitions

Due to the continuous evolution of the Aura Platform, it is possible that the indexes definitions of the different components need to be reviewed and updated. This process can be done through a make-up process.

If required, the update of these indexes can be done through a hot swapping process, uploading a new index definition file to Azure Blob Storage, in the container aura-configuration/AURA-VERSION and then executing the make-up process of the corresponding component.

Follow the guidelines Manage MongoDB Indexes to understand how to define a new index file.

Be aware of the impact of this process over certain Aura components: Available hot swapping processes and associated impact - Item 11 in table.

Aura –