Skip to navigation

Install the Passport Proxy

Install the Passport Proxy with Helm, confirm that it’s running, and note the values you need to register it in Passport. This page assumes you’ve configured the proxy, including creating the passport Kubernetes namespace and the passport-keys Secret.

Install the chart

Installing the proxy means that Helm creates the Kubernetes resources that run it in your cluster. In the passport Kubernetes namespace that you created, the chart creates the following resources:

  • Deployment — Runs the proxy as pods, two by default. The pods read their settings from your values.yaml and their keys from the passport-keys Secret.
  • Services — Expose the proxy’s data and management endpoints.
  • Ingress — Exposes the setup routes of the management URL. Helm creates it only if you set up the management URL.

To install the chart, use the following command:

helm install passport \
oci://ociregistry.usepassport.ai/passport/passport \
--version 0.6.0 -n passport -f values.yaml

The passport after helm install is the name of this installation, which Helm calls a release. Helm names the deployment after the release and the chart, so the deployment is passport-passport.

Confirm the proxy is running

Helm finishes the install as soon as it submits the proxy’s resources, so it doesn’t tell you whether the proxy started. Confirm the proxy is running:

kubectl -n passport rollout status deploy/passport-passport
kubectl -n passport get pods

The pods should show 1/1 Running. If a pod doesn’t reach that state, check its logs with kubectl -n passport logs deploy/passport-passport. If the pod status is ImagePullBackOff, check the image name and the passport-registry pull secret.

The proxy values

After installation, note the following values. You’ll need them when registering the proxy in Passport. If you deploy the Passport CLI with mobile device management, the proxy and management host are also the ProxyURL and ManagementURL values in its configuration profile.

ItemValueWhat it’s for
Proxy<proxy_url>:8443The address your members’ machines send API traffic to.
Management Host<management_url>The HTTPS address your members’ machines use to get certificates. It’s the hostname you set in proxy.managementHost.
Console<management_url>/consoleWhere you view logged API traffic, if you’ve turned on the Console.
Console credentialsConfigured in values.yamlThe sign-in for the Console, if you’ve turned it on.
Public keyThe contents of reference-public-key.pemYou enter it when you register the proxy.

API traffic logging

The proxy logs API traffic in OpenTelemetry (OTEL) format. Passport namespaces aren’t required for logging. Traffic is logged once the proxy is running. If you’ve turned on the Console, you can view logged traffic at <management_url>/console.

With the audit.sink: stdout setting from the example, the proxy also writes audit events to the pod logs. To read them, use kubectl -n passport logs deploy/passport-passport.

You can export those OTEL logs and use them as a source when adding resources to a Passport namespace to identify the APIs being accessed.

Next steps

After the proxy is running, register it in Passport so your team can use it.