cloudfoundry / cloudfoundry/cli

Adding list of bound service instances of an app in the 'cf app' command

Open
#1,789 6 comments 0 reactions 1 assignee View on GitHub

@a-b is already working on this.

Since Oct 3, 2024.

enhancement unscheduled v7
Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

What's the user value of this feature request?

One of the first commands that operators and developers look to get a summary of the details of an app is the cf app. As such this command has become the quick stop quick details of an app. This command is especially crucial to SRE and support engineers to get a quick glance of the details of the apps in downtime and provide quick details.

My request is that it would be really great if the command would also provide the list service-instances that the app is bound to.

During downtimes and firefights, it becomes very necessary to get such details as quick as possible.

Current methods include:

  • cf env: Too verbose for quick glances
  • cf services | grep app-name: Not the most intuitive approach when a simple command should give it and time-consuming if there are a large number of services in a given space.
  • cf curl /v2/apps/:app_guid/service_bindings: again to verbose and wordy for quick glances

Who is the functionality for?

All users for the cf CLI especially operators/deployer of the app, SREs, Support Engineers etc who need to get a quick summary of everything related to the application.

How often will this functionality be used by the user?

Many a time, I've heard service engineers say if there was a one-stop to get this detail in a single go of the app summary. The cf app is one of the most common commands used for getting details of the app, (probably even the first command used) Whenever there is a need to know a summary of the deployed application.

How often will they use this feature?

Quite often, Whenever there is a need to know a summary of the deployed application

Who else is affected by the change?

As the output is not JSON and designed to be Human/Reader-friendly, no it should not break anything. Code implementation when the app calls v2/v3 APIs will need be checked..

Is your feature request related to a problem? Please describe.

Whenever I need to quickly get a glance of services bound to an app I have to always go through the cf env or go to the application's manifest to see bound app or list

or grep through cf service and then skim through.

Describe the solution you'd like
This is a small addition to the existing set of info. It would be much better if just like how running instances are provided with the list of bound service instances and type are listed.

since an API is already available it just needs to be added to the cli call

Describe alternatives you've considered
As of now, the alternatives are the said steps mentioned above

Additional context
Possible Hiccup....V3compatibility
Anyhow, I would love to work on this provide a PR if it seems to be a worthy add on :)

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.