Upgrading¶
How to upgrade Fleio Docker installation¶
Important
When upgrading Fleio we always recommend you to follow the Recommended upgrade procedure procedure.
To upgrade Fleio to the latest stable version run:
fleio upgrade
You can check list available newer stable versions by running:
fleio updates
If you want to include beta versions in the list, use the --include-beta (or -b) flag:
fleio updates --include-beta
fleio upgrade --include-beta
If you want to upgrade to a certain version, you need to pass the Fleio version. First you should check what versions are available for upgrade:
$ fleio updates --include-beta
Creating fleio_utils_run ... done
Current version: 2021.01.2
Available updates:
2021.03.1
2021.03.0
2021.02.1
2021.02.0
Then you can run the upgrade command using the desired Fleio version:
$ fleio upgrade 2021.02.1
Recommended upgrade procedure¶
Warning
We strongly recommend that you have a staging Fleio installation and you test upgrades in your environment before performing the upgrade on production. You are entitled to one development/staging license for each license that you purchase.
Note
The Fleio upgrade script waits for running tasks to complete since version 2022.09 and performs an automatic backup since version 2022.10. To safely upgrade to a version older than 2022.09, see previous documentation versions.
The database is automatically backed by the fleio upgrade script. Backups are placed in /home/fleio/backup/.
To upgrade Fleio to the latest stable version run:
fleio upgrade
or if you want to upgrade to a specified version, run something like:
fleio upgrade 2022.10.1
How to upgrade Fleio system packages¶
System package (deb/rpm) deployment is no longer supported by Fleio. See previous documentation versions for this topic.
Recommended upgrade procedure¶
System package (deb/rpm) deployment is no longer supported by Fleio. See previous documentation versions for this topic.
Upgrading to 2022.11¶
Add pull_policy before upgrading¶
Warning
If you are using docker-compose.override.yml to build custom images you need to add pull_policy: never to the
service definition before upgrade. See Adding or changing files in Fleio docker images for more details.
Sync OpenStack¶
After upgrading to 2022.11 you must perform a Manual synchronization, since new “region” fields were added in the Fleio database to volume availability zones (AZ) and router AZ. Until you sync, the volume creation form and the router creation form will miss the AZ fields.
Remove docker-compose¶
Starting with 2022.11 release we only use Docker Compose V2 (https://docs.docker.com/compose/),
which supports the compose command as part of the Docker CLI. Thus we have replaced docker-compose commands with
docker compose. If you’re using the docker-compose command internally, you should switch to Docker Compose
plugin (docker compose command).
Because Compose V1 (docker-compose) is now deprecated, we also strongly recommend that you remove related files:
sudo rm -rf /usr/bin/docker-compose \
/usr/local/bin/docker-compose \
/etc/bash_completion.d/docker-compose
With the new Docker Compose plugin you will notice that container names do not use underscore (_) as
separator anymore but the hyphen-minus (-) character (e.g. fleio_backend_1 becomes fleio-backend-1).
Update incomingmail container name in mail server aliases¶
If you are using the support ticketing system feature and you have mail server aliases define on the host, you need
to update the container name in the aliases file from fleio_incomingmail_1 to fleio-incomingmail-1.
For instructions to update the mail server aliases file, see See Email routing.
Upgrading to 2022.10¶
In the 2022.10 release we configured Fleio logger to send emails to admins in case an error is logged. In order for this to work for existing installation you need to add ADMINS setting to settings.py (see https://docs.djangoproject.com/en/4.1/ref/settings/#admins).
Also we have added a fix for a issue with update_exchange_rates_task_at_midnight schedule. If you
intend to use this task we suggest you use corrected schedule for it as defined in the comment below:
'update_exchange_rates_task_at_midnight': {
'task': 'Update exchange rates task',
'schedule': crontab(hour='0', minute='0')
},
docker-compose.utils.yml file was also removed. utils container is now defined in docker-compose.yml file.
If you have any customizations to utils container in docker-compose.utils.override.yml file you should move those to
docker-compose.override.yml file.
Upgrading to 2022.09¶
In the 2022.09 release we have added a fix for multiple problems with the processing incoming email when emojis where
used in the ticket subject or body. The fix must be applied on your settings.py file, as it’s related to the
database options.
In order to edit the settings.py file, please run fleio edit settings.py and look for the DATABASES dictionary:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'fleio',
'USER': 'root',
'PASSWORD': '',
'HOST': 'localhost',
'PORT': '3306',
'CONN_MAX_AGE': 500,
'OPTIONS': {
'init_command': "SET sql_mode='STRICT_ALL_TABLES'",
},
},
}
In the OPTIONS part, you need to add the charset:
...
'OPTIONS': {
'charset': 'utf8mb4',
'init_command': "SET sql_mode='STRICT_ALL_TABLES'",
},
...
In the 2022.09 release we also introduced a new periodic task, which will clear the expired Django sessions / Fleio tokens.
If you’ve overwritten the CELERY_BEAT_SCHEDULE dictionary (in order to change how often a period task is run, then
you will have to update it, in your settings.py file. The new CELERY_BEAT_SCHEDULE should be the following:
CELERY_BEAT_SCHEDULE = {
'process_clients_task_every_15_minutes': {
'task': 'Process clients task',
'schedule': crontab(minute='*/15')
},
'collect_traffic_data_task_every_15_minutes': {
'task': 'Collect traffic data task',
'schedule': crontab(minute='*/15')
},
'update_exchange_rates_task_at_midnight': {
'task': 'Update exchange rates task',
'schedule': crontab()
},
'process_scheduled_backups_task_every_15_minutes': {
'task': 'Process scheduled backups task',
'schedule': crontab(minute='*/15')
},
'sync_hypervisors_task_every_60_minutes': {
'task': 'Hypervisors background synchronization',
'schedule': crontab(minute='*/60')
},
'clear_expired_sessions_every_12_hours': {
'task': 'Clear expired sessions task',
'schedule': crontab(hour='*/12')
},
}
In 2022.09 release we also merged end-user’s openstack/billing/history API into openstack/billing and staff’s
billing/usage-history API into billing/usage API. If you’ve made any changes or you have any scripts that pull
information using these APIs, you will have to adapt them.
Upgrading to 2022.04¶
In the 2022.04 release we have upgraded the Fleio backend dependencies. With this upgrade, we also moved to django 4.0,
where PASSWORD_RESET_TIMEOUT_DAYS setting was removed. If you’re aware that you changed the
PASSWORD_RESET_TIMEOUT_DAYS time by redefining the variable in your settings.py, then you need to remove it and use
the PASSWORD_RESET_TIMEOUT variable.
Note that the new variable uses seconds while the old one used days.
If you’re using the CSRF_TRUSTED_ORIGINS setting, then you will need to also include the scheme (http:// or
https://)
Upgrading to 2021.12¶
In the 2021.12 release we have changed the utils menu option to utilities.
If you redefined the Fleio menu in settings.py, you will have to rename all utils/xxx angular_route parameters to
utilities/xxx.
Upgrading to 2021.11.0¶
In the 2021.11.0 release we have removed the “state” parameter from the MenuItem classes in their definition of menu in
settings.py. If you redefined the Fleio menu in settings.py, you will have to remove all traces of the ‘state’
parameter.
For example, Networks menu changed from:
MenuItem(label=_('Networks'), state='openstackNetworks', icon='networks', feature='openstack.networks', angular_route='openstack/networks', related_permission='networks.list'),
to
MenuItem(label=_('Networks'), icon='networks', feature='openstack.networks', angular_route='openstack/networks', related_permission='networks.list'),
Another thing that was removed in the 2021.11.0 release is “minTTL” frontend setting. In order to configure a minimum TTL you need to add the following variable in the settings.py:
DNS_ENDUSER_MIN_TTL = 300
Replace 300 with the desired value.
In 2021.11.0 we also added a new dark theme. For existing installations, you will have to manually add the theme in the enduser and staff panels, by running the following commands:
fleio edit enduser.config.json
fleio edit staff.config.json
fleio edit reseller.config.json
Then, in the availableThemes list, add “dark”:
"availableThemes": [
"spring",
"navy",
"dusk",
"dark"
],
Upgrading to 2021.10.1¶
In the 2021.10.1 release we have added new filters and modifiers. If you’re upgrading from a previous Fleio version, then you will not be able to configure them until you will add the new filters and modifiers into Fleio.
First, you will have to enable django admin. Please see Django admin.
Next step is to access the django admin, which should be available at {{ your configured frontend url }}/backend/admin
If you are asked to login, then you will have to use your administrator credentials.
Navigate to Billing app -> billing resources -> Instance and in the definition field, replace all it’s contents with
the one from below (has_boot_volume is the new entry that was added).
{
"attributes": [
{
"type": "string",
"name": "availability_zone"
},
{
"type": "string",
"name": "instance_type"
},
{
"type": "string",
"name": "display_name"
},
{
"type": "datetime",
"name": "launched_at"
},
{
"type": "string",
"name": "state"
},
{
"type": "integer",
"name": "vcpus"
},
{
"type": "integer",
"name": "root_gb",
"value_size": "g"
},
{
"value_size": "m",
"name": "memory_mb",
"type": "integer"
},
{
"type": "string",
"name": "os_type"
},
{
"type": "string",
"name": "instance_id"
},
{
"type": "string",
"name": "tenant_id"
},
{
"type": "string",
"name": "host"
},
{
"type": "string",
"name": "has_boot_volume"
},
{
"type": "integer",
"name": "ephemeral_gb",
"value_size": "g"
},
{
"type": "string",
"name": "region"
}
]
}
Save and navigate to Billing app -> billing resources -> Volume and in the definition field
replace the contents with the following (related_instance_flavor new entry was added):
{
"attributes": [
{
"value_size": "g",
"type": "integer",
"name": "size"
},
{
"type": "string",
"name": "availability_zone"
},
{
"type": "datetime",
"name": "created_at"
},
{
"type": "string",
"name": "volume_type"
},
{
"type": "string",
"name": "related_instance_flavor"
},
{
"type": "string",
"name": "display_name"
},
{
"type": "string",
"name": "region"
}
]
}
Pre 2021.01.0¶
Upgrading to 2020.12.1¶
Important
This method works only when you have Fleio installed using system packages. We recommend you to migrate to docker (see Migrate to Fleio docker deployment) as soon as possible.
In 2020.12.1 we have added the enduser panel in Angular and support for Swift object store. In order to enable Swift object store you need enable the Angular enduser panel so you will need to add the following configuration in the Nginx configuration:
location /new {
alias /var/webapps/fleio/frontend/enduser/;
expires -1;
try_files $uri $uri/ /../enduser/index.html;
}
Finally do not forget to reload nginx using the following cli commands:
nginx -t
systemctl reload nginx
Upgrading to 2020.11.1¶
Important
This method works only when you have Fleio installed using system packages. We recommend you to migrate to docker (see Migrate to Fleio docker deployment) as soon as possible.
With the 2020.11.1 upgrade we have implemented a new log level called FLEIO ACTIVITY and we have redesigned the general logging.
Before upgrading to the 2020.11.1 version you will have to check /var/webapps/fleio/fleiosettings/settings.py
to be sure that you have no custom logging setting added. You can do that by running the following command:
grep LOGGING /var/webapps/fleio/fleiosettings/settings.py
If you have any results, you will need to comment or remove those lines.
After that you can proceed with the Recommended upgrade procedure.
However, if you already upgraded and you received an error related to Logging, you can just do the steps from above and then run the update commands again.
Upgrading to 2020.07.1¶
Important
This method works only when you have Fleio installed using system packages. We recommend you to migrate to docker (see Migrate to Fleio docker deployment) as soon as possible.
New nginx configuration¶
In 2020.07.1 we have added the Tickets plugin in Angular. In order to properly work you need to add the following tinymce configuration in the Nginx configuration:
location /tinymce {
alias /var/webapps/fleio/frontend/staff/tinymce/;
break;
}
Finally do not forget to reload nginx using the following cli commands:
nginx -t
systemctl reload nginx
Upgrading to 2020.05.0¶
Important
This method works only when you have Fleio installed using system packages. We recommend you to migrate to docker (see Migrate to Fleio docker deployment) as soon as possible.
To upgrade to version 2020.05.0 on Ubuntu 16 and Ubuntu 18 first you will need to run:
apt-get dist-upgrade fleio-backend fleio-frontend
This is necessary due to a new dependency (patch) that was introduced in 2020.05 release. The regular
apt-get upgrade fleio-backend fleio-frontend command will not install the dependency and you might get in a state
that fleio-frontend is not automatically upgraded.
To upgrade to version 2020.05.0 on Centos you need to run:
yum install fleio-backend fleio-frontend
Besides this, the following additional steps are required.
We are migrating the Fleio frontend from the legacy AngularJS framework to Angular. For a smooth migration we are gradually rewriting and releasing pages from the staff panel in Angular. After the staff panel is successfully migrated to Angular we will do the same for the end-user panel. This is expected to take several months.
The new Angular pages are temporarily located a under the /newstaff URL, while the previous pages remain for now
under /staff URL.
New nginx settings¶
By default some of the staff panel menu options already point to /newstaff links, while the pages that are not yet
migrated to Angular will still link to a /staff URL. For instance, one of the first pages migrated to Angular is
Settings > Configurations and it links to /newstaff/settings/configurations.
This requires that you add a new entry to your nginx conf, which is usually located at
for Ubuntu at /etc/nginx/sites-enabled/{ your domain }.conf and for CentOS at
/etc/nginx/conf.d/{ your domain }.conf.
Add this entry in the server configuration after the /staff location.
# identify the following section and leave it unchanged
location /staff {
alias /var/webapps/fleio/frontend/site/staff/;
expires -1;
try_files $uri $uri/ /staff/index.html;
}
# insert below the following lines
location /newstaff {
alias /var/webapps/fleio/frontend/staff/;
expires -1;
try_files $uri $uri/ /../staff/index.html;
}
Reload nginx to apply the change:
systemctl reload nginx
If you have enabled the reseller feature an additional change is required in the nginx config. Replace this section:
# identify these section and delete it
location /reseller {
root /var/webapps/fleio/frontend/site/;
expires -1;
try_files $uri $uri/ /reseller/index.html;
}
Replace with:
# the new reseller directives
location /reseller {
alias /var/webapps/fleio/frontend/reseller/;
expires -1;
try_files $uri $uri/ /../reseller/index.html;
}
Reload nginx to apply the change:
systemctl reload nginx