Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mlibrary/aspace-containerization

Containerization of ArchivesSpace for Kubernetes deployment
https://github.com/mlibrary/aspace-containerization

archivesspace

Last synced: 4 months ago
JSON representation

Containerization of ArchivesSpace for Kubernetes deployment

Awesome Lists containing this project

README 

          
# aspace-containerization

Containerization of ArchivesSpace for Kubernetes deployment



## GitHub Workflows

| Workflow                  | YAML                         | Image       |

|---------------------------|------------------------------|-------------|

| Build app image           | build-app-image.yml          | aspace-app  |

| Build solr image          | build-solr-image.yml         | aspace-solr |

| Delete old workflow runs  | delete-old-workflow-runs.yml | n/a         |



## Running Locally

### Configure Environment

The images are configured through environment variables. The docker compose yaml file expects `.env` files to exist in the `app` and `db` directories. Copy the `env.example` file to `.env` in each of the directories.

```shell

cp ./app/env.example ./app/.env

cp ./db/env.example ./db/.env

```

### Build Images

```shell

docker-compose build --build-arg ASPACE_VERSION=v3.4.1

```

NOTE: `ASPACE_VERSION=latest` is the default but `v3.4.1` is known to work with this containerization a.k.a. newer versions of ArcivhesSpace may require changes to the Dockerfiles and/or configuration files.



### Launch Application

```shell

docker-compose up -d

```

The app container may initial exit because the db and/or solr wasn't responding fast enough (ye olde start up race condition).  If that happens just chill for a bit and then restart the app:

```shell

docker-compose restart app

```

  The first time it starts, the system will take a minute or so to start up. Once it is ready, confirm that ArchivesSpace is running correctly by accessing the following URLs in your browser:



| URL                                                                                                      | Service                                                  |

|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------|

| [http://localhost:8080/](http://localhost:8080/)                                                         | the staff interface                                      |

| [http://localhost:8081/](http://localhost:8081/)                                                         | the public interface                                     |

| [http://localhost:8082/](http://localhost:8082/)                                                         | the [OAI-PMH](https://www.openarchives.org/pmh/) server  |

| [http://localhost:8089/](http://localhost:8089/)                                                         | the backend                                              |

| [~~http://localhost:8090/~~](http://localhost:8090/)                                                     | ~~the internal Solr admin console~~                      |

| [http://localhost:8091/aspace-indexer/](http://localhost:8091/aspace-indexer/)                           | the indexer                                              |

| [http://localhost:8888/archivesspace/api/](http://localhost:8888/archivesspace/api/)                     | the API documentation                                    |

| [http://localhost:8983/solr/#/](http://localhost:8983/solr/#/)                                           | the external Solr admin console                          |



To start using the Staff interface application, log in using the adminstrator account:

* Username: admin

* Password: admin



Then, you can create a new repository by selecting “System” -> “Manage repositories” at the top right hand side of the screen. From the “System” menu, you can perform a variety of administrative tasks, such as creating and modifying user accounts. Be sure to change the “admin” user’s password at this time.

### List all environment variables

```shell

docker-compose exec -- app env

docker-compose exec -- db env

docker-compose exec -- solr env

```

### Bring it all down and up again

```shell

docker-compose down

docker-compose up -d

```

Since docker-compose.yml mapping app data, db data, and solr data to volumes data is not lost between the docker ups and downs. If you wish to start from a clean slate just bring down, remove the volumes, and bring it back up again.

```shell

docker-compose down

docker volume ls

docker volume prune --all

docker volume ls

docker-compose up -d

```

## Running other instances locally

The containerization work within this repository is designed to serve three stakeholder groups,

each of which require different plugins and configuration. To accomodate these differences,

we have created separate `Dockerfile`s -- all of which build upon the base `app/Dockerfile` -- and

configuration files to help properly set up these instances. These artifacts are located under

[`app/instances`](/app/instances/).



The separate instances can also be built and run locally using `instances.yaml`.

To build and run one of these versions, do the following:

1) Build the base `app` and `solr` images using `compose.yaml`, as described under **Build Images** above.

2) Build the service you want to run, e.g.

    ```sh

    docker compose -f instances.yaml build spcoll

    ```

3) Start up the `db`, `solr`, and stakeholder-specfic service. The latter is likely to fail because

  of ye-old race condition mentioned in **Launch Application**.

    ```sh

    docker compose -f instances.yaml up -d db solr spcoll

    ```

4) Re-start the stakeholder-specfic service.

    ```sh

    docker compose -f instances.yaml restart spcoll

    ```

Because the `instances.yaml` services depend on the `db` and `solr` services from `compose.yaml`,

you may need to clear out volumes if you've previously run the application using `compose.yaml`.

Note however that the stakeholder-specific services use their own log and data volumes.

```sh

docker compose -f instances.yaml down

docker volume prune --all

```



## Volumes

| Volume                             | Container | Mount               |

|------------------------------------|-----------|---------------------|

| aspace-containerization_app-data   | app       | /archivesspace/data |

| aspace-containerization_app-logs   | app       | /archivesspace/logs |

| aspace-containerization_db-data    | db        | /var/lib/mysql      |

| aspace-containerization_solr-data  | solr      | /var/solr           |

## [ArchivesSpace technical documentation](https://archivesspace.github.io/tech-docs/)

Highlights

* [Configuring ArchivesSpace](https://archivesspace.github.io/tech-docs/customization/configuration.html)

* [Serving ArchivesSpace over subdomains](https://archivesspace.github.io/tech-docs/provisioning/domains.html)

* [Running ArchivesSpace under a prefix](https://archivesspace.github.io/tech-docs/provisioning/prefix.html)

* [Serving ArchivesSpace user-facing applications over HTTPS](https://archivesspace.github.io/tech-docs/provisioning/https.html)

* [Application monitoring with New Relic](https://archivesspace.github.io/tech-docs/provisioning/newrelic.html)

## [Hello World Plug-in](https://github.com/archivesspace/archivesspace/blob/82c4603fe22bf0fd06043974478d4caf26e1c646/plugins/hello_world/README.md)