Sunsetting Service Descriptors

For more than 2 years, after the rewrite of the proxy engine in v1.5.3, Service Descriptors has been deprecated.

Now (v17.0.0) it’s time to go ahead and provide some migration tools to help users getting rid of Service Descriptor in favor of routes before completely removing support of Service Descriptors in v18.0.0 (probably in 2026). Under the hood the new proxy engine already convert your Service Descriptors to Route in order to route traffic to your backends. The idea here is to remove the Service Descriptor entity in favor of the Route entity and let the user adapt their workflows and automations.

If you still have Service Descriptors in you database, otoroshi will warn you in the logs

you will also have a popup displayed in the backoffice from time to time

This toolkit consists of 3 tools that you can use to migrate existing Service Descriptors

Migration Job

you can enable a job launched after the start of the otoroshi cluster by setting otoroshi.service-descriptors-migration-job.enabled=true or OTOROSHI_SERVICE_DESCRIPTORS_MIGRATION_JOB_ENABLED=true

Migration API

You can migrate service descriptor to routes by calling the following endpoint

curl -X POST -H 'Content-Type: application/json' "http://otoroshi-api.oto.tools:8080/api/services/service-xxxxxxxx/route" -d '{}'

Migration button

on any Service Descriptor, you can click on the convert to route button

and just confirm it