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

Add some clarification to the section Deploy Chaos Toolkit as a Kubernetes Operator #87

Open
gtfisher opened this issue Apr 6, 2020 · 2 comments

Comments

@gtfisher
Copy link

gtfisher commented Apr 6, 2020

Under https://docs.chaostoolkit.org/deployment/k8s/operator/#deploy-the-operator

Should there be a note before: "Next, simply run the following:" explaining you will need to be connected to a cluster prior to running the kustomize command. and perhaps a link to https://cloud.google.com/kubernetes-engine/docs/quickstart#create_cluster

After the section: "Look at the Chaos Toolkit running:" - should we add a not about viewing the logs:

kubectl -n chaostoolkit-run logs chaostoolkit-<pod-id>

After "They will be injected into the Chaos Toolkit’s pod as environment variables."
Add a link to the example showing the use of environment variables.

After the code section of "configMapName", add a link to the example using the config map.

At the end of "https://docs.chaostoolkit.org/deployment/k8s/operator/#load-the-experiment-from-a-url" add a link to the example that run's from a URL.

@dmartin35
Copy link
Collaborator

  • deploy:
    We could add a note to say, you need to have access to your kubernetes cluster with Kubectl .
    pointing to the official Kubernetes doc https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/
    but definitely not the google one. Not every one is using google.

  • ctk logs
    you can add a note to view logs:

    • logs for a single pod
      kubectl -n chaostoolkit-run logs chaostoolkit-
      (please note, the pod id is the entire chaostoolkit-<suffix> not the part after the dash (as you wrote in your example; this is an internally generated suffix used to create a unique pod ID)
    • logs for all ctk pods
      kubectl -n chaostoolkit-run logs -l app=chaostoolkit
  • for links to examples, please add them at the end of the section, not in the middle. A section might have several snippets that have to be described before showing the full manifest.
    You can add something line : you can refer to a full example ...

A final comment, bear in mind that users must have basic knowledge of Kubernetes, they shall be familiar at least with the basic commands.
For your examples, please keep them a precise as possible for the intended thing to explain, not to mix two features in one example.
We could also have other more complexion

@Lawouach
Copy link
Contributor

Lawouach commented Jun 4, 2020

Hey folks, is this still relevant?

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

No branches or pull requests

3 participants