npm - zuplo - Versions diffs - 7.12.6 → 7.12.7 - Mend

zuplo 7.12.6 → 7.12.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (579) hide show

package/docs/articles/non-standard-ports.mdx CHANGED Viewed

@@ -6,6 +6,9 @@ description:
 tags:
   - deployment
   - request-handling
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo supports making requests to non-standard ports when your runtime is

package/docs/articles/oauth-authentication.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: OAuth Authentication
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo comes with build-in and extensible OAuth policies out of the box. These

package/docs/articles/openapi-server-urls.mdx CHANGED Viewed

@@ -7,6 +7,18 @@ description:
 tags:
   - openapi
   - deployment
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Environment URLs use your instance's domain, such as
+      `*.your-account.zuplo.work` for preview environments, instead of
+      `zuplo.app`. See [Managed Dedicated: Custom
+      Domains](../dedicated/custom-domains.mdx).
+    self-hosted: >-
+      Environment URLs use the deployment subdomain you configure for your
+      cluster instead of `zuplo.app`. See [Install](../self-hosted/install.md).
 ---
 When working with OpenAPI specifications in Zuplo, it's important to understand

package/docs/articles/openapi-string-format-validation-warnings.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ tags:
   - openapi
   - local-development
   - validation
+applies_to:
+  product: gateway
+  hosting: all
 ---
 When you run a Zuplo project locally with `npm run dev` (or `zuplo dev`), the

package/docs/articles/openapi.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: OpenAPI Support in Zuplo
 sidebar_label: OpenAPI
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo natively supports the OpenAPI 3.1 (and is compatible with 3.0)

package/docs/articles/opentelemetry.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Zuplo OpenTelemetry
 sidebar_label: OpenTelemetry
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo ships with an OpenTelemetry plugin (`@zuplo/otel`) that instruments your

package/docs/articles/performance-testing.mdx CHANGED Viewed

@@ -1,6 +1,15 @@
 ---
 title: Performance Testing Your Gateway
 sidebar_label: Performance Testing
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of at
+      the edge, and cold starts don't apply.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of at the edge.
 ---
 <!-- vale Vale.Spelling["Blazemeter","JMeter","wrk"] = NO -->

package/docs/articles/plugin-akamai-api-security.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Akamai API Security (AKA NONAME) plugin
 sidebar_label: Akamai API Security
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This plugin pushes request/response data to Akamai API Security, formerly known

package/docs/articles/plugin-azure-blob.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Azure Blob Plugin
 sidebar_label: Azure Blob
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This plugin pushes request/response logs to Azure Blob Storage. This can be used

package/docs/articles/plugin-azure-event-hubs.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Azure Event Hubs Request Logger Plugin
 sidebar_label: Azure Event Hubs
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This plugin pushes request/response logs to Azure Event Hubs. This can be used

package/docs/articles/plugin-hydrolix-traffic-peak.mdx CHANGED Viewed

@@ -1,6 +1,18 @@
 ---
 title: Hydrolix / Akamai Traffic Peak Plugin
 sidebar_label: Hydrolix / Traffic Peak
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Geolocation data, such as country, region, and `colo`, comes from your
+      instance's hosting environment. It's usually available, but which fields
+      are populated can vary.
+    self-hosted: >-
+      Geolocation data, such as country, region, and `colo`, comes from the
+      environment your cluster runs in. It's usually available, but which fields
+      are populated can vary.
 ---
 This plugin pushes request/response logs to Hydrolix AKA Akamai Traffic Peak.

package/docs/articles/policies.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Policy Fundamentals
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Policies are modules that can intercept an incoming request or outgoing

package/docs/articles/rename-or-move-project.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: How to rename or move a project
 sidebar_label: Rename/Move Project
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Projects can't be moved between accounts or renamed in Zuplo but there is an

package/docs/articles/rick-and-morty-api-developer-portal-example.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - dev-portal
   - openapi
+applies_to:
+  product: developer-portal
+  hosting: all
 ---
 This is an example API proxied via Zuplo - these docs are generated based on the

package/docs/articles/routing.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Zuplo Routing
 sidebar_label: Routing
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo's routing system is designed to be simple and powerful, allowing you to

package/docs/articles/s3-signed-url-uploads.mdx CHANGED Viewed

@@ -7,6 +7,14 @@ description:
 tags:
   - integrations
   - backends
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Request body size limits can be customized for your instance, so you can
+      raise the limit instead of uploading through signed URLs. Contact your
+      account team.
 ---
 Zuplo's managed edge deployment has a 500MB request body size limit. For

package/docs/articles/secure-tunnel.mdx CHANGED Viewed

@@ -1,6 +1,18 @@
 ---
 title: Secure Tunnel
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Tunnels work on Managed Dedicated, but most teams connect to private
+      backends with their cloud provider's native networking, such as a transit
+      gateway or VPC peering. See [Networking](../dedicated/networking.mdx).
+    self-hosted: >-
+      Tunnels work on Self-Hosted, but your gateway already runs on your
+      network, so most teams reach private backends directly or with native
+      networking, such as a transit gateway or VPC peering.
 ---
 <EnterpriseFeature name="Secure tunneling" />
@@ -81,9 +93,8 @@ Kubernetes, and plain Linux hosts. Only the deployment mechanics change.
 ## Security model
-Zuplo's tunnel is built on [cloudflared](./tunnel-advanced.mdx), Cloudflare's
-open source tunnel connector, and inherits Cloudflare's network for transport.
-Several layers control what can reach your API:
+The tunnel makes only outbound, encrypted connections to Zuplo, so your network
+needs no inbound ports. Several layers control what can reach your API:
 - **Token authentication.** Each tunnel has its own secret token. Without it, a
   tunnel instance can't connect.
@@ -154,7 +165,7 @@ configuration.
   and expose your first service.
 - [Connect to tunnel services](./tunnel-services.mdx) — call `service://` URLs
   from your gateway code and configuration.
-- [Advanced tunnel configuration](./tunnel-advanced.mdx) — the cloudflared
-  foundation, environment variable reference, and self-managed images.
+- [Advanced tunnel configuration](./tunnel-advanced.mdx) — image settings,
+  environment variable reference, and version pinning.
 - [Troubleshoot a tunnel](./tunnel-troubleshooting.mdx) — diagnose a tunnel
   that's down or not passing traffic.

package/docs/articles/securing-backend-mtls.mdx CHANGED Viewed

@@ -1,6 +1,15 @@
 ---
 title: Gateway to Origin mTLS Authentication
 sidebar_label: Gateway to Origin
+applies_to:
+  product: gateway
+  hosting: all
+  plan: enterprise
+  differs:
+    managed-dedicated: >-
+      Client certificates also load in local development with `zuplo dev`.
+    self-hosted: >-
+      Client certificates also load in local development with `zuplo dev`.
 ---
 <EnterpriseFeature name="mTLS Client Certificates" />

package/docs/articles/securing-the-gateway-with-client-mtls.mdx CHANGED Viewed

@@ -4,6 +4,9 @@ sidebar_label: Client mTLS
 description:
   Require API callers to present client certificates signed by a CA you trust
   before they reach your Zuplo gateway.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 <EnterpriseFeature name="Client mTLS" />

package/docs/articles/securing-your-backend.mdx CHANGED Viewed

@@ -1,5 +1,12 @@
 ---
 title: Securing your backend
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Custom networking, such as VPC peering and PrivateLink, is also available.
+      See [Custom networking](#custom-networking-managed-dedicated-only).
 ---
 When using a gateway, it's important to ensure that your backend API is only

package/docs/articles/security.mdx CHANGED Viewed

@@ -1,5 +1,16 @@
 ---
 title: Security
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in a dedicated, isolated instance on the cloud provider
+      you choose, which Zuplo provisions and operates.
+    self-hosted: >-
+      Your gateways run in your own Kubernetes cluster, so you manage that
+      infrastructure and apply updates. The Zuplo cloud services that support
+      your gateways follow the practices on this page.
 ---
 Zuplo hosts mission-critical infrastructure for our customers and as such we

package/docs/articles/sharing-code-across-projects.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - custom-code
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
 ---
 When you have multiple Zuplo projects that share common functionality like

package/docs/articles/source-control-setup-azure.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Azure DevOps Setup
 sidebar_label: Setup
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Azure DevOps integration is available on

package/docs/articles/source-control-setup-bitbucket.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Bitbucket Setup
 sidebar_label: Setup
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Bitbucket integration is available on

package/docs/articles/source-control-setup-github.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: GitHub Setup
 sidebar_label: Setup
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Connect your Zuplo project to GitHub for source control and automatic

package/docs/articles/source-control-setup-gitlab.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: GitLab Setup
 sidebar_label: Setup
+applies_to:
+  product: gateway
+  hosting: all
 ---
 GitLab integration is available on

package/docs/articles/source-control.mdx CHANGED Viewed

@@ -1,6 +1,18 @@
 ---
 title: Source Control & Deployments
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Working copy environments aren't available, so you develop locally. Git
+      integrations and the Zuplo CLI deploy the same way. See [Managed
+      Dedicated: Source Control](../dedicated/source-control.mdx).
+    self-hosted: >-
+      Deployments from the Zuplo Portal reach your cluster after Zuplo registers
+      your management API endpoint. Zuplo CLI deployments pass the endpoint
+      directly. See [Requirements](../self-hosted/requirements.md).
 ---
 Zuplo integrates with your Git repository for both development and deployments.

package/docs/articles/streaming-responses-sse.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ description:
 tags:
   - request-handling
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo's runtime is built on web-standard APIs, so streaming responses work the

package/docs/articles/support.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Support
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This document explains the Zuplo support plans, communication methods,

package/docs/articles/terraform.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: "Native GitOps: Better Than Terraform"
 sidebar_label: "GitOps vs Terraform"
+applies_to:
+  product: gateway
+  hosting: all
 ---
 <!-- vale Vale.Spelling["declaratively"] = NO -->

package/docs/articles/testing-getting-started.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Take a Zuplo project from no tests to a green run against a local dev server
   in three steps. Covers test file location, the TestHelper API, and CLI flags
   for filtering and skipping tests.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This guide takes a Zuplo project from no tests to a green test run against a

package/docs/articles/testing-graphql.mdx CHANGED Viewed

@@ -6,6 +6,9 @@ description:
 tags:
   - testing
   - dev-portal
+applies_to:
+  product: gateway
+  hosting: all
 ---
 If you write a route that proxies a GraphQL API, you can test your route using

package/docs/articles/testing-preview-environments.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Run the same test suite against a real per-branch Zuplo deployment before
   merging. Covers getting the preview URL into your tests, waiting for
   readiness, per-environment secrets, and scoping what runs where.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 A preview environment is a full Zuplo deployment of a branch, on the same edge

package/docs/articles/testing-recipes.mdx CHANGED Viewed

@@ -6,6 +6,9 @@ description: >-
   gateway—auth rejections, deterministic rate limits, response schema validation
   with Zod, OpenAPI conformance, error contracts, routing, and test data
   hygiene.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The interesting assertions at a gateway are the rejections. A suite that only

package/docs/articles/testing.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Learn how `zuplo test` runs the same TypeScript test files against your local
   dev server, preview deployments, and production to catch configuration defects
   that unit tests miss.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Your gateway holds authentication, authorization, rate limits, routing, request

package/docs/articles/troubleshooting-deployments-and-git-sync.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Diagnose Zuplo deployments that hang at "Deploying api" or "Building Developer
   Portal" and fix Git source-control sync errors such as Bitbucket 410 Gone
   responses on branch retrieval.
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 When a deploy seems to hang at `Deploying api…` or `Building Developer Portal…`,

package/docs/articles/troubleshooting-slow-responses.mdx CHANGED Viewed

@@ -4,6 +4,16 @@ sidebar_label: Troubleshooting Slow Responses
 description:
   Diagnose and fix slow API response times through your Zuplo gateway. Covers
   backend latency, cold starts, DNS, policy overhead, and geographic routing.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your gateway runs in the regions of your dedicated instance instead of
+      300+ edge locations. Cold starts don't apply.
+    self-hosted: >-
+      Your gateway runs in your own Kubernetes cluster instead of 300+ edge
+      locations.
 ---
 When API responses through your Zuplo gateway are slower than expected, a

package/docs/articles/troubleshooting.md CHANGED Viewed

@@ -1,6 +1,20 @@
 ---
 title: Troubleshooting
 sidebar_label: Troubleshooting
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
+    self-hosted: >-
+      `rayId` comes from the hosting network and maps to its request ID where
+      one exists, and `environmentType` values also depend on the hosting
+      environment. Don't rely on either having the same format across hosting
+      options.
 ---
 This guide covers common errors you may encounter when building, deploying, and

package/docs/articles/tsconfig.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: TypeScript Configuration (tsconfig.json)
 sidebar_label: TypeScript Config
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo projects use TypeScript for custom code. At the root of every project is a