zuplo 6.71.22 → 6.71.25
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.
|
@@ -84,9 +84,9 @@ inside Zuplo)
|
|
|
84
84
|
```bash
|
|
85
85
|
# Your Zuplo Account Name
|
|
86
86
|
export ACCOUNT_NAME=my-account
|
|
87
|
-
# Your bucket
|
|
87
|
+
# Your bucket name (Found in Services > API Key Service)
|
|
88
88
|
export BUCKET_NAME=my-bucket
|
|
89
|
-
# Your Zuplo API Key (Found in Settings > Zuplo API Keys)
|
|
89
|
+
# Your Zuplo API Key (Found in Account Settings > Zuplo API Keys)
|
|
90
90
|
export API_KEY=zpka_YOUR_API_KEY
|
|
91
91
|
```
|
|
92
92
|
|
|
@@ -46,16 +46,17 @@ For more information, see the
|
|
|
46
46
|
|
|
47
47
|
## 3. Self-Hosted (On-Premises)
|
|
48
48
|
|
|
49
|
-
Run Zuplo on your own infrastructure in any cloud or private data center
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
49
|
+
Run Zuplo on your own infrastructure in any cloud or private data center. Zuplo
|
|
50
|
+
Self-Hosted runs exclusively on Kubernetes and is installed with a single Helm
|
|
51
|
+
chart into your cluster.
|
|
52
|
+
|
|
53
|
+
In the standard hybrid deployment model, you run the Zuplo API Gateway and its
|
|
54
|
+
management plane on your Kubernetes cluster, while a small set of Zuplo cloud
|
|
55
|
+
services provides supporting features such as deployment configuration and API
|
|
56
|
+
key management. All API traffic to your gateways stays on your infrastructure.
|
|
57
|
+
For environments with strict egress restrictions,
|
|
58
|
+
[book a meeting](https://zuplo.com/meeting) to review your requirements with the
|
|
59
|
+
Zuplo team.
|
|
59
60
|
|
|
60
61
|
Self-Hosted is ideal for organizations that need:
|
|
61
62
|
|
|
@@ -63,8 +64,8 @@ Self-Hosted is ideal for organizations that need:
|
|
|
63
64
|
- To run Zuplo in a private data center or on-premises Kubernetes environment
|
|
64
65
|
- To meet strict data sovereignty or regulatory requirements
|
|
65
66
|
- To integrate with existing on-premises systems and networks
|
|
66
|
-
- To customize the deployment architecture to match your specific requirements
|
|
67
67
|
|
|
68
68
|
For more information, see the
|
|
69
|
-
[Self-Hosted documentation](/docs/self-hosted/overview)
|
|
70
|
-
[
|
|
69
|
+
[Self-Hosted documentation](/docs/self-hosted/overview.md), including the
|
|
70
|
+
[requirements](/docs/self-hosted/overview.md#requirements) to prepare for a
|
|
71
|
+
deployment, or [book a meeting](https://zuplo.com/meeting) with the Zuplo team.
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
title: Proxying Between Zuplo Gateways
|
|
3
3
|
sidebar_label: Proxying Between Gateways
|
|
4
4
|
description:
|
|
5
|
-
Learn how to proxy requests from one Zuplo
|
|
6
|
-
|
|
7
|
-
upstream errors, and troubleshoot 522 timeouts.
|
|
5
|
+
Learn how to proxy requests from one Zuplo gateway to another, propagate
|
|
6
|
+
authentication, handle upstream errors, and fix 522 timeouts.
|
|
8
7
|
tags:
|
|
9
8
|
- backends
|
|
10
9
|
- deployment
|
|
@@ -3,58 +3,145 @@ title: Zuplo Self-Hosted
|
|
|
3
3
|
sidebar_label: Overview
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
Zuplo Self-Hosted (also known as on-
|
|
7
|
-
|
|
8
|
-
Self-Hosted runs exclusively on Kubernetes and
|
|
9
|
-
|
|
6
|
+
Zuplo Self-Hosted (also known as on-prem) is a deployment model where you run
|
|
7
|
+
the Zuplo API Gateway on your own infrastructure — any cloud or private data
|
|
8
|
+
center. Zuplo Self-Hosted runs exclusively on Kubernetes and is installed with a
|
|
9
|
+
single Helm chart into your cluster.
|
|
10
10
|
|
|
11
11
|
Self-hosted deployment might be the right choice for you if you need:
|
|
12
12
|
|
|
13
13
|
- Complete control over your infrastructure and deployment environment
|
|
14
14
|
- To run Zuplo in a private data center or on-premises environment
|
|
15
|
-
- To meet
|
|
16
|
-
to remain within your infrastructure
|
|
15
|
+
- To meet data sovereignty or regulatory requirements that require API traffic
|
|
16
|
+
and data to remain within your infrastructure
|
|
17
17
|
- To integrate with existing on-premises systems and networks
|
|
18
|
-
- To customize the deployment architecture to match your organization's specific
|
|
19
|
-
requirements
|
|
20
18
|
|
|
21
|
-
##
|
|
19
|
+
## How It Works
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
Your cluster runs two groups of workloads: a small Zuplo management plane that
|
|
22
|
+
receives deployments, builds gateway images inside your cluster, and manages
|
|
23
|
+
certificates and routing, and the gateway deployments themselves, which serve
|
|
24
|
+
your API traffic. Developers deploy to your instance directly with the Zuplo CLI
|
|
25
|
+
— the same Zuplo project format and deployment workflow used on every other
|
|
26
|
+
Zuplo deployment model. Gateway images are built in-cluster and stored in your
|
|
27
|
+
own container registry, and API traffic is served entirely from your
|
|
28
|
+
infrastructure.
|
|
29
|
+
|
|
30
|
+
## Deployment Models
|
|
24
31
|
|
|
25
32
|
### Hybrid Deployment
|
|
26
33
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
34
|
+
You run the gateway and management plane on your infrastructure, while a small
|
|
35
|
+
set of Zuplo cloud services provides supporting features such as deployment
|
|
36
|
+
configuration and API key management. All API traffic to your gateways stays on
|
|
37
|
+
your infrastructure. This is the standard deployment model.
|
|
38
|
+
|
|
39
|
+
### Restricted-Egress Environments
|
|
40
|
+
|
|
41
|
+
For environments with strict egress restrictions or stronger isolation
|
|
42
|
+
requirements, [book a meeting](https://zuplo.com/meeting) to review your
|
|
43
|
+
requirements with the Zuplo team.
|
|
44
|
+
|
|
45
|
+
## Responsibilities
|
|
46
|
+
|
|
47
|
+
Self-hosting keeps you in control of your infrastructure while Zuplo supplies
|
|
48
|
+
everything Zuplo-specific — the chart, the images, and the support to run them
|
|
49
|
+
well:
|
|
50
|
+
|
|
51
|
+
| Phase | Your team | Zuplo |
|
|
52
|
+
| ------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
53
|
+
| Prepare | Kubernetes cluster, DNS records, TLS certificates (optional), container registry | Registry credentials, account configuration, installation guide |
|
|
54
|
+
| Install | Run the Helm install in your cluster | Helm chart, component images, starter configuration reviewed with your team |
|
|
55
|
+
| Operate | Cluster operations, applying updates | Updated charts and images, support |
|
|
56
|
+
|
|
57
|
+
:::tip
|
|
58
|
+
|
|
59
|
+
If this division of responsibilities doesn't fit your organization,
|
|
60
|
+
[book a meeting](https://zuplo.com/meeting) with the Zuplo team. For teams that
|
|
61
|
+
prefer Zuplo to run the infrastructure,
|
|
62
|
+
[Managed Dedicated](../dedicated/overview.mdx) offers the same gateway fully
|
|
63
|
+
operated by Zuplo.
|
|
64
|
+
|
|
65
|
+
:::
|
|
66
|
+
|
|
67
|
+
## Requirements
|
|
68
|
+
|
|
69
|
+
This section lists what your team needs to prepare before installing Zuplo
|
|
70
|
+
Self-Hosted. Use it to plan your platform and security review. Your Zuplo
|
|
71
|
+
solutions architect walks through each item during onboarding.
|
|
72
|
+
|
|
73
|
+
### Kubernetes Cluster
|
|
74
|
+
|
|
75
|
+
- A conformant Kubernetes cluster — managed offerings such as EKS, AKS, and GKE,
|
|
76
|
+
or your own distribution.
|
|
77
|
+
- Support for Services of type `LoadBalancer` to expose the ingress.
|
|
78
|
+
- Cluster administrator access for the initial install (the chart installs CRDs
|
|
79
|
+
and cluster-scoped RBAC).
|
|
80
|
+
- Zuplo builds gateway images inside your cluster. The build process runs
|
|
81
|
+
privileged pods, so clusters that enforce a restricted Pod Security Standard
|
|
82
|
+
cluster-wide need accommodations — discuss this with your Zuplo solutions
|
|
83
|
+
architect during onboarding.
|
|
84
|
+
- Helm 3 on the machine performing the install; supported versions are confirmed
|
|
85
|
+
during onboarding.
|
|
86
|
+
|
|
87
|
+
### DNS and TLS
|
|
88
|
+
|
|
89
|
+
You control DNS for two names, both pointing at the cluster's ingress load
|
|
90
|
+
balancer:
|
|
91
|
+
|
|
92
|
+
- A wildcard subdomain for your gateway environments, for example
|
|
93
|
+
`*.api.example.com` — each deployed gateway environment receives a hostname
|
|
94
|
+
under it.
|
|
95
|
+
- A hostname for the management API, for example `zuplo-admin.example.com` —
|
|
96
|
+
used by the Zuplo CLI and your CI/CD pipelines to deploy.
|
|
97
|
+
|
|
98
|
+
For TLS you can either:
|
|
99
|
+
|
|
100
|
+
- Use the bundled cert-manager to issue certificates automatically from an ACME
|
|
101
|
+
certificate authority (for example Let's Encrypt), which requires the
|
|
102
|
+
hostnames to be reachable for HTTP-01 challenges, or
|
|
103
|
+
- Bring your own wildcard certificate as a Kubernetes TLS secret — common in
|
|
104
|
+
private-network deployments.
|
|
105
|
+
|
|
106
|
+
### Container Registry
|
|
107
|
+
|
|
108
|
+
Gateway images are built inside your cluster and pushed to a container registry
|
|
109
|
+
that you provide. You need:
|
|
110
|
+
|
|
111
|
+
- A registry your cluster can push to and pull from (for example ACR, Google
|
|
112
|
+
Artifact Registry, GitHub Container Registry, or a private Harbor).
|
|
113
|
+
- Write credentials for that registry, supplied at install time.
|
|
114
|
+
|
|
115
|
+
### Network Egress
|
|
116
|
+
|
|
117
|
+
In the hybrid deployment model, the cluster needs outbound HTTPS access to:
|
|
32
118
|
|
|
33
|
-
|
|
119
|
+
- Zuplo's private container registry, to pull Zuplo's component images
|
|
120
|
+
(credentials provided during onboarding).
|
|
121
|
+
- Zuplo cloud services, used for deployment configuration and management API
|
|
122
|
+
authentication.
|
|
123
|
+
- Your ACME certificate authority, if using automatic certificates.
|
|
34
124
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
125
|
+
The exact hostnames for your egress allow-list are provided during onboarding.
|
|
126
|
+
If your environment can't allow this egress,
|
|
127
|
+
[book a meeting](https://zuplo.com/meeting) to review options with the Zuplo
|
|
128
|
+
team.
|
|
38
129
|
|
|
39
|
-
|
|
130
|
+
### Provided by Zuplo During Onboarding
|
|
40
131
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
132
|
+
- Credentials to pull Zuplo component images from Zuplo's private registry.
|
|
133
|
+
- Your account configuration and an API key for the management API.
|
|
134
|
+
- The Helm chart, an installation guide, and a starter configuration reviewed
|
|
135
|
+
with your team.
|
|
44
136
|
|
|
45
|
-
|
|
137
|
+
### Observability
|
|
46
138
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
- **Data Sovereignty**: Keep all data and processing within your infrastructure
|
|
52
|
-
- **Custom Networking**: Integrate with your existing network architecture and
|
|
53
|
-
security policies
|
|
54
|
-
- **Compliance**: Meet regulatory and compliance requirements that require
|
|
55
|
-
on-premises deployment
|
|
139
|
+
The chart bundles a Prometheus-based metrics stack that Zuplo components use for
|
|
140
|
+
autoscaling gateway deployments. You can integrate your own logging and
|
|
141
|
+
monitoring stack alongside it; gateway and component logs are written to
|
|
142
|
+
standard output for collection by your log shipper.
|
|
56
143
|
|
|
57
144
|
## Getting Started
|
|
58
145
|
|
|
59
146
|
To learn more about self-hosting Zuplo or to discuss your specific requirements,
|
|
60
|
-
[book a meeting](https://zuplo.com/meeting) with
|
|
147
|
+
[book a meeting](https://zuplo.com/meeting) with the Zuplo team.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zuplo",
|
|
3
|
-
"version": "6.71.
|
|
3
|
+
"version": "6.71.25",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "The programmable API Gateway",
|
|
6
6
|
"author": "Zuplo, Inc.",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"zuplo": "zuplo.js"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@zuplo/cli": "6.71.
|
|
23
|
-
"@zuplo/core": "6.71.
|
|
24
|
-
"@zuplo/runtime": "6.71.
|
|
22
|
+
"@zuplo/cli": "6.71.25",
|
|
23
|
+
"@zuplo/core": "6.71.25",
|
|
24
|
+
"@zuplo/runtime": "6.71.25",
|
|
25
25
|
"@zuplo/test": "1.4.0"
|
|
26
26
|
}
|
|
27
27
|
}
|