Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify description for cf restart-app-instance command #3059

Closed
tcdowney opened this issue Jul 29, 2024 · 2 comments
Closed

Clarify description for cf restart-app-instance command #3059

tcdowney opened this issue Jul 29, 2024 · 2 comments

Comments

@tcdowney
Copy link
Member

tcdowney commented Jul 29, 2024

What's the user value of this feature request?
The current description for the restart-app-instance command is confusing. Unlike the regular cf restart command, this command does not update the app environment (environment variables, service bindings, app renaming, etc.) for the instance.

Current help text:

cf restart-app-instance -h
NAME:
   restart-app-instance - Terminate, then instantiate an app instance

USAGE:
   cf restart-app-instance APP_NAME INDEX [--process PROCESS]

OPTIONS:
   --process      Process to restart (Default: web)

Who is the functionality for?
App developers / app operators.

How often will this functionality be used by the user?
Whenever they wish to learn more about cf restart-app-instance.

Who else is affected by the change?
No one, it merely clarifies existing behavior.

Is your feature request related to a problem? Please describe.
Users run cf restart-app-instance and expect it to behave like cf restart. When it doesn't they are surprised and confused.

Describe the solution you'd like
Update the description to the command to something like:

Stop, then start application instance without updating application environment

(thanks @Benjamintf1 for talking through suggestions with me)

Example new help text:

cf restart-app-instance -h
NAME:
   restart-app-instance - Stop, then start application instance without updating application environment

USAGE:
   cf restart-app-instance APP_NAME INDEX [--process PROCESS]

OPTIONS:
   --process      Process to restart (Default: web)

Additional context
Under the hood Cloud Controller calls the RetireActualLRP endpoint on BBS.

// Shuts down the ActualLRP matching the given ActualLRPKey, but does not modify the desired state
	RetireActualLRP(logger lager.Logger, traceID [string](https://pkg.go.dev/builtin#string), key *[models](https://pkg.go.dev/code.cloudfoundry.org/bbs/models).[ActualLRPKey](https://pkg.go.dev/code.cloudfoundry.org/bbs/models#ActualLRPKey)) [error](https://pkg.go.dev/builtin#error)
@gururajsh
Copy link
Member

Hi @tcdowney ,

I have added this issue to our tracker and will let you know when it's complete.

@gururajsh
Copy link
Member

PRs are in. This change should be available with next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants