Skip to content

Commit

Permalink
Added information about Docker Hub repo. Rearranged instructions re i…
Browse files Browse the repository at this point in the history
…nstallation from PyPI
  • Loading branch information
alattner committed Apr 28, 2015
1 parent 5399536 commit 09ba3ec
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 15 deletions.
24 changes: 16 additions & 8 deletions docs/user/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ Building the Palladium base image

Here's instructions on how to build the Palladium base image. This
isn't usually necessary, as you'll probably want to just use the
released base images for Palladium and add your application on top,
see `Building a Palladium app image`_.
`released base images
<https://registry.hub.docker.com/u/ottogroup/palladium-base/>`_ for
Palladium and add your application on top, see `Building a Palladium
app image`_.

A ``Dockerfile`` is available in the directory
``addons/docker/palladium_base_image`` for building a base image. You
Expand All @@ -136,7 +138,13 @@ Building a Palladium app image
------------------------------

Palladium has support for quickly building a Docker image to run your
own application based on the Palladium base image.
own application based on the Palladium base image. The Palladium base
image can be pulled from Docker Hub as follows:

.. code-block:: bash
docker pull ottogroup/palladium-base
As an example, let's build a Docker image for the Iris example that's
included in the source. We'll use the Palladium base image for
Expand Down Expand Up @@ -178,9 +186,9 @@ To test your image you can:

1) Create app images using ``pld-dockerize`` as shown above.

2) Run the "predict" image (e.g. ``my-palladium-app-predict`` if you
2) Run the "predict" image (e.g., ``my-palladium-app-predict`` if you
used ``my-palladium-app`` to create the image), and map the Docker
container's port 8000 to a local port (e.g. 8001)::
container's port 8000 to a local port (e.g., 8001)::

sudo docker run -d -p 8001:8000 my-palladium-app-predict

Expand Down Expand Up @@ -218,7 +226,7 @@ like this:
"id": "<app_name>",
"container": {
"docker": {
"image": "<owner/palladium_app_name:version>",
"image": "<owner/palladium-app-name:version>",
"network": "BRIDGE",
"parameters": [
{"key": "link", "value":"<some_container_to_link>"}
Expand Down Expand Up @@ -258,15 +266,15 @@ like this:
You have to replace the Docker image name, port number (currently set
to 8000) and - if there is any dependency - specify links to other
containers. If you have a Docker image of the Iris service available
(named `user/palladium-iris_predict:0.1`), you can use this file:
(named `user/palladium-iris-predict:0.1`), you can use this file:

.. code-block:: json
{
"id": "palladium-iris",
"container": {
"docker": {
"image": "user/palladium-iris_predict:0.1",
"image": "user/palladium-iris-predict:0.1",
"network": "BRIDGE",
"parameters": [
],
Expand Down
19 changes: 12 additions & 7 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,22 @@ following commands assume that you have your environment active.
Install from PyPI
=================

Simply run:
It is a good practice to install dependencies with exactly the same
version numbers that the release was made with. You can find the
``requirements.txt`` that defines those version numbers in the top
level directory of Palladium's source tree or can download it here:
:download:`requirements.txt <../../requirements.txt>`. You can
install the dependencies with the following command:

.. code-block:: bash
pip install palladium
pip install -r requirements.txt
It's also a good practice to install dependencies with exactly the
same version numbers that the release was made with. You can find the
``requirements.txt`` that defines those version numbers in the top
level directory of Palladium's source tree or download it here:
:download:`requirements.txt <../../requirements.txt>`.
In order to install Palladium from PyPI, simply run:

.. code-block:: bash
pip install palladium
Install from binstar
====================
Expand Down

0 comments on commit 09ba3ec

Please sign in to comment.