PoC for hosted development environment for FOLIO teams (FOLIO-2601)

[FOLIO-2669] SPIKE: Determine method of deploying Stripes bundles to dev environments Created: 01/Jul/20  Updated: 17/Jul/20  Resolved: 17/Jul/20

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None
Parent: PoC for hosted development environment for FOLIO teams

Type: Task Priority: P2
Reporter: John Malconian Assignee: Stanislav Miroshnichenko
Resolution: Done Votes: 0
Labels: dev-environment
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-2624 SPIKE: Build and deploy Stripes bund... Closed
relates to FOLIO-2661 bootstrap a superuser for a tenant Closed
relates to FOLIO-2601 PoC for hosted development environmen... Closed
Sprint: DevOps: sprint 92
Development Team: FOLIO DevOps
Epic Link: PoC for hosted development environment for FOLIO teams

 Description   

Identify and document the requirements and process for deployment of Stripes bundles into hosted dev environments including necessity and/or limitations of a Helm chart for Stripes (platform-complete and platform-core) as opposed to utilizing custom, dev-driven rancher pipelines and deployment templates.



 Comments   
Comment by Jakub Skoczen [ 06/Jul/20 ]

Stanislav Miroshnichenko is investigating using Rancher to build Stripes. He has successfully utilised Helm to do that (workfow: developer has to build the image locally, upload it to a shared repo and use Helm to deploy to the team env)

Comment by Wayne Schneider [ 06/Jul/20 ]

See this comment on FOLIO-2661 Closed : https://folio-org.atlassian.net/browse/FOLIO-2661?focusedCommentId=199254&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel

I believe the bundle is being built correctly, but the backend (Okapi and mod-permissions) are not configured. Each UI module in the bundle needs to be registered with Okapi and enabled for the tenant in order for the UI permissionSets to be created (and thus available to assign to the tenant admin user).

In folio-ansible, we do this using the stripes-build role (https://github.com/folio-org/folio-ansible/tree/master/roles/stripes-build). Unfortunately, the code is rather convoluted – it is long overdue for a good refactoring – but in essence, these are the steps that need to happen as part of the bundle build:

  1. Run yarn build-module-descriptors
  2. Slurp in the files from ./ModuleDescriptors
  3. Post them to Okapi's /_/proxy/modules API
  4. Enable them for the tenant – the playbook posts them separately to Okapi's //proxy/tenants/tenantId/modules API, but you could also just post a list to //proxy/tenants/tenantId/install

Once the modules are enabled for the tenant, you can run the tenant admin bootstrap script to assign the permissions.

Comment by Jakub Skoczen [ 17/Jul/20 ]

Stanislav Miroshnichenko John Malconian

I am closing this ticket since the workflow for deploying stripes bundle has been captured on FOLIO-2671 Closed

Generated at Thu Feb 08 23:22:22 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.