This page announces which endpoints and features will be breaking in the upcoming major release. Users of the Varnish Controller are advised to implement the alternatives. Are you only using the UI? Then no action is needed, these changes are mostly regarding configuration, API endpoints and CLI commands.
No known deprecations.
CLI
The following flags for the vcli
will be replaced in a future major release. Support for both will be in place from 6.0, it is however recommended to start migrating to the new flags.
cidr-to-tag
for CIDR routes will be replaced by cidr
.cidr-to-tag-csv
for CIDR routes will be replaced by cidr-csv
.asn-to-tag
for ASN routes will be replaced by asn
.asn-to-tag-csv
for ASN routes will be replaced by asn-csv
.geolocation-to-tag
for Geolocation routes will be replaced by geolocation
.geolocation-to-tag-csv
for Geolocation routes will be replaced by geolocation-csv
.API-GW
varnishstat
endpoints are renamed to stats
as they no longer hold just Varnish Statistics. As of version 5 there is support for both endpoints, the following API endpoints need to be changed:
/api/v1/agents/varnishstats
to /api/v1/agents/stats
/api/v1/agents/{id}/varnishstats
to /api/v1/agents/{id}/stats
/api/v1/domains/varnishstats
to /api/v1/domains/stats
/api/v1/domains/{id}/varnishstats
to /api/v1/domains/{id}/stats
/api/v1/routers/varnishstats
to /api/v1/routers/stats
/api/v1/routers/{id}/varnishstats
to /api/v1/routers/{id}/stats
/api/v1/tags/varnishstats
to /api/v1/tags/stats
/api/v1/tags/{id}/varnishstats
to /api/v1/tags/{id}/stats
/api/v1/vclgroups/varnishstats
to /api/v1/vclgroups/stats
/api/v1/vclgroups/{id}/varnishstats
to /api/v1/vclgroups/{id}/stats
CLI
vcli vcl *
commands has been removed, use the vcli files *
commands instead.API-GW
/api/v1/vcls/*
endpoints has been removed, use the /api/v1/files/*
endpoints instead./api/v1/agents/1/vclgroups
endpoint has been removed, use /api/v1/vclgroups?agents.id=1&vg_states.deployed=true
instead./api/v1/tags/1/agents
endpoint has been removed, use /api/v1/agents?tags.id=1
instead./api/v1/vclgroups/1/agents
endpoint has been removed, use /api/v1/agents?vcl_groups.id=1&vg_states.deployed=true
instead.operator=and
has been removed from the filters, instead of ?tags.id=1,2&operator=and
use ?tags.id[all]=1,2
.You can replace the above commands and API endpoints as of version 4.1.0.