Skip to content

Commit 8d0043c

Browse files
committed
Add env setups for gds_plugin deployment
1 parent c43090c commit 8d0043c

File tree

3 files changed

+57
-0
lines changed

3 files changed

+57
-0
lines changed

scripts/test_envs/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Test environments
2+
3+
Each folder represents an environemnt to test the python client against.
4+
5+
## Requirements
6+
7+
* You should be able to run a compose.yaml file (such as through `docker compose`)
8+
* For gds_plugin_enterprise, you need to modify the compose file to find a license under `$HOME/.gds_license`
9+
10+
## Workflow
11+
12+
1. Switch to the env folder you like to use -- `cd gds_plugin_community``
13+
2. Start the environment using `docker compose up -d`
14+
3. Run your tests such as `pytest graphdatascience/tests/integration` (best in a different shell)
15+
4. Scale down environment using `docker compose kill` from the env folder
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
services:
2+
neo4j:
3+
image: neo4j:latest
4+
environment:
5+
- NEO4J_AUTH=none
6+
- NEO4J_PLUGINS=["graph-data-science"]
7+
- NEO4J_dbms_security_procedures_allowlist=gds.*
8+
- NEO4J_dbms_security_procedures_unrestricted=gds.*
9+
ports:
10+
- "7474:7474"
11+
- "7687:7687"
12+
restart: always
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
services:
2+
neo4j:
3+
image: neo4j:enterprise
4+
volumes:
5+
- ${HOME}/.gds_license:/licenses/.gds_license
6+
environment:
7+
- NEO4J_ACCEPT_LICENSE_AGREEMENT=yes
8+
- NEO4J_AUTH=none
9+
- NEO4J_PLUGINS=["graph-data-science"]
10+
- NEO4J_dbms_security_procedures_allowlist=gds.*
11+
- NEO4J_dbms_security_procedures_unrestricted=gds.*
12+
- NEO4J_gds_enterprise_license__file=/licenses/.gds_license
13+
- NEO4J_gds_arrow_enabled=true
14+
- NEO4J_gds_export_location=/tmp/gds_graphs
15+
- NEO4J_gds_model_store__location=/tmp/gds_models
16+
17+
# should only be used for testing
18+
- NEO4J_gds_arrow_advertised__listen__address=0.0.0.0:8491
19+
- NEO4J_gds_arrow_listen__address=0.0.0.0:8491
20+
21+
- NEO4J_server_metrics_prometheus_enabled=true
22+
- NEO4J_server_metrics_prometheus_endpoint=0.0.0.0:2004
23+
- NEO4J_server_metrics_filter=*
24+
- NEO4J_server_metrics_enabled=true
25+
ports:
26+
- "7474:7474"
27+
- "7687:7687"
28+
- "8491:8491"
29+
- "2004:2004"
30+
restart: always

0 commit comments

Comments
 (0)