You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ this repository is purely experimental!
11
11
12
12
## What is the registry component?
13
13
The Delphi registry is a server that provides access to all information and operations needed to set up, run and manage the Delphi system. By default, the REST interface is exposed at *0.0.0.0:8087*, and contains endpoints for:
14
+
14
15
* Retrieving a list of all instances of a certain type (Crawler, WebApi, WebApp, ElasticSearch)
15
16
* Retrieving the whole network graph (all instances and links between instances)
16
17
* Deploying new instances of a certain type to a docker host
@@ -37,16 +38,32 @@ For Linux users, checkout Delphi Registry repository and execute the command
37
38
```
38
39
sudo bash ./Delphi_install.sh
39
40
```
40
-
inside the registry's root directory. This installation script will create the required repositories, build the docker images, and register them directly at the local docker registry.
41
+
inside the ```/Setup```directory. This installation script will create the required repositories, build the docker images, and register them directly at the local docker registry.
41
42
The registry requires an initial instance of ElasticSearch to be running.
42
43
44
+
To allow access to Delphi components deployed via Docker, the registry supports the reverse-proxy [Traefik](https://traefik.io/). While it is running, it will automatically detected containers deployed by the registry, and provide access to them using the host specified in each instances' ```Host``` attribute.
45
+
Windows users can install Traefik (using Docker) based on [this tutorial](https://docs.traefik.io/#the-traefik-quickstart-using-docker). For Linux users, Traefik will be installed and started by the installation script mentioned above.
46
+
47
+
**Note:** Traefik must be running inside the same Docker network as the containers it is associated with. By default the name for this network is expected to be ```delphi```. Windows users have to manually create it using ```docker network create delphi``` before starting Traefik. If you want to change this network name, please follow these steps:
48
+
49
+
1. Go to ```docker-compose.yml``` file (for Windows: Create during tutorial; for Linux found in ```/Setup```)
50
+
51
+
2. Change the item *services->traefik->networks* to your new network name
52
+
53
+
3. Change the item *networks->delphi->external:true* to *networks->your-network-name->external:true*. Save and close the file
54
+
55
+
4. Change the ````traefikDockerNetwork`` setting in the configuration file to your new network name (see section below for details)
56
+
43
57
## Adapt the configuration file
44
58
Before you can start the application, you have to make sure your configuration file contains valid data. The file can be found at *src/main/scala/de/upb/cs/swt/delphi/instanceregistry/Configuration.scala*, and most of its attributes are string or integer values. The following table describes the attributes in more detail.
45
59
46
60
|Attribute | Type | Default Value |Explanation |
47
61
| :---: | :---: | :---: | :--- |
48
62
|```bindHost```|```String```|```"0.0.0.0"```| Host address that the registry server should be bound to |
49
63
|```bindPort```|```Int```|```8087```| Port that the registry server should be reachable at |
64
+
|```traefikBaseHost```|```String```|```"delphi.de"```| The host part of the URL that traefik is configured to append to instance URLs. |
65
+
|```traefikDockerNetwork```|```String```|```"delphi"```| The Docker network Traefik is configured to use. |
66
+
|```traefikUri```|```String```|```"http://172.17.0.1:80"```| The URI that the Traefik reverse-proxy is hosted at.|
50
67
|```defaultCrawlerPort```|```Int```|```8882```| Port that Delphi Crawlers are reachable at. This may only be adapted if you manually changed the default port of crawlers before registering the respective image. |
51
68
|```defaultWebApiPort```|```Int```|```8080```| Port that Delphi WebAPIs are reachable at. This may only be adapted if you manually changed the default port of WebAPIs before registering the respective image. |
52
69
|```defaultWebAppPort```|```Int```|```8085```| Port that Delphi WebApps are reachable at. This may only be adapted if you manually changed the default port of WebApps before registering the respective image. |
@@ -58,7 +75,7 @@ Before you can start the application, you have to make sure your configuration f
58
75
|```uriInLocalNetwork```|```String```|```"http://172.17.0.1:8087"```| URI that the registry is reachable at for all docker containers. In most of the use-cases this is going to be the gateway of the default docker bridge.<br>**Note:** For OSX you have to set this value to the DNS name of the docker host, which is ```http://host.docker.internal:8087``` (If the registry is running on the host).|
59
76
|```maxLabelLength```|```Int```|```50```| Maximum number of characters for instance labels. Longer labels will be rejected.|
60
77
|```dockerOperationTimeout```|```Timeout```|```Timeout(20 seconds)```| Default timeout for docker operations. If any of the async Docker operations (deploy, stop, pause, ..) takes longer than this, it will be aborted.|
61
-
|```defaultDockerUri```|```String```|```http://localhost:9095```| Default uri to connect to docker. It will be used if the environment variable ```DELPHI_DOCKER_HOST``` is not specified.|
78
+
|```dockerUri```|```String```|```http://localhost:9095```| Default uri to connect to docker. It will be used if the environment variable ```DELPHI_DOCKER_HOST``` is not specified.|
62
79
|```jwtSecretKey```|```String```|```changeme```| Secret key to use for JWT signature (HS256). This setting can be overridden by specifying the ```JWT_SECRET``` environment variable.|
63
80
|```useInMemoryInstanceDB```|```Boolean```|```true```| If set to true, all instance data will be kept in memory instead of using a MySQL database.|
64
81
|```instanceDatabaseHost```|```String```|```"jdbc:mysql://localhost/"```| Host that the MySQL instance database is reachable at (only necessary if *useInMemoryInstanceDB* is false).|
0 commit comments