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.

Sign up for GitHub

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

Jump to bottom

add info on scaling logic to typha overview #1360

Closed
wants to merge 5 commits into from
Closed

add info on scaling logic to typha overview #1360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ada404f
add info on scaling logic to typha overview
jgilfoil Mar 7, 2024
7b8c930
Remove extra header formatting
jgilfoil Mar 7, 2024
2d7d433
fix formating
jgilfoil Mar 7, 2024
675906a
add disclaimer about algorithm
jgilfoil Mar 8, 2024
644f71d
Add scaling notes to main calico overview
jgilfoil Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions calico/reference/typha/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Operator Scaling Logic
## Operator scaling logic

We use sentence case for headings.


If you're using the Operator installation, then the operator will automatically scales Typha pods for optimal performance.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.


- Small Cluster Considerations: Special handling is in place for clusters with fewer than five nodes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 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.


Here's the scaling logic it uses:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove. The table explains itself.


Typha Replicas per Node Count

| Nodes | Replicas |
| ---- | ---- |
| `1-2` | 1 |
| `3-4` | 2 |
| `<200` | 3 |
| `<400` | 4 |
| `<600` | 5 |
| `...` | |
| `<2000` | 12 |
| `...` | |
| `<3600` | 20 |

:::note

This algorithm may change as needs evolve.

:::
Comment on lines +42 to +46
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

28 changes: 28 additions & 0 deletions calico_versioned_docs/version-3.27/reference/typha/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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.

Here's the scaling logic it uses:

Typha Replicas per Node Count

| Nodes | Replicas |
| ---- | ---- |
| `1-2` | 1 |
| `3-4` | 2 |
| `<200` | 3 |
| `<400` | 4 |
| `<600` | 5 |
| `...` | |
| `<2000` | 12 |
| `...` | |
| `<3600` | 20 |

:::note

This algorithm may change as needs evolve.

:::
Loading