[pve-devel] [RFC manager] pveceph: add osd details command

[Aaron Lauterer]

ping?

patch still applies

On 12/19/22 15:46, Aaron Lauterer wrote:
> To provide similar output on the CLI as is possible in the GUI/API
> regaring OSD details.
> 
> By default (output-format=text) a more concise output is shown. Using
> json or yaml as output format will print all the available data.
> 
> The 'verbose' flag causes json-pretty output to be used.
> 
> The functionality is split between the actual function and the output
> formatter as not all options/parameters are available in each.
> 
> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
> Depends on the OSD Details patches which are not yet applied [0].
> 
> RFC because in order to check against the output format and the verbose
> flag, the code ended up split between the actual cmdline method and
> the formatting function.
> 
> The verbose flag is only available in the formatter and the verbose in
> the method itself.
> 
> If there would be a nicer way to achieve a similar result, I would be
> happy to get hints.
> 
> [0] https://lists.proxmox.com/pipermail/pve-devel/2022-December/055154.html
> 
>   PVE/CLI/pveceph.pm | 66 ++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 66 insertions(+)
> 
> diff --git a/PVE/CLI/pveceph.pm b/PVE/CLI/pveceph.pm
> index afcc67e0..e08cc344 100755
> --- a/PVE/CLI/pveceph.pm
> +++ b/PVE/CLI/pveceph.pm
> @@ -352,6 +352,71 @@ __PACKAGE__->register_method ({
>   	return $rpcenv->fork_worker('cephdestroyfs', $fs_name,  $user, $worker);
>       }});
>   
> +__PACKAGE__->register_method ({
> +    name => 'osddetails',
> +    path => 'osddetails',
> +    method => 'GET',
> +    description => "Get OSD details.",
> +    parameters => {
> +	additionalProperties => 0,
> +	properties => {
> +	    node => get_standard_option('pve-node'),
> +	    osdid => {
> +		description => "ID of the OSD",
> +		type => 'string',
> +	    },
> +	    verbose => {
> +		description => "Print verbose information, same as json-pretty output format.",
> +		type => 'boolean',
> +		default => 0,
> +		optional => 1,
> +	    },
> +	},
> +    },
> +    returns => { type => 'object' },
> +    code => sub {
> +	my ($param) = @_;
> +	PVE::Ceph::Tools::check_ceph_inited();
> +	my $res = PVE::API2::Ceph::OSD->osddetails({
> +		osdid => $param->{osdid},
> +		node => $param->{node},
> +	    });
> +
> +	for my $dev (@{ $res->{devices} }) {
> +	    $dev->{"lv-info"} = PVE::API2::Ceph::OSD->osdvolume({
> +		    osdid => $param->{osdid},
> +		    node => $param->{node},
> +		    type => $dev->{device},
> +		});
> +	}
> +	$res->{verbose} = 1 if $param->{verbose};
> +	return $res;
> +    }});
> +
> +my $format_osddetails = sub {
> +    my ($data, $schema, $options) = @_;
> +    $options->{"output-format"} //= "text";
> +
> +    if ($data->{verbose}) {
> +	$options->{"output-format"} = "json-pretty";
> +	delete $data->{verbose};
> +    }
> +
> +    if ($options->{"output-format"} eq "text") {
> +	for my $dev (@{ $data->{devices} }) {
> +	    my $str = "Disk: $dev->{physical_device},"
> +		." Type: $dev->{type},"
> +		." LV Size: $dev->{'lv-info'}->{lv_size},"
> +		." LV Creation Time: $dev->{'lv-info'}->{creation_time}";
> +
> +	    $data->{osd}->{$dev->{device}} = $str;
> +	}
> +	PVE::CLIFormatter::print_api_result($data->{osd}, $schema, undef, $options);
> +    } else {
> +	PVE::CLIFormatter::print_api_result($data, $schema, undef, $options);
> +    }
> +};
> +
>   our $cmddef = {
>       init => [ 'PVE::API2::Ceph', 'init', [], { node => $nodename } ],
>       pool => {
> @@ -392,6 +457,7 @@ our $cmddef = {
>       osd => {
>   	create => [ 'PVE::API2::Ceph::OSD', 'createosd', ['dev'], { node => $nodename }, $upid_exit],
>   	destroy => [ 'PVE::API2::Ceph::OSD', 'destroyosd', ['osdid'], { node => $nodename }, $upid_exit],
> +	details => [ __PACKAGE__, 'osddetails', ['osdid'], { node => $nodename }, $format_osddetails, $PVE::RESTHandler::standard_output_options],
>       },
>       createosd => { alias => 'osd create' },
>       destroyosd => { alias => 'osd destroy' },