Merge pull request #3243 from jeff1evesque/feature-3242

#3242: Adjust 'README.md' regarding docker-compose

Author: jeff1evesque

README.md

@@ -34,8 +34,17 @@ Fork this project, using of the following methods:
 
 ## Installation
 
-To proceed with the installation for this project, both docker and rancher must be
-installed. Installing docker must be done manually, to fulfill a set of [dependencies](https://jeff1evesque.github.io/machine-learning.docs/latest/html/installation/dependencies.html).
+To proceed with the installation for this project, users will need to decide
+whether to use the rancher ecosystem, or use `docker-compose`. The former will
+likely be less reliable, since the corresponding install script, may not work
+nicely across different operating systems. Additionally, this project will
+assume rancher as the primary method to deploy, and run the application. So,
+when using the `docker-compose` alternate, keep track what the corresponding
+[endpoints](https://github.com/jeff1evesque/machine-learning/blob/master/README.md#execution)
+should be.
+
+If users choose rancher, both docker and rancher must be installed.
+Installing docker must be done manually, to fulfill a set of [dependencies](https://jeff1evesque.github.io/machine-learning.docs/latest/html/installation/dependencies.html).
 Once completed, rancher can be installed, and automatically configured, by simply
 executing a provided bash script, from the docker quickstart terminal:
 
@@ -47,11 +56,28 @@ cd /path/to/machine-learning
 **Note:** the installation, and the configuration of rancher, has been [outlined](https://jeff1evesque.github.io/machine-learning.docs/latest/html/installation/rancher.html)
 if more explicit instructions are needed.
 
+If users choose to forgo rancher, and use the `docker-compose`, then simply
+install `docker`, as well as `docker-compose`. This will allow the application
+to be deployed from any terminal console:
+
+```bash
+cd /path/to/machine-learning
+docker-compose up
+```
+
+**Note:** the installation, and the configuration of `docker-compose`, has been [outlined](https://jeff1evesque.github.io/machine-learning.docs/latest/html/installation/docker-compose.html)
+if more explicit instructions are needed.
+
 ## Execution
 
 Both the web-interface, and the programmatic-api, have corresponding
  [unit tests](https://github.com/jeff1evesque/machine-learning/blob/master/doc/test/pytest.rst)
- which can be reviewed, and implemented.
+ which can be reviewed, and implemented. It is important to remember,
+ the installation of this application will dictate the endpoint. More
+ specifically, if the application was installed via rancher, then the
+ endpoint will take the form of `https://192.168.99.101:XXXX`. However,
+ if the `docker-compose up` alternate was used, then the endpoint will
+ likely change to `https://localhost:XXXX`, or `https://127.0.0.1:XXXX`.
 
 ### Web Interface
 

doc/installation/docker-compose.rst

@@ -7,10 +7,21 @@ This allows various respective docker containers, to be managed consistently.
 However, before proceeding, it is important to follow the |docker|_ , and
 |docker-compose|_ installation guide.
 
-Once docker-compose has installed, simply run ``docker-compose up``, in the
-root directory of this cloned project. This will allow the web-application to
+Once docker-compose has installed, simply run ``docker-compose up``:
+
+.. code:: bash
+
+    cd /path/to/machine-learning
+    docker-compose up
+
+This will allow the web-application to
 be accessible on the host machine, via https://localhost:8080. Similarly, the
-programmatic-api will be accessible at https://localhost:9090.
+programmatic-api will be accessible at https://localhost:9090. However, since
+this project assumes rancher as the primary method to deploy, and run the
+application, it will be important to remember when reading through this
+documentation, to substitute the localhost, or the `https://127.0.0.1:XXXX`
+address, in place of the `https://192.168.99.101:XXXX` endpoint. This will
+allow users to perform the same tasks outlined throughout this documentation.
 
 .. |docker-compose| replace:: docker-compose
 .. _docker-compose: https://docs.docker.com/compose/install/#install-compose