README.md

pdc_describe

Cataloging application for PDC content and more

Dependencies

• Ruby: 3.0.3
• nodejs: 16.15.0
• yarn: 1.22.18
• Lando: 3.6.2

Local development

Setup

1. Check out code and cd
2. Install tool dependencies
   1. Lando
   2. asdf
3. Install asdf dependencies
   1. asdf plugin add ruby
   2. asdf plugin add nodejs
   3. asdf plugin add yarn
   4. asdf plugin add awscli
   5. asdf install
   6. ... but because asdf is not a dependency manager, if there are errors, you may need to install other dependencies. For example: brew install gpg or brew install pkgconfig
4. Install language-specific dependencies
   1. bundle install
   2. yarn install
5. Set up local AWS credentials
   1. Put a stanza like this in your UNIX setup environment (e.g., .zshrc or .bashrc). Get the AWS secrets from the staging server:

   # AWS settings for PDC Describe
   # (copied these values from ENV staging)
   export AWS_S3_POST_CURATE_BUCKET="pdc-describe-staging-postcuration"
   export AWS_S3_PRE_CURATE_BUCKET="pdc-describe-staging-precuration"
   export AWS_S3_SECRET_KEY="AWS_S3_SECRET_KEY"
   export AWS_S3_POST_CURATE_REGION="us-east-1"
   export AWS_S3_PRE_CURATE_REGION="us-east-1"
   export AWS_S3_KEY_ID="AWS_S3_KEY_ID"
   

Starting / stopping services

We use lando to run services required for both test and development environments.

Start and initialize database services with:

bundle exec rake servers:start

To stop database services:

bundle exec rake servers:stop or lando stop

Running tests

1. Fast: bundle exec rspec spec
2. Run in browser: RUN_IN_BROWSER=true bundle exec rspec spec

Starting the development server

1. bundle exec rails s -p 3000
2. Access application at http://localhost:3000/

Give yourself admin privs in your local dev instance

1. Login at http://localhost:3000/ so a User exists.
2. Enter the rails console: bundle exec rails console
3. Elevate your privs: User.new_super_admin("your NetID here")

Separate from admin, users may also be given permission to add post-dated notes in the provenance / change log.

Development with AWS resources

Tests should never depend on outside resources, and it's best minimize dependencies during development, too, but it can be useful. To give your local instance access to the staging S3 create ~/s3-envvars.sh:

export AWS_S3_PRE_CURATE_BUCKET=pdc-describe-staging-precuration
export AWS_S3_POST_CURATE_BUCKET=pdc-describe-staging-postcuration
export AWS_S3_DSPACE_BUCKET=prds-dataspace
export AWS_S3_DSPACE_REGION=us-east-1
# For these last two, open Lastpass and look under `princeton_ansible/RDSS Globus AWS`:
export AWS_S3_KEY_ID=...
export AWS_S3_SECRET_KEY=...

Then source this file before starting rails:

$ . ~/s3-envvars.sh; bundle exec rails s -p 3000

By default storage.yml is also configured to use local storage instead of connecting to AWS. Make sure you update your local copy as indicated inside the file if you want to use AWS.

DataCite integration

We use DataCite to mint DOIs and in production you must to define the DATACITE_* environment values indicated here for the system to run. During development if you do not set these values the system will use a hard-coded DOI.

Release and deployment

RDSS uses the same release and deployment process for all projects.

Sidekiq

Background jobs in staging and production are run via sidekiq. You can go to https://pdc-describe-staging.princeton.edu/describe/sidekiq to see the sidekiq dashboard, but because these environments are load balanced, that view will switch back and forth between hosts. Instead, use the capistrano task: cap staging sidekiq:console or cap production sidekiq:console. This will open an ssh tunnel to all nodes in a PDC Describe environment (staging or production), with a tab in your browser for each one.

Mail

Mail on Development

Mailcatcher is a gem that can also be installed locally. See the mailcatcher documentation for how to run it on your machine.

Mail on Staging

To See mail that has been sent on the staging server you can utilize capistrano to open up both mailcatcher consoles in your browser.

cap staging  mailcatcher:console

Look in your default browser for the consoles

Mail on Production

Emails on production are sent via Pony Express.

Admin users in Production

To add a new user as an admin (e.g., so they can migrate data from DataSpace), use the rails console on the production system:

irb(main):010:0> user = User.find_by(uid: 'hb0344')
irb(main):015:0> user.add_role(:group_admin, Group.plasma_laboratory)
irb(main):016:0> user.add_role(:group_admin, Group.research_data)

PPPL submitters

To allow a non-admin user to submit only to the PPPL group and its communities and subcommunities, that user's default Group must be set to the Princeton Plasma Physics Lab and their roles must be updated. To do this, use the Rake task users:make_pppl_user and pass the netid of the user to update:

bundle exec rake users:make_pppl_user[xx123]

Viewing the Application outside of the load balancer

To view the application on a specific server you can utilize capistrano to tunnel into the server and open up a browser.

The following would open up a browser to the web application after deploying. This will allow the developer to verify that the deployment was successful prior to deploying the secondary.

cap production_primary application:webapp

Note to login you must hand edit the response url to have http instead of https. Otherwise read operations work fairly well. Edit (POST/PUT) operations do not seem to work.

Rolling deployments to production

We utilize rolling deployments to production. When a new release is ready to deploy

1. deploy to production_primary via ansible tower
2. verify that the deployment was successful utilizing capistrano cap production_primary application:webapp
3. deploy to production_secondary via ansible tower
4. verify that the deployment was successful utilizing capistrano cap production_secondary application:webapp