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

Reduce repo complexity and consolidate specs #58

Closed
2 of 4 tasks
diamonwiggins opened this issue Mar 10, 2023 · 2 comments · Fixed by #63
Closed
2 of 4 tasks

Reduce repo complexity and consolidate specs #58

diamonwiggins opened this issue Mar 10, 2023 · 2 comments · Fixed by #63

Comments

@diamonwiggins
Copy link
Member

diamonwiggins commented Mar 10, 2023

Currently, we have many different specs and it's not clear which you should provide when a user needs to generate a support bundles. We should consolidate any specs that don't need to be separate, create a directory structure to further organize any one-of specs, and maintain a default.yaml or all.yaml that is an aggregate of all specs in the respective host and in-cluster directories. New directory structure could look similiar to:

host/
  networking/
  resource-contention/
  default.yaml
in-cluster/
  kurl/
  other/
  default.yaml
  • Remove any unneeded specs
  • Consolidate any specs that don't need to be separate into default.yaml
  • Maintain a Makefile which has a make generate-cluster-specs/make generate-host-specs or something similar that's required to be run before a PR can be merged
  • Update the DNS address for https://support-bundle.replicated.com to point to the raw result of in-cluster/default.yaml
@banjoh
Copy link
Member

banjoh commented Jun 8, 2023

I think we can serve both in-cluster and host default specs using https://support-bundle.replicated.com?spec=in-cluster or https://support-bundle.replicated.com/in-cluster. I prefer the latter cause of ease of caching

@xavpaice
Copy link
Member

Currently https://support-bundle.replicated.com redirects to https://raw.githubusercontent.com/replicatedhq/troubleshoot/master/examples/support-bundle/sample-supportbundle.yaml which is a placeholder example with little use to anyone other than to help write a real spec.

Outstanding for this issue:

I've created separate issues for the remaining items since they do appear to be separate to the main event for this issue, and will close this one now.

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

Successfully merging a pull request may close this issue.

3 participants