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
Removed the section where we installed apoc with the env ["apoc"]. This
is not needed if we are just pointing to the file in labs.
---------
Co-authored-by: Reneta Popova <[email protected]>
Copy file name to clipboardExpand all lines: modules/ROOT/pages/kubernetes/plugins.adoc
+78-88Lines changed: 78 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,88 +1,5 @@
1
1
= Plugins
2
2
3
-
[[operations-using-apoc-core]]
4
-
== Configure and install APOC core only
5
-
6
-
APOC core is shipped with Neo4j, but it is not installed in the Neo4j _plugins_ directory.
7
-
If APOC core is the _only_ plugin that you want to add to Neo4j, it is not necessary to perform plugin installation as described in xref:kubernetes/configuration.adoc#operations-installing-plugins[Install Plugins].
8
-
Instead, you can configure the helm deployment to use APOC core by upgrading the deployment with these additional settings in the _values.yaml_ file:
9
-
10
-
. Configure APOC core by loading and unresticting the functions and procedures you need (for more details see link:{neo4j-docs-base-uri}/apoc/{page-version}/installation/#restricted[APOC installation guide]).
. After the Helm upgrade rollout is complete, verify that APOC core has been configured by running the following Cypher query using `cypher-shell` or Neo4j Browser:
48
-
+
49
-
[source, cypher]
50
-
----
51
-
RETURN apoc.version()
52
-
----
53
-
54
-
== Configure credentials for plugin's aliases using APOC-extended
55
-
56
-
From 5.11, the Neo4j Helm chart supports configuring credentials for the plugin's aliases using a Kubernetes secret mounted on the provided path.
57
-
This feature is available `apoc.jdbc.<aliasname>.url` and `apoc.es.<aliasname>.url` via
58
-
APOC-extended.
59
-
60
-
[NOTE]
61
-
====
62
-
The secret must be created beforehand and must contain the key-named `URL`, otherwise, the Helm chart throws an error. For example:
Under `apoc_credentials`, configure `aliasName`, `secretName`, and `secretMountPath`.
67
-
For example:
68
-
69
-
[source, yaml]
70
-
----
71
-
apoc_credentials: {}
72
-
# jdbc:
73
-
# aliasName: "jdbc"
74
-
# secretName: "jdbcsecret"
75
-
# secretMountPath: "/secret/jdbcCred"
76
-
#
77
-
# elasticsearch:
78
-
# aliasName: "es"
79
-
# secretName: "essecret"
80
-
# secretMountPath: "/secret/esCred"
81
-
----
82
-
83
-
[[operations-installing-plugins]]
84
-
== Install Plugins
85
-
86
3
There are three recommended methods for adding Neo4j plugins to Neo4j Helm chart deployments.
87
4
You can use:
88
5
@@ -91,12 +8,12 @@ You can use:
91
8
* <<plugins-volume, a `plugins` volume>>.
92
9
93
10
[[automatic-plugin-download]]
94
-
=== Add plugins using an automatic plugin download
11
+
== Add plugins using an automatic plugin download
95
12
96
13
You can configure the Neo4j deployment to automatically download and install plugins.
97
14
If licenses are required for the plugins, you must provide the licenses in a secret.
98
15
99
-
==== Install GDS Community Edition (CE)
16
+
=== Install GDS Community Edition (CE)
100
17
101
18
GDS Community Edition does not require a license.
102
19
To add the GDS CE, configure the Neo4j _values.yaml_ and set the `env` to download the plugins:
@@ -116,7 +33,7 @@ config:
116
33
dbms.security.procedures.unrestricted: "gds.*"
117
34
----
118
35
119
-
==== Install GDS Enterprise Edition (EE) and Bloom plugins
36
+
=== Install GDS Enterprise Edition (EE) and Bloom plugins
120
37
121
38
To install GDS EE and Bloom, you must provide a license for each plugin.
122
39
You provide the licenses in a Kubernetes secret.
@@ -160,7 +77,7 @@ config:
160
77
----
161
78
162
79
[[custom-container]]
163
-
=== Add plugins using a custom container image
80
+
== Add plugins using a custom container image
164
81
165
82
The best method for adding plugins to Neo4j running in Kubernetes is to create a new Docker container image that contains both Neo4j and the Neo4j plugins.
166
83
This way, you can ensure when building the container that the correct plugin version for the Neo4j version of the container is used and that the resulting image encapsulates all Neo4j runtime dependencies.
@@ -211,7 +128,7 @@ Strict config validation can be disabled by setting `server.config.strict_valida
211
128
====
212
129
213
130
[[plugins-volume]]
214
-
=== Add plugins using a plugins volume
131
+
== Add plugins using a plugins volume
215
132
216
133
An alternative method for adding Neo4j plugins to a Neo4j Helm deployment uses a `plugins` volume mount.
217
134
With this method, the plugin jar files are stored on a Persistent Volume that is mounted to the `/plugins` directory of the Neo4j container.
APOC core library is shipped with Neo4j and is located in the _labs_ folder.
189
+
190
+
If APOC core is the _only_ plugin that you want to add to Neo4j, it is not necessary to perform plugin installation as described above.
191
+
Instead, you can configure the helm deployment to use APOC core by upgrading the deployment with these additional settings in the _values.yaml_ file:
192
+
193
+
. Configure APOC core by directly pointing to the location of the APOC core library in the _labs_ folder and by loading and unrestricting the functions and procedures you need (for more details see link:{neo4j-docs-base-uri}/apoc/{page-version}/installation/#restricted[APOC installation guide]).
. After the Helm upgrade rollout is complete, verify that APOC core has been configured by running the following Cypher query using `cypher-shell` or Neo4j Browser:
223
+
+
224
+
[source, cypher]
225
+
----
226
+
RETURN apoc.version()
227
+
----
228
+
229
+
== Configure credentials for the plugin's aliases using APOC-extended
230
+
231
+
From 5.11, the Neo4j Helm chart supports configuring credentials for the plugin's aliases using a Kubernetes secret mounted on the provided path.
232
+
This feature is available `apoc.jdbc.<aliasname>.url` and `apoc.es.<aliasname>.url` via
233
+
APOC-extended.
234
+
235
+
[NOTE]
236
+
====
237
+
The secret must be created beforehand and must contain the key-named `URL`, otherwise, the Helm chart throws an error. For example:
0 commit comments