api: snapshot, snapshotpolicy tag support by shwstppr · Pull Request #3228 · apache/cloudstack

shwstppr · 2019-03-14T12:05:32Z

Description

Problem: Currently tags cannot be applied to snapshot when it is being created but through separate “create tags” API calls. For snapshot policies tags cannot be set either at creation or through “create tags” API.

Root Cause: The “create snapshots” API does not support adding tags during creation and it can only be done through “create tags” API. Snapshot policy as a resource does not support tags and no tags can be set for them through any API.

Solution: Tag support for snapshot policy has been added. Snapshot policy with tags when executed will produce snapshots containing the same tags from snapshot policy.

Following APIs have been updated:

Both “create snapshotpolicy” and “create snapshot” now accepts “tags” as a new parameter. The expected format for “tags” parameter is similar to parameter “tags” in “create tags“ API.
Deletion support for tags associated with snapshots policy has been added to “delete snapshotpolicies” API.
Tags set for snapshot policies are added to the Response of “list snapshotpolicies“ API.

UI support for setting tags to snapshots and snapshot policy is provided through the corresponding menus with a new section in each form to set tags.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

Screenshots (if appropriate):

How Has This Been Tested?

UI And Cloudmonkey.

(local) 🐵 > create snapshot volumeid=9d4a3e48-2c27-4822-98c0-a79381cf4113 tags[0].key=keyss tags[0].value=valuess
 
{
  "accountid": "77891a42-1e18-11e9-8d89-34e12d5f623e",
  "cmd": "org.apache.cloudstack.api.command.user.snapshot.CreateSnapshotCmd",
  "created": "2019-02-08T00:01:15+0530",
  "jobid": "f4b82b0d-f256-4c87-a8b4-36bbcb44cdeb",
  "jobinstanceid": "21086b5a-42da-4bd1-aa10-d7e62bed88a9",
  "jobinstancetype": "Snapshot",
  "jobprocstatus": 0,
  "jobresult": {
    "snapshot": {
      "account": "admin",
      "created": "2019-02-08T00:01:15+0530",
      "domain": "ROOT",
      "domainid": "77890928-1e18-11e9-8d89-34e12d5f623e",
      "id": "21086b5a-42da-4bd1-aa10-d7e62bed88a9",
      "intervaltype": "MANUAL",
      "name": "vm1_ROOT-6_20190207183115",
      "osdisplayname": "CentOS 5.5 (64-bit)",
      "ostypeid": "7780d0f5-1e18-11e9-8d89-34e12d5f623e",
      "physicalsize": 1596588032,
      "revertable": true,
      "snapshottype": "MANUAL",
      "state": "BackedUp",
      "tags": [
        {
          "key": "keyss",
          "value": "valuess"
        }
      ],
      "virtualsize": 8589934592,
      "volumeid": "9d4a3e48-2c27-4822-98c0-a79381cf4113",
      "volumename": "ROOT-6",
      "volumetype": "ROOT",
      "zoneid": "df67395c-d21d-4404-adcc-a44c9994763d"
    }
  },
  "jobresultcode": 0,
  "jobresulttype": "object",
  "jobstatus": 1,
  "userid": "77892e56-1e18-11e9-8d89-34e12d5f623e"
}
(local) 🐵 > create snapshotpolicy volumeid=9d4a3e48-2c27-4822-98c0-a79381cf4113 schedule=1 maxsnaps=1 intervaltype=HOURLY timezone="Etc/GMT+12" tags[0].key=hello tags[0].value=world
{
  "snapshotpolicy": {
    "fordisplay": true,
    "id": "c9da9363-cbab-47d8-8d1c-cbc69c140946",
    "intervaltype": 0,
    "maxsnaps": 1,
    "schedule": "1",
    "tags": [
      {
        "account": "system",
        "domain": "ROOT",
        "domainid": "77890928-1e18-11e9-8d89-34e12d5f623e",
        "key": "hello",
        "resourceid": "c9da9363-cbab-47d8-8d1c-cbc69c140946",
        "resourcetype": "SnapshotPolicy",
        "value": "world"
      }
    ],
    "timezone": "Etc/GMT+12",
    "volumeid": "9d4a3e48-2c27-4822-98c0-a79381cf4113"
  }
}
(local) 🐵 > list snapshotpolicies id=c9da9363-cbab-47d8-8d1c-cbc69c140946
{
  "count": 1,
  "snapshotpolicy": [
    {
      "fordisplay": true,
      "id": "c9da9363-cbab-47d8-8d1c-cbc69c140946",
      "intervaltype": 0,
      "maxsnaps": 1,
      "schedule": "1",
      "tags": [
        {
          "account": "system",
          "domain": "ROOT",
          "domainid": "77890928-1e18-11e9-8d89-34e12d5f623e",
          "key": "hello",
          "resourceid": "c9da9363-cbab-47d8-8d1c-cbc69c140946",
          "resourcetype": "SnapshotPolicy",
          "value": "world"
        }
      ],
      "timezone": "Etc/GMT+12",
      "volumeid": "9d4a3e48-2c27-4822-98c0-a79381cf4113"
    }
  ]
}

borisstoyanov · 2019-03-25T10:53:22Z

@blueorangutan package

blueorangutan · 2019-03-25T10:53:52Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-03-25T11:25:57Z

Packaging result: ✖centos6 ✖centos7 ✔debian. JID-2642

borisstoyanov

@shwstppr there seems to be some build issues, can you have a look?

DaanHoogland · 2019-03-26T12:08:17Z

...c/test/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmdTest.java

@@ -0,0 +1,30 @@
+package org.apache.cloudstack.api.command.user.snapshot;


license needed, @shwstppr . Can you add it?

@DaanHoogland added license

borisstoyanov · 2019-04-01T11:37:34Z

@blueorangutan package

blueorangutan · 2019-04-01T11:38:25Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-04-01T11:58:52Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2665

borisstoyanov · 2019-04-01T12:21:39Z

@blueorangutan test

blueorangutan · 2019-04-01T12:22:25Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

borisstoyanov

LGTM, now tags look like this:

{
      "account": "user",
      "created": "2019-04-01T12:21:04+0000",
      "domain": "ROOT",
      "domainid": "c1bf87c5-4fb7-11e9-b7a8-1e004901077b",
      "id": "03298bd6-605a-49bf-a599-449e8de4a8d9",
      "intervaltype": "MANUAL",
      "name": "snap1",
      "osdisplayname": "CentOS 5.3 (64-bit)",
      "ostypeid": "c1c83ce2-4fb7-11e9-b7a8-1e004901077b",
      "physicalsize": 419862016,
      "revertable": false,
      "snapshottype": "MANUAL",
      "state": "BackedUp",
      "tags": [
        {
          "key": "random",
          "value": "rand-value"
        }
      ],
      "virtualsize": 2147483648,
      "volumeid": "545f71aa-d92d-4650-ad8b-1032d3a1709a",
      "volumename": "ROOT-5",
      "volumetype": "ROOT",
      "zoneid": "5c3dcefe-7b0e-4c3e-bb92-271a3c01229e"
    }

blueorangutan · 2019-04-01T20:54:33Z

Trillian test result (tid-3457)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 28705 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3228-t3457-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_host_maintenance.py
Smoke tests completed. 69 look OK, 1 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File
test_01_cancel_host_maintenace_with_no_migration_jobs	`Failure`	5.48	test_host_maintenance.py
test_02_cancel_host_maintenace_with_migration_jobs	`Error`	1.50	test_host_maintenance.py

yadvr · 2019-05-23T14:34:09Z

@shwstppr can you fix the conflicts?

shwstppr · 2019-05-24T07:19:42Z

@blueorangutan package

blueorangutan · 2019-05-24T07:20:02Z

@shwstppr a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-05-24T08:23:21Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2785

borisstoyanov · 2019-06-06T09:17:17Z

@blueorangutan test

blueorangutan · 2019-06-06T09:17:58Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

anuragaw · 2019-06-19T08:24:27Z

@blueorangutan package

blueorangutan · 2019-06-19T08:24:53Z

@anuragaw a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-06-19T08:46:03Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2906

anuragaw · 2019-06-20T05:56:00Z

@blueorangutan package

blueorangutan · 2019-06-20T05:56:56Z

@anuragaw a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-06-20T06:18:11Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2907

borisstoyanov · 2019-06-20T06:59:19Z

@blueorangutan test

blueorangutan · 2019-06-20T06:59:57Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2019-06-20T14:56:19Z

Trillian test result (tid-3711)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 26945 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3228-t3711-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_internal_lb.py
Smoke tests completed. 71 look OK, 0 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File

borisstoyanov

LGTM on latest changes

anuragaw · 2019-06-25T07:03:40Z

Updated heght of the dilague box -

@andrijapanic , @rhtyd , @shwstppr

anuragaw · 2019-06-25T07:07:49Z

@blueorangutan package

blueorangutan · 2019-06-25T07:08:08Z

@anuragaw a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

borisstoyanov · 2019-06-25T07:23:11Z

@blueorangutan package

blueorangutan · 2019-06-25T07:24:08Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-06-25T07:30:41Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-12

blueorangutan · 2019-06-25T07:46:11Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-13

yadvr · 2019-06-25T09:32:31Z

Packaging race condition, the repo may be inconsistent. Will rekick packaging.
@blueorangutan package

blueorangutan · 2019-06-25T09:33:10Z

@rhtyd a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-06-25T09:54:17Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-18

yadvr · 2019-06-25T09:56:19Z

@blueorangutan test

blueorangutan · 2019-06-25T09:57:09Z

@rhtyd a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2019-06-25T19:01:23Z

Trillian test result (tid-18)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 30865 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3228-t18-kvm-centos7.zip
Smoke tests completed. 71 look OK, 0 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File

Correção na listagem de _backup schedules_ de projetos Closes #3228 See merge request scclouds/scclouds!1346

yadvr added the status:work-in-progress label Mar 25, 2019

yadvr requested review from PaulAngus, mike-tutkowski and rafaelweingartner March 25, 2019 08:24

borisstoyanov requested changes Mar 25, 2019

View reviewed changes

PaulAngus modified the milestones: 4.11.3.0, 4.13.0.0 Mar 25, 2019

DaanHoogland reviewed Mar 26, 2019

View reviewed changes

shwstppr closed this Mar 27, 2019

shwstppr reopened this Mar 27, 2019

yadvr changed the title ~~api: snapshot, snapshotpolicy tag support~~ [WIP DO NOT MERGE] api: snapshot, snapshotpolicy tag support Mar 29, 2019

borisstoyanov approved these changes Apr 1, 2019

View reviewed changes

yadvr approved these changes May 24, 2019

View reviewed changes

shwstppr force-pushed the snapshot-snapshotpolicy-tag-support branch from 3dcb841 to 26b4073 Compare May 24, 2019 07:18

Allow users to tag snapshot policy for the volumes they own

eeb2238

borisstoyanov approved these changes Jun 20, 2019

View reviewed changes

Increase min height for snapshot dialog forms

ee904ce

yadvr approved these changes Jun 25, 2019

View reviewed changes

yadvr removed the status:work-in-progress label Jun 27, 2019

yadvr changed the title ~~[WIP DO NOT MERGE] api: snapshot, snapshotpolicy tag support~~ api: snapshot, snapshotpolicy tag support Jun 27, 2019

yadvr merged commit 5847453 into apache:master Jun 27, 2019

winterhazel pushed a commit that referenced this pull request Jan 28, 2026

Merge branch 'fix-backup-schedule-list' into '4.20.0.0-scclouds'

c331ae2

Correção na listagem de _backup schedules_ de projetos Closes #3228 See merge request scclouds/scclouds!1346

		@@ -0,0 +1,30 @@
		package org.apache.cloudstack.api.command.user.snapshot;

Conversation

shwstppr commented Mar 14, 2019

Description

Types of changes

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

borisstoyanov commented Mar 25, 2019

Uh oh!

blueorangutan commented Mar 25, 2019

Uh oh!

blueorangutan commented Mar 25, 2019

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Mar 26, 2019

Choose a reason for hiding this comment

Uh oh!

shwstppr Mar 26, 2019

Choose a reason for hiding this comment

Uh oh!

borisstoyanov commented Apr 1, 2019

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

borisstoyanov commented Apr 1, 2019

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

yadvr commented May 23, 2019

Uh oh!

shwstppr commented May 24, 2019

Uh oh!

blueorangutan commented May 24, 2019

Uh oh!

blueorangutan commented May 24, 2019

Uh oh!

borisstoyanov commented Jun 6, 2019

Uh oh!

blueorangutan commented Jun 6, 2019

Uh oh!

anuragaw commented Jun 19, 2019

Uh oh!

blueorangutan commented Jun 19, 2019

Uh oh!

blueorangutan commented Jun 19, 2019

Uh oh!

anuragaw commented Jun 20, 2019

Uh oh!

blueorangutan commented Jun 20, 2019

Uh oh!

blueorangutan commented Jun 20, 2019

Uh oh!

borisstoyanov commented Jun 20, 2019

Uh oh!

blueorangutan commented Jun 20, 2019

Uh oh!

blueorangutan commented Jun 20, 2019

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

anuragaw commented Jun 25, 2019

Uh oh!

anuragaw commented Jun 25, 2019

Uh oh!

blueorangutan commented Jun 25, 2019

Uh oh!

borisstoyanov commented Jun 25, 2019

Uh oh!

blueorangutan commented Jun 25, 2019

Uh oh!