DirectorySecurity Advisories
Sign In
Directory
prism logo

prism

Last changed

Create your Free Account

Be the first to hear about exciting product updates, critical vulnerability alerts, compare alternative images, and more.

Sign Up
Versions
Overview
Provenance
Specifications
SBOM
Vulnerabilities
Advisories

Chainguard Image for prism

Prism is a set of packages for API mocking and contract testing with OpenAPI v2 (formerly known as Swagger) and OpenAPI v3.x.

Chainguard Images are regularly-updated, minimal container images with low-to-zero CVEs.

Download this Image

This image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/prism:latest

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

Usage

Prism provides:

  • Mock Servers: Life-like mock servers from any API specification document.
  • Validation Proxy: Contract Testing for API consumers and developers.

If you want to start the mock server, you can run a command like this:

export SPEC_FILE="https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml"
docker run --init -p 4010:4010 cgr.dev/ORGANIZATION/prism:latest mock -h 0.0.0.0 $SPEC_FILE

If the document you want to mock is on your computer, you'll need to mount the directory where the file resides as a volume:

docker run --init --rm -v $(pwd):/tmp -p 4010:4010 cgr.dev/ORGANIZATION/prism:latest mock -h 0.0.0.0 "/tmp/file.yaml"

If you want to start the proxy server, you can run a command like this:

docker run --init --rm -d -p 4010:4010 -v $(pwd):/tmp -P cgr.dev/ORGANIZATION/prism:latest proxy -h 0.0.0.0 "/tmp/file.yml" http://host.docker.internal:8080 --errors

For example, creating a proxy server for the mock server would look like this:

export SPEC_FILE="https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml"

# create the mock server
docker run --init -p 4010:4010 cgr.dev/ORGANIZATION/prism:latest mock -h 0.0.0.0 $SPEC_FILE

# create the proxy server
docker run --init -p 3000:3000 -P cgr.dev/ORGANIZATION/prism:latest proxy -h 0.0.0.0 $SPEC_FILE http://localhost:4010 --errors

For more information on using prism, refer to the official docs.

Contact Support

If you have a Zendesk account (typically set up for you by your Customer Success Manager) you can reach out to Chainguard's Customer Success team through our Zendesk portal.

What are Chainguard Images?

Chainguard Images are a collection of container images designed for security and minimalism.

Many Chainguard Images are distroless; they contain only an open-source application and its runtime dependencies. These images do not even contain a shell or package manager. Chainguard Images are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a secure software supply chain.

The main features of Chainguard Images include:

-dev Variants

As mentioned previously, Chainguard’s distroless Images have no shell or package manager by default. This is great for security, but sometimes you need these things, especially in builder images. For those cases, most (but not all) Chainguard Images come paired with a -dev variant which does include a shell and package manager.

Although the -dev image variants have similar security features as their distroless versions, such as complete SBOMs and signatures, they feature additional software that is typically not necessary in production environments. The general recommendation is to use the -dev variants only to build the application and then copy all application artifacts into a distroless image, which will result in a final container image that has a minimal attack surface and won’t allow package installations or logins.

That being said, it’s worth noting that -dev variants of Chainguard Images are completely fine to run in production environments. After all, the -dev variants are still more secure than many popular container images based on fully-featured operating systems such as Debian and Ubuntu since they carry less software, follow a more frequent patch cadence, and offer attestations for what they include.

Learn More

To better understand how to work with Chainguard Images, we encourage you to visit Chainguard Academy, our documentation and education platform.

Licenses

Chainguard Images contain software packages that are direct or transitive dependencies. The following licenses were found in the "latest" version of this image:

  • Apache-2.0

  • GCC-exception-3.1

  • GPL-3.0-or-later

  • ISC

  • LGPL-2.1-or-later

  • MIT

  • MPL-2.0

For a complete list of licenses, please refer to this Image's SBOM.

Software license agreement

Category
application

Safe Source for Open Sourceâ„¢
Media KitContact Us
© 2024 Chainguard. All Rights Reserved.
Private PolicyTerms of Use

Product

Chainguard Images