Clarification and plugin-inclusion #12
Conversation
joergdw
changed the title
joergdw
changed the title
…com/cloudfoundry/app-autoscaler-cli-plugin> with slight modifications.
| “Application Autoscaler” offers a plug-in for the “Cloud Foundry CLI”. With it users can attach or detach scaling-policies to their apps. They can view them and view the scaling-history. And they can view the metrics send by their apps. | ||
|
|
||
| This is useful to get some insights on how currently applied scaling-policies work and if changes are reasonable. It is as well useful for debugging. A common case is, when [custom-metrics](<../defining-a-custom-metric-87e657e.md>) are introduced to scale an app and the developers want to check, if the send metrics are correctly processed by Autoscaler and why up-/down-scaling happens or does not happen. | ||
|
|
There was a problem hiding this comment.
It's very helpful to mention the autosclaer cf cli plugin in the documentation! that's definitely an improvement. from my point of view, we shouldn't repeat ourself by copying the complete content of https://github.com/cloudfoundry/app-autoscaler-cli-plugin/blob/main/README.md into the help.sap.scom-documentation one more time. from my point of view, linking to it is enough 👍
There was a problem hiding this comment.
My impression is, that our content was intended to be self-contained, so that you don't need to leave our help-page. The other approach would be to just transfer the good content of our help-page to the repository “app-autoscaler-release”. Then we consume everything from there. Using GitHub's “permalinks” makes it possible for us, to still be consistent and history-safe when we change the upstream-repository.
@silvestre and perhaps @sapsy, what do you think?
docs/cf-cli-plugin.md
Outdated
| @@ -0,0 +1,210 @@ | |||
| # Plug-in for the “Cloud Foundry CLI” | |||
| “Application Autoscaler” offers a plug-in for the “Cloud Foundry CLI”. With it users can attach or detach scaling-policies to their apps. They can view them and view the scaling-history. And they can view the metrics send by their apps. | |||
There was a problem hiding this comment.
Also thank you for using the correct name "Application Autoscaler" here!
I think further down there's quite a few mentions of "AutoScaler". Can we replace them with the correct (for SAP) name, "Application Autoscaler" as well?
There was a problem hiding this comment.
Sometimes it is what the cli responds, e.g.:
$ cf asa 'https://autoscaler.cf.stagingaws.hanavlab.ondemand.com'
Setting AutoScaler api endpoint to https://autoscaler.cf.stagingaws.hanavlab.ondemand.com...
OK
In those cases I would not diverge from the output of the cli. In all other I'll fix it.
There was a problem hiding this comment.
Of course, we can as well change now that output of the cli. What do you think? @silvestre
There was a problem hiding this comment.
Btw. I have set a non-breaking whitespace in Application Autoscaler for better readability because then both words will be enforced to stay at the same line. (Personally I prefer the more visible Application-Autoscaler which also shows to humans that it belongs together, but I don't want to touch that here.)
joergdw
force-pushed
the
clarification_and_plugin
branch
from
12b17ba to
c0eb6f6
Compare
This PR adds two points: