hyperhq / hyperd

HyperContainer Daemon
http://www.hypercontainer.io
Apache License 2.0
1.98k stars 196 forks source link

A mistake in online doc #714

Open preytaren opened 6 years ago

preytaren commented 6 years ago

When I tried the API for creating a container, it says that the request body is a json string represents a container. And there is a link to the Container Spec page, the specification of container is a list of containers, like below: "containers" : [{...}, ... {...}] But actually, the request body should be just one container, drop the outer brackets, like { "id": "app", "image": "repo/image:tag", "command": ["/bin/sh"], "workdir": "/root", "envs": [{ "env": "JAVA_OPT", "value": "-XMx=256m" }], "volumes": [{ "path": "/var/log", "volume": "name", "readOnly": false, "detail": {
"name": "prod_log", "source": "/var/log/myweb.img", "format": "raw" } }], "files": [{ "path": "/var/lib/xxx/xxxx", "filename": "name", "perm": "0755", "detail": { "name": "nginx.conf", "encoding": "raw", "uri": "https://s3.amazonaws/bucket/file.conf", "content": "" } }], "tty": true }

vbmade2000 commented 6 years ago

@preytaren Can you point to that part of doc ?

preytaren commented 6 years ago

@vbmade2000 example part on the container spec page, https://docs.hypercontainer.io/reference/containers.html