cli icon indicating copy to clipboard operation
cli copied to clipboard

cf service --params doesn't comply with openservicebrokerapi Fetch Service Instance

Open LiliVideva opened this issue 2 years ago • 1 comments

Please fill out the issue checklist below and provide ALL the requested information.

  • [x] I reviewed open and closed github issues that may be related to my problem.
  • [x] I tried updating to the latest version of the CF CLI to see if it fixed my problem.
  • [x] I attempted to run the command with CF_TRACE=1 to help debug the issue.
  • [x] I am reporting a bug that others will be able to reproduce.

Describe the bug and the command you saw an issue with What: Fetch service instance details via cf CLI Why: Implementing the functionality to offer to our stakeholders

What happened In our service broker, we have implemented the openservicebrokerapi Fetch Service Instance endpoint in order to be able to retrieve the parameters specified in an existing service instance. Once the broker was deployed with the code changes, we have tried to fetch the parameters of a service instance via cf service <service> --params (as cf service <service> doesn't return this information). The command failed with a custom error, coming from our broker, saying that the plan ID was not provided. When checking the logs of the broker app (cf logs <broker-app> --recent) we have spotted that the GET command executed against our broker does not include any of the expected query parameters, specified by the openservicebrokerapi Fetch Service Instance. The command looked like GET /v2/service_instances/<instance-id>, instead of GET /v2/service_instances/<instance-id>?service_id=<service-id>&plan_id=<plan-id>.
When checking the broker logs for execution of cf delete-service <service> command (which we support for some time now), we can see that the command includes the query parameters, expected by openservicebrokerapi Delete Service Instance. This leads to the conclusion that there is an inconsistency of the support for query parameters between the different cf commands.

Expected behavior

  • To execute with query parameters, as defined in the openservicebrokerapi Fetch Service Instance
  • To receive the parameters of the service instance

Exact Steps To Reproduce Steps to reproduce the behavior; include the exact CLI commands and verbose output:

  1. Have a broker, implementing openservicebrokerapi Fetch Service Instance and Create Service Instance
  2. Create a service instance via cf cli: cf create-service <offering> <plan> <service> -c <config-file>
  3. Run cf service <service> --params
  4. See error

Provide more context

  • Mac OS Ventura 13.5
  • zsh
  • cf cli version: 8.7.1+9c81242.2023-06-15

LiliVideva avatar Aug 11 '23 12:08 LiliVideva

We created a ticket in our team's tracker to look into this issue.

a-b avatar Oct 01 '24 14:10 a-b