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

Document/configuration for resources in core #1208

Open
mjnagel opened this issue Jan 17, 2025 · 3 comments
Open

Document/configuration for resources in core #1208

mjnagel opened this issue Jan 17, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@mjnagel
Copy link
Contributor

mjnagel commented Jan 17, 2025

Affected Documentation Section

Currently we have a prerequisites documentation page that mainly focuses on OS/cluster pre-configuration.

Update Details

It would be helpful to provide a document on resource requirement/prerequisites either as part of or in addition to the existing prereq doc. Scope of this should be:

  • Default resource needs of core: focus on CPU, memory, and storage/PVCs; consider daemonsets that scale based on nodes
  • Relevant overrides to scale back resource usage on applications: This may be a heavy lift but would provide value to end users trying to reduce resource usage
  • (possibly a follow on) Resource usage based on user counts of applications: This is tricky to capture since core does not provide any "tenant" apps by default

Why Is This Update Needed?

We frequently get questions about core's resource needs and how small it can go/how many users it can support. Providing these docs would help end users to understand core's needs better.

Additional Context (Optional)

It would be beneficially to provide recommended cluster sizes (possibly based on AWS instance types even). This could be done as a follow-on to this initial work for documenting defaults/overrides.

@mjnagel mjnagel added the documentation Improvements or additions to documentation label Jan 17, 2025
@UnicornChance
Copy link
Contributor

Definitely a bit of work involved in this, i'd vote for decomposing into a couple issues (possibly each bullet needs its own issue?). Do we need any documentation for machine requirements for testing / developing locally (not totally sure this would be necessary)?

@mjnagel
Copy link
Contributor Author

mjnagel commented Jan 17, 2025

@UnicornChance yeah I think I agree. On the local dev/test requirements we actually have some basic stuff documented here which I think currently might be more confusing since it's only for dev/demo, but possibly satisfies that need to some extent.

@noahpb
Copy link
Contributor

noahpb commented Jan 17, 2025

We should also consider profiling/benchmarking the UDS Operator as well.

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

No branches or pull requests

3 participants