dmartin35
commented
4 years ago -
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
- logs for a single pod
kubectl -n chaostoolkit-run logs 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
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
kustomizecommand. and perhaps a link to https://cloud.google.com/kubernetes-engine/docs/quickstart#create_clusterAfter the section: "Look at the Chaos Toolkit running:" - should we add a not about viewing the logs:
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.