add info on scaling logic to typha overview #1360
Conversation
This information wasn't readily available anywhere in the docs that i could find, so I wanted to make it easier to find for users.
|
|
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@tigera/docs |
didn't intend for that to be a header
formatting got screwed up somehow when i removed the header
|
Looks good. I had a conversation with the other maintainers about whether we should document this implementation detail or not. Its a balance. The conclusion was that this table is fine, but it would be good to add a caveat that "we may change the algorithm as needs evolve". For example, at high scale we might reduce the number of typhas in future. |
|
Also, once we're happy with the text, we should copy it into |
|
I've added a link to the preview page so you can see your change as it will appear on the website. |
Just noting that it could change in the future.
added so that it will go into the next version of the docs as well.
|
Thanks for the feedback. I've added a note about potential for change and added the update to the |
| @@ -16,3 +16,31 @@ If you are using the Kubernetes API Datastore, we recommend using Typha. Althoug | |||
|
|
|||
| - Since one Typha instance can support hundreds of Felix instances, it reduces the load on the datastore by a large factor. | |||
| - Since Typha can filter out updates that are not relevant to Felix, it also reduces Felix's CPU usage. In a high-scale (100+ node) Kubernetes cluster, this is essential because the number of updates generated by the API server scales with the number of nodes. | |||
|
|
|||
| ## Operator Scaling Logic | |||
There was a problem hiding this comment.
| ## Operator Scaling Logic | |
| ## Operator scaling logic |
We use sentence case for headings.
|
|
||
| ## Operator Scaling Logic | ||
|
|
||
| If you're using the Operator installation, then the operator will automatically scales Typha pods for optimal performance. |
There was a problem hiding this comment.
| If you're using the Operator installation, then the operator will automatically scales Typha pods for optimal performance. | |
| If you installed {{prodname}} using the operator, then the operator will automatically scale Typha pods to optimize performance. |
|
|
||
| If you're using the Operator installation, then the operator will automatically scales Typha pods for optimal performance. | ||
|
|
||
| - Small Cluster Considerations: Special handling is in place for clusters with fewer than five nodes. |
There was a problem hiding this comment.
- It's not clear what this special handling is.
- Whatever it is, we can keep the explanation as a regular sentence in the same paragraph as the previous sentence. For example, "For clusters with fewer than five nodes, we do things like this."
- If the special handling is merely what's described in the table, let's just let the table do the work. We can strike out this line.
|
|
||
| - Small Cluster Considerations: Special handling is in place for clusters with fewer than five nodes. | ||
|
|
||
| Here's the scaling logic it uses: |
There was a problem hiding this comment.
Remove. The table explains itself.
| :::note | ||
|
|
||
| This algorithm may change as needs evolve. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
On second thought, let's remove this too. The same applies to pretty much everything in the docs. If we make a change, that should be documented just like any other change.
This information wasn't readily available anywhere in the docs that i could find, so I wanted to make it easier to find for users.
Product Version(s): 3.27
Issue: No issue on this that i'm aware of
Link to docs preview:
Sorry, I don't know how to find this.https://deploy-preview-1360--tigera.netlify.app/calico/latest/reference/typha/overview
SME review:
DOCS review:
Additional information:
Merge checklist: