cloudfoundry / cloudfoundry/cli

Display service offerings metadata

Open
#2,715 1 comment 0 reactions 1 assignee View on GitHub

@a-b is already working on this.

Since Sep 6, 2024.

product-improvement
Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

Please provide details on the following items. Failure to do so may result in deletion of your feature request.

What's the user value of this feature request?

  • As a cf user,
  • In order to discover osb metadata associated to a service offering (longDescription, documentationUrl, supportUrl) and metadata associated to plans (bullets).
  • I need cf cli to display them

Who is the functionality for?
App developers, Space managers

Describe the solution you'd like

cf m -e displays the service offering metadata

currently it only partially displays plan metadata, but no service offering metadata:

$ cf m -b osb-cmdb-broker-cf-z2 -e mariadb-shared-dev --show-unavailable
Getting service plan information for service offering mariadb-shared-dev from service broker osb-cmdb-broker-cf-z2 in org system_domain / space smoke-tests as xxx...

broker: osb-cmdb-broker-cf-z2
   plan    description                           free or paid   costs              available
   10mb    Shared MySQL/MariaDB Galera Cluster   free           EUR 0.00/Monthly   yes
   20mb    Shared MySQL/MariaDB Galera Cluster   paid           EUR 0.00/Monthly   yes
   100mb   Shared MySQL/MariaDB Galera Cluster   paid           EUR 0.00/Monthly   yes
   1gb     Shared MySQL/MariaDB Galera Cluster   paid           EUR 0.00/Monthly   yes
   15gb    Shared MySQL/MariaDB Galera Cluster   paid           EUR 0.00/Monthly   yes

Describe alternatives you've considered

use cf curl and yq to extra metadata from cf api

The following example extracts from cf marketplace command the cf curl command to execute and then displays partial json output for bullets

cf curl "$(CF_TRACE=true cf m | grep 'GET ' | awk '{print $2}')" | jq ".resources[].broker_catalog.metadata.bullets " | grep -v null


  "1 GB storage",
  "20 concurrent connections"
]
[
  "15 GB storage",
  "75 concurrent connections"
]
[
  "No yet limits",
  "1 CPU",
  "2 GB Memory",
  "3 * 100 20 GB Disk"
]

Additional context

Same previous feature request against cf v6 was tracked in https://github.com/cloudfoundry/cli/issues/1298 and closed without being reopened for v7 or v8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.