Updating QA Anvil Environment 2021.04 qa-anvil.planx-pla.net 1620674324

[PlanXCyborg]

Applying version 2021.04 to qa-anvil.planx-pla.net

[PlanXCyborg]

qa-anvil.planx-pla.net/manifest.json

Deployment changes

• fence
  • Audit logs for user logins and data downloads can be enabled by deploying the audit-service and adding setting ENABLE_AUDIT_LOGS to the fence config (see https://github.com/uc-cdis/fence/blob/1c850d07e54f8527dbde182fdd9dd593d18f660e/fence/config-default.yaml#L586-L588) (uc-cdis/PXP-7447 audit-service integration fence#885)
  • REQUIRES A FENCE DB MIGRATION, since with this update there is now an additional column in the authorization_code table "refresh_token_expires_in" (uc-cdis/Feat/refresh expires in fence#848)
• guppy
  • To deploy SearchFilters in a tab of the Explorer page, add an entry to data{/file}ExplorerConfig.filters.tabs.searchFields. NOTE: Do not add the same field to both searchFields and fields, this will cause strange behavior in the search field. Example config: (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "filters": { (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "tabs": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • { (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "title": "Subject", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "searchFields": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "subject_id", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "submitter_id", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "consent_codes" (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ], (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "fields": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "data_type", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "data_format", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ... (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ] (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • } (uc-cdis/(PXP-6359) Add Search Filter guppy#99)

• portal
  • envs with customized color schemes no longer need to overwrite dictionary button color in their gitops.css (uc-cdis/(PXP-6570): refactor/dictionaryBtnColor: change dictionary btn to use defined global colors data-portal#822)
  • New optional config property, tierAccessLevel, in each tab of the explorerConfig block in the portal config. Used to enable index-scoped tiered-access, which is only available starting with Guppy server version 0.11.0. See README for more information. (uc-cdis/Feat/index scoped tiered access data-portal#802)
  • To deploy Discovery page: (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • "featureFlags": { "discovery": true } must be set in the portal config. (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • If discoveryConfig.features.authorization.enabled: true, "useArboristUI": true must be set in the portal config. (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • "discoveryConfig": <DiscoveryConfig> must be set in the portal config. DiscoveryConfig documentation can be found at https://github.com/uc-cdis/data-portal/blob/master/docs/portal_config.md (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • To upload data to Discovery page, data must be uploaded to environment's metadata-service instance with guid_type: "discovery_metadata". The metadata must all be under the top-level property gen3_discovery. (No documentation on this process yet, see this gist for right now https://gist.github.com/Avantol13/a53593837503fede2881f315198247c4) (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • Added new entry GWASApp for analysisTools for this new GWAS app for VA. Beaware not to confuse with the old "GWAS PoC" app, which bears the entry vaGWAS (uc-cdis/PXP-7296 PXP-7180 Feat/va gwas app data-portal#777)
  • antd modal now by default will use g3-color__base-blue as header background color, this is consistant with our color schemes for other UI components. If an env has customized color scheme, please override .ant-modal-header in gitops.css (uc-cdis/PXP-7296 PXP-7180 Feat/va gwas app data-portal#777)
  • The new feature of Portal requires Guppy v0.10.0 (uc-cdis/(PXP-6540): Feat/explorer download formats data-portal#780)
  • Added new button types in the Portal config. See portal_config.md for an example. (uc-cdis/(PXP-6540): Feat/explorer download formats data-portal#780)
  • At time of writing, qa-midrc is only env using the new feature flag. These changes should be deployed alongside each other to production, but nothing will break if done separately. (uc-cdis/(PXP-7097) Add optional alternate TopBar profile menu data-portal#759)
  • New value for GEN3_BUNDLE env var GEN3_BUNDLE=nct (uc-cdis/PXP-6895 NIAID CT bundle data-portal#742)
  • New optional portal config variable injectDAPTag (default value is false). If set to true, will inject DAP tag script into page header (this is required for NCT PROD env only) (uc-cdis/PXP-6895 NIAID CT bundle data-portal#742)
  • All envs should check if the dataExplorerConfig field in its portal config has ONLY arrangerConfig field but NO guppyConfig field (it is okay to have both). If so, please update dataExplorerConfig to use Guppy (uc-cdis/PXP-6409 Remove arranger data-portal#743)
  • A new Export to PFB button can be optionally enabled in the config.json. It is disabled by default. The button requires at least pelican:2020.10 release. (uc-cdis/Feat/export pfb to workspace data-portal#681)
  • Add GEN3_BUNDLE=covid19 as portal env var to enable covid bundle (uc-cdis/Feat/covid bundle data-portal#737)
• ssjdispatcher
  • metadata-service must already be present or added to the "versions": { section of the cdis-manifest. After metadata-service has been confirmed to be in the cdis-manifest, the now-required Metadata Service creds for SSJDispatcher must be configured by running gen3 roll all with JENKINS_HOME not set. gen3 roll all calls gen3 kube-setup-ssjdispatcher, which now automatically configures the SSJDispatcher secret with Metadata Service creds. (uc-cdis/(PXP-6977): make mds creds required for service startup ssjdispatcher#32)

[PlanXCyborg]

qa-anvil.planx-pla.net/manifest.json

Deployment changes

• fence
  • Audit logs for user logins and data downloads can be enabled by deploying the audit-service and adding setting ENABLE_AUDIT_LOGS to the fence config (see https://github.com/uc-cdis/fence/blob/1c850d07e54f8527dbde182fdd9dd593d18f660e/fence/config-default.yaml#L586-L588) (uc-cdis/PXP-7447 audit-service integration fence#885)
  • REQUIRES A FENCE DB MIGRATION, since with this update there is now an additional column in the authorization_code table "refresh_token_expires_in" (uc-cdis/Feat/refresh expires in fence#848)
• guppy
  • To deploy SearchFilters in a tab of the Explorer page, add an entry to data{/file}ExplorerConfig.filters.tabs.searchFields. NOTE: Do not add the same field to both searchFields and fields, this will cause strange behavior in the search field. Example config: (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "filters": { (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "tabs": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • { (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "title": "Subject", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "searchFields": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "subject_id", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "submitter_id", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "consent_codes" (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ], (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "fields": [ (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "data_type", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • "data_format", (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ... (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • ] (uc-cdis/(PXP-6359) Add Search Filter guppy#99)
  • } (uc-cdis/(PXP-6359) Add Search Filter guppy#99)

• portal
  • envs with customized color schemes no longer need to overwrite dictionary button color in their gitops.css (uc-cdis/(PXP-6570): refactor/dictionaryBtnColor: change dictionary btn to use defined global colors data-portal#822)
  • New optional config property, tierAccessLevel, in each tab of the explorerConfig block in the portal config. Used to enable index-scoped tiered-access, which is only available starting with Guppy server version 0.11.0. See README for more information. (uc-cdis/Feat/index scoped tiered access data-portal#802)
  • To deploy Discovery page: (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • "featureFlags": { "discovery": true } must be set in the portal config. (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • If discoveryConfig.features.authorization.enabled: true, "useArboristUI": true must be set in the portal config. (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • "discoveryConfig": <DiscoveryConfig> must be set in the portal config. DiscoveryConfig documentation can be found at https://github.com/uc-cdis/data-portal/blob/master/docs/portal_config.md (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • To upload data to Discovery page, data must be uploaded to environment's metadata-service instance with guid_type: "discovery_metadata". The metadata must all be under the top-level property gen3_discovery. (No documentation on this process yet, see this gist for right now https://gist.github.com/Avantol13/a53593837503fede2881f315198247c4) (uc-cdis/(PXP-7402) Discovery page data-portal#803)
  • Added new entry GWASApp for analysisTools for this new GWAS app for VA. Beaware not to confuse with the old "GWAS PoC" app, which bears the entry vaGWAS (uc-cdis/PXP-7296 PXP-7180 Feat/va gwas app data-portal#777)
  • antd modal now by default will use g3-color__base-blue as header background color, this is consistant with our color schemes for other UI components. If an env has customized color scheme, please override .ant-modal-header in gitops.css (uc-cdis/PXP-7296 PXP-7180 Feat/va gwas app data-portal#777)
  • The new feature of Portal requires Guppy v0.10.0 (uc-cdis/(PXP-6540): Feat/explorer download formats data-portal#780)
  • Added new button types in the Portal config. See portal_config.md for an example. (uc-cdis/(PXP-6540): Feat/explorer download formats data-portal#780)
  • At time of writing, qa-midrc is only env using the new feature flag. These changes should be deployed alongside each other to production, but nothing will break if done separately. (uc-cdis/(PXP-7097) Add optional alternate TopBar profile menu data-portal#759)
  • New value for GEN3_BUNDLE env var GEN3_BUNDLE=nct (uc-cdis/PXP-6895 NIAID CT bundle data-portal#742)
  • New optional portal config variable injectDAPTag (default value is false). If set to true, will inject DAP tag script into page header (this is required for NCT PROD env only) (uc-cdis/PXP-6895 NIAID CT bundle data-portal#742)
  • All envs should check if the dataExplorerConfig field in its portal config has ONLY arrangerConfig field but NO guppyConfig field (it is okay to have both). If so, please update dataExplorerConfig to use Guppy (uc-cdis/PXP-6409 Remove arranger data-portal#743)
  • A new Export to PFB button can be optionally enabled in the config.json. It is disabled by default. The button requires at least pelican:2020.10 release. (uc-cdis/Feat/export pfb to workspace data-portal#681)
  • Add GEN3_BUNDLE=covid19 as portal env var to enable covid bundle (uc-cdis/Feat/covid bundle data-portal#737)
• ssjdispatcher
  • metadata-service must already be present or added to the "versions": { section of the cdis-manifest. After metadata-service has been confirmed to be in the cdis-manifest, the now-required Metadata Service creds for SSJDispatcher must be configured by running gen3 roll all with JENKINS_HOME not set. gen3 roll all calls gen3 kube-setup-ssjdispatcher, which now automatically configures the SSJDispatcher secret with Metadata Service creds. (uc-cdis/(PXP-6977): make mds creds required for service startup ssjdispatcher#32)