Release/Upgrade notes for 2.0.0

[samene]

Hi, we are using the version 1.5.2 of clickhouse-backup and recently upgraded to the 2.1.3 image. The very first thing that broke for us was a HTTP 201 instead of a HTTP 200 in the API call to backup.

Where can we find the release notes for 2.0.x and any special considerations when upgrading from 1.x to 2.x?

[Slach]

How exactly do you try to call API backup?
AFAIK clickhouse-backup return 200 status code for every success backup request

# clickhouse-backup --version
Version:         2.1.3
Git Commit:      f3e6a5667371bfa122e5a907b68e5004b40251f7
Build Date:      2022-12-26

# curl -vvv http://127.0.0.1:7171/backup/status
*   Trying 127.0.0.1:7171...
* Connected to 127.0.0.1 (127.0.0.1) port 7171 (#0)
> GET /backup/status HTTP/1.1
> Host: 127.0.0.1:7171
> User-Agent: curl/7.83.1
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Date: Tue, 31 Jan 2023 10:57:47 GMT
< Content-Length: 99
< Content-Type: text/plain; charset=utf-8
<
{"command":"list","status":"success","start":"2023-01-31 04:27:49","finish":"2023-01-31 04:27:49"}
* Connection #0 to host 127.0.0.1 left intact

[samene]

failed: [localhost] (item=0) => {"ansible_loop_var": "item", "changed": false, "connection": "close", "content_length": "83", "content_type": "text/plain; charset=utf-8", "cookies": {}, "cookies_string": "", "date": "Thu, 26 Jan 2023 08:46:38 GMT", "elapsed": 0, "item": "0", "msg": "Status code was 201 and not [200]: OK (83 bytes)", "redirected": false, "status": 201, "url": "http://***-clickhouse-estorage-0-0-0.***-clickhouse-estorage-0-0.***-cloud.svc.cluster.local:7171/backup/create?name=backup_1674722704-0"}

This is our ansible playbook's output that does the backup

[Slach]

could you share your ansible playbook part which call API? not just execution log?

[samene]

Nothing special

- name: Trigger backup on all shards
  uri:
    url: "http://{{ service_prefix }}-{{ item }}-0-0.{{ service_prefix }}-{{ item }}-0.{{ ns.stdout }}.svc.cluster.local:7171/backup/create?{{table_query}}name={{file_name}}-{{ item }}"
    method: POST
  with_sequence: "start=0 count={{ shards |int }}"

The variable are all set somewhere else.

[Slach]

looks weird, are you sure your playbook works with 1.5.2?
according to
according to f24b0cd#diff-99552855ebe788117dd63e292608b1acfcefc0d726d15629c5e57ac485898fd9R304
and
https://github.com/AlexAkulov/clickhouse-backup/blob/v1.5.2/pkg/server/server.go#L659-L667

/backup/create shall return 201 status from 1.0.0 beta from the beginning, we just didn't change this behavior since 2020

[samene]

bash-5.1$ curl -k -v -X POST http://localhost:7171/backup/create?name=test
*   Trying 127.0.0.1:7171...
* Connected to localhost (127.0.0.1) port 7171 (#0)
> POST /backup/create?name=test HTTP/1.1
> Host: localhost:7171
> User-Agent: curl/7.80.0
> Accept: */*
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Cache-Control: no-store, no-cache, must-revalidate
< Content-Type: application/json; charset=UTF-8
< Pragma: no-cache
< Date: Wed, 01 Feb 2023 03:52:21 GMT
< Content-Length: 68
< 
{"status":"acknowledged","operation":"create","backup_name":"test"}
* Connection #0 to host localhost left intact
bash-5.1$ clickhouse-backup --version
Version:         1.5.2
Git Commit:      f67d23fd3b775f887683d3d3fdea1b1500419987
Build Date:      2022-08-08
bash-5.1$ 

bash-5.1$ curl -k -v -X POST http://localhost:7171/backup/create?name=test
*   Trying 127.0.0.1:7171...
* Connected to localhost (127.0.0.1) port 7171 (#0)
> POST /backup/create?name=test HTTP/1.1
> Host: localhost:7171
> User-Agent: curl/7.83.1
> Accept: */*
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 201 Created
< Date: Wed, 01 Feb 2023 03:55:49 GMT
< Content-Length: 68
< Content-Type: text/plain; charset=utf-8
< 
{"status":"acknowledged","operation":"create","backup_name":"test"}
* Connection #0 to host localhost left intact
bash-5.1$ clickhouse-backup --version
Version:         2.1.3
Git Commit:      f3e6a5667371bfa122e5a907b68e5004b40251f7
Build Date:      2022-12-26
bash-5.1$ 

[Slach]

found root cause
look like it was minor error, and error was fixed during massive refactoring for 2.1.0 version
https://github.com/AlexAkulov/clickhouse-backup/blame/master/pkg/server/utils.go#L35

you just can change your playbook and add
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/uri_module.html#parameter-status_code

status_code: [200, 201]

or use common POST /backup/actions
with

body: '{"command":"create {{file_name}}-{{ item }} --tables {{ table_query }}"}'

i will add changelog comment to 2.1.0 release