[FOLIO-1314] review the folio-install single server deployment guide Created: 27/Jun/18  Updated: 12/Nov/18  Resolved: 29/Aug/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Jakub Skoczen Assignee: David Crossley
Resolution: Done Votes: 0
Labels: ci, sprint41, sprint42, sprint43, sprint44, sprint45
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
is blocked by FOLIO-1315 mechanism to consume tenant config at... Open
is blocked by FOLIO-1336 bootstrap necessary user data in orde... Closed
Relates
relates to FOLIO-1315 mechanism to consume tenant config at... Open
relates to FOLIO-1336 bootstrap necessary user data in orde... Closed
relates to FOLIO-1352 Update reference data in folio-install Closed
Sprint:

 Description   

Note any development dependencies or build procedures involved. We will try to come up with alternative approaches.

David Crossley



 Comments   
Comment by David Crossley [ 02/Jul/18 ]

Followed the guide on macOS host. All was clear.

This guide does already note that it needs more work with the "securing" aspect. For now i linked to the relevant section of the Okapi Guide.

(If the following is not what is required for this task, then please elaborate.)

Dev dependencies:
vagrant for managing the VM
maven and java, for the current method to generate initial superuser password

Extra build and preparation procedures:

  • Update ./deployment-descriptor-templates directory. These templates are used later in the process.
  • Update local copy of ./reference-data directories. These are loaded later in the process. There is now a reference-data/import.sh at some modules.
  • Clone the platform, yarn build the webpack for Stripes.
  • Follow on from the generated config, to prepare the actual current deployment descriptors for the required modules, via the initial Okapi.
  • To create password for superuser, clone and build mod-login separately, and follow the steps.
Comment by Jakub Skoczen [ 11/Jul/18 ]

1. https://github.com/folio-org/folio-install/blob/master/single-server.md#create-a-folio-superuser The section on setting up initial user and password needs to be modified so it does not refer to building mod-login. We may need additional functionality in mod-login and mod-permisssions to bootstrap a user. Comment Heikki Levanto Adam Dickmeiss Kurt Nordstrom?

2.Fix the documentation for deployment descriptors (launchDescriptor are now bundled with module descriptors) Wayne Schneider

3. Stripes bundle – we would like to avoid the build step (and building the head of master). We can zip up snapshot and snapshot-stable bundles and offer them for download but we need a way to update the tenantId and okapiUrl settings. Possibly a dedicated config file? Mike Taylor Zak Burke

Comment by Mike Taylor [ 11/Jul/18 ]

Are you saying you want to instruct people to use a prebuilt Stripes bundle instead of making their own?

Comment by Zak Burke [ 11/Jul/18 ]

Yes; that's the goal.

Comment by Zak Burke [ 11/Jul/18 ]

We want an end user to be able to complete a single-server install without needing tools like maven and yarn. We recognize we may need to hack the bundle with a small shell script to set things like the tenant ID and Okapi URL, but John Malconian indicated this is likely not a big deal.

Comment by Mike Taylor [ 11/Jul/18 ]

OK, sounds like you have this covered Zak Burke. I'll leave it to you, unless at any point you want ask me something.

Comment by Matthew Jones [ 11/Jul/18 ]

Is this script to inject tenant ID and Okapi URL considered a short term solution for FOLIO-1315 Open ? I still need to fill out the details on that one, but the general idea is we allow the tenant-config to be consumed at runtime.

Comment by Wayne Schneider [ 19/Jul/18 ]

I've updated the documentation as discussed above as part of the Q2-2018 release.

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