Skip to content

Commit 6958581

Browse files
committed
Incorporating feedback from pull conversation comments
1 parent e2d65e2 commit 6958581

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,10 @@ For **developers of Clowder**, a hybrid is recommended. :ref:`Dev quickstart her
2323
- Run the required services via Docker, and expose each of their ports
2424
to Clowder.
2525

26-
For **production instances of Clowder**, manual installation is
27-
recommended.
26+
For **production instances of Clowder**, a Kubernetes deployment is recommended and manual installations are being phased out.
2827

29-
- Manual clowder install
30-
- Manual install of required services (at a minimum: MongoDB,
28+
- See `Kubernetes install instructions here <https://opensource.ncsa.illinois.edu/confluence/display/CATS/Kubernetes>`__
29+
- Otherwise, manually install Clowder, and each of it's required services (at a minimum: MongoDB,
3130
ElasticSearch, RabbitMQ). See
3231
`Requirements <https://clowder-framework.readthedocs.io/en/latest/admin/installing.html#requirements>`__
3332
for details.
@@ -65,12 +64,12 @@ Helpful Docker commands:
6564
- ``docker-compose up -d`` - start up all required services
6665
- ``docker-compose down`` - stop all docker containers
6766
- ``docker-compose logs -f`` - see the logs
68-
- ``docker info`` - check how many services are running
67+
- ``docker ps`` - check how many services are running
68+
- ``docker info`` - details about your docker version
6969

70-
- Server → containers → Running shows currently active containers.
71-
You should expect to see 3 (MongoDB, Elasticsearch, RabbitMQ).
70+
- After starting your services, run ``docker ps`` and check that 3 containers are running. The "Image" column should show ``rabbitmq``, ``elasticsearch`` and ``mongo``.
7271

73-
- Check on Docker services via the Docker Desktop GUI (on Windows and
72+
- You could also check on Docker services via the Docker Desktop GUI (on Windows and
7473
Mac)
7574

7675
Done! Now simply `create a new user (below) <easyUserCreation>`_
@@ -249,15 +248,14 @@ Done!
249248
Now simply ensure your docker services are still running from the
250249
previous step.
251250
252-
- You can check by running ``docker info`` and check that 3 services
251+
- You can check by running ``docker ps`` and check that 3 services
253252
are running.
254253
- If not, start them with
255254
``docker-compose -f docker-compose.override.yml up -d``
256255
257-
Now in IntelliJ, click the green play button (top right) to build Clowder from source! Give it a minute to finish.
256+
Now in IntelliJ, click the green play button (top right) to build Clowder from source! Give it a minute to finish. Access Clowder via ``localhost:9000`` in the browser.
258257
259-
Access Clowder via ``localhost:9000`` in the
260-
browser.
258+
Also note, a handy debugging mode is enabled by default. You can run the debug mode by clicking the green "bug" button right beside the play button.
261259
262260
.. note::
263261
@@ -389,7 +387,7 @@ Start Clowder:
389387
Clowder directory).
390388
391389
1. You can check if your services are already running using
392-
``docker info`` and check that 3 containers are active (MongoDB,
390+
``docker ps`` and check that 3 containers are active (MongoDB,
393391
ElasticSearch, and RabbitMQ) by looking at
394392
``Server → Containser: 3``. Or check via the Docker Desktop GUI.
395393
@@ -572,3 +570,4 @@ can be installed on other machines with Clowder configured to communicate with t
572570
* ElasticSearch is used for text based search by Clowder.
573571
* Versions above 2.x have not been tested.
574572
573+

0 commit comments

Comments
 (0)