search

CiscoCloud / mantl-api

Mantl API
Apache License 2.0
17 stars 12 forks source link

readme: make curl commands consistent #28

Closed ryane closed 8 years ago

langston-barrett commented 8 years ago

Maybe we should also have a note explaining that you can use mantl-api on a worker node? I don't know that I would assume that if all the examples are control nodes.

ryane commented 8 years ago

It actually always runs on a worker node (assuming it's deployed via marathon). But, on Mantl clusters, it is automatically proxied via nginx running on control nodes (along with our other control software and UIs). If you wanted to, though, you could always discover the worker node, ip, and host that is running on via Marathon and make api requests directly (assuming the port is accessible).

Maybe I'll add some text that explains how it is deployed and wired up on Mantl clusters (the fact that it's automatically accessible on control nodes). Would that help?

langston-barrett commented 8 years ago

I think that'd be great! I like that most of the documentation is mantl-agnostic, but I think it might be useful for people who are running this on top of mantl to have a deeper understanding of how it works.

ryane commented 8 years ago

@siddharthist updated, let me know if this is more clear

langston-barrett commented 8 years ago

Very clear :) LGTM!