Botfront.
 Github
Authoring conversations
Configuring channels
On screen guidance
Proactive conversations
Installation
On your local machineOn servers or clustersUsing the CLIMigration guideMinor versionsMajor versionsManual upgrades
Developers
Administration

Migration guide

This sections indicates how to migrate your assistant to a new Botfront version.

As we haven’t reached 1.x minor versions are considered major and could have breaking changes.

Botfront and Rasa versions compatibility

Botfront and Rasa versions are tightly coupled. To avoid compatibility issues when installing or upgrading, use the CLI and Helm charts enforce compatibility.

Minor versions

Minor upgrades are generally seamless.

With the CLI

You can run botfront upgrade in your terminal.

With Kubernetes

You can upgrade our Helm Charts.

Make sure you install the same chart versions

Although we offer seperate charts for the Botfront framework and Rasa itself, they both have the same version. Installing the same chart version for both Botfront and Rasa ensures that Rasa and Botfront versions are compatible.

Major versions

When upgrading to a major version, always flush locally build images as follow:

docker rmi <folder_name>_rasa # e.g. docker rmi my_project_rasa
docker rmi <folder_name>_actions

0.21.x -> 0.22.x

Tracker store definitions

In Settings > Endpoints, replace:

tracker_store:
store_type: rasa_addons.core.tracker_stores.AnalyticsTrackerStore
url: 'http://botfront-api:8080'
project_id: 'bf'

with:

tracker_store:
store_type: 'rasa_addons.core.tracker_stores.botfront.BotfrontTrackerStore'
url: 'http://botfront:3000/graphql' # Or the appropriate custom URL

0.20.x -> 0.21.x

0.19.x -> 0.20.x

0.18.x -> 0.19.x

Breaking changes

We significantly changed (and improved) how bot responses work. Only three types remain:

  • Text
  • Text with buttons
  • Image
  • Custom

If you were using other response types (mostly facebook related such as Templates, Lists, …) they will be lost. You need to make a copy before upgrading.

Upgrading a project

The project structure has changed

You will need to create another project and copy your data in it:

  1. Create a new project with botfront init.
  2. Copy the botfront-db folder from your old project to the newly created project. Make sure to copy and not move your db so you can always recover it from your existing project. Your existing project should remain unchanged.
  3. If you have custom actions, copy them to the actions folder in the new project.
  4. Run your project with botfront up. At this point, you should be able to log in.
  5. Go to Settings > Endpoints If you are running with the default CLI configuration, replace:
nlg:
url: "http://botfront-api:8080/project/bf/nlg"

with:

nlg:
type: "rasa_addons.core.nlg.GraphQLNaturalLanguageGenerator"
url: "http://botfront:3000/graphql" # This should be the same host as the Botfront app
  1. Restart Rasa with botfront restart rasa
  2. Train
  3. You’re done, have fun :)

Manual upgrades

Always check that the Botfront and Rasa versions you install are compatible. You can check this file to find out which version of Rasa corresponds to the Botfront version you are upgrading to: https://github.com/botfront/botfront/blob/vX.X.X/cli/project-template/.botfront/botfront.yml (replace vX.X.X with your version, e.g: v0.24.0)

🖊️ Edit this page on Github