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/ci-cd-github/cleanup-on-branch-delete.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitHub Actions: Automatic Cleanup"
 sidebar_label: Automatic Cleanup
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo list` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Delete Zuplo environments automatically when branches are deleted. This keeps

package/docs/articles/ci-cd-github/deploy-and-test.mdx CHANGED Viewed

@@ -5,6 +5,14 @@ description:
   Deploy to Zuplo from a GitHub Actions workflow, capture the deployment URL,
   and run your test suite against the live environment to validate changes
   before they reach production.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run your test suite against the deployed environment to validate changes before

package/docs/articles/ci-cd-github/local-testing.mdx CHANGED Viewed

@@ -4,6 +4,14 @@ sidebar_label: Local testing in CI
 description:
   Start a local Zuplo dev server inside a GitHub Actions workflow, poll it until
   it answers, run your test suite, and only deploy if every test passes.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run tests against a local Zuplo development server before deploying anywhere.

package/docs/articles/ci-cd-github/multi-stage-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitHub Actions: Multi-Stage Deployment"
 sidebar_label: Multi-Stage Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy to staging first, run tests, then promote to production with manual

package/docs/articles/ci-cd-github/pr-preview-environments.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitHub Actions: PR Preview Environments"
 sidebar_label: PR Preview Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Give every pull request its own Zuplo environment. Reviewers can test changes

package/docs/articles/ci-cd-github/tag-based-releases.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitHub Actions: Tag-Based Releases"
 sidebar_label: Tag-Based Releases
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy only when you explicitly tag a release. This gives you complete control

package/docs/articles/ci-cd-gitlab/basic-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD: Basic Deployment"
 sidebar_label: Basic Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 The simplest pipeline deploys your API to Zuplo on every push to main.

package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD: Deploy and Test"
 sidebar_label: Deploy and Test
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run your test suite against the deployed environment to validate changes.

package/docs/articles/ci-cd-gitlab/local-testing.mdx CHANGED Viewed

@@ -4,6 +4,14 @@ sidebar_label: Local testing in CI
 description:
   Start a local Zuplo dev server inside GitLab CI/CD, poll it until it answers,
   run your test suite, and only deploy if every test passes.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Test against a local Zuplo server before deploying anywhere.

package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD: MR Preview Environments"
 sidebar_label: MR Preview Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Deploy preview environments for merge requests and clean up when they close.

package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD: Multi-Stage Deployment"
 sidebar_label: Multi-Stage Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy to staging, test, then promote to production with approval.

package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD: Tag-Based Releases"
 sidebar_label: Tag-Based Releases
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy only when tags are pushed for controlled releases.

package/docs/articles/composite-policy-reference.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
   routes.
 tags:
   - policies
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Composite policies let you group multiple policies into a single reusable unit

package/docs/articles/configuring-auth0-for-mcp-auth.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - authentication
   - integrations
+applies_to:
+  product: gateway
+  hosting: all
 ---
 In this guide, you'll learn how to configure Auth0 as an Authorization Server

package/docs/articles/configuring-okta-for-mcp-auth.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - authentication
   - integrations
+applies_to:
+  product: gateway
+  hosting: all
 ---
 <!-- vale Vale.Spelling["URIs"] = NO -->

package/docs/articles/connect-to-aws-alb-with-mtls.mdx CHANGED Viewed

@@ -9,6 +9,16 @@ tags:
   - backends
   - authentication
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Client certificates also load in local development with `zuplo dev`. See
+      [Local Development](./securing-backend-mtls.mdx#local-development).
+    self-hosted: >-
+      Client certificates also load in local development with `zuplo dev`. See
+      [Local Development](./securing-backend-mtls.mdx#local-development).
 ---
 <EnterpriseFeature name="mTLS Client Certificates" />

package/docs/articles/convert-urls-to-openapi.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - openapi
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This is an example script that shows how to convert URLs in your Zuplo OpenAPI

package/docs/articles/cors.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Configuring CORS
 sidebar_label: CORS
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Cross-Origin Resource Sharing (CORS) controls which web applications on

package/docs/articles/custom-audit-logs.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Custom Audit Logs
 sidebar_label: Custom Audit Logs
+applies_to:
+  product: gateway
+  hosting: all
 ---
 [Zuplo Audit Logs](./audit-logs.mdx) stores your audit trail in Zuplo and gives

package/docs/articles/custom-ci-cd-azure.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines"
 sidebar_label: Azure Pipelines
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 Azure Pipelines brings enterprise-grade CI/CD to your Zuplo Gateway. Build

package/docs/articles/custom-ci-cd-bitbucket.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines"
 sidebar_label: Bitbucket Pipelines
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 Bitbucket Pipelines brings CI/CD directly into your Bitbucket workflow. Define

package/docs/articles/custom-ci-cd-circleci.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI"
 sidebar_label: CircleCI
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 CircleCI offers powerful, flexible CI/CD with advanced workflow capabilities.

package/docs/articles/custom-ci-cd-github.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: Custom GitHub Actions
 sidebar_label: Custom CI/CD
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 :::note

package/docs/articles/custom-ci-cd-gitlab.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitLab CI/CD"
 sidebar_label: GitLab CI/CD
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 GitLab CI/CD provides integrated pipelines right where your code lives. No

package/docs/articles/custom-ci-cd.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: Custom CI/CD Pipelines
 sidebar_label: Custom CI/CD
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../cli/deploy.mdx).
 ---
 Custom CI/CD pipelines give you complete control over your deployment workflow.

package/docs/articles/custom-code-patterns.md CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Custom Code Patterns
 sidebar_label: Custom Code
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo is fully programmable. You can write custom TypeScript code for inbound

package/docs/articles/custom-domains.mdx CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: Custom Domains
 sidebar_label: Overview
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Zuplo configures custom domains for your instance. See [Managed Dedicated:
+      Custom Domains](../dedicated/custom-domains.mdx).
+    self-hosted: >-
+      You manage DNS and certificates for your own cluster. See [Self-Hosted
+      requirements](../self-hosted/requirements.md).
 ---
 This guide will walk you through the process of setting up a custom domain for

package/docs/articles/custom-logging-example.mdx CHANGED Viewed

@@ -1,5 +1,8 @@
 ---
 title: Custom Logging Policy
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Some of our customers want to build custom logging for their gateway runtime.

package/docs/articles/ddos-protection.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Managed DDoS Protection
 sidebar_label: DDoS Protection
+applies_to:
+  product: gateway
+  hosting: [managed-edge]
 ---
 <!-- vale Vale.Spelling["slowloris","Unmetered"] = NO -->

package/docs/articles/development-options.mdx CHANGED Viewed

@@ -1,5 +1,12 @@
 ---
 title: Development Options
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Working copy environments aren't available. Use [local
+      development](./local-development.mdx) instead.
 ---
 Zuplo offers both a local and web-based development experiences. For most

package/docs/articles/environment-variables.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: Configuring Environment Variables
 sidebar_label: Environment Variables
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Working copy environments aren't available, so the **Development (Working
+      Copy)** option doesn't apply. Use a `.env` file for [local
+      development](./local-development-env-variables.mdx) instead.
 ---
 Environment variables are key-value pairs that are stored outside of source

package/docs/articles/environments.mdx CHANGED Viewed

@@ -1,5 +1,15 @@
 ---
 title: Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Working copy environments aren't available. Production and preview
+      environments run in the regions of your dedicated instance instead of 300+
+      edge locations.
+    self-hosted: >-
+      Production and preview environments run in your own Kubernetes cluster.
 ---
 One of the things that makes Zuplo different from most API gateways, and API
@@ -18,8 +28,8 @@ For a comprehensive guide to how branches map to environments, see
 ## Environment Types
 There are three types of environments on Zuplo - Production, Preview, and
-Development (called Working Copy). Each environment has a unique URL and every
-environment is deployed to 300+ edge locations around the world.
+Development (called Working Copy). Each environment has a unique URL. On Managed
+Edge, every environment is deployed to 300+ edge locations around the world.
 ### Development (Working Copy)
@@ -76,12 +86,12 @@ carefully.
 :::note
 There is **no technical difference** between a Production environment and a
-Preview environment. Both deploy to the same infrastructure, run in the same
-300+ edge locations, and have identical performance characteristics. The
-"production" label simply means "deployed from the default branch." It controls
-which set of [environment variables](/docs/articles/environment-variables.mdx)
-and [API key buckets](/docs/articles/api-key-buckets.mdx) apply by default, but
-the underlying deployment is exactly the same.
+Preview environment. Both deploy to the same infrastructure and have identical
+performance characteristics. The "production" label simply means "deployed from
+the default branch." It controls which set of
+[environment variables](/docs/articles/environment-variables.mdx) and
+[API key buckets](/docs/articles/api-key-buckets.mdx) apply by default, but the
+underlying deployment is exactly the same.
 :::

package/docs/articles/fastly-zuplo-host-setup.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Using Zuplo as a Fastly Host
 sidebar_label: Fastly Setup
+applies_to:
+  product: gateway
+  hosting: all
 ---
 This document outlines how to use Zuplo as a host for Fastly. While this isn't a

package/docs/articles/feature-flags.mdx CHANGED Viewed

@@ -9,6 +9,9 @@ tags:
   - integrations
   - custom-code
   - caching
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo doesn't have a dedicated feature-flag policy — instead, every provider

package/docs/articles/github-deployment-testing.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Trigger a GitHub Actions workflow on Zuplo's deployment_status event, run your
   test suite against the preview URL, and make the result a required status
   check so a gateway regression blocks the merge.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Run your test suite automatically after every Zuplo deployment without replacing

package/docs/articles/gke-with-upstream-auth-policy.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Secure a GCP Backend with Zuplo Upstream Auth
 sidebar_label: GCP Backend
+applies_to:
+  product: gateway
+  hosting: all
 ---
 When using any gateway as your API's entry point, it's critical that only

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

@@ -7,6 +7,9 @@ description:
 tags:
   - caching
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 GraphQL clients send queries as POST request bodies, so a normal CDN — which

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

@@ -7,6 +7,9 @@ description:
 tags:
   - authentication
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 GraphQL gives clients enormous flexibility over what they ask for — which is

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

@@ -6,6 +6,9 @@ description:
   gateway to add auth, rate limiting, caching, and GraphQL-specific policies.
 tags:
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 **Yes, Zuplo supports GraphQL.** Zuplo is a proxy-based API gateway, and a

package/docs/articles/graphql.mdx CHANGED Viewed

@@ -6,6 +6,9 @@ description:
   reference with a playground in your Dev Portal.
 tags:
   - backends
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Zuplo has rich support for GraphQL. Pass your requests through the gateway,

package/docs/articles/handling-form-data.mdx CHANGED Viewed

@@ -6,6 +6,9 @@ description:
 tags:
   - request-handling
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo supports working with `FormData` including `multipart/form-data`. In this

package/docs/articles/health-checks.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - observability
   - backends
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Part of running a reliable Zuplo Gateway is ensuring that the service is healthy

package/docs/articles/hosting-options.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Hosting Options
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Your place or ours; Zuplo has a variety of hosting options to suit your needs.

package/docs/articles/lazy-load-configuration-into-cache.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - caching
   - custom-code
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Often when working with a programmable gateway like Zuplo you'll want to load

package/docs/articles/limits.mdx CHANGED Viewed

@@ -1,6 +1,13 @@
 ---
 title: Zuplo Platform Limits
 sidebar_label: Platform Limits
+applies_to:
+  product: gateway
+  hosting: [managed-edge, managed-dedicated]
+  differs:
+    managed-dedicated: >-
+      Most limits can be customized for your instance. Contact your account
+      team.
 ---
 This document describes the limits that apply to your Zuplo account.

package/docs/articles/local-development-debugging.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: "Debugging Locally"
 sidebar_label: Debugging
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Set breakpoints, step through code, and inspect variables in your route handlers