samuelallan72 commented 5 months ago

Required information

Distribution: ubuntu
Distribution version: noble

The output of "snap list --all lxd core20 core22 core24 snapd":

Name    Version         Rev    Tracking       Publisher   Notes
core20  20240227        2264   latest/stable  canonical✓  base,disabled
core20  20240416        2318   latest/stable  canonical✓  base
core22  20240111        1122   latest/stable  canonical✓  base,disabled
core22  20240408        1380   latest/stable  canonical✓  base
lxd     5.21.1-d46c406  28460  5.21/stable    canonical✓  -
snapd   2.62            21465  latest/stable  canonical✓  snapd,disabled
snapd   2.63            21759  latest/stable  canonical✓  snapd

The output of "lxc info"]:

lxc info

``` config: {} api_extensions: - storage_zfs_remove_snapshots - container_host_shutdown_timeout - container_stop_priority - container_syscall_filtering - auth_pki - container_last_used_at - etag - patch - usb_devices - https_allowed_credentials - image_compression_algorithm - directory_manipulation - container_cpu_time - storage_zfs_use_refquota - storage_lvm_mount_options - network - profile_usedby - container_push - container_exec_recording - certificate_update - container_exec_signal_handling - gpu_devices - container_image_properties - migration_progress - id_map - network_firewall_filtering - network_routes - storage - file_delete - file_append - network_dhcp_expiry - storage_lvm_vg_rename - storage_lvm_thinpool_rename - network_vlan - image_create_aliases - container_stateless_copy - container_only_migration - storage_zfs_clone_copy - unix_device_rename - storage_lvm_use_thinpool - storage_rsync_bwlimit - network_vxlan_interface - storage_btrfs_mount_options - entity_description - image_force_refresh - storage_lvm_lv_resizing - id_map_base - file_symlinks - container_push_target - network_vlan_physical - storage_images_delete - container_edit_metadata - container_snapshot_stateful_migration - storage_driver_ceph - storage_ceph_user_name - resource_limits - storage_volatile_initial_source - storage_ceph_force_osd_reuse - storage_block_filesystem_btrfs - resources - kernel_limits - storage_api_volume_rename - network_sriov - console - restrict_devlxd - migration_pre_copy - infiniband - maas_network - devlxd_events - proxy - network_dhcp_gateway - file_get_symlink - network_leases - unix_device_hotplug - storage_api_local_volume_handling - operation_description - clustering - event_lifecycle - storage_api_remote_volume_handling - nvidia_runtime - container_mount_propagation - container_backup - devlxd_images - container_local_cross_pool_handling - proxy_unix - proxy_udp - clustering_join - proxy_tcp_udp_multi_port_handling - network_state - proxy_unix_dac_properties - container_protection_delete - unix_priv_drop - pprof_http - proxy_haproxy_protocol - network_hwaddr - proxy_nat - network_nat_order - container_full - backup_compression - nvidia_runtime_config - storage_api_volume_snapshots - storage_unmapped - projects - network_vxlan_ttl - container_incremental_copy - usb_optional_vendorid - snapshot_scheduling - snapshot_schedule_aliases - container_copy_project - clustering_server_address - clustering_image_replication - container_protection_shift - snapshot_expiry - container_backup_override_pool - snapshot_expiry_creation - network_leases_location - resources_cpu_socket - resources_gpu - resources_numa - kernel_features - id_map_current - event_location - storage_api_remote_volume_snapshots - network_nat_address - container_nic_routes - cluster_internal_copy - seccomp_notify - lxc_features - container_nic_ipvlan - network_vlan_sriov - storage_cephfs - container_nic_ipfilter - resources_v2 - container_exec_user_group_cwd - container_syscall_intercept - container_disk_shift - storage_shifted - resources_infiniband - daemon_storage - instances - image_types - resources_disk_sata - clustering_roles - images_expiry - resources_network_firmware - backup_compression_algorithm - ceph_data_pool_name - container_syscall_intercept_mount - compression_squashfs - container_raw_mount - container_nic_routed - container_syscall_intercept_mount_fuse - container_disk_ceph - virtual-machines - image_profiles - clustering_architecture - resources_disk_id - storage_lvm_stripes - vm_boot_priority - unix_hotplug_devices - api_filtering - instance_nic_network - clustering_sizing - firewall_driver - projects_limits - container_syscall_intercept_hugetlbfs - limits_hugepages - container_nic_routed_gateway - projects_restrictions - custom_volume_snapshot_expiry - volume_snapshot_scheduling - trust_ca_certificates - snapshot_disk_usage - clustering_edit_roles - container_nic_routed_host_address - container_nic_ipvlan_gateway - resources_usb_pci - resources_cpu_threads_numa - resources_cpu_core_die - api_os - container_nic_routed_host_table - container_nic_ipvlan_host_table - container_nic_ipvlan_mode - resources_system - images_push_relay - network_dns_search - container_nic_routed_limits - instance_nic_bridged_vlan - network_state_bond_bridge - usedby_consistency - custom_block_volumes - clustering_failure_domains - resources_gpu_mdev - console_vga_type - projects_limits_disk - network_type_macvlan - network_type_sriov - container_syscall_intercept_bpf_devices - network_type_ovn - projects_networks - projects_networks_restricted_uplinks - custom_volume_backup - backup_override_name - storage_rsync_compression - network_type_physical - network_ovn_external_subnets - network_ovn_nat - network_ovn_external_routes_remove - tpm_device_type - storage_zfs_clone_copy_rebase - gpu_mdev - resources_pci_iommu - resources_network_usb - resources_disk_address - network_physical_ovn_ingress_mode - network_ovn_dhcp - network_physical_routes_anycast - projects_limits_instances - network_state_vlan - instance_nic_bridged_port_isolation - instance_bulk_state_change - network_gvrp - instance_pool_move - gpu_sriov - pci_device_type - storage_volume_state - network_acl - migration_stateful - disk_state_quota - storage_ceph_features - projects_compression - projects_images_remote_cache_expiry - certificate_project - network_ovn_acl - projects_images_auto_update - projects_restricted_cluster_target - images_default_architecture - network_ovn_acl_defaults - gpu_mig - project_usage - network_bridge_acl - warnings - projects_restricted_backups_and_snapshots - clustering_join_token - clustering_description - server_trusted_proxy - clustering_update_cert - storage_api_project - server_instance_driver_operational - server_supported_storage_drivers - event_lifecycle_requestor_address - resources_gpu_usb - clustering_evacuation - network_ovn_nat_address - network_bgp - network_forward - custom_volume_refresh - network_counters_errors_dropped - metrics - image_source_project - clustering_config - network_peer - linux_sysctl - network_dns - ovn_nic_acceleration - certificate_self_renewal - instance_project_move - storage_volume_project_move - cloud_init - network_dns_nat - database_leader - instance_all_projects - clustering_groups - ceph_rbd_du - instance_get_full - qemu_metrics - gpu_mig_uuid - event_project - clustering_evacuation_live - instance_allow_inconsistent_copy - network_state_ovn - storage_volume_api_filtering - image_restrictions - storage_zfs_export - network_dns_records - storage_zfs_reserve_space - network_acl_log - storage_zfs_blocksize - metrics_cpu_seconds - instance_snapshot_never - certificate_token - instance_nic_routed_neighbor_probe - event_hub - agent_nic_config - projects_restricted_intercept - metrics_authentication - images_target_project - cluster_migration_inconsistent_copy - cluster_ovn_chassis - container_syscall_intercept_sched_setscheduler - storage_lvm_thinpool_metadata_size - storage_volume_state_total - instance_file_head - instances_nic_host_name - image_copy_profile - container_syscall_intercept_sysinfo - clustering_evacuation_mode - resources_pci_vpd - qemu_raw_conf - storage_cephfs_fscache - network_load_balancer - vsock_api - instance_ready_state - network_bgp_holdtime - storage_volumes_all_projects - metrics_memory_oom_total - storage_buckets - storage_buckets_create_credentials - metrics_cpu_effective_total - projects_networks_restricted_access - storage_buckets_local - loki - acme - internal_metrics - cluster_join_token_expiry - remote_token_expiry - init_preseed - storage_volumes_created_at - cpu_hotplug - projects_networks_zones - network_txqueuelen - cluster_member_state - instances_placement_scriptlet - storage_pool_source_wipe - zfs_block_mode - instance_generation_id - disk_io_cache - amd_sev - storage_pool_loop_resize - migration_vm_live - ovn_nic_nesting - oidc - network_ovn_l3only - ovn_nic_acceleration_vdpa - cluster_healing - instances_state_total - auth_user - security_csm - instances_rebuild - numa_cpu_placement - custom_volume_iso - network_allocations - storage_api_remote_volume_snapshot_copy - zfs_delegate - operations_get_query_all_projects - metadata_configuration - syslog_socket - event_lifecycle_name_and_project - instances_nic_limits_priority - disk_initial_volume_configuration - operation_wait - cluster_internal_custom_volume_copy - disk_io_bus - storage_cephfs_create_missing - instance_move_config - ovn_ssl_config - init_preseed_storage_volumes - metrics_instances_count - server_instance_type_info - resources_disk_mounted - server_version_lts - oidc_groups_claim - loki_config_instance - storage_volatile_uuid - import_instance_devices - instances_uefi_vars - instances_migration_stateful - container_syscall_filtering_allow_deny_syntax - access_management - vm_disk_io_limits - storage_volumes_all - instances_files_modify_permissions api_status: stable api_version: "1.0" auth: trusted public: false auth_methods: - tls auth_user_name: ubuntu auth_user_method: unix environment: addresses: [] architectures: - x86_64 - i686 certificate: | -----BEGIN CERTIFICATE----- MIIB5TCCAWygAwIBAgIQYe6nUgy5sIGapNM7Ywd7zzAKBggqhkjOPQQDAzAlMQww CgYDVQQKEwNMWEQxFTATBgNVBAMMDHJvb3RAZGVza3RvcDAeFw0yNDA1MzEwMjAy MjNaFw0zNDA1MjkwMjAyMjNaMCUxDDAKBgNVBAoTA0xYRDEVMBMGA1UEAwwMcm9v dEBkZXNrdG9wMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAECb0rFZWKrRbpV3PMYA1C ZgmEq+l2Q3Tu/7zuNSUlUYG5n2mp1kRR7FRyljRjsAIXgLTVz+4tVw3Tww0pU5OJ 5fc050Mtvin53LzZwrwOmZf06IFFh/fLIf4Mnn5Pi9zJo2EwXzAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDAYDVR0TAQH/BAIwADAqBgNVHREE IzAhggdkZXNrdG9whwR/AAABhxAAAAAAAAAAAAAAAAAAAAABMAoGCCqGSM49BAMD A2cAMGQCMEJNBCA+ifNcEdsMPI+oBXx3kk2c5UR/rJbh0FLewSNfaI7RgMNtAOzC PyBmN0EX0gIwUAcA/x2B6CgNYz4Qf81Gt6UPbCPOEhk7v4U9LJfQOKstaFlqv+r9 crFtF8l9xRZ0 -----END CERTIFICATE----- certificate_fingerprint: c38aefe784a4c0fc1da60d38df749401175d882a03b129468fccbfb7e7edf0e9 driver: lxc | qemu driver_version: 6.0.0 | 8.2.1 instance_types: - container - virtual-machine firewall: nftables kernel: Linux kernel_architecture: x86_64 kernel_features: idmapped_mounts: "true" netnsid_getifaddrs: "true" seccomp_listener: "true" seccomp_listener_continue: "true" uevent_injection: "true" unpriv_fscaps: "true" kernel_version: 6.8.0-35-generic lxc_features: cgroup2: "true" core_scheduling: "true" devpts_fd: "true" idmapped_mounts_v2: "true" mount_injection_file: "true" network_gateway_device_route: "true" network_ipvlan: "true" network_l2proxy: "true" network_phys_macvlan_mtu: "true" network_veth_router: "true" pidfd: "true" seccomp_allow_deny_syntax: "true" seccomp_notify: "true" seccomp_proxy_send_notify_fd: "true" os_name: Ubuntu os_version: "24.04" project: default server: lxd server_clustered: false server_event_mode: full-mesh server_name: desktop server_pid: 77108 server_version: 5.21.1 server_lts: true storage: zfs storage_version: 2.2.2-0ubuntu9 storage_supported_drivers: - name: lvm version: 2.03.11(2) (2021-01-08) / 1.02.175 (2021-01-08) / 4.48.0 remote: false - name: powerflex version: 1.16 (nvme-cli) remote: true - name: zfs version: 2.2.2-0ubuntu9 remote: false - name: btrfs version: 5.16.2 remote: false - name: ceph version: 17.2.7 remote: true - name: cephfs version: 17.2.7 remote: true - name: cephobject version: 17.2.7 remote: true - name: dir version: "1" remote: false ```

Issue description

metadata.update_source.image_type for the GET /1.0/images/{fingerprint} api endpoint is documented as

string example: container Type of image (container or virtual-machine)

However it has been observed to be an empty string.

Steps to reproduce

lxc launch ubuntu:noble
lxc image list # note the image is available in the list

Call the /1.0/images/{fingerprint} endpoint with the fingerprint of the image. Note that the update_source.image_type value is an empty string (""). For example:

$ sudo curl -X GET --unix-socket /var/snap/lxd/common/lxd/unix.socket http://lxd/1.0/images/2961ee641e643d4a10fa582b83581179fd83bb5bc3577c764e65538b84358fcf | jq .metadata.update_source.image_type
""

Information to attach

[ ] Any relevant kernel output (dmesg)
[ ] Container log (lxc info NAME --show-log)
[ ] Container configuration (lxc config show NAME --expanded)
[ ] Main daemon log (at /var/log/lxd/lxd.log or /var/snap/lxd/common/lxd/logs/lxd.log)
[ ] Output of the client with --debug
[ ] Output of the daemon with --debug (alternatively output of lxc monitor while reproducing the issue)

MusicDin commented 4 months ago

Hi,

the update_source.image_type is used when requesting an image from the given source (remote). Since the same structure is used for returning update_source (and the corresponding documentation is generated), the field image_type is included within the response example.

To get the image type, the type field should be used:

GET /1.0/images/<fingerprint>
{
        ...
        "type": "container",
        "update_source": {
                "alias": "alpine/edge",
                "certificate": "",
                "image_type": "",
                "protocol": "simplestreams",
                "server": "https://images.lxd.canonical.com"
        },
}

I think we should separate the get/put structures, or at least clarify it in a documentation example.

samuelallan72 commented 4 months ago

Ah ok, thanks for the info. That sounds very similar to https://github.com/canonical/lxd/issues/12993 . There was a large PR recently to separate the get/put structures ( https://github.com/canonical/lxd/pull/13035 ), but maybe some were missed.

The ideal solution would be to separate the structures, so there aren't spurious/unused fields returned, and so the docs are inline with how the API behaves. :+1:

tomponline commented 4 months ago

@MusicDin how much work is this to fix, can we get it in for 6.1?

canonical / lxd

image source image_type is empty string #13586

Required information

Issue description

Steps to reproduce

Information to attach