crkn-rcdr / Access-Platform

Documentation, specifications, and APIs for the Canadiana Access Platform.
https://www.canadiana.ca/
2 stars 0 forks source link

Install Test version of FOLIO on a CRKN server. #552

Closed RussellMcOrmond closed 9 months ago

RussellMcOrmond commented 2 years ago

https://lotus.docs.folio.org/docs/getting-started/installation/

A Sharepoint document is being used to discuss overall project.

brittnylapierre commented 2 years ago

We will want a pretty bare bones installation as we won't be making use of FOLIO's other library apps (sourcing, legal, and a system where users could check out items.)

The only apps we are looking to have as part of our install are related to Metadata Management (Cataloging) https://lotus.docs.folio.org/docs/metadata/

RussellMcOrmond commented 2 years ago

For @hstgelais-crkn-rcdr , as we'll want to decide which path to go.

We have some choices:

a) We can set up on the same computer as Archivematica, using the Fortinet VPN to ensure only staff has acccess.

b) We can set it up on Toma or similar, making use of an Authenticated Proxy (#551). This is a technique we will want to use for other services later, so not specific to this short-term project.

RussellMcOrmond commented 2 years ago

For scheduling/prioritisation reasons we are going with (a) above.

RussellMcOrmond commented 2 years ago

We can share notes with @nataliemacdonald here.

It may be easiest for testing out the software to use a pre-built Vagrant box. https://lotus.docs.folio.org/docs/getting-started/installation/vagrantboxes/

Vagrant is a wrapper around standard virtual machines, allowing for a common way to get virtual machines running on any computer. https://www.vagrantup.com/docs/installation

Vagrant is available for MacOS, Windows and Linux. I only have Linux at home, but I believe @brittnylapierre has access to Windows as well to help get that set up.

Vagrant is also used for Archivematica https://www.archivematica.org/en/docs/archivematica-1.13/getting-started/quick-start/quick-start/#installing-on-a-virtual-machine-using-vagrant and many other tools we may want to be able to install evaluation test/dev environments for.

It turns out that the additional networking configuration required to get these tools running on a server means it takes longer to do that. While we will of course do that for a production environment, it may be best to use the pre-built vagrant environments for evaluations.

RussellMcOrmond commented 1 year ago

http://oma.ott.c7a.ca:3000/ is where the login will be.

IP address in DNS requires staff to be logged into the Fortinet VPN.

[09:50] root@eclipse ~# host oma.ott.c7a.ca
oma.ott.c7a.ca has address 10.200.1.35

For those of us that connect to gateway-ott, there is a different IP address to put into /etc/hosts

10.202.250.42 oma.ott.c7a.ca

Instructions to replace "localhost" for contacting OKAOPI (required for login) doesn't work with recent snapshots. I will have to ask about those details. https://github.com/folio-org/folio-ansible/blob/master/doc/index.md#replace-localhost-by-hostname-on-the-demo-box

Current Vagrantfile. This will be changing as testing goes forward.

Vagrant.configure("2") do |config|
  config.vm.box = "folio/release-core"
  config.vm.network "forwarded_port", guest: 9130, host: 9130
  config.vm.network "forwarded_port", guest: 3000, host: 3000
  config.vm.network "forwarded_port", guest: 8000, host: 8000
  config.vm.provider "virtualbox" do |vb|
    vb.memory = 65536
    vb.cpus = 8
  end

  config.vm.provision "shell", env: {
    "OKAPI" => "http://oma.ott.c7a.ca:9130"
  }, inline: <<-SHELL
    set -e
    rm -rf /etc/folio/stripes/output
    /etc/folio/stripes/build-run
    docker restart okapi
  SHELL
end

This is an old version, but the instructions to set the API URL was close enough to be able to log in: http://oma.ott.c7a.ca:3000/settings/about

https://dev.folio.org/tutorials/folio-vm/01-create-workspace/

Modifying

Use the local web browser to login to the user interface at http://oma.ott.c7a.ca:3000 The default administrative user is diku_admin/admin

Inspect the Settings page to find the version of Okapi, and the installed modules: http://oma.ott.c7a.ca:3000/settings/about

Currently shows: stripes-core 7.2.0 https://github.com/folio-org/stripes-core/releases/tag/v7.2.0 -- is from Jun 9, 2021.

https://dev.folio.org/tutorials/folio-vm/overview/#old-vm https://wiki.folio.org/display/REL/ - this is Kiwi (R3 2021)

RussellMcOrmond commented 1 year ago

Question posted, awaiting some feedback rather than fiddling with software I don't understand yet :-)

https://discuss.folio.org/t/new-method-to-replace-localhost-by-hostname-on-the-demo-box-ansible/3404

RussellMcOrmond commented 1 year ago

Awaiting feedback from Folio comunity.

In the interim, the old version is available via http://oma.ott.c7a.ca:3000 for @brittnylapierre and @nataliemacdonald to look at. This is only for playing around. Please post feedback here, and I will coordinate future upgrades/etc with the two of you.

This URL is only available while connected to the CRKN VPN, and the default administrator password has been kept.

From https://dev.folio.org/tutorials/folio-vm/01-create-workspace/ "The default administrative user is diku_admin/admin"

For Britney,

If you are connected using OpenVPN via gateway-tor, you don't need to also connect to the Fortinet VPN to access Folio or Archivematica. You can just put the following in your /etc/hosts:

russell@russell-XPS-13-7390:~$ grep oma.ott /etc/hosts
10.202.250.42 oma.ott.c7a.ca
russell@russell-XPS-13-7390:~$ host archivematica-test.c7a.ca
archivematica-test.c7a.ca is an alias for oma.ott.c7a.ca.
oma.ott.c7a.ca has address 10.202.250.42
russell@russell-XPS-13-7390:~$ 
brittnylapierre commented 1 year ago

Hey Russell! This instance is working for me.

James said we should look into only keeping the modules we want to use in our test instance.

To add/keep only the modules and plugins we want, I think this would be the install instructions:

  1. Clone the platform repo: https://github.com/crkn-rcdr/folio-platform-custom (I made a fork of platform-complete and tried to edit it to only contain things we are interested in. There may be errors because of this that need to be fixes as you go.)

  2. Follow these instructions to get it running locally. Instead of platform-complete use the above repo (fixes might be necessary!!) https://lotus.docs.folio.org/docs/getting-started/installation/singleserverfreshinstall/

  3. Package it up with vagrant (I think?) https://www.engineyard.com/blog/building-a-vagrant-box-from-start-to-finish/

  4. Deploy the vagrant to the server (I think?)

Thanks!

RussellMcOrmond commented 1 year ago

This is the piece of the puzzle we need to figure out before we can move to the new version and try it out.

There are documents on that release page for running modules on your host system