Jump to: navigation, search

Difference between revisions of "Glance-v2-v1-client-compatability"

 
(40 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
This is an overview of the effects of the non-backwards compatibility of the prospective 1.0.0 glance client (which defaults to v2) on existing glance cli scripts.
 +
 +
Note: "Input compatible: No" means that any existing glance cli script with the specified arguments will fail with the new client.
 +
 +
Note: "Output compatible: No" means that the output to stdout is missing some fields, or ordering is reversed. Scripts relying on those fields/order being the same in the output will fail.
 +
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! command !! sub-command !! Compatible !! Notes  
+
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes  
 
|-
 
|-
−
| image-list || || No (orange) || v2 displays fewer fields
+
| image-create || || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output 
 
|-
 
|-
−
| image-list || --verbose || Yes || v2 displays fewer fields
+
| image-create || <data on stdin> || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output 
 
|-
 
|-
−
| image-list || --name || No (red) || Does not exist in v2
+
| image-create || --id || <span style="color:green">Yes</span> || <span style="color:orange">No</span> ||   Slightly different output 
 
|-
 
|-
−
| image-list || --status || No (red) || Does not exist in v2
+
| image-create || --name || <span style="color:green">Yes</span> || <span style="color:orange">No</span> ||   Slightly different output 
 
|-
 
|-
−
| image-list || --container-format || No (red) || Does not exist in v2
+
| image-create || --owner || <span style="color:red">No</span> || <span style="color:orange">No</span> || Slightly different output 
 
|-
 
|-
−
| image-list || --disk-format || No (red) || Does not exist in v2
+
| image-create || --size || <span style="color:red">No</span> || || Not implemented in v2 client 
 
|-
 
|-
−
| image-list || --size-min || No (red) || Does not exist in v2
+
| image-create || --store || <span style="color:red">No</span> || || Not implemented in v2 client
 
|-
 
|-
−
| image-list || --size-max || No (red) || Does not exist in v2
+
| image-create || --min-disk || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output 
 
|-
 
|-
−
| image-list || --property-filter || No (orange) || v2 displays fewer fields
+
| image-create || --min-ram || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output 
 
|-
 
|-
−
| image-list || --page-fize || No (orange) || v2 displays fewer fields
+
| image-create || --location || <span style="color:red">No</span> || || Not implemented in v2 client
 
|-
 
|-
−
| image-list || --human-readable || No (red) || Does not exist in v2
+
| image-create || --owner || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 
|-
 
|-
−
| image-list || --sort-key || No (red) || v2 sorts in the opposite direction
+
| image-create || --file || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 
|-
 
|-
−
| image-list || --sort-dir || Yes ||
+
| image-create || --checksum || <span style="color:red">No</span> || || Not implemented in v2 client
 
|-
 
|-
−
| image-list || --is-public || No (red) || Does not exist in v2 (ignored/broken in v1?)
+
| image-create || --copy-from || <span style="color:red">No</span> || || Not implemented in v2 server
 
|-
 
|-
−
| image-list || --owner || No (orange) || v2 displays fewer fields
+
| image-create || --is-public || <span style="color:red">No</span> || || Replaced with --visibility in v2 client
 
|-
 
|-
−
| image-list || --all-tenants || No (red) || Does not exist in v2
+
| image-create || --is-protected || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-create || --property || <span style="color:green">Yes</span> || <span style="color:orange">No</span> ||  Slightly different output
 +
|-
 +
| image-create || --progress || <span style="color:green">Yes</span> || <span style="color:orange">No</span> ||  Slightly different output
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| image-delete || <IMAGE_UUID> ||  <span style="color:red">No</span> || <span style="color:green">Yes</span> || v2 client cannot accept more than one image to delete
 +
|-
 +
| image-delete || <IMAGE_NAME> ||  <span style="color:red">No</span> || || v2 client does not accept a name
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| image-download || <IMAGE_UUID> ||  <span style="color:green">Yes</span> || <span style="color:green">Yes</span> || Note: bug 1488914
 +
|-
 +
| image-download || <IMAGE_NAME> ||  <span style="color:red">No</span> ||  || v2 client does not accept an image name.
 +
|-
 +
| image-download || --file || <span style="color:green">Yes</span> || <span style="color:green">Yes</span> ||
 +
|-
 +
| image-download || --progress || <span style="color:green">Yes</span> || <span style="color:green">Yes</span> ||
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| image-list ||  || <span style="color:green">Yes</span> || <span style="color:orange">No</span>  || v2 client displays fewer fields
 +
|-
 +
| image-list || --verbose || <span style="color:green">Yes</span> || <span style="color:orange">No</span>  || v2 client displays fewer fields
 +
|-
 +
| image-list || --name || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-list || --status || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-list || --container-format || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-list || --disk-format || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-list || --size-min || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-list || --size-max || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-list || --property-filter ||  <span style="color:green">Yes</span> || <span style="color:orange">No</span> || v2 client displays fewer fields
 +
|-
 +
| image-list || --page-fize ||  <span style="color:green">Yes</span> || <span style="color:orange">No</span> || v2 client displays fewer fields
 +
|-
 +
| image-list || --human-readable || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-list || --sort-key || <span style="color:green">Yes</span> ||  <span style="color:red">No</span> || v2 client sorts in the opposite direction
 +
|-
 +
| image-list || --sort-dir || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || v2 client displays fewer fields
 +
|-
 +
| image-list || --is-public || <span style="color:red">No</span> || || Not implemented in  v2 client (ignored/broken in v1?)
 +
|-
 +
| image-list || --owner || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || v2 client displays fewer fields
 +
|-
 +
| image-list || --all-tenants || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| image-show || <IMAGE_UUID> || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-show || <IMAGE_NAME> || <span style="color:red">No</span> || || v2 client does not accept a name
 +
|-
 +
| image-show || --human-readable || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-show || --max-column-width || <span style="color:green">Yes</span> ||  <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| image-update || <IMAGE_UUID> || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || <IMAGE_NAME> || <span style="color:red">No</span> ||  || v2 client does not accept a name.
 +
|-
 +
| image-update || <data on stdin> || <span style="color:red">No</span> || <span style="color:orange">No</span> || v2 client ignores data on stdin
 +
|-
 +
| image-update || --name || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --disk-format || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --container-format || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --owner || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output . (v1 returns 0 indicating success -- bug?)
 +
|-
 +
| image-update || --container-format || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --size ||  <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-update || --min-disk || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --min-ram || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --location || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-update || --file || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
| image-update || --checksum || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-update || --copy-from || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-update || --is-public || <span style="color:red">No</span> ||  || Not implemented in v2 client (Replaced with visibility)
 +
|-
 +
| image-update || --is-protected || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-update || --property || <span style="color:green">Yes</span> || <span style="color:orange">No</span> || Slightly different output
 +
|-
 +
| image-update || --purge-props || <span style="color:red">No</span> || || Not implemented in v2 server
 +
|-
 +
| image-update || --human-readable || <span style="color:red">No</span> || || Not implemented in v2 client
 +
|-
 +
| image-update || --progress || <span style="color:red">No</span> ||  || Not implemented in v2 client
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| member-create || <IMAGE_UUID> || <span style="color:green">Yes</span> || <span style="color:green">Yes</span> || displays additional output
 +
|-
 +
| member-create || <IMAGE_NAME> || <span style="color:red">No</span> || || v2 client does not support a name
 +
|-
 +
| member-create || --can-share || <span style="color:red">No</span> ||  || Not implemented in v2 client (server?)
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| member-delete || <IMAGE_UUID> || <span style="color:green">Yes</span> || <span style="color:green">Yes</span> ||
 +
|-
 +
| member-delete || <IMAGE_NAME> || <span style="color:red">No</span> || || v2 client does not support a name
 +
|-
 +
|-
 +
! command !! sub-command !! Input Compatible !! Output Compatible!! Notes
 +
|-
 +
| member-list || --image-id ||  <span style="color:green">Yes</span> || <span style="color:red">No</span> || v2 client displays different output
 +
|-
 +
| member-list || --tenant-id || <span style="color:red">No</span> || || Not implemented in v2 client
 
|-
 
|-
 
|}
 
|}

Latest revision as of 16:04, 15 September 2015

This is an overview of the effects of the non-backwards compatibility of the prospective 1.0.0 glance client (which defaults to v2) on existing glance cli scripts.

Note: "Input compatible: No" means that any existing glance cli script with the specified arguments will fail with the new client.

Note: "Output compatible: No" means that the output to stdout is missing some fields, or ordering is reversed. Scripts relying on those fields/order being the same in the output will fail.

command sub-command Input Compatible Output Compatible Notes
image-create Yes No Slightly different output
image-create Yes No Slightly different output
image-create --id Yes No Slightly different output
image-create --name Yes No Slightly different output
image-create --owner No No Slightly different output
image-create --size No Not implemented in v2 client
image-create --store No Not implemented in v2 client
image-create --min-disk Yes No Slightly different output
image-create --min-ram Yes No Slightly different output
image-create --location No Not implemented in v2 client
image-create --owner Yes No Slightly different output
image-create --file Yes No Slightly different output
image-create --checksum No Not implemented in v2 client
image-create --copy-from No Not implemented in v2 server
image-create --is-public No Replaced with --visibility in v2 client
image-create --is-protected No Not implemented in v2 client
image-create --property Yes No Slightly different output
image-create --progress Yes No Slightly different output
command sub-command Input Compatible Output Compatible Notes
image-delete <IMAGE_UUID> No Yes v2 client cannot accept more than one image to delete
image-delete <IMAGE_NAME> No v2 client does not accept a name
command sub-command Input Compatible Output Compatible Notes
image-download <IMAGE_UUID> Yes Yes Note: bug 1488914
image-download <IMAGE_NAME> No v2 client does not accept an image name.
image-download --file Yes Yes
image-download --progress Yes Yes
command sub-command Input Compatible Output Compatible Notes
image-list Yes No v2 client displays fewer fields
image-list --verbose Yes No v2 client displays fewer fields
image-list --name No Not implemented in v2 client
image-list --status No Not implemented in v2 client
image-list --container-format No Not implemented in v2 client
image-list --disk-format No Not implemented in v2 client
image-list --size-min No Not implemented in v2 client
image-list --size-max No Not implemented in v2 client
image-list --property-filter Yes No v2 client displays fewer fields
image-list --page-fize Yes No v2 client displays fewer fields
image-list --human-readable No Not implemented in v2 client
image-list --sort-key Yes No v2 client sorts in the opposite direction
image-list --sort-dir Yes No v2 client displays fewer fields
image-list --is-public No Not implemented in v2 client (ignored/broken in v1?)
image-list --owner Yes No v2 client displays fewer fields
image-list --all-tenants No Not implemented in v2 client
command sub-command Input Compatible Output Compatible Notes
image-show <IMAGE_UUID> Yes No Slightly different output
image-show <IMAGE_NAME> No v2 client does not accept a name
image-show --human-readable Yes No Slightly different output
image-show --max-column-width Yes No Slightly different output
command sub-command Input Compatible Output Compatible Notes
image-update <IMAGE_UUID> Yes No Slightly different output
image-update <IMAGE_NAME> No v2 client does not accept a name.
image-update <data on stdin> No No v2 client ignores data on stdin
image-update --name Yes No Slightly different output
image-update --disk-format Yes No Slightly different output
image-update --container-format Yes No Slightly different output
image-update --owner Yes No Slightly different output . (v1 returns 0 indicating success -- bug?)
image-update --container-format Yes No Slightly different output
image-update --size No Not implemented in v2 client
image-update --min-disk Yes No Slightly different output
image-update --min-ram Yes No Slightly different output
image-update --location No Not implemented in v2 client
image-update --file No Not implemented in v2 client
image-update --checksum No Not implemented in v2 client
image-update --copy-from No Not implemented in v2 client
image-update --is-public No Not implemented in v2 client (Replaced with visibility)
image-update --is-protected No Not implemented in v2 client
image-update --property Yes No Slightly different output
image-update --purge-props No Not implemented in v2 server
image-update --human-readable No Not implemented in v2 client
image-update --progress No Not implemented in v2 client
command sub-command Input Compatible Output Compatible Notes
member-create <IMAGE_UUID> Yes Yes displays additional output
member-create <IMAGE_NAME> No v2 client does not support a name
member-create --can-share No Not implemented in v2 client (server?)
command sub-command Input Compatible Output Compatible Notes
member-delete <IMAGE_UUID> Yes Yes
member-delete <IMAGE_NAME> No v2 client does not support a name
command sub-command Input Compatible Output Compatible Notes
member-list --image-id Yes No v2 client displays different output
member-list --tenant-id No Not implemented in v2 client
Retrieved from "https://wiki.openstack.org/w/index.php?title=Glance-v2-v1-client-compatability&oldid=90305"