Skip to content

Commit

Permalink
Add Dataverse as git submodule. Relates to #64.
Browse files Browse the repository at this point in the history
  • Loading branch information
poikilotherm committed Sep 13, 2019
1 parent b77000c commit f7c92df
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 9 deletions.
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "dataverse"]
path = dataverse
url = https://github.com/IQSS/dataverse
branch = develop
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ For quick and easy demo purposes, you can use one of the examples:
* [Usage with minimized k3s](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/k3s.md)
* [Deploy to an Amazon EC2 based custom K8s cluster](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/aws-kops.md)

For production usage, you should make yourself familiar with a series of
documentation articles, linked below:
A number of utilities have been added for your convienience:
have a look at [Little Helpers](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/little-helpers.md).

#### Production usage
You should make yourself familiar with a series of documentation articles, linked below:

* [Container images](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/images.md)
* [Detailed insight into inner workings](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/how-it-works.md)
Expand All @@ -45,8 +48,11 @@ Please be aware that this project currently only offers images and support
for basic usage. Integrations are not yet part of this, but may be added as needed.
See also relevant docs within Dataverse guides and upstream projects.

A number of utilities have been added for your convienience:
have a look at [Little Helpers](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/little-helpers.md).
#### Development usage
First, you will need to read up and get familiar with all of the above about production usage.
More details about usage for developing Dataverse below.

* TODO: Skaffold, Kind/K3s, Building, Kustomization

### Upgrading your installation

Expand Down
1 change: 1 addition & 0 deletions dataverse
Submodule dataverse added at 9f4160
26 changes: 21 additions & 5 deletions docs/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,33 @@ images to be used for the Dataverse deployment.
2. Derive those and push your customized image to a place you like.
3. Build the genuine images yourself and push to a registry of your choice.

## Building is easy
## Tooling

*Currently, only Docker is supported for image building.*

You might try to build with [Podman](https://podman.io) or [Buildah](https://buildah.io/), too.
This has the advantage of no need to run a Docker daemon, which might be easier
when using your custom CI.

## Production images

Simple with Docker after cloning and accessing the source folder:
```
cd $(git rev-parse --show-cdup)
docker build -t iqss/dataverse-k8s:4.15.1 -f docker/dataverse-k8s/glassfish/Dockerfile .
docker build -t iqss/solr-k8s:4.15.1 docker/solr-k8s
```
*Please remember to change the tag above as appropriate. You should be*
*using tagged images as best practice, not 'latest'.*

You might try to build with [Podman](https://podman.io) or [Buildah](https://buildah.io/), too.
This has the advantage of no need to run a Docker daemon, which might be easier
when using your custom CI.
## Development images

### Prepare Dataverse sources
For building images from any branch or commit of Dataverse, you need to have
it in your Docker build context. Easiest way to achieve this, after cloning the
K8s repo, run:

```
git submodule init
```

This will checkout the upstream Dataverse `develop` branch into `./dataverse`.

0 comments on commit f7c92df

Please sign in to comment.