Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GQL-96: Updating the README #151

Closed
wants to merge 1 commit into from
Closed

GQL-96: Updating the README #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,20 @@ CMR-GraphQL uses a few environment variables for configuring runtime options:
|MMT_ROOT_URL||URL to ping when retrieving metadata from MMT e.g. https://mmt.earthdata.nasa.gov|
|DRAFT_MMT_ROOT_URL||URL to ping when retrieving draft metadata from Draft MMT e.g. https://draftmmt.earthdata.nasa.gov|
|LAMBDA_TIMEOUT|30|Number of seconds to set the Lambda timeout to.|
|EDL_KEY_ID, EDL_JWK, EDL_CLIENT_ID|For facilitating EDL connection -- obtain these from a dev|
|EDL_KEY_ID, EDL_JWK, EDL_CLIENT_ID, EDL_PASSWORD| .bash or .zshrc file|For facilitating EDL connection -- obtain these from a dev and upload. After making changes, remember to run $ source ~/.zshrc|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.bash or .zshrc file is not a default value that is used, so it doesn't make sense in that column. And again, there are more than one valid ways to save environment variables, adding that you have to run $ source ~/.zshrc is not valid for all users, and we should leave it up to the dev to set variables however they want to


### Serverless Framework
### Local Environment Spin-Up
If using cmr-graphql in conjunction with MMT, setup local CMR database with the [instructions found here](https://github.com/nasa/mmt/tree/main). Then utilize one of the following commands depending on the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MMT specific help should exist in the MMT readme. Adding this information here will only add confusion for people who aren't developing MMT.

environment you wish to point graphql towards. You do not need quotations around any variables EXCEPT for UAT's EDL_PASSWORD.

|Environment|CLI|
|-|-|
|Local| $ CMR_ROOT_URL=http://localhost:4000 EDL_CLIENT_ID=SIT Client ID EDL_PASSWORD=SIT Password npm start|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My commands I use look very different from these. These actually wouldn't work for me without changing my environment. We already describe the environment variables needed, that should be enough for a developer to understand, and they can use their personal preference on how to save those variables.

|SIT| $ EDL_CLIENT_ID=SIT Client ID EDL_PASSWORD=SIT Password npm start
|UAT| $ CMR_ROOT_URL=https://cmr.uat.earthdata.nasa.gov EDL_CLIENT_ID=UAT Client Id EDL_PASSWORD='UAT Password' URS_ROOT_URL=https://uat.urs.earthdata.nasa.gov npm start

When using Apollo Studio, you should be able to do queries without needing a token. Mutations will require you utilize the token provided to you at the URS_ROOT_URL. Once aquired, go to Headers, select "+ New header". Header Key = Authorization and value = Bearer urs.token
### Serverless Framework
The local development environment for the static assets can be started by executing the command below in the project root directory:

serverless offline
Expand Down
Loading