zuplo 7.12.7 → 7.13.2
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.
- package/docs/articles/api-key-best-practices.mdx +0 -7
- package/docs/articles/api-key-management.mdx +0 -7
- package/docs/articles/custom-domains.mdx +12 -3
- package/docs/articles/monetization/stripe-integration.md +16 -6
- package/docs/articles/source-control-setup-github.mdx +23 -2
- package/docs/articles/troubleshooting-deployments-and-git-sync.mdx +6 -4
- package/docs/concepts/api-keys.md +0 -9
- package/docs/dedicated/architecture.mdx +7 -6
- package/docs/getting-started/gateway/deploy-to-the-edge/index.mdx +3 -3
- package/package.json +5 -5
|
@@ -4,13 +4,6 @@ sidebar_label: Best Practices
|
|
|
4
4
|
applies_to:
|
|
5
5
|
product: gateway
|
|
6
6
|
hosting: all
|
|
7
|
-
differs:
|
|
8
|
-
managed-dedicated: >-
|
|
9
|
-
Validation results are cached in the regions of your dedicated instance
|
|
10
|
-
instead of across 300+ edge locations.
|
|
11
|
-
self-hosted: >-
|
|
12
|
-
Validation results are cached by your gateways inside your own cluster,
|
|
13
|
-
and Zuplo cloud services provide key storage and management.
|
|
14
7
|
---
|
|
15
8
|
|
|
16
9
|
A well-designed API key system handles much more than authentication. It covers
|
|
@@ -4,13 +4,6 @@ sidebar_label: Overview
|
|
|
4
4
|
applies_to:
|
|
5
5
|
product: gateway
|
|
6
6
|
hosting: all
|
|
7
|
-
differs:
|
|
8
|
-
managed-dedicated: >-
|
|
9
|
-
Keys are validated and cached in the regions of your dedicated instance
|
|
10
|
-
instead of across 300+ edge locations.
|
|
11
|
-
self-hosted: >-
|
|
12
|
-
Your gateways validate keys inside your own cluster, and Zuplo cloud
|
|
13
|
-
services provide key storage and management.
|
|
14
7
|
---
|
|
15
8
|
|
|
16
9
|
Zuplo provides a fully managed API key authentication system that you can add to
|
|
@@ -100,13 +100,22 @@ verification. Please be patient if this happens.
|
|
|
100
100
|
By default, you can also use the url on `zuploapp.com` although, if you prefer
|
|
101
101
|
that to be removed contact support and we can disable it for you.
|
|
102
102
|
|
|
103
|
-
:::
|
|
103
|
+
:::note
|
|
104
|
+
|
|
105
|
+
If you use Cloudflare as your DNS provider, you can set the `CNAME` record to
|
|
106
|
+
either proxy status:
|
|
104
107
|
|
|
105
|
-
|
|
106
|
-
your
|
|
108
|
+
- **DNS only**: Traffic goes straight to Zuplo.
|
|
109
|
+
- **Proxied**: Traffic passes through your own Cloudflare zone first, so your
|
|
110
|
+
zone's settings, such as WAF rules and caching, apply before the request
|
|
111
|
+
reaches Zuplo.
|
|
107
112
|
|
|
108
113
|

|
|
109
114
|
|
|
115
|
+
If you see Cloudflare Error 1014 (CNAME Cross-User Banned), check that the
|
|
116
|
+
domain is added to your Zuplo project and that its status is active. See
|
|
117
|
+
[Cloudflare Customers](#cloudflare-customers) for other limitations.
|
|
118
|
+
|
|
110
119
|
:::
|
|
111
120
|
|
|
112
121
|
### 4. Redeploy
|
|
@@ -176,13 +176,23 @@ Stripe dashboard.
|
|
|
176
176
|
|
|
177
177
|
When a customer clicks "Subscribe" in your Developer Portal:
|
|
178
178
|
|
|
179
|
-
1.
|
|
179
|
+
1. The customer is redirected to Stripe Checkout, where they enter and save a
|
|
180
|
+
payment method
|
|
181
|
+
2. The customer returns to the Developer Portal and confirms the subscription
|
|
182
|
+
3. The subscription is created, and an API key is generated scoped to the plan's
|
|
183
|
+
entitlements
|
|
184
|
+
4. Stripe issues an invoice for the subscription and charges the saved payment
|
|
180
185
|
method
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
+
5. The customer can immediately see their subscription, usage dashboard, and API
|
|
187
|
+
key in the Developer Portal
|
|
188
|
+
|
|
189
|
+
:::note
|
|
190
|
+
|
|
191
|
+
Stripe Checkout only collects a payment method, so the Checkout page doesn't
|
|
192
|
+
show the plan name, price, or line items. Customers see the charge on the
|
|
193
|
+
subscription's invoice.
|
|
194
|
+
|
|
195
|
+
:::
|
|
186
196
|
|
|
187
197
|
### Plan changes (upgrades/downgrades)
|
|
188
198
|
|
|
@@ -165,8 +165,29 @@ With GitHub connected, you get:
|
|
|
165
165
|
settings and reconnect it.
|
|
166
166
|
</FaqItem>
|
|
167
167
|
<FaqItem question="What happens if I rename my repository?">
|
|
168
|
-
|
|
169
|
-
|
|
168
|
+
Nothing changes for your project. Zuplo updates the connection to the new
|
|
169
|
+
repository name automatically, and pushes keep deploying as before.
|
|
170
|
+
</FaqItem>
|
|
171
|
+
<FaqItem question="What happens if I transfer my repository to another GitHub organization?">
|
|
172
|
+
|
|
173
|
+
Zuplo doesn't follow a transfer. After you move the repository, pushes stop
|
|
174
|
+
deploying and no error appears. To move the repository without losing
|
|
175
|
+
deployments:
|
|
176
|
+
|
|
177
|
+
1. Install the [Zuplo GitHub app](https://github.com/apps/zuplo) on the new
|
|
178
|
+
organization and give it access to the repository.
|
|
179
|
+
2. Transfer the repository in GitHub.
|
|
180
|
+
3. Open your
|
|
181
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
182
|
+
select **Source Control**, and click **Disconnect**.
|
|
183
|
+
4. Connect the project to the same repository in its new organization and
|
|
184
|
+
click **Link project**. If your production branch isn't `main`, set it
|
|
185
|
+
again under **Default Branch**.
|
|
186
|
+
5. Push a commit to confirm that deployments run again.
|
|
187
|
+
|
|
188
|
+
Your existing deployments, environment URLs, and custom domains keep serving
|
|
189
|
+
traffic throughout the move.
|
|
190
|
+
|
|
170
191
|
</FaqItem>
|
|
171
192
|
<FaqItem question="Can I connect multiple Zuplo projects to the same repo?">
|
|
172
193
|
No, each Zuplo project must be connected to a unique GitHub repository.
|
|
@@ -138,7 +138,8 @@ mean the connection is no longer authorized:
|
|
|
138
138
|
|
|
139
139
|
- The OAuth authorization Zuplo uses to reach the provider has **expired or been
|
|
140
140
|
revoked**.
|
|
141
|
-
- The repository was **
|
|
141
|
+
- The repository was **moved** to another organization, which breaks the
|
|
142
|
+
existing connection.
|
|
142
143
|
- The Git app was **uninstalled** or lost access to the repository in the
|
|
143
144
|
provider's settings.
|
|
144
145
|
|
|
@@ -161,9 +162,10 @@ After reconnecting, retrieving branches should succeed again.
|
|
|
161
162
|
|
|
162
163
|
:::caution
|
|
163
164
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
165
|
+
Zuplo follows a GitHub repository rename automatically. Moving a repository to
|
|
166
|
+
another organization breaks the connection, and pushes stop deploying. To
|
|
167
|
+
restore it, follow
|
|
168
|
+
[the steps for transferring a repository](./source-control-setup-github.mdx#frequently-asked-questions).
|
|
167
169
|
|
|
168
170
|
:::
|
|
169
171
|
|
|
@@ -3,15 +3,6 @@ title: API Keys
|
|
|
3
3
|
applies_to:
|
|
4
4
|
product: gateway
|
|
5
5
|
hosting: all
|
|
6
|
-
differs:
|
|
7
|
-
managed-dedicated: >-
|
|
8
|
-
Gateway services that run with your dedicated instance validate API keys,
|
|
9
|
-
instead of the 300+ edge locations. See [Managed Dedicated
|
|
10
|
-
architecture](../dedicated/architecture.mdx).
|
|
11
|
-
self-hosted: >-
|
|
12
|
-
Zuplo cloud services provide API key management, and your self-hosted
|
|
13
|
-
gateway validates keys against them. See
|
|
14
|
-
[Self-Hosted](../self-hosted/overview.md).
|
|
15
6
|
---
|
|
16
7
|
|
|
17
8
|
Zuplo includes a fully managed API key system with global edge validation,
|
|
@@ -20,10 +20,11 @@ A managed dedicated instance of Zuplo consists of the following components:
|
|
|
20
20
|
receives incoming requests, routes them to the appropriate backend, and
|
|
21
21
|
returns the response to the client. The gateway handles authentication,
|
|
22
22
|
authorization, rate limiting, and other features.
|
|
23
|
-
- **Gateway Services**: Zuplo
|
|
24
|
-
to facilitate features such as
|
|
23
|
+
- **Gateway Services**: Zuplo-hosted services that power features such as
|
|
25
24
|
[Rate Limiting](../getting-started/gateway/add-rate-limiting/index.mdx) and
|
|
26
|
-
[API Key Authentication](../articles/api-key-management.mdx).
|
|
25
|
+
[API Key Authentication](../articles/api-key-management.mdx). Every Zuplo
|
|
26
|
+
deployment, including managed dedicated instances, uses the same gateway
|
|
27
|
+
services.
|
|
27
28
|
- **Control Plane**: The Control Plane manages the configuration of the Zuplo
|
|
28
29
|
Gateway. It deploys new configurations, manages the lifecycle of the Zuplo
|
|
29
30
|
Gateway, and monitors its health.
|
|
@@ -92,9 +93,6 @@ instance of Zuplo and how the components interact with each other.
|
|
|
92
93
|
<DiagramNode id="gateway" variant="zuplo">
|
|
93
94
|
Zuplo Gateway
|
|
94
95
|
</DiagramNode>
|
|
95
|
-
<DiagramNode id="services" variant="zuplo">
|
|
96
|
-
Gateway Services
|
|
97
|
-
</DiagramNode>
|
|
98
96
|
</DiagramGroup>
|
|
99
97
|
<DiagramGroup id="customer-vpc" label="Customer Private Network">
|
|
100
98
|
<DiagramNode id="backend">Backend</DiagramNode>
|
|
@@ -102,6 +100,9 @@ instance of Zuplo and how the components interact with each other.
|
|
|
102
100
|
<DiagramNode id="control" variant="zuplo">
|
|
103
101
|
Control Plane
|
|
104
102
|
</DiagramNode>
|
|
103
|
+
<DiagramNode id="services" variant="zuplo">
|
|
104
|
+
Gateway Services
|
|
105
|
+
</DiagramNode>
|
|
105
106
|
<DiagramEdge from="client" to="gateway" />
|
|
106
107
|
<DiagramEdge from="gateway" to="backend" />
|
|
107
108
|
<DiagramEdge from="gateway" to="services" fromSide="bottom" toSide="top" />
|
|
@@ -227,8 +227,8 @@ when running commits, pulls or try to open a pull request.
|
|
|
227
227
|
collaborator. This can be verified by going to the GitHub repository >
|
|
228
228
|
Settings > Collaborators section. You'll need admin permissions to the
|
|
229
229
|
repository.
|
|
230
|
-
- If the GitHub repository has been
|
|
231
|
-
|
|
232
|
-
|
|
230
|
+
- If the GitHub repository has been moved to a different organization,
|
|
231
|
+
disconnect and reconnect to it in your Zuplo project's settings > Source
|
|
232
|
+
Control section. Zuplo follows a repository rename automatically.
|
|
233
233
|
|
|
234
234
|
<TutorialPager build="gateway" method="portal" step="deploy-to-the-edge" />
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zuplo",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.13.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "The official Zuplo CLI for local development and platform management",
|
|
6
6
|
"homepage": "https://zuplo.com/docs/cli/overview",
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
"zuplo": "zuplo.js"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@zuplo/cli": "7.
|
|
36
|
-
"@zuplo/core": "7.
|
|
37
|
-
"@zuplo/runtime": "7.
|
|
38
|
-
"@zuplo/test": "7.
|
|
35
|
+
"@zuplo/cli": "7.13.2",
|
|
36
|
+
"@zuplo/core": "7.13.2",
|
|
37
|
+
"@zuplo/runtime": "7.13.2",
|
|
38
|
+
"@zuplo/test": "7.13.2"
|
|
39
39
|
}
|
|
40
40
|
}
|