trellis-shares

A microservice to process sharing jobs. A sharing job shares a document from a src to a destination.

In its current form, it accepts jobs that look like this:

POST /bookmarks/services/trellis-shares/jobs
{
  service: 'trellis-shares',
  type: 'share-user-link',
  config: {
    src: { _id: 'resources/123abc' },
    versioned: false, // do you want to link with _rev or not
    // Where to link from root
    dest: '/bookmarks/trellisfw/fsqa-audits/123abc',
    // If you want to shift root elsewhere
    chroot: '/bookmarks/trellisfw/trading-partners/987def/user/bookmarks'
    doctype: 'audits',
    tree: { ... a usual tree, representing only dest path (ignoring chroot) ... }
  }
}

Note that technically "bookmarks" is repeated twice, but the library removes one of them when smashing the strings together. Tree shold be rooted at the dest rather than trying to include the chroot and the dest.

Installation

cd path/to/your/oada-srvc-docker
cd services-available
git clone [email protected]:trellisfw/trellis-shares.git
cd ../services-enabled
ln -s ../services-available/trellis-shares .
oada up -d trellis-shares

Overriding defaults for Production

Using the common z_tokens method outlined for oada-srvc-docker, the following entries for the z_tokens docker-compose file will work:

  trellis-shares:
    volumes:
      - ./services-available/z_tokens/private_key.jwk:/private_key.jwk
    environment:
      - token=atokentouseinproduction
      - domain=your.trellis.domain

Masking and PDF Generation

Plan is for this to work as follows:

• This only works for copying, it does not work for re-linking an existing document
• job config includes mask and pdf creation instructions (i.e. whether to mask, and which keys to mask)
• when the copy is created, the copy will ref back to the original in its meta/vdoc/unmasked
• the masked copy will be linked from the original through the job's final result object rather than semantically under meta somewhere
• if pdf creation is enabled for the mask, and it is a supported type, the PDF will be made
• PDF will be linked under meta/vdoc/pdf just as the unmasked copy, and the JSON will be linked under the pdf's meta/vdoc/(audits|cois|etc)/{key} (i.e. doubly-linked)
• I think this will just work as-is for Reagan because the PDF contains links already for verification, no need to alter the emails.