summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbhishek Kekane <akekane@redhat.com>2018-07-06 07:14:25 +0000
committerErno Kuvaja <jokke@usr.fi>2018-07-26 09:51:18 +0000
commit70d6afbc59d8ded749db4dd65b2e690386b8f836 (patch)
tree7fdb0612f6fe39ca129108289bb4ff164c157d0d
parent65a234b15891ca4ef6e6b1a47494d76b0d31f26a (diff)
Modify operator image workflow specs
Modified specs to reflect changes as per the implementation. Highlights: In the response of create/show image the new property will be displayed as 'os_hidden'. If a pre-Rocky image already has a custom property named as 'os_hidden' then that property will no longer be visible in the response from Rocky release. Change-Id: I9d012a81ad5c8d209cf52634740268989eaed928
Notes
Notes (review): Code-Review+2: Brian Rosmaita <rosmaita.fossdev@gmail.com> Code-Review+2: Sean McGinnis <sean.mcginnis@gmail.com> Workflow+1: Erno Kuvaja <jokke@usr.fi> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 26 Jul 2018 14:48:03 +0000 Reviewed-on: https://review.openstack.org/580568 Project: openstack/glance-specs Branch: refs/heads/master
-rw-r--r--specs/rocky/approved/glance/operator-image-workflow.rst45
1 files changed, 26 insertions, 19 deletions
diff --git a/specs/rocky/approved/glance/operator-image-workflow.rst b/specs/rocky/approved/glance/operator-image-workflow.rst
index fa9fd97..f7307da 100644
--- a/specs/rocky/approved/glance/operator-image-workflow.rst
+++ b/specs/rocky/approved/glance/operator-image-workflow.rst
@@ -52,9 +52,9 @@ included in the end user's default image-list in the first place.
52Proposed change 52Proposed change
53=============== 53===============
54 54
55This spec proposes adding a new boolean column ``"hidden"`` in images table. 55This spec proposes adding a new boolean column ``"os_hidden"`` in images table.
56Images where ``"hidden" = True`` will be omitted from the image list presented 56Images where ``"os_hidden" = True`` will be omitted from the image list
57to the user. This will apply to all image visibilities. 57presented to the user. This will apply to all image visibilities.
58However, the images will continue to be discoverable. 58However, the images will continue to be discoverable.
59 59
60.. note:: Example 60.. note:: Example
@@ -63,17 +63,22 @@ However, the images will continue to be discoverable.
63 ``"?visibility=public"`` on the ``GET v2/images`` call. 63 ``"?visibility=public"`` on the ``GET v2/images`` call.
64 He sees a CentOS 7 image, but notices that it was created_at today, 64 He sees a CentOS 7 image, but notices that it was created_at today,
65 so he realizes that it's not the same image that he's searching for. 65 so he realizes that it's not the same image that he's searching for.
66 So now he uses ``"?visibility=public&hidden=true"`` to get the list of all 66 So now he uses ``"?visibility=public&os_hidden=true"`` to get the list of all
67 available images. 67 available images.
68 68
69If the image has ``"hidden" = False`` the image is not omitted from the image 69If the image has ``"os_hidden" = False`` the image is not omitted from the
70list. It preserves the current behaviour. 70image list. It preserves the current behaviour.
71 71
72At image creation, if not specified, it's used ``"hidden" = False``. 72At image creation, if not specified, it's used ``"os_hidden" = False``.
73 73
74Changing the property "hidden" will be considered an image update. Because, 74Changing the property "os_hidden" will be considered an image update. Because,
75the policy is already defined for this operation no other changes are required. 75the policy is already defined for this operation no other changes are required.
76 76
77In the response of create/show image the new property will be displayed as
78``os_hidden``. If a pre-Rocky image already has a custom property named as
79``os_hidden`` then that property will no longer be visible in the response
80from Rocky release.
81
77All operations in the image will continue to be available considering the 82All operations in the image will continue to be available considering the
78policy defined. 83policy defined.
79 84
@@ -103,22 +108,24 @@ admins will need implement their own solution to expose these images.
103Data model impact 108Data model impact
104----------------- 109-----------------
105 110
106Add the "hidden" boolean column in images table. 111Add the "os_hidden" boolean column in images table.
107 112
108For the E-M-C migration strategy is proposed: 113For the E-M-C migration strategy is proposed:
109- Triggers: not required. Queens release will reject an image-update call 114
110setting 'hidden' with a 400 because it doesn't recognize the field. 115- Triggers: not required. A pre-Rocky glance release will reject an
111- Expand: will add a boolean "hidden" column to the images table. 116 image-update call setting 'os_hidden' with a 400 because it doesn't recognize
117 the field.
118- Expand: will add a boolean "os_hidden" column to the images table.
112- Contract: not required 119- Contract: not required
113- Data Migration: set the "hidden" column to False in all rows. 120- Data Migration: Not required.
114 121
115 122
116REST API impact 123REST API impact
117--------------- 124---------------
118 125
119A new property "hidden" will be accepted for the GET call. 126A new property "os_hidden" will be accepted for the GET call.
120GET v2/images ... hidden=true/false 127GET v2/images ... os_hidden=true/false
121By default the API will consider hidden=false. 128By default the API will consider os_hidden=false.
122 129
123Security impact 130Security impact
124--------------- 131---------------
@@ -154,13 +161,13 @@ Assignee(s)
154----------- 161-----------
155 162
156Primary assignee: 163Primary assignee:
157- Belmiro Moreira 164- Abhishek Kekane
158 165
159Work Items 166Work Items
160---------- 167----------
161 168
162- Add support in GET call for the property "hidden". 169- Add support in GET call for the property "os_hidden".
163 Consider the default "hidden=false". 170 Consider the default "os_hidden=false".
164- Change the image table schema adding a new field. 171- Change the image table schema adding a new field.
165- Change the glance-client to support the new property. 172- Change the glance-client to support the new property.
166 173