Pds registry app 263 docs docker compose tl #42
Conversation
…ckstart. REsTful API documentation endpoint is TBD
…registry-app-240
…lication documentation
Pds registry app 240 tl
pds-registry-app #240
… loading instead of docker compose naked commands
docs/source/cloud_startup.rst
Outdated
| ************** | ||
|
|
||
| Once the above setup is complete, the Registry Tools are used to process and ingest product | ||
| metadata into the Registry. Details on how to run these tools is found in the :doc:`User |
There was a problem hiding this comment.
Minor typo: "Details on how to run these tools is" should be "Details on how to run these tools are".
|
|
||
| The high level architecture of the PDS Registry Service is shown below: | ||
|
|
||
| .. image:: _static/images/registry_service.png |
There was a problem hiding this comment.
This image (_static/images/registry_service.png) is not visible/available.
There was a problem hiding this comment.
I missed to add it to git. Done now.
docs/source/admin/tasks.rst
Outdated
| @@ -2,6 +2,10 @@ | |||
| Admin Tasks | |||
| =========== | |||
|
|
|||
| Admin tasks describes processes for the intialization/deletion of the registry and reference dictionnary updates. | |||
There was a problem hiding this comment.
Minor typo: "Admin tasks describes" should be "Admin tasks describe"
docs/source/admin/tasks.rst
Outdated
| @@ -2,6 +2,10 @@ | |||
| Admin Tasks | |||
| =========== | |||
|
|
|||
| Admin tasks describes processes for the intialization/deletion of the registry and reference dictionnary updates. | |||
There was a problem hiding this comment.
Minort typo: dictionnary
docs/source/cloud/architecture.rst
Outdated
| On-Prem vs. Cloud | ||
| ***************** | ||
|
|
||
| In a typical on-premise deployment, the PDS Registry Application is composed, server-side of |
There was a problem hiding this comment.
I feel it is better to reword this (from line 8 to 11).
There was a problem hiding this comment.
I tried to simplify the sentence, these are not my words so I am not necessarily comfortable in doing that but I agree this sentence is a bit complicated, although it sounds like good english.
| Systems Manager Parameter Store. | ||
|
|
||
| Amazon's content delivery network, Cloudfront, is placed in front of | ||
| the Elastic Load Balancer (ELB). Cloudfront provides high-speed, low-latency |
There was a problem hiding this comment.
I feel it is better to reword "Cloudfront provides high-speed, low-latency access while also ensuring unintention or malicious bulk downloading of data is avoided".
Suggestion (may be not the best suggestion) : "Cloudfront provides high-speed, low-latency access, while also ensuring the avoidance of unintentional or malicious bulk downloading of data".
There was a problem hiding this comment.
What about "Cloudfront provides high-speed, low-latency
access while also preventing from unintentional or malicious bulk download
of data" ?
There was a problem hiding this comment.
Your suggestion is good!
docs/source/index.rst
Outdated
|
|
||
| This documentation is intended for the users and adminitrators who contributes to the PDS Registry Service. The users of the PDS Registry Service through the web API should refer to the `PDS Search API user's guide <https://nasa-pds.github.io/pds-api/>`_ |
There was a problem hiding this comment.
Minor typo: "This documentation is intended for the users and adminitrators who contributes to the PDS Registry Service" should be "This documentation is intended for the users and administrators who contribute to the PDS Registry Service"
docs/source/cloud_startup.rst
Outdated
| querying of the PDS Registry Service on the cloud from the perspective of a Discipline | ||
| Node (DN). | ||
|
|
||
| Initial set-up |
There was a problem hiding this comment.
Title Case Suggestion: Better to have set-up start with an upper case S (as Set-up)to make this heading consistent with the Title Case used in other headings in this page.
| Therefore, the deployment procedures described here can be used to deploy server-side and/or client-side registry components, without having to install the individual components manually. | ||
|
|
||
| .. warning:: | ||
| these deployment are not intended for production given that 1. docker compose works on a single host and 2. permanent storage is left to docker to manage. |
There was a problem hiding this comment.
Minor suggestion: It is better to start this warning with an upper case T (These) to make it consistent with the .. note: below.
| pds-batch-loader.sh <harvest job confg file> Executes the Standalone Harvest client-side tool. The `pds-core-registry` server-side profile | ||
| This tool is recommended for small data sets of must be up and running | ||
| up to 10,000 PDS4 labels. | ||
| pds-service-loader.sh <harvest job confg file> Executes the Scalable Harvest client-side tool. The `pds-service-loader` server-side profile |
There was a problem hiding this comment.
It seems I have made a mistake when preparing this table previously.
The Prerequisites of the pds-service-loader.sh should be,
The pds-loader-services server-side profile must be up and running
instead of
The pds-service-loader server-side profile must be up and running.
There was a problem hiding this comment.
Maybe I introduced that mistake, anyway it is corrected now.
There was a problem hiding this comment.
No, that was my mistake.
|
|
||
| cd .. | ||
|
|
||
| Deployment profiles |
There was a problem hiding this comment.
Title Case Suggestion: It is better to start the work profiles with an upper case P (Profiles) in this heading to be consistent with the Title Case used in most of the heading in this page (E.g.: Clean-up the Deployment, Download and Configure the PDS Registry Application)
| ====================== ==================================================== ============================================== | ||
|
|
||
|
|
||
| Client-side operations |
There was a problem hiding this comment.
Title Case Suggestion: Client-side Operations
It is better to use the Title Case in this heading to be consistent with the Title Cases used on most of the headings in this page.
| ================================================ ==================================================== ============================================== | ||
|
|
||
|
|
||
| Common deployment scenarii |
There was a problem hiding this comment.
Title Case Suggestion: Common Deployment Scenarii
| docker-registry-api-1 | :: Spring Boot :: (v2.3.1.RELEASE) | ||
| docker-registry-api-1 | | ||
|
|
||
| Run Standalone Harvest to load some PDS4 products |
There was a problem hiding this comment.
Title Case Suggestion: Run Standalone Harvest to Load Some PDS4 Products
|
|
||
| 1) Open a new terminal and change the current working directory to the ``<REGISTRY_ROOT>/docker/scripts`` directory. | ||
|
|
||
| 2) Define an harvest job configuration as specified in :doc:`Harvest Job Configuration<../user/harvest_job_configuration>` |
There was a problem hiding this comment.
Minor typo: "an harvest" should be "a harvest"
|
|
||
| 3) Run the harvest command: | ||
|
|
||
| ./pds-batch-loader.sh <harvest job confg file> |
There was a problem hiding this comment.
Better to use a code block here for,
./pds-batch-loader.sh <harvest job confg file>
|
|
||
| 1) Open a new terminal and change the current working directory to the ``<REGISTRY_ROOT>/docker/scripts`` directory. | ||
|
|
||
| 2) Define an harvest job configuration as specified in :doc:`Harvest Job Configuration<../user/harvest_job_configuration>` |
There was a problem hiding this comment.
The following link did not appear in the generated html.
:doc:Harvest Job Configuration<../user/harvest_job_configuration>
There was a problem hiding this comment.
I missed to add the file on git. This done now
|
|
||
| 1) Open a new terminal and change the current working directory to the ``<REGISTRY_ROOT>/docker/scripts/`` directory. | ||
|
|
||
| 2) Define an harvest job configuration as specified in :doc:`Harvest Job Configuration<../user/harvest_job_configuration>` |
There was a problem hiding this comment.
The following link did not appear in the generated html.
:doc:Harvest Job Configuration<../user/harvest_job_configuration>
There was a problem hiding this comment.
I missed to add the file on git. This done now
|
|
||
| 1) Open a new terminal and change the current working directory to the ``<REGISTRY_ROOT>/docker/scripts/`` directory. | ||
|
|
||
| 2) Define an harvest job configuration as specified in :doc:`Harvest Job Configuration<../user/harvest_job_configuration>` |
There was a problem hiding this comment.
Minor typo: "an harvest" should be "a harvest"
|
|
||
| 3) Run the harvest command: | ||
|
|
||
| ./pds-service-loader.sh <harvest job confg file> |
There was a problem hiding this comment.
Better to use a code block here for,
./pds-service-loader.sh <harvest job confg file>
| docker compose --profile=pds-core-registry down | ||
|
|
||
|
|
||
| Core registry with Scalable Harvest |
There was a problem hiding this comment.
Title Case Suggestion: Core Registry with Scalable Harvest
|
|
||
| docker compose --profile=pds-loader-services up | ||
|
|
||
| Run Scalable Harvest Service client to load some PDS4 products |
There was a problem hiding this comment.
Title Case Suggestion: Run Scalable Harvest Service Client to Load Some PDS4 Products
docs/source/install/tools.rst
Outdated
| Some applications, like Harvest or Registry Manager will not run with **Java 1.8**. | ||
|
|
||
|
|
||
| Test if Java is already installed |
There was a problem hiding this comment.
Looks like I missed this one when restructuring the previous document.
Title Case Suggestion: Test If Java Is Already Installed
This was a tough one. I used the https://titlecaseconverter.com/ get the correct suggestion :-)
There was a problem hiding this comment.
I need to learn that, to stays 'to' but 'if' becomes 'If' as well as 'Is'. It is a whole field of expertise that I had no idea of !
docs/source/cloud_startup.rst
Outdated
| Along with your Opensearch user credentials you will receive the URL which points to your Opensearch | ||
| instance - we will refer to this as the Opensearch URL. | ||
|
|
||
| Changing Your Opensearch password |
There was a problem hiding this comment.
Title Case Suggestion: Changing Your Opensearch Password
There was a problem hiding this comment.
Done, I first thought you missed it so I corrected and then I saw your comment !
…stry_app_263_docs_docker_compose-TL
…38) * Add instructions to use docker compose to deploy registry components Refer to the task nasa-pds-engineering-node/pds-registry-app#263 * Pds registry app 263 docs docker compose tl (#42) * Incorporate cloud section consisting of architecture overview and quickstart. REsTful API documentation endpoint is TBD * Add API documentation URL * update integration tests for v1.0.0 * trying to integrate the cloud service deployment and the registry application documentation * Revise image to utiize updated architecture diagram. * add some more general introductions * Add instructions to use docker compose to deploy registry components Refer to the task nasa-pds-engineering-node/pds-registry-app#263 * wip: review docker compose doc, trying to take the user point of view * wip * make the doc a bit more user oriented, use .sh script to trigger data loading instead of docker compose naked commands * update typos and all sort of wording improvments after review Co-authored-by: Jimmie Young <jdyoung@jpl.nasa.gov> Co-authored-by: Thomas Loubrieu <loubrieu@jpl.nasa.gov> Co-authored-by: Jimmie Young <jimmie.d.young@gmail.com> Co-authored-by: Ramesh Maddegoda <94033485+ramesh-maddegoda@users.noreply.github.com> Co-authored-by: thomas loubrieu <60993872+tloubrieu-jpl@users.noreply.github.com> Co-authored-by: Jimmie Young <jdyoung@jpl.nasa.gov> Co-authored-by: Thomas Loubrieu <loubrieu@jpl.nasa.gov> Co-authored-by: Jimmie Young <jimmie.d.young@gmail.com>
🗒️ Summary
make the documentation a bit more user oriented by shifting the focus away from docker-compose when it is not useful to the user.
If you are good with that and if you don't catch typo and errors we can merge in your branch and then your branc in main.