Skip to content

Commit b523197

Browse files
author
Pablo Panero
committed
global: structure initialization and wiki migration
0 parents  commit b523197

23 files changed

+1022
-0
lines changed

‎.travis.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Copyright (C) 2019 CERN.
4+
# Copyright (C) 2019 Northwestern University.
5+
#
6+
# Invenio-Cli is free software; you can redistribute it and/or modify it
7+
# under the terms of the MIT License; see LICENSE file for more details.
8+
9+
notifications:
10+
email: false
11+
12+
sudo: true
13+
14+
language: python
15+
16+
python:
17+
- "3.6"
18+
19+
services:
20+
- docker
21+
22+
before_script:
23+
- gem install awesome_bot
24+
25+
script:
26+
- ./run-tests.sh

‎LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
Copyright (C) 2019 CERN.
4+
Copyright (C) 2019 Northwestern University.
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of
7+
this software and associated documentation files (the "Software"), to deal in
8+
the Software without restriction, including without limitation the rights to
9+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10+
of the Software, and to permit persons to whom the Software is furnished to do
11+
so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.
23+

‎README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# docs.reana.io
2+
3+
[![Travis Build Status](https://img.shields.io/travis/inveniosoftware/docs-invenio-rdm.svg)](https://travis-ci.org/inveniosoftware/docs-invenio-rdm.svg) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/inveniosoftware/InvenioRDM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![License](https://img.shields.io/github/license/inveniosoftware/InvenioRDM.svg)](https://github.com/inveniosoftware/docs-invenio-rdm/blob/master/LICENSE)
4+
5+
## About
6+
7+
InvenioRDM user documentation web site.
8+
9+
## Running
10+
11+
```console
12+
$ mkvirtualenv docs-invenio-rdm
13+
$ pip install -r requirements.txt
14+
$ mkdocs serve
15+
$ firefox http://127.0.0.1:8000
16+
```
17+

‎docs/deployment/kubernetes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Kubernetes

‎docs/deployment/openshit.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# OpenShift

‎docs/images/favicon.ico

1.23 KB
Binary file not shown.

‎docs/images/favicon.svg

Lines changed: 37 additions & 0 deletions
Loading

‎docs/images/logo-rdm.png

13.4 KB
Loading

‎docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Home

‎docs/quickstart/build_setup.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Build and Setup
2+
3+
## Deploy your instance
4+
5+
The CLI supports two deployment modes: local development and containerized *semi*-production. This document will focus on deploying a containerized *semi*-production instance (we will use the `--containers` flag throughout). To deploy for local development, replace that flag by `--local`.
6+
7+
Before going on, let's move into the project directory:
8+
9+
``` console
10+
$ cd december-release
11+
```
12+
13+
**Known issues**:
14+
15+
- If you do not move into the correct directory you will get an error like this:
16+
```
17+
ERROR:root:No flavour specified.
18+
```
19+
20+
The error message is not intuitive: it is not because no flavour was specified that there is an error! We will change it. It just means that the folder does not contain the `.invenio` config file because the current directory is wrong: *cd into it :-)*.
21+
22+
### Build the docker images
23+
24+
We use the `build` command with the `--containers` flag to build the images specified in the `december-release/docker-compose.full.yml`.
25+
In addition, we need to add ``--pre`` in order to allow `pipenv` to install alpha releases, since many InvenioRDM packages are now in this phase. Be patient, the docker images might take some time to build.
26+
27+
``` console
28+
(your-virtualenv)$ invenio-cli build --pre --containers
29+
Building RDM application...
30+
Locking dependencies...
31+
Bootstrapping server...
32+
Building base docker image...
33+
Building applications docker image...
34+
Creating services...
35+
```
36+
37+
As a result, six images (December-Release, Nginx, Redis, PostgreSQL, RabbitMQ and Elasticsearch) have been built.
38+
39+
### Setup the DB, ES and others
40+
41+
We just need to initialize the database, the indices and so on. For this, we can use the `setup` command. Note that this command is only needed once. Afterwards, you can stop (not destroy) your instance and start again, and your data will still be there.
42+
43+
``` console
44+
(your-virtualenv)$ invenio-cli setup --containers
45+
Setting up environment for RDM application...
46+
Setting up server...
47+
Starting containers...
48+
Creating database...
49+
Creating indexes...
50+
Creating files location...
51+
Creating admin role...
52+
Assigning superuser access to admin role...
53+
Stopping containers...
54+
```
55+
56+
In case you want to wipe out the data that was there (say to start fresh), you can use `--force` and nuke the content!
57+
58+
``` console
59+
(your-virtualenv)$ invenio-cli setup --containers --force
60+
Setting up environment for RDM application...
61+
Setting up server...
62+
Starting containers...
63+
Flushing redis cache...
64+
Deleting database...
65+
Deleting indexes...
66+
Purging queues...
67+
Creating database...
68+
Creating indexes...
69+
Creating files location...
70+
Creating admin role...
71+
Assigning superuser access to admin role...
72+
Stopping containers...
73+
```
74+
75+
### Populate DB
76+
77+
Let's add some content so you can interact a bit with the instance. For this you will generate 10 random demo records, using the `demo` command:
78+
79+
``` console
80+
(your-virtualenv)$ invenio-cli demo --containers
81+
Setting up server...
82+
Starting containers...
83+
Populating instance with demo records...
84+
```

0 commit comments

Comments
 (0)