d4s-vre-manager-setup/README.md

65 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2022-01-07 11:55:00 +01:00
# README #
### What is this repository for? ###
2022-01-07 11:57:41 +01:00
* Overview
This repository contains instructions to setup the D4S VRE Manager island
2022-01-07 11:55:00 +01:00
* Version
2022-01-07 11:57:41 +01:00
0.0.1
* Dependencies
This repository depends on D4S CDN (https://code-repo.d4science.org/gCubeSystem/d4s-cdn-setup.git).
2022-01-07 11:55:00 +01:00
### How do I get set up? ###
* Summary of set up
2022-01-07 11:57:41 +01:00
This repository contains all information to build a D4S VRE Manager image. Most importantly it contains the ansible instructions to deploy a swarm, CDN VRE manager island and PEP.
2022-01-07 11:55:00 +01:00
* Deployment instructions
2022-01-07 11:57:41 +01:00
There are 4 branches.
__main__ branch contains configurations to start a local instance useful for development. It is configured to use the D4SCience dev IAM.
__dev__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the DEV infrastructure.
2022-01-07 11:55:00 +01:00
2022-01-07 11:57:41 +01:00
__pre__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the PRE infrastructure.
__prod__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the PROD infrastructure.
In order to run a local site the following commands need to be executed:
```
git clone https://code-repo.d4science.org/gCubeSystem/d4s-vre-manager-setup.git
ansible-playbook site.yaml --ask-vault-pass
```
This will create a basic stack with an NGINX based PEP and base navigation service.
If you want to deploy on a specific D4S infrastructure please clone the corresponding branch.
```
git clone -b {infra} https://code-repo.d4science.org/gCubeSystem/d4s-vre-manager-setup.git
ansible-playbook site.yaml --ask-vault-pass
```
* Commit guidelines
DO NOT commit the following files:
conf/pep/config.js
conf/service/auth.js
They will be generated by the ansible based deployment procedure in order to inject the secrets.
2022-01-07 11:55:00 +01:00
### Who do I talk to? ###
* Repo owner or admin
2022-01-07 11:57:41 +01:00
Marco Lettere
marco.lettere@nubisware.com