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

[CLI] output manifests instead of applying them directly #2559

Closed
adnanrahic opened this issue May 22, 2023 · 6 comments
Closed

[CLI] output manifests instead of applying them directly #2559

adnanrahic opened this issue May 22, 2023 · 6 comments
Labels

Comments

@adnanrahic
Copy link
Contributor

Is your feature request related to a problem? Please describe.
From what I saw, tracetest server install does not have the option to output manifests instead of applying them directly, hence I cannot store them in Git and apply them with ArgoCD or Flux. Alternatively, it would be OK to use a Helm chart if there is one. https://docs.tracetest.io/deployment/kubernetes does not mention any alternatives to tracetest server install.
From Discord.

Describe the solution you'd like
Have a dry run command option. Or something better?

Describe alternatives you've considered
Use Helm charts from GitHub, here: https://github.com/kubeshop/helm-charts/tree/develop/charts/tracetest

helm repo add kubeshop https://kubeshop.github.io/helm-charts
helm repo update
helm install tracetest kubeshop/tracetest

Additional context
Question opened by Viktor Farcic in Discord, here.

@adnanrahic
Copy link
Contributor Author

I think we have 2 options:

  1. Add detailed docs about the Helm charts here: https://docs.tracetest.io/deployment/kubernetes — they should explain how to use Helm to generate manifest files, do dry runs, and deploy the chart to a running cluster.
  2. Add a feature in the CLI to generate files into a directory instead of applying them to a cluster right away. — Then add these instructions to https://docs.tracetest.io/deployment/kubernetes

What do you think?

@danielbdias
Copy link
Contributor

I believe that we can follow the first option.

When a user wants to use the helm chart directly, it is because they have a specific need on their infra (like for instance, configuring Flux to read helm charts and auto-update a deployment), and it usually is difficult to map on our CLI.

Does it make sense? What do you think, @mathnogueira and @schoren?

@adnanrahic
Copy link
Contributor Author

I think we should also re-write this page https://docs.tracetest.io/getting-started/detailed-installation to include both using the CLI and the Helm charts. This page can be shorter and more concise than the full explanation on this page https://docs.tracetest.io/deployment/kubernetes.

WDYT @danielbdias ?

@adnanrahic
Copy link
Contributor Author

Update: Helm docs were added in #2562 .
https://docs.tracetest.io/deployment/kubernetes

We're still considering updating the https://docs.tracetest.io/getting-started/detailed-installation page as well.

@adnanrahic
Copy link
Contributor Author

adnanrahic commented May 23, 2023

@adnanrahic
Copy link
Contributor Author

To summarize, we've updated two pages with more detailed instructions and added Helm instructions.

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

No branches or pull requests

2 participants