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

Docs reference a binary, but instruct helm installation #160

Open
solarmosaic-kflorence opened this issue Nov 27, 2019 · 3 comments
Open

Comments

@solarmosaic-kflorence
Copy link

Hey, thanks for this useful tool. The documentation has me confused, as it instructs installation via a helm deployment (which is cool), but 90% of the documentation references a binary (chaoskube) but there isn't any documentation on how to get access to that binary. Am I supposed to clone repository this and put something in my PATH? Am I expected to create a local binary which runs this tool through docker?

@linki
Copy link
Owner

linki commented Nov 27, 2019

Hi @solarmosaic-kflorence,

you're right, that must be confusing. Indeed, when mentioning chaoskube like that it means "any binary however you obtain it" which is not very nice.

At the moment this repository doesn't provide any pre-built binaries so you have to build it yourself by cloning and then doing a go install or go run main.go.

As this project is mainly intended to run inside your Kubernetes cluster as a container there is an up-to-date docker image that you can use at quay.io/linki/chaoskube.

Normally, any arguments you see passed to chaoskube, e.g. in the README or in the helm chart's docs, you can also just pass to docker run quay.io/linki/chaoskube or define them in your Kubernetes manifest under the args section.

Let me know if that helps you.

PS: I was thinking about uploading pre-built binaries here but then didn't bother because I thought most people would prefer the docker image in their cluster.

@solarmosaic-kflorence
Copy link
Author

solarmosaic-kflorence commented Nov 27, 2019

@linki thanks for the quick reply, I think perhaps just some extra context in the README would suffice -- i wasn't sure in which context the binary was being used. I think it is useful to use the binary locally for testing, in a remote environment it seems better to just use the helm deployment or the docker image.

PS: I settled on docker run quay.io/linki/chaoskube for local execution since it seemed the easiest re-produceable way to execute commands in my testing scripts.

@dhpizza
Copy link

dhpizza commented Dec 2, 2019

Hi,
had the same question, thanks for the info 👍
When doing a go install though a lot of additional packages are needed.
Running a go get ... for each of the needed packages helped. In case somebody comes across that issue as well...

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

No branches or pull requests

3 participants