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: Ambassador REST endpoint path #688

Closed
masonlr opened this issue Jul 14, 2019 · 1 comment · Fixed by #779
Closed

docs: Ambassador REST endpoint path #688

masonlr opened this issue Jul 14, 2019 · 1 comment · Fixed by #779
Assignees
Projects

Comments

@masonlr
Copy link
Contributor

masonlr commented Jul 14, 2019

Should the Ambassador REST endpoint docs mention the namespace in which a model is deployed, or am I missing something here?

To reproduce:

The Ambassador REST docs at https://docs.seldon.io/projects/seldon-core/en/v0.3.1/workflow/serving.html state:

A REST endpoint will be exposed at : http://<ambassadorEndpoint>/seldon/<deploymentName>/api/v0.1/predictions

If, as an example, I deploy a model on minikube following https://github.com/SeldonIO/seldon-core/blob/v0.3.1/examples/models/mlflow_model/mlflow.ipynb and port-forward using

kubectl port-forward $(kubectl get pods -l app.kubernetes.io/name=ambassador -o jsonpath='{.items[0].metadata.name}')  8003:8080

then the namespace seems to be needed in the REST endpoint path: i.e. predictions are accessible via

curl -v 0.0.0.0:8003/seldon/default/mlflow-example/api/v0.1/predictions -d '{"data": {"ndarray": [[12.8, 0.029, 0.48, 0.98, 6.2, 29, 3.33, 1.2, 0.39, 75, 0.66]]}}'  -H "Content-Type: application/json"

If I deploy the same mlflow-example model into a "seldon" namespace (loosely following https://github.com/SeldonIO/seldon-core/blob/v0.3.1/notebooks/helm_examples.ipynb), then the model predictions are accessible via

curl -v 0.0.0.0:8003/seldon/seldon/mlflow-example/api/v0.1/predictions -d '{"data": {"ndarray": [[12.8, 0.029, 0.48, 0.98, 6.2, 29, 3.33, 1.2, 0.39, 75, 0.66]]}}'  -H "Content-Type: application/json"

Both of these have a namespace in the path? If the above is correct/intended, then a change like the following would be clearer for new users:

A REST endpoint will be exposed at : http://<ambassadorEndpoint>/seldon/<deploymentNamespace>/<deploymentName>/api/v0.1/predictions

@ukclivecox
Copy link
Contributor

Yes you are correct. We had both before but as the operator is clusterwide by default at present then the namespace is needed to ensure no clashes. We should update the docs.

@ukclivecox ukclivecox added this to To do in 0.4.0 via automation Jul 14, 2019
@ukclivecox ukclivecox self-assigned this Jul 14, 2019
@ukclivecox ukclivecox moved this from To do to In progress in 0.4.0 Aug 9, 2019
0.4.0 automation moved this from In progress to Done Aug 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
0.4.0
  
Done
Development

Successfully merging a pull request may close this issue.

2 participants