Search
Varnish Controller

Deprecation

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.

Upcoming deprecations

Deprecations as of Version 7.0.0

The following arguments will be removed from the Varnish Controller Agent in version 7.0.0, support for the new -stats-filter is added in version 6.4.0. We recommend to move to this new argument instead of the following:

  • -agent-stats-filter is replaced by -stats-filter, can be used as is in the new argument.
  • -vclgroup-stats-filter is replaced by -stats-filter, defined filters need to be prefixed with VBE.*..
  • -accounting-stats-filter is replaced by -stats-filter, defined filters need to be prefixed with ACCG.*.total..
  • -accounting-stats-keys is replaced by -stats-filter, define the counters you want to track of your accounting key with the following prefix ACCG.*.<insert_your_key>.<your_counter_name>.

The -stats-filter matches on the whole accounting key and has support for wildcards, like the previous statistics keys. Multiple wildcards in the same filter are supported.

Deprecations as of Version 6.0.0

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.

  • The flag cidr-to-tag for CIDR routes will be replaced by cidr.
  • The flag cidr-to-tag-csv for CIDR routes will be replaced by cidr-csv.
  • The flag asn-to-tag for ASN routes will be replaced by asn.
  • The flag asn-to-tag-csv for ASN routes will be replaced by asn-csv.
  • The flag geolocation-to-tag for Geolocation routes will be replaced by geolocation.
  • The flag geolocation-to-tag-csv for Geolocation routes will be replaced by geolocation-csv.

API-GW

  • All 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

Deprecations as of Version 5.0.0

CLI

  • All vcli vcl * commands has been removed, use the vcli files * commands instead.

API-GW

  • All /api/v1/vcls/* endpoints has been removed, use the /api/v1/files/* endpoints instead.
  • The /api/v1/agents/1/vclgroups endpoint has been removed, use /api/v1/vclgroups?agents.id=1&vg_states.deployed=true instead.
  • The /api/v1/tags/1/agents endpoint has been removed, use /api/v1/agents?tags.id=1 instead.
  • The /api/v1/vclgroups/1/agents endpoint has been removed, use /api/v1/agents?vcl_groups.id=1&vg_states.deployed=true instead.
  • The 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.


®Varnish Software, Wallingatan 12, 111 60 Stockholm, Organization nr. 556805-6203