Passport onboard guide

This guide walks you through setting up Passport: deploying the Passport Proxy, configuring a namespace in Passport Cloud, and installing the Passport CLI. Each section links to a full walkthrough.

Passport has the following components:

Prerequisites

Make sure you have the following:

• macOS or Linux
• Docker, Kubernetes, and Helm installed and configured
• Familiarity with YAML and private container registries

Passport Proxy

The Passport Proxy runs in your Kubernetes environment, proxying and logging API traffic. Its image and Helm chart come from the Passport registry, and you configure the values file that controls how it’s deployed.

For the full walkthrough — generating a registry credential, pulling the image and chart, configuring values.yaml, and deploying with Helm — see Deploy the Passport Proxy.

Passport app

The Passport app on Passport Cloud is where you create your account, register the proxy, set up a namespace and its resources, and invite your team. Namespaces enable secret reference issuance and revocation, and map API endpoints to resources. The proxy keeps logging traffic without them.

1. Create a Passport account.
2. Register the Passport Proxy you deployed earlier.
3. Create a namespace and add resources to it.
4. Invite team members.

Passport CLI

The CLI installs on your machine and runs the developer-side daemons that route your requests through the proxy.

To learn how to install and set up the CLI, see Connect to the Passport Proxy. Once it’s running, you can issue and resolve secret references.

Next steps

Once your team can access the namespace, Members can request access to an API.

For the complete lifecycle — from setup through requesting, calling, and revoking API access — see End-to-end flow.