Browse Source

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
Abhishek Kekane 9 months ago
parent
commit
70d6afbc59
1 changed files with 26 additions and 19 deletions
  1. 26
    19
      specs/rocky/approved/glance/operator-image-workflow.rst

+ 26
- 19
specs/rocky/approved/glance/operator-image-workflow.rst View File

@@ -52,9 +52,9 @@ included in the end user's default image-list in the first place.
52 52
 Proposed change
53 53
 ===============
54 54
 
55
-This spec proposes adding a new boolean column ``"hidden"`` in images table.
56
-Images where ``"hidden" = True`` will be omitted from the image list presented
57
-to the user. This will apply to all image visibilities.
55
+This spec proposes adding a new boolean column ``"os_hidden"`` in images table.
56
+Images where ``"os_hidden" = True`` will be omitted from the image list
57
+presented to the user. This will apply to all image visibilities.
58 58
 However, the images will continue to be discoverable.
59 59
 
60 60
 .. note:: Example
@@ -63,17 +63,22 @@ However, the images will continue to be discoverable.
63 63
     ``"?visibility=public"`` on the  ``GET v2/images`` call.
64 64
     He sees a CentOS 7 image, but notices that it was created_at today,
65 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 67
     available images.
68 68
 
69
-If the image has ``"hidden" = False`` the image is not omitted from the image
70
-list. It preserves the current behaviour.
69
+If the image has ``"os_hidden" = False`` the image is not omitted from the
70
+image list. It preserves the current behaviour.
71 71
 
72
-At image creation, if not specified, it's used ``"hidden" = False``.
72
+At image creation, if not specified, it's used ``"os_hidden" = False``.
73 73
 
74
-Changing the property "hidden" will be considered an image update. Because,
74
+Changing the property "os_hidden" will be considered an image update. Because,
75 75
 the policy is already defined for this operation no other changes are required.
76 76
 
77
+In 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
80
+from Rocky release.
81
+
77 82
 All operations in the image will continue to be available considering the
78 83
 policy defined.
79 84
 
@@ -103,22 +108,24 @@ admins will need implement their own solution to expose these images.
103 108
 Data model impact
104 109
 -----------------
105 110
 
106
-Add the "hidden" boolean column in images table.
111
+Add the "os_hidden" boolean column in images table.
107 112
 
108 113
 For the E-M-C migration strategy is proposed:
109
-- Triggers: not required. Queens release will reject an image-update call
110
-setting 'hidden' with a 400 because it doesn't recognize the field.
111
-- Expand: will add a boolean "hidden" column to the images table.
114
+
115
+- Triggers: not required. A pre-Rocky glance release will reject an
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 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
 
116 123
 REST API impact
117 124
 ---------------
118 125
 
119
-A new property "hidden" will be accepted for the GET call.
120
-GET v2/images ... hidden=true/false
121
-By default the API will consider hidden=false.
126
+A new property "os_hidden" will be accepted for the GET call.
127
+GET v2/images ... os_hidden=true/false
128
+By default the API will consider os_hidden=false.
122 129
 
123 130
 Security impact
124 131
 ---------------
@@ -154,13 +161,13 @@ Assignee(s)
154 161
 -----------
155 162
 
156 163
 Primary assignee:
157
-- Belmiro Moreira
164
+- Abhishek Kekane
158 165
 
159 166
 Work Items
160 167
 ----------
161 168
 
162
-- Add support in GET call for the property "hidden".
163
-  Consider the default "hidden=false".
169
+- Add support in GET call for the property "os_hidden".
170
+  Consider the default "os_hidden=false".
164 171
 - Change the image table schema adding a new field.
165 172
 - Change the glance-client to support the new property.
166 173
 

Loading…
Cancel
Save