gremlin-server

packaged by Chainguard

Chainguard Container for gremlin-server

Gremlin Server is the server component of Apache TinkerPop that answers Gremlin graph traversal queries over WebSocket and HTTP.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/gremlin-server:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is comparable to the upstream tinkerpop/gremlin-server image and can be used as a drop-in replacement.

Getting Started

Start Gremlin Server with the default configuration, publishing the WebSocket port 8182:

docker run -d --name gremlin-server -p 8182:8182 cgr.dev/ORGANIZATION/gremlin-server:latest

The server is ready once it logs that the channel has started:

docker logs gremlin-server

[INFO] o.a.t.g.s.GremlinServer - Channel started at port 8182.

The default configuration binds an empty in-memory TinkerGraph to the traversal source g, so you can connect a client and begin issuing traversals immediately. The following example uses the gremlinpython driver to connect over WebSocket, add a vertex, and read it back:

from gremlin_python.driver.driver_remote_connection import DriverRemoteConnection
from gremlin_python.process.anonymous_traversal import traversal

g = traversal().with_remote(
    DriverRemoteConnection("ws://localhost:8182/gremlin", "g"))

g.add_v("person").property("name", "chainguard").next()
print(g.V().has("name", "chainguard").values("name").next())

chainguard

You can also connect interactively with the Gremlin Console, pointing its conf/remote.yaml at the server's host and port 8182.

Configuration

Gremlin Server is configured through a YAML file passed as the command argument. To use a configuration other than the default, override the command. For example, conf/gremlin-server-rest-modern.yaml enables the HTTP channelizer and preloads the sample "modern" graph, which lets you submit scripts over plain HTTP:

docker run -d --name gremlin-server -p 8182:8182 \
  cgr.dev/ORGANIZATION/gremlin-server:latest \
  conf/gremlin-server-rest-modern.yaml

With the HTTP channelizer enabled, submit a traversal with a POST request:

curl -XPOST -H "Content-Type: application/json" \
  -d '{"gremlin":"g.V().count()"}' \
  http://localhost:8182

{"requestId":"...","status":{"message":"","code":200},"result":{"data":[6],"meta":{}}}

To supply your own configuration, mount it into the container and pass its path as the argument. Gremlin Server ships several example configurations under conf/. Note that the container entrypoint rewrites the host: line of the chosen configuration to the container's address before starting the server, so the listener is reachable from other containers and pods.

Documentation and Resources

• Apache TinkerPop Documentation
• Gremlin Server Reference
• Connecting Gremlin Language Variants

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.