Skip to content

Commit 098a9e7

Browse files
committed
revamp neptune
1 parent 3523070 commit 098a9e7

File tree

2 files changed

+37
-32
lines changed

2 files changed

+37
-32
lines changed

src/content/docs/aws/capabilities/config/filesystem-layout.mdx renamed to src/content/docs/aws/capabilities/config/filesystem.mdx

File renamed without changes.

src/content/docs/aws/services/neptune.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: "Neptune"
3-
linkTitle: "Neptune"
4-
description: >
5-
Get started with Neptune on LocalStack
3+
description: Get started with Neptune on LocalStack
64
tags: ["Ultimate"]
75
---
86

@@ -13,7 +11,7 @@ It is designed for storing and querying highly connected data for applications t
1311
Neptune supports popular graph query languages like Gremlin and SPARQL, making it compatible with a wide range of graph applications and tools.
1412

1513
LocalStack allows you to use the Neptune APIs in your local environment to support both property graph and RDF graph models.
16-
The supported APIs are available on our [API coverage page]({{< ref "coverage_neptune" >}}), which provides information on the extent of Neptune's integration with LocalStack.
14+
The supported APIs are available on our [API coverage page](), which provides information on the extent of Neptune's integration with LocalStack.
1715

1816
The following versions of Neptune engine are supported by LocalStack:
1917

@@ -52,11 +50,11 @@ We will demonstrate the following with AWS CLI & Python:
5250
To create a Neptune cluster you can use the [`CreateDBCluster`](https://docs.aws.amazon.com/neptune/latest/userguide/api-clusters.html#CreateDBCluster) API.
5351
Run the following command to create a Neptune cluster:
5452

55-
{{< command >}}
56-
$ awslocal neptune create-db-cluster \
53+
```bash
54+
awslocal neptune create-db-cluster \
5755
--engine neptune \
5856
--db-cluster-identifier my-neptune-db
59-
{{< / command >}}
57+
```
6058

6159
You should see the following output:
6260

@@ -77,13 +75,13 @@ You should see the following output:
7775
To add an instance you can use the [`CreateDBInstance`](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#CreateDBInstance) API.
7876
Run the following command to create a Neptune instance:
7977

80-
{{< command >}}
81-
$ awslocal neptune create-db-instance \
78+
```bash
79+
awslocal neptune create-db-instance \
8280
--db-cluster-identifier my-neptune-db \
8381
--db-instance-identifier my-neptune-instance \
8482
--engine neptune \
8583
--db-instance-class db.t3.medium
86-
{{< / command >}}
84+
```
8785

8886
In LocalStack the `Endpoint` for the `DBCluster` and the `Endpoint.Address` of the `DBInstance` will be the same and can be used to connect to the graph database.
8987

@@ -159,37 +157,44 @@ When LocalStack starts with [IAM enforcement enabled]({{< ref "/user-guide/secur
159157

160158
Start LocalStack with `LOCALSTACK_ENFORCE_IAM=1` to create a Neptune cluster with IAM DB authentication enabled.
161159

162-
{{< command >}}
163-
$ LOCALSTACK_ENFORCE_IAM=1 localstack start
164-
{{< /command >}}
160+
```bash
161+
LOCALSTACK_ENFORCE_IAM=1 localstack start
162+
```
165163

166164
You can then create a cluster.
167165

168-
{{< command >}}
169-
$ awslocal neptune create-db-cluster \
166+
```bash
167+
awslocal neptune create-db-cluster \
170168
--engine neptune \
171169
--db-cluster-identifier myneptune-db \
172170
--enable-iam-database-authentication
173-
{{< /command >}}
171+
```
174172

175173
After the cluster is deployed, the Gremlin server will reject unsigned queries.
176174

177-
{{< command >}}
178-
$ curl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V()" -v
179-
<disable-copy>...
175+
```bash
176+
curl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V()" -v
177+
```
178+
179+
The output will be similar to the following:
180+
181+
```bash
180182
- Request completely sent off
181183
< HTTP/1.1 403 Forbidden
182184
- no chunk, no close, no size.
183185
Assume close to signal end
184186
...
185-
</disable-copy>
186-
{{< /command >}}
187+
```
187188

188189
Use the Python package [awscurl](https://pypi.org/project/awscurl/) to make your first signed query.
189190

190-
{{< command >}}
191-
$ awscurl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V().count()" -H "Accept: application/json" | jq .
192-
<disable-copy>
191+
```bash
192+
awscurl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V().count()" -H "Accept: application/json" | jq .
193+
```
194+
195+
The output will be similar to the following:
196+
197+
```json
193198
{
194199
"requestId": "729c3e7b-50b3-4df7-b0b6-d1123c4e81df",
195200
"status": {
@@ -216,16 +221,16 @@ $ awscurl "https://localhost.localstack.cloud:4510/gremlin?gremlin=g.V().count()
216221
}
217222
}
218223
}
219-
</disable-copy>
220-
{{< /command >}}
224+
```
221225

222-
{{< callout "note" >}}
226+
:::note
223227
If Gremlin Server is installed in your LocalStack environment, you must delete it and restart LocalStack.
224-
You can find your LocalStack volume location on the [LocalStack filesystem documentation]({{< ref "/references/filesystem/#localstack-volume" >}}).
225-
{{< command >}}
226-
$ rm -rf <LocalStack Volume>/lib/tinkerpop
227-
{{< /command >}}
228-
{{< /callout >}}
228+
You can find your LocalStack volume location on the [LocalStack filesystem documentation](/aws/capabilities/config/filesystem/#localstack-volume).
229+
230+
```bash
231+
rm -rf <LocalStack Volume>/lib/tinkerpop
232+
```
233+
:::
229234

230235
## Resource Browser
231236

0 commit comments

Comments
 (0)