Skip to content
This repository has been archived by the owner on Feb 2, 2022. It is now read-only.

Latest commit

 

History

History
422 lines (275 loc) · 8.71 KB

PITCHME.md

File metadata and controls

422 lines (275 loc) · 8.71 KB
Raw

DSpace Docker for Repository Managers

Running Any Version of DSpace from your Desktop
  • Terry Brady, Georgetown University Library
  • Pascal Becker, The Library Code

@size20px

http://bit.ly/docker4rm

Webinar Video

Note:

Who We Are

+++

Terry Brady

Note: Terry presents

+++

Pascal Becker

Note: Pascal presents

Background

  • 2018 the DSpace for Docker was created
  • Possible to start any version of DSpace from your desktop
    • (Windows 10, MacOS, Linux)
  • Great potential for repository managers

+++

Who You Are (we think)

  • Repository Managers who want to ...
    • preview new DSpace functionality
    • become more involved in DSpace development
    • test certain functionality of DSpace
  • Developers who want to ...
    • learn how they can get started with the project
    • use DSpace within Docker as part of their development environment

+++

Webinar Objectives

  • What is a Docker image and what are Containers
  • What Docker images have been published for DSpace
  • How to install Docker
  • How to launch DSpace 6 and DSpace 7 using Docker
  • How to participate in DSpace testing using Docker

Motivation

In our first demo, we want to show you how easy it is to get DSpace 7 runing. For this demo, we have already

  • Installed Docker
  • Installed a command line tool
  • Downloaded some code to help us start DSpace

Note: Terry presents

cd
git clone https://github.com/DSpace-Labs/DSpace-Docker-Images.git
cd DSpace-Docker-Images/docker-compose-files/dspace-compose

+++

Demo: Running DSpace 7

  • It takes 2-3 minutes to start up
  • The following command was already run
docker-compose -p d7 -f docker-compose.yml -f d7.override.yml up -d

+++?image=documentation/webinar/win.d7.start.gif

+++

Testing DSpace 7

5 Quick Docker Concepts

  • Docker Images
  • DSpace Docker Images
  • Docker Containers
  • Docker Volumes
  • Docker compose

Note: Pascal presents

+++

Docker Images

  • Imagine you could
    • install a complex application with its complete environment with one command
    • pack a whole environment into one package

Docker Images make that possible.

+++

Docker Images (continued)

An Image is

  • A snapshot of an application and its complete environment
  • Published Online
  • Can be shared and downloaded

+++

DSpace Docker Images

+++

Docker Containers

  • A running version of a docker image
  • Like a small server running within your desktop
  • Containing a complete environment
  • Containing an application or service
  • Started and stopped by Docker
  • Runs independently of other applications

+++

A container's lifetime

  • Images package a complete environment needed to run an application
  • Containers can be deleted when they are stopped
  • A container can be thrown away and recreated easily as the image defines it well

+++

Docker Volumes

  • Can be (re-)used when a container starts
  • Volumes outlive the containers that uses them
  • Like a really small disk drive or network drive
  • Data you wish to save must be stored in a volume

+++

docker-compose

  • Docker compose is a command to control environments of multiple containers that work together
    • DSpace Database
    • DSpace Web Server
    • Angular UI (for DSpace 7)
  • Build, start, stop, ... all necessary containers for a service or application

What is possible with DSpace and Docker?

  • Try out a DSpace feature without impacting your existing instance
  • Preview an enhancement or new version
  • Give input on the implementation
  • Verify a bug fix before it is released
  • Onboard new developers and repository managers to the project

Install Instructions

  • Install Docker Desktop
  • Install a terminal for running docker
  • Download DSpace Docker Compose files

Note: Terry presents

+++

Installation instructions

Step by Step Demonstration

+++

Verify Installs

git version
docker version
docker-compose version

+++?image=documentation/webinar/win.versions.gif

+++

Download DSpace Docker Compose Files

cd
git clone https://github.com/DSpace-Labs/DSpace-Docker-Images.git
cd DSpace-Docker-Images/docker-compose-files/dspace-compose

+++?image=documentation/webinar/win.clone.gif

+++

Running DSpace

+++

A quick peek at the DSpace 6 compose files

+++?code=docker-compose-files/dspace-compose/docker-compose.yml&lang=yml Docker Compose File @[4-8](DSpace Database Image Name) @[19-21](DSpace Image Definition) @[24-27](Default Administrator Credentials) @[28](AIP Files to ingest on initial startup) +++?code=docker-compose-files/dspace-compose/d6.override.yml&lang=yml DSpace 6 Overrides @[5](Default DSpace 6 Image)

+++

Running DSpace 6

docker-compose -p d6 -f docker-compose.yml -f d6.override.yml up -d

+++?image=documentation/webinar/win.d6.start.gif

+++

Running a DSpace command line task

  • dspace version
  • dspace index-discovery
  • dspace filter-media
  • dspace oai import

+++?image=documentation/webinar/win.d6version.gif

+++

Test DSpace 6

+++?image=documentation/webinar/d6.web.gif

+++

Stop DSpace 6

docker-compose -p d6 -f docker-compose.yml -f d6.override.yml down

+++?image=documentation/webinar/win.d6.down.gif

+++

A quick peek at the DSpace 7 compose files

+++?code=docker-compose-files/dspace-compose/d7.override.yml&lang=yml DSpace 7 Overrides @[5](Default DSpace 7 Image) @[13-15](DSpace Angular Image) @[16-18](Ports for Angular) @[23-26](Location of the DSpace REST API)

+++

Running DSpace 7

docker-compose -p d7 -f docker-compose.yml -f d7.override.yml up -d

+++?image=documentation/webinar/win.d7.start.gif

+++

DSpace 7 REST API Back End

+++?image=documentation/webinar/d7.rest.gif

+++

Manually Index DSpace 7 content

docker exec dspace //dspace/bin/dspace index-discovery

+++

DSpace 7 Angular Front End

+++?image=documentation/webinar/d7.angular.gif

+++

Stopping DSpace 7

docker-compose -p d7 -f docker-compose.yml -f d7.override.yml down

+++?image=documentation/webinar/win.d7.down.gif

We need your help

  • Try it yourself, give us feedback on the documentation
    • Join the #dspace-docker Slack Channel
  • Help us assemble assets to distribute in AIP files

+++

  • Curating and Assembling AIP Resources
    • Public domain / restriction free
    • Real repository content (but not very large)
      • Small PDFs
      • Small image
    • Realistic metadata

Reference Links

Discussion

  • Could you imagine using this capability?
  • What would be needed to make this compelling for the repository manager community?

Feedback/Questions?

  • What ideas do you have?
  • What questions do you have?

Thank You

  • Terry Brady, Georgetown University Library
  • Pascal Becker, The Library Code

@size20px

http://bit.ly/docker4rm

Webinar Video