Improvements and structure changes for autoscaling docs #2439

abrennan89 · 2020-05-07T19:36:28Z

Proposed Changes

Split autoscaling into its own sub directory and smaller topics, to make the content easier to consume.
General content editing.

docs/serving/autoscaling/autoscaling.md

abrennan89 · 2020-05-08T14:45:49Z

/retest

mattmoor · 2020-05-08T14:53:44Z

/approve
/hold

If you git commit --amend and force push, it will stage the docs for you now :D

docs/serving/autoscaling/README.md

docs/serving/autoscaling/supported-autoscaler-types.md

docs/serving/autoscaling/target-burst-capacity.md

docs/serving/autoscaling/concurrency.md

docs/serving/autoscaling/target-burst-capacity.md

markusthoemmes

I'm no expert but I'm wondering if making the users click more to get to the respective chapters is doing more harm than it does good. I personally like docs like these, which are mostly setting centered, to be on a single page so I can CTRL-F search for what I need.

docs/serving/autoscaling/README.md

docs/serving/autoscaling/concurrency.md

docs/serving/autoscaling/autoscaling-metrics.md

docs/serving/autoscaling/README.md

docs/serving/autoscaling/autoscaling-metrics.md

docs/serving/autoscaling/target-burst-capacity.md

abrennan89 · 2020-05-12T13:30:02Z

I'm no expert but I'm wondering if making the users click more to get to the respective chapters is doing more harm than it does good. I personally like docs like these, which are mostly setting centered, to be on a single page so I can CTRL-F search for what I need.

The idea is that each section should have a topic that's a self-explanatory user story, i.e. a user looking for how to configure a certain thing will go to the section for that thing, rather than needing to search through a lengthy page/doc to find it.
It also IMHO makes documentation a lot easier to maintain.

vagababov

It also seems to miss the parameters I've added (activator-capacty and scale to zero pod retention), so we might need to reconcile with the head.

vagababov · 2020-05-28T17:13:58Z

docs/serving/autoscaling/autoscaling-concepts.md

+{{< /tab >}}
+{{< /tabs >}}
+
+## Global versus per-revision settings


This should probably go above the class, since it affects the choices made there as well.

I think this fits here as well -- it provides more detail, but if users are happy with the first choice they found, it should work.

I think this is why we need to be able to reuse / include content - so we can have a blurb about something in more than one place in the docs but maintain it from one file.

docs/serving/autoscaling/autoscaling-concepts.md

docs/serving/autoscaling/target-burst-capacity.md

evankanderson

A few minor bits, but this looks pretty good right now.

I'm going to:

/hold cancel

But I'm going to wait on the LGTM until you get a chance to comment on at least the sample/alias question.

evankanderson · 2020-05-28T21:37:10Z

docs/serving/autoscaling/README.md

+* Disable scale to zero functionality for your cluster ([global configuration only](./scale-to-zero.md)).
+* Configure the [type of metrics](./autoscaling-metrics.md) your Autoscaler consumes.
+* Configure [concurrency limits](./concurrency.md) for applications.
+* Try out the [Go Autoscale Sample App](./autoscale-go/README.md).


Do you see doing a similar move for other samples in the future (e.g. traffic splitting samples into the networking subsection)?

Yep, I'd like to do this with all of them, it just makes more sense to me as a place where someone would look for it. WDYT?

I don't think we've discussed it; I don't have an intrinsic problem with it, but it would be good to have a documented strategy.

docs/serving/autoscaling/autoscale-go/index.md

evankanderson · 2020-05-28T21:40:06Z

docs/serving/autoscaling/autoscaling-concepts.md

+{{< /tab >}}
+{{< /tabs >}}
+
+## Global versus per-revision settings


I think this fits here as well -- it provides more detail, but if users are happy with the first choice they found, it should work.

docs/serving/autoscaling/autoscaling-concepts.md

evankanderson · 2020-05-28T21:41:53Z

docs/serving/autoscaling/autoscaling-concepts.md

+
+### Per-revision settings
+
+Per-revision settings for autoscaling are configured by adding _annotations_ to a revision.


Are the annotation keys the same ones as are present in the ConfigMap?

Nope, they're different afaik, it's explained in the section for each key.

evankanderson · 2020-05-28T21:43:43Z

docs/serving/autoscaling/autoscaling-metrics.md

+The possible metric types that can be configured per revision depend on the type of Autoscaler implementation you are using:
+
+* The default KPA Autoscaler supports the `concurrency` and `rps` metrics.
+* The HPA Autoscaler supports the `concurrency`, `rps` and `cpu` metrics.


Can you describe what these options mean?

In particular, how concurrency and RPS differ.

Feel free to defer with a  if you don't have bandwidth right now.

Added a TODO note :) I think I had pretty much the same note previously and removed it because I knew I wouldn't get to it 😂

A TODO lets someone else pick up the item if you don't get back to it. 😁

docs/serving/autoscaling/autoscaling-targets.md

evankanderson · 2020-05-28T21:46:04Z

docs/serving/autoscaling/concurrency.md

+---
+
+Concurrency determines the number of simultaneous requests that can be processed by each replica of an application at any given time.
+<!-- this is where including files would be useful. We could create a concurrency global config module and insert it here, in the docs for metrics, and in the docs for targets. Showing the correct information each time instead of having it in one place with the per revision config jumbled in with it makes it easier to understand IMHO, and would mean users don't need to visit different pages or hunt for the same information for similar user stories @abrennan89.-->


Reference an issue in the website repo if this isn't working and you want it to?

I'll come back to it when I have more time :)

docs/serving/autoscaling/concurrency.md

docs/serving/autoscaling/_index.md

docs/serving/autoscaling/autoscale-go/index.md

evankanderson

One more alias that needs updating!

Sorry for the delay on re-reviewing.

docs/serving/autoscaling/_index.md

abrennan89 · 2020-06-04T18:13:19Z

No problem, thanks for looking at this @evankanderson - should be finally ready now 😂

evankanderson · 2020-06-04T18:20:13Z

BTW, you don't need to squash your changes to the docs repo; Tide will do a squash merge automatically when it merges, so each PR becomes one commit. Leaving the commits un-squashed during review makes it easier to see what's changed since the last commit. (But I'll run through this one and approve in a moment.)

evankanderson

/lgtm
/approve

knative-prow-robot · 2020-06-04T18:22:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, evankanderson, mattmoor

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [evankanderson,mattmoor]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Auto TLS verification used the `autoscale-go` sample, but it was moved in #2439, and not updated here.

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 7, 2020

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label May 7, 2020

knative-prow-robot requested review from markusthoemmes and vagababov May 7, 2020 19:36

knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 7, 2020

mattmoor reviewed May 7, 2020

View reviewed changes

docs/serving/autoscaling/autoscaling.md Outdated Show resolved Hide resolved

knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 7, 2020

abrennan89 commented May 7, 2020

View reviewed changes

docs/serving/autoscaling/autoscaling.md Outdated Show resolved Hide resolved

knative-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels May 8, 2020

abrennan89 force-pushed the autoscaling branch from 4558679 to 277f7c5 Compare May 8, 2020 13:22

knative-prow-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved labels May 8, 2020

abrennan89 force-pushed the autoscaling branch 4 times, most recently from 485c78f to e4feac1 Compare May 8, 2020 15:42

abrennan89 commented May 11, 2020

View reviewed changes

docs/serving/autoscaling/README.md Outdated Show resolved Hide resolved

abrennan89 commented May 11, 2020

View reviewed changes

docs/serving/autoscaling/supported-autoscaler-types.md Outdated Show resolved Hide resolved

abrennan89 commented May 11, 2020

View reviewed changes

docs/serving/autoscaling/target-burst-capacity.md Outdated Show resolved Hide resolved

abrennan89 commented May 11, 2020

View reviewed changes

docs/serving/autoscaling/concurrency.md Outdated Show resolved Hide resolved

vagababov reviewed May 12, 2020

View reviewed changes

docs/serving/autoscaling/target-burst-capacity.md Outdated Show resolved Hide resolved

docs/serving/autoscaling/target-burst-capacity.md Outdated Show resolved Hide resolved

docs/serving/autoscaling/target-burst-capacity.md Outdated Show resolved Hide resolved

markusthoemmes reviewed May 12, 2020

View reviewed changes

abrennan89 force-pushed the autoscaling branch from 47071f4 to f7e4757 Compare May 12, 2020 15:11

knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 14, 2020

abrennan89 force-pushed the autoscaling branch from f7e4757 to ea6b6ff Compare May 14, 2020 18:57

abrennan89 changed the title ~~[WIP] Improvements and structure changes for autoscaling docs~~ Improvements and structure changes for autoscaling docs May 21, 2020

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 21, 2020

abrennan89 mentioned this pull request May 21, 2020

Knative Samples: Add alternative version with using "kn" #2435

Closed

abrennan89 requested review from carieshmarie, markusthoemmes, mattmoor and vagababov May 22, 2020 16:42

abrennan89 mentioned this pull request May 27, 2020

Productionize and public target burst capacity document. #2375

Closed

vagababov reviewed May 28, 2020

View reviewed changes

evankanderson reviewed May 28, 2020

View reviewed changes

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 28, 2020

abrennan89 force-pushed the autoscaling branch from 6fe8f52 to c975e60 Compare May 29, 2020 17:38

abrennan89 requested a review from evankanderson May 29, 2020 17:39

evankanderson reviewed May 29, 2020

View reviewed changes

docs/serving/autoscaling/_index.md Outdated Show resolved Hide resolved

docs/serving/autoscaling/autoscale-go/index.md Outdated Show resolved Hide resolved

abrennan89 requested a review from evankanderson June 1, 2020 12:49

evankanderson reviewed Jun 4, 2020

View reviewed changes

docs/serving/autoscaling/_index.md Outdated Show resolved Hide resolved

abrennan89 force-pushed the autoscaling branch from 0c84555 to 86f8b22 Compare June 4, 2020 18:12

[WIP] Improvements and structure changes for autoscaling docs

c934ec7

abrennan89 force-pushed the autoscaling branch from 86f8b22 to c934ec7 Compare June 4, 2020 18:12

evankanderson reviewed Jun 4, 2020

View reviewed changes

knative-prow-robot assigned evankanderson Jun 4, 2020

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 4, 2020

knative-prow-robot merged commit b3ffdbf into knative:master Jun 4, 2020

abrennan89 linked an issue Jun 9, 2020 that may be closed by this pull request

Productionize and public target burst capacity document. #2375

Closed

zevisert mentioned this pull request Jun 19, 2020

Template for verifying AutoTLS was moved #2603

Merged

knative-prow-robot pushed a commit that referenced this pull request Jun 22, 2020

Template for verifying AutoTLS was moved (#2603)

42d6180

Auto TLS verification used the `autoscale-go` sample, but it was moved in #2439, and not updated here.

abrennan89 deleted the autoscaling branch May 3, 2021 16:46


		### Per-revision settings

		Per-revision settings for autoscaling are configured by adding _annotations_ to a revision.

Improvements and structure changes for autoscaling docs #2439

Improvements and structure changes for autoscaling docs #2439

Uh oh!

Conversation

abrennan89 commented May 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Uh oh!

Uh oh!

Uh oh!

abrennan89 commented May 8, 2020

Uh oh!

mattmoor commented May 8, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markusthoemmes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abrennan89 commented May 12, 2020

Uh oh!

vagababov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evankanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evankanderson left a comment

Choose a reason for hiding this comment

abrennan89 commented May 7, 2020 •

edited

Loading