Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 3.67 KB

README.md

File metadata and controls

72 lines (45 loc) · 3.67 KB
Raw

Evaluation Tasks

After you have installed the prerequisite software, started, and verified that the milestone is up, it is time to perform the evaluation tasks!

  1. Resources and URIs
  2. Service Documents
  3. Interacting with Exposed Services
  4. Loading Extensions
  5. Ontologies and Binding

The tasks do not have to be done linearly, and they do not have to be done all at once. Take your time, and feel free to stop the milestone at any time, and restart it later when you're ready to perform more tasks.

Running the evaluation

The getting started documentation will get the demo running. This section describes things to keep in mind while running the demo

Starting, stopping, cleaning

The demo can be started by

docker-compose up -d

Stopping the containers shuts down all services, but keeps data on disk. Once the demo has been stopped, it can be started at any time in order to resume where you left off

# to stop
docker-compose stop

# to start/resume
docker-compose up -d

You can also completely destroy all containers including persisted data (e.g. Fedora objects created by these exercises) by:

# Destroy/clean
docker-compose down

# Start a new environment from scratch
docker-compose up -d

Updating demo images

The API-X docker images are hosted on dockerhub, here. Docker-compose downloads these images in order to start the docker containers, and also has the ability to update/patch the local images whenever the hosted images are updated. Any bugs found and fixed in the demo will be pushed to dockerhub. It's a good idea to periodically check for updates by doing:

docker-compose pull

It will let you know if it pulls in any updates to images. If so, you can simply re-start docker-compose to update the relevant images. All demo-related data will be preserved (i.e. if you added or modified Fedora objects, they'll still be there when you update). Do this by

docker-compose up -d

Non-default URIs and ports

As mentioned in the alternate ports and verification sections, users may have modified their environment (the .env file) for a couple of reasons:

  • You are a docker-machine user, and have modified the PUBLIC_REPOSITORY_BASEURI to point to the IP address of your docker machine
  • You have a port conflict, and have modified one or more API-X-related services to use a different port.

It is important to remember as you go through the exercises that you may need to modify the bold localhost URIs, especially if you have modified your PUBLIC_REPOSITORY_BASEURI or PUBLIC_REPOSITORY_PORT.

For example, if you have modified your PUBLIC_REPOSITORY_BASEURI and PUBLIC_REPOSITORY_PORT to http://192.168.99.100:10000/fcrepo/rest and 10000, respectively, you must replace this

http://localhost/fcrepo/rest/path/to/object

with

http://192.168.99.100:10000/fcrepo/rest/path/to/object

To that end, each exercise carries the following reminder at the top of the page:

Please remember: The instructions below use the default URLs and ports found in the environment file
If you have modified the environment file, you must be sure to substitute the correct URL and port in the instructions below.