zuplo 6.69.10 → 6.69.11
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/ai-gateway/apps.mdx +5 -5
- package/docs/ai-gateway/custom-providers.mdx +6 -5
- package/docs/ai-gateway/getting-started.mdx +2 -1
- package/docs/ai-gateway/guardrails.mdx +2 -2
- package/docs/ai-gateway/managing-apps.mdx +10 -8
- package/docs/ai-gateway/managing-providers.mdx +9 -7
- package/docs/ai-gateway/managing-teams.mdx +4 -4
- package/docs/ai-gateway/usage-limits.mdx +8 -5
- package/docs/articles/accounts/audit-logs.mdx +3 -5
- package/docs/articles/accounts/billing.mdx +9 -5
- package/docs/articles/accounts/default-api-key.mdx +4 -5
- package/docs/articles/accounts/delete-account.mdx +11 -11
- package/docs/articles/accounts/enterprise-sso.mdx +5 -3
- package/docs/articles/accounts/managing-account-members.mdx +3 -3
- package/docs/articles/accounts/zuplo-api-keys.mdx +8 -6
- package/docs/articles/api-key-administration.mdx +8 -5
- package/docs/articles/api-key-end-users.mdx +4 -3
- package/docs/articles/api-key-self-serve-integration.mdx +8 -4
- package/docs/articles/branch-based-deployments.mdx +7 -4
- package/docs/articles/custom-ci-cd-azure.mdx +3 -2
- package/docs/articles/custom-ci-cd-bitbucket.mdx +3 -2
- package/docs/articles/custom-ci-cd-circleci.mdx +4 -2
- package/docs/articles/custom-ci-cd-github.mdx +5 -3
- package/docs/articles/custom-ci-cd-gitlab.mdx +3 -2
- package/docs/articles/custom-ci-cd.mdx +6 -8
- package/docs/articles/custom-domains.mdx +8 -6
- package/docs/articles/environments.mdx +5 -2
- package/docs/articles/mcp-quickstart.mdx +2 -2
- package/docs/articles/migrate-from-kong.md +2 -2
- package/docs/articles/monetization/api-access.mdx +3 -2
- package/docs/articles/monetization/billing-models.md +137 -31
- package/docs/articles/monetization/developer-portal.md +7 -3
- package/docs/articles/monetization/features.mdx +0 -28
- package/docs/articles/monetization/plans.mdx +0 -1
- package/docs/articles/monetization/pricing-models.mdx +21 -7
- package/docs/articles/monetization/private-plans.md +0 -1
- package/docs/articles/monetization/quickstart.md +4 -2
- package/docs/articles/monetization/rate-cards.mdx +4 -4
- package/docs/articles/monetization/stripe-integration.md +16 -12
- package/docs/articles/monetization/subscription-lifecycle.md +4 -4
- package/docs/articles/monorepo-deployment.mdx +2 -3
- package/docs/articles/source-control-setup-github.mdx +6 -4
- package/docs/articles/step-1-setup-basic-gateway.mdx +3 -3
- package/docs/articles/step-3-add-api-key-auth-local.mdx +4 -3
- package/docs/articles/step-3-add-api-key-auth.mdx +3 -2
- package/docs/articles/step-4-deploying-to-the-edge.mdx +6 -4
- package/docs/articles/testing.mdx +4 -3
- package/docs/articles/troubleshooting.md +7 -4
- package/docs/cli/authentication.mdx +4 -2
- package/docs/cli/deploy.mdx +2 -1
- package/docs/cli/deploy.partial.mdx +2 -1
- package/docs/concepts/api-keys.md +9 -8
- package/docs/concepts/authentication.mdx +3 -2
- package/docs/concepts/source-control-and-deployment.mdx +3 -1
- package/docs/dev-portal/documenting-mcp-servers.mdx +223 -0
- package/docs/dev-portal/zudoku/openapi-extensions/x-mcp-server.md +1 -1
- package/docs/guides/canary-routing-for-employees.mdx +3 -1
- package/docs/guides/user-based-backend-routing.mdx +3 -2
- package/docs/programmable-api/environment.mdx +6 -5
- package/docs/programmable-api/zuplo-context.mdx +3 -3
- package/package.json +4 -4
package/docs/ai-gateway/apps.mdx
CHANGED
|
@@ -12,11 +12,11 @@ API Key so that usage is tracked independently. Apps are owned by a specific
|
|
|
12
12
|
## API Keys
|
|
13
13
|
|
|
14
14
|
Each App in the AI Gateway has its own API Key. This allows you to track usage
|
|
15
|
-
independently for each App. You can find the API Key for an App by
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
independently for each App. You can find the API Key for an App by opening the
|
|
16
|
+
[Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab of your AI
|
|
17
|
+
Gateway project in the Zuplo Portal. Select the App you want to view the API Key
|
|
18
|
+
for. With the App open you will see the API Key section at the top of the app
|
|
19
|
+
page.
|
|
20
20
|
|
|
21
21
|
**Additional Resources**
|
|
22
22
|
|
|
@@ -21,8 +21,9 @@ To add a custom AI provider to your Zuplo AI Gateway, follow these steps:
|
|
|
21
21
|
|
|
22
22
|
<Stepper>
|
|
23
23
|
|
|
24
|
-
1.
|
|
25
|
-
|
|
24
|
+
1. Open
|
|
25
|
+
[**Settings → AI Providers**](https://portal.zuplo.com/+/account/project/ai/settings/data-models)
|
|
26
|
+
in your AI Gateway project in the Zuplo Portal.
|
|
26
27
|
|
|
27
28
|
1. Click on the **Add Provider** button.
|
|
28
29
|
|
|
@@ -46,9 +47,9 @@ To add a custom AI provider to your Zuplo AI Gateway, follow these steps:
|
|
|
46
47
|
|
|
47
48
|
## Modify, Update or Delete your Custom AI Provider
|
|
48
49
|
|
|
49
|
-
|
|
50
|
-
**Settings
|
|
51
|
-
|
|
50
|
+
To modify, update, or delete an existing provider, open
|
|
51
|
+
[**Settings → AI Providers**](https://portal.zuplo.com/+/account/project/ai/settings/data-models)
|
|
52
|
+
and click the **Edit** or **Delete** icon next to the custom provider.
|
|
52
53
|
|
|
53
54
|
Further information can be found in the
|
|
54
55
|
[Managing Providers](./managing-providers.mdx) guide.
|
|
@@ -183,7 +183,8 @@ curl https://your-ai-gateway-url.zuplo.app/v1/chat/completions \
|
|
|
183
183
|
|
|
184
184
|
### Check Your Dashboard
|
|
185
185
|
|
|
186
|
-
1.
|
|
186
|
+
1. Open the [**Apps**](https://portal.zuplo.com/+/account/project/ai/apps) tab
|
|
187
|
+
of your AI Gateway project
|
|
187
188
|
2. Click on your app
|
|
188
189
|
3. Click on **Dashboard** to view:
|
|
189
190
|
- Request count
|
|
@@ -49,8 +49,8 @@ When a guardrail detects a policy violation:
|
|
|
49
49
|
|
|
50
50
|
To add guardrails to your AI Gateway:
|
|
51
51
|
|
|
52
|
-
1.
|
|
53
|
-
|
|
52
|
+
1. Open your [project](https://portal.zuplo.com/+/account/project/) associated
|
|
53
|
+
with your AI Gateway in the Zuplo Portal
|
|
54
54
|
2. Open the **Code** tab and select your `routes.oas.json` file
|
|
55
55
|
3. Select the route for your AI Gateway endpoint
|
|
56
56
|
4. Click **Add Policy** and search for the guardrail you want to add
|
|
@@ -12,8 +12,8 @@ that usage is tracked independently. Apps are owned by a specific
|
|
|
12
12
|
|
|
13
13
|
<Stepper>
|
|
14
14
|
|
|
15
|
-
1.
|
|
16
|
-
|
|
15
|
+
1. Open the [Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab of
|
|
16
|
+
your AI Gateway project in the Zuplo Portal.
|
|
17
17
|
|
|
18
18
|
1. Click on the **Create App** button.
|
|
19
19
|
|
|
@@ -33,14 +33,16 @@ that usage is tracked independently. Apps are owned by a specific
|
|
|
33
33
|
|
|
34
34
|
## Editing an App
|
|
35
35
|
|
|
36
|
-
To edit an app,
|
|
37
|
-
[
|
|
38
|
-
Select the
|
|
39
|
-
|
|
36
|
+
To edit an app, open the
|
|
37
|
+
[Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab of your AI
|
|
38
|
+
Gateway project in the Zuplo Portal. Select the app you want to edit. Select the
|
|
39
|
+
tab you want to edit (Policies or Settings). Make your changes and click the
|
|
40
|
+
**Save** button.
|
|
40
41
|
|
|
41
42
|
## Deleting an App
|
|
42
43
|
|
|
43
|
-
To delete an app,
|
|
44
|
-
[
|
|
44
|
+
To delete an app, open the
|
|
45
|
+
[Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab of your AI
|
|
46
|
+
Gateway project in the Zuplo Portal. Select the app you want to delete and
|
|
45
47
|
scroll to the bottom of the page and click the **Delete App** button. You will
|
|
46
48
|
be prompted to confirm the deletion.
|
|
@@ -13,8 +13,9 @@ To add a new AI provider to your Zuplo AI Gateway, follow these steps:
|
|
|
13
13
|
|
|
14
14
|
<Stepper>
|
|
15
15
|
|
|
16
|
-
1.
|
|
17
|
-
|
|
16
|
+
1. Open
|
|
17
|
+
[**Settings → AI Providers**](https://portal.zuplo.com/+/account/project/ai/settings/data-models)
|
|
18
|
+
in your AI Gateway project in the Zuplo Portal.
|
|
18
19
|
|
|
19
20
|
1. Click on the **Add Provider** button.
|
|
20
21
|
|
|
@@ -44,9 +45,9 @@ To add a new AI provider to your Zuplo AI Gateway, follow these steps:
|
|
|
44
45
|
|
|
45
46
|
## Editing an AI Provider
|
|
46
47
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
want to modify.
|
|
48
|
+
To modify an existing provider, open
|
|
49
|
+
[**Settings → AI Providers**](https://portal.zuplo.com/+/account/project/ai/settings/data-models)
|
|
50
|
+
and click the **Edit** button next to the provider you want to modify.
|
|
50
51
|
|
|
51
52
|
You can modify the label, API key, and selected models for the provider. After
|
|
52
53
|
making your changes, click **Save** to apply them. Changes are effective
|
|
@@ -62,5 +63,6 @@ existing applications that rely on the provider.
|
|
|
62
63
|
## Deleting an AI Provider
|
|
63
64
|
|
|
64
65
|
Providers that are no longer used within your project can be deleted. To delete
|
|
65
|
-
a provider,
|
|
66
|
-
|
|
66
|
+
a provider, open
|
|
67
|
+
[**Settings → AI Providers**](https://portal.zuplo.com/+/account/project/ai/settings/data-models)
|
|
68
|
+
and click the **Delete** button next to the provider you want to remove.
|
|
@@ -10,8 +10,8 @@ also where you define usage limits.
|
|
|
10
10
|
|
|
11
11
|
<Stepper>
|
|
12
12
|
|
|
13
|
-
1.
|
|
14
|
-
|
|
13
|
+
1. Open the [Teams](https://portal.zuplo.com/+/account/project/ai/teams) tab of
|
|
14
|
+
your AI Gateway project in the Zuplo Portal.
|
|
15
15
|
|
|
16
16
|
1. Click on the **Create Team** button.
|
|
17
17
|
|
|
@@ -28,8 +28,8 @@ and Apps associated with that team.
|
|
|
28
28
|
|
|
29
29
|
<Stepper>
|
|
30
30
|
|
|
31
|
-
1.
|
|
32
|
-
|
|
31
|
+
1. Open the [Teams](https://portal.zuplo.com/+/account/project/ai/teams) tab of
|
|
32
|
+
your AI Gateway project in the Zuplo Portal.
|
|
33
33
|
|
|
34
34
|
1. Select the team you want to add members to.
|
|
35
35
|
|
|
@@ -30,9 +30,9 @@ enforcement configuration.
|
|
|
30
30
|
|
|
31
31
|
To configure daily budgets:
|
|
32
32
|
|
|
33
|
-
1.
|
|
34
|
-
|
|
35
|
-
|
|
33
|
+
1. Open your AI Gateway project in the Zuplo Portal
|
|
34
|
+
2. Select the [Teams](https://portal.zuplo.com/+/account/project/ai/teams) or
|
|
35
|
+
[Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab
|
|
36
36
|
3. Click on the team or app to edit
|
|
37
37
|
4. Select the **Usage & Limits** tab and configure the **Daily Budget** field
|
|
38
38
|
5. Click **Save Changes**
|
|
@@ -60,7 +60,9 @@ When a limit is reached, the AI Gateway can operate in two modes:
|
|
|
60
60
|
|
|
61
61
|
Track current usage and spending through the AI Gateway dashboard:
|
|
62
62
|
|
|
63
|
-
1.
|
|
63
|
+
1. Open the
|
|
64
|
+
[**Analytics**](https://portal.zuplo.com/+/account/project/ai/analytics) tab
|
|
65
|
+
of your AI Gateway project
|
|
64
66
|
2. Click on an app and select **Dashboard**
|
|
65
67
|
3. View real-time metrics including:
|
|
66
68
|
- Request count
|
|
@@ -77,7 +79,8 @@ queries.
|
|
|
77
79
|
|
|
78
80
|
To enable semantic caching:
|
|
79
81
|
|
|
80
|
-
1.
|
|
82
|
+
1. Open the [Apps](https://portal.zuplo.com/+/account/project/ai/apps) tab and
|
|
83
|
+
click on the app to edit
|
|
81
84
|
2. Enable the **Semantic Caching** toggle under **Advanced Features**
|
|
82
85
|
3. Save your changes
|
|
83
86
|
|
|
@@ -34,11 +34,9 @@ easy to investigate issues, track changes, and demonstrate compliance.
|
|
|
34
34
|
## Accessing Audit Logs
|
|
35
35
|
|
|
36
36
|
Audit logs are available for accounts on the Enterprise plan. To access your
|
|
37
|
-
audit logs
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
2. Click on **Audit Logs** in the left sidebar
|
|
41
|
-
3. View the chronological list of all account activities
|
|
37
|
+
audit logs, open
|
|
38
|
+
[**Account Settings → Audit Logs**](https://portal.zuplo.com/+/account/settings/audit-logs)
|
|
39
|
+
in the Zuplo Portal to view the chronological list of all account activities.
|
|
42
40
|
|
|
43
41
|
:::note
|
|
44
42
|
|
|
@@ -3,8 +3,10 @@ title: Zuplo Billing
|
|
|
3
3
|
sidebar_label: Billing
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
The
|
|
7
|
-
|
|
6
|
+
The
|
|
7
|
+
[**Account Settings → Billing**](https://portal.zuplo.com/+/account/settings/upgrade-billing)
|
|
8
|
+
page in the Zuplo dashboard allows you to subscribe to a Zuplo plan, update your
|
|
9
|
+
payment method, and view your billing history.
|
|
8
10
|
|
|
9
11
|
Zuplo uses Stripe to process payments. When you subscribe to a Zuplo plan, you
|
|
10
12
|
will be redirected to the Stripe checkout page to enter your payment
|
|
@@ -13,9 +15,11 @@ Zuplo dashboard.
|
|
|
13
15
|
|
|
14
16
|
## Update Payment Method
|
|
15
17
|
|
|
16
|
-
When you navigate to the
|
|
17
|
-
|
|
18
|
-
page
|
|
18
|
+
When you navigate to the
|
|
19
|
+
[**Account Settings → Billing**](https://portal.zuplo.com/+/account/settings/upgrade-billing)
|
|
20
|
+
page, you will see a link to manage your existing subscription. Clicking this
|
|
21
|
+
link will take you to the Stripe checkout page where you can update your payment
|
|
22
|
+
method.
|
|
19
23
|
|
|
20
24
|
:::note{title="Enterprise Plans"}
|
|
21
25
|
|
|
@@ -23,9 +23,8 @@ To delete the default API key, follow these steps:
|
|
|
23
23
|
|
|
24
24
|
{/* prettier-ignore */}
|
|
25
25
|
<Stepper>
|
|
26
|
-
1.
|
|
27
|
-
2.
|
|
28
|
-
3.
|
|
29
|
-
4.
|
|
30
|
-
5. Confirm the deletion when prompted.
|
|
26
|
+
1. Open [**Account Settings → API Keys**](https://portal.zuplo.com/+/account/settings/api-keys) in the Zuplo Portal.
|
|
27
|
+
2. Locate the default API key in the list. It will be labeled "Default consumer for account-name" and have a "default" tag.
|
|
28
|
+
3. Click the **Delete** button next to the default API key.
|
|
29
|
+
4. Confirm the deletion when prompted.
|
|
31
30
|
</Stepper>
|
|
@@ -8,19 +8,19 @@ sure you want to delete your account, follow these steps:
|
|
|
8
8
|
|
|
9
9
|
<Stepper>
|
|
10
10
|
|
|
11
|
-
1. Remove any custom domains from your
|
|
12
|
-
**Custom Domains**
|
|
13
|
-
domains.
|
|
11
|
+
1. Remove any custom domains from your account. You can do this from
|
|
12
|
+
[**Account Settings → Custom Domains**](https://portal.zuplo.com/+/account/settings/custom-domains).
|
|
14
13
|
1. Delete all your projects. You can do this by going to the **General** tab in
|
|
15
14
|
your each project settings and clicking the **Delete Project** button.
|
|
16
|
-
1. Remove any additional team members from your account. You can do this
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
1. Once you have completed the above steps, go to
|
|
23
|
-
|
|
15
|
+
1. Remove any additional team members from your account. You can do this from
|
|
16
|
+
[**Account Settings → Members**](https://portal.zuplo.com/+/account/settings/members).
|
|
17
|
+
1. You must also unsubscribe from any paid plans. You can do this from
|
|
18
|
+
[**Account Settings → Billing**](https://portal.zuplo.com/+/account/settings/upgrade-billing).
|
|
19
|
+
You will need to wait until the end of your billing cycle to delete your
|
|
20
|
+
account.
|
|
21
|
+
1. Once you have completed the above steps, go to
|
|
22
|
+
[**Account Settings → General**](https://portal.zuplo.com/+/account/settings/general)
|
|
23
|
+
and click the **Delete Account** button.
|
|
24
24
|
1. Confirm that you want to delete your account by entering your the text shown
|
|
25
25
|
in the confirmation box.
|
|
26
26
|
1. Click the **Delete Account** button to permanently delete your account.
|
|
@@ -21,8 +21,9 @@ by following the steps below.
|
|
|
21
21
|
|
|
22
22
|
<Stepper>
|
|
23
23
|
|
|
24
|
-
1.
|
|
25
|
-
|
|
24
|
+
1. Open
|
|
25
|
+
[**Account Settings → Security**](https://portal.zuplo.com/+/account/settings/security)
|
|
26
|
+
in the Zuplo Portal.
|
|
26
27
|
1. In the section labeled "Single Sign On (SSO)", click the "Setup Single
|
|
27
28
|
Sign-On" button.
|
|
28
29
|
1. This will open a new window hosted by Auth0 that allows you to configure SSO
|
|
@@ -39,7 +40,8 @@ by following the steps below.
|
|
|
39
40
|
|
|
40
41
|
If you need to edit your SSO configuration after the initial setup, you can do
|
|
41
42
|
so by clicking the "Edit Connection" button in the "Single Sign On (SSO)"
|
|
42
|
-
section of
|
|
43
|
+
section of
|
|
44
|
+
[**Account Settings → Security**](https://portal.zuplo.com/+/account/settings/security).
|
|
43
45
|
|
|
44
46
|
This will open the Auth0 configuration window where you can make changes to your
|
|
45
47
|
connection settings. This is useful if you need to rotate certificates or client
|
|
@@ -8,9 +8,9 @@ manage users in your account.
|
|
|
8
8
|
|
|
9
9
|
## Add Account Member
|
|
10
10
|
|
|
11
|
-
To start,
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
To start, open
|
|
12
|
+
[**Account Settings → Members**](https://portal.zuplo.com/+/account/settings/members)
|
|
13
|
+
in the Zuplo Portal.
|
|
14
14
|
|
|
15
15
|
The view will display the users that are currently members of the account and
|
|
16
16
|
their roles.
|
|
@@ -12,10 +12,10 @@ accessible areas such as GitHub repositories.
|
|
|
12
12
|
|
|
13
13
|
## Creating an API Key
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
15
|
+
Open
|
|
16
|
+
[**Account Settings → API Keys**](https://portal.zuplo.com/+/account/settings/api-keys)
|
|
17
|
+
in the Zuplo Portal to view the API keys in your account that you have access
|
|
18
|
+
to.
|
|
19
19
|
|
|
20
20
|

|
|
21
21
|
|
|
@@ -26,8 +26,10 @@ only view their own API keys. Members don't have access to API keys.
|
|
|
26
26
|
|
|
27
27
|
:::
|
|
28
28
|
|
|
29
|
-
Select the
|
|
30
|
-
|
|
29
|
+
Select the
|
|
30
|
+
[**Create API Key**](https://portal.zuplo.com/+/account/settings/api-keys/create)
|
|
31
|
+
button to create a new API key. You can enter a label, expiration, and select
|
|
32
|
+
the permissions for your new API key.
|
|
31
33
|
|
|
32
34
|
<EnterpriseFeature name="Fine-grained API Key Management" />
|
|
33
35
|
|
|
@@ -3,10 +3,11 @@ title: Manage Keys in the Portal
|
|
|
3
3
|
sidebar_label: Manage in the Portal
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
API Key Consumers can be managed
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
environments
|
|
6
|
+
API Key Consumers can be managed from your project's
|
|
7
|
+
[**Services**](https://portal.zuplo.com/+/account/project/services) page in the
|
|
8
|
+
Zuplo Portal. Each project is created with three API Key Buckets - one for
|
|
9
|
+
production, one shared by preview environments, and one for development (working
|
|
10
|
+
copy) environments.
|
|
10
11
|
|
|
11
12
|

|
|
12
13
|
|
|
@@ -40,7 +41,9 @@ or more managers, via e-mail, to be a manager for your API Key Consumer. This is
|
|
|
40
41
|
optional if you aren't using the
|
|
41
42
|
[Developer Portal](../dev-portal/introduction.mdx).
|
|
42
43
|
|
|
43
|
-
You can assign managers
|
|
44
|
+
You can assign managers from your project's
|
|
45
|
+
[Services](https://portal.zuplo.com/+/account/project/services) page in the
|
|
46
|
+
Zuplo Portal or via the API.
|
|
44
47
|
|
|
45
48
|
If you want to automatically create an API Key for a customer automatically when
|
|
46
49
|
they sign into your developer portal using Auth0,
|
|
@@ -43,9 +43,10 @@ hand in the admin portal does not scale to a production user base.
|
|
|
43
43
|
:::
|
|
44
44
|
|
|
45
45
|
For development or one-off needs, the easiest way to obtain an API key is in the
|
|
46
|
-
[Zuplo Portal](https://portal.zuplo.com). Open
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
[Zuplo Portal](https://portal.zuplo.com). Open your project's
|
|
47
|
+
[**Services**](https://portal.zuplo.com/+/account/project/services) page, find
|
|
48
|
+
the **API Key Service**, click **Configure**, and you can view existing keys or
|
|
49
|
+
create new keys for your consumers manually.
|
|
49
50
|
|
|
50
51
|

|
|
51
52
|
|
|
@@ -48,11 +48,15 @@ Before you start, you need:
|
|
|
48
48
|
[API Key Authentication policy](../policies/api-key-inbound.mdx) configured on
|
|
49
49
|
your routes.
|
|
50
50
|
- A **Zuplo API key** for the Developer API. Create one in the Zuplo Portal
|
|
51
|
-
under
|
|
51
|
+
under
|
|
52
|
+
[**Account Settings → Zuplo API Keys**](https://portal.zuplo.com/+/account/settings/api-keys).
|
|
52
53
|
[More information](./accounts/zuplo-api-keys).
|
|
53
54
|
- Your **account name** and **bucket name**. A bucket groups consumers for an
|
|
54
55
|
environment - each project has buckets for production, preview, and
|
|
55
|
-
development. Find
|
|
56
|
+
development. Find the bucket name on your project's
|
|
57
|
+
[**Services**](https://portal.zuplo.com/+/account/project/services) page, and
|
|
58
|
+
the account name in
|
|
59
|
+
[**Project Settings → General**](https://portal.zuplo.com/+/account/project/settings/general).
|
|
56
60
|
- An application with server-side code and existing user authentication.
|
|
57
61
|
|
|
58
62
|
All examples in this guide use these environment variables:
|
|
@@ -60,9 +64,9 @@ All examples in this guide use these environment variables:
|
|
|
60
64
|
```bash
|
|
61
65
|
# Your Zuplo Account Name
|
|
62
66
|
export ZUPLO_ACCOUNT=my-account
|
|
63
|
-
# Your bucket name (found
|
|
67
|
+
# Your bucket name (found on your project's Services page)
|
|
64
68
|
export ZUPLO_BUCKET=my-bucket
|
|
65
|
-
# Your Zuplo API Key (found in Settings > Zuplo API Keys)
|
|
69
|
+
# Your Zuplo API Key (found in Account Settings > Zuplo API Keys)
|
|
66
70
|
export ZUPLO_API_KEY=zpka_YOUR_API_KEY
|
|
67
71
|
```
|
|
68
72
|
|
|
@@ -107,16 +107,19 @@ git push -u origin my-new-feature
|
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
Within seconds, Zuplo deploys a new environment named `my-new-feature`. You can
|
|
110
|
-
see the new environment in the Zuplo
|
|
110
|
+
see the new environment in the Zuplo Portal's environment selector or on the
|
|
111
|
+
[**Environments**](https://portal.zuplo.com/+/account/project/environments) tab
|
|
112
|
+
of your project.
|
|
111
113
|
|
|
112
114
|
## Deleting Environments
|
|
113
115
|
|
|
114
116
|
When you delete a branch in your Git repository, the corresponding Zuplo
|
|
115
117
|
environment is **not automatically deleted**. To delete an environment:
|
|
116
118
|
|
|
117
|
-
1.
|
|
118
|
-
|
|
119
|
-
|
|
119
|
+
1. In your project, open the
|
|
120
|
+
[**Environments**](https://portal.zuplo.com/+/account/project/environments)
|
|
121
|
+
tab
|
|
122
|
+
2. Select the environment and delete it
|
|
120
123
|
|
|
121
124
|
Alternatively, use the [Zuplo CLI](../cli/delete.mdx):
|
|
122
125
|
|
|
@@ -51,8 +51,9 @@ CLI outputs `Deployed to https://...` which you can parse with `grep` or `sed`.
|
|
|
51
51
|
|
|
52
52
|
1. **Disconnect Git integration** — If you're using Azure Pipelines for
|
|
53
53
|
deployments, disconnect the native Git integration to avoid duplicate
|
|
54
|
-
deployments.
|
|
55
|
-
|
|
54
|
+
deployments. Open your
|
|
55
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
56
|
+
select **Source Control**, and click **Disconnect**.
|
|
56
57
|
|
|
57
58
|
2. **Add your API key** — Store your Zuplo API key as a pipeline variable or in
|
|
58
59
|
a variable group. Go to **Pipelines** > **Library** to create a variable
|
|
@@ -50,8 +50,9 @@ and mark it as an artifact for subsequent steps.
|
|
|
50
50
|
|
|
51
51
|
1. **Disconnect Git integration** — If you're using Bitbucket Pipelines for
|
|
52
52
|
deployments, disconnect the native Git integration to avoid duplicate
|
|
53
|
-
deployments.
|
|
54
|
-
|
|
53
|
+
deployments. Open your
|
|
54
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
55
|
+
select **Source Control**, and click **Disconnect**.
|
|
55
56
|
|
|
56
57
|
2. **Add your API key** — Store your Zuplo API key as a repository variable. Go
|
|
57
58
|
to **Repository settings** > **Repository variables** and add
|
|
@@ -48,8 +48,10 @@ in the deploy job and attach the workspace for the test job.
|
|
|
48
48
|
## Prerequisites
|
|
49
49
|
|
|
50
50
|
1. **Disconnect Git integration** — If you're using CircleCI for deployments,
|
|
51
|
-
disconnect the native Git integration to avoid duplicate deployments.
|
|
52
|
-
|
|
51
|
+
disconnect the native Git integration to avoid duplicate deployments. Open
|
|
52
|
+
your
|
|
53
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
54
|
+
select **Source Control**, and click **Disconnect**.
|
|
53
55
|
|
|
54
56
|
2. **Add your API key** — Store your Zuplo API key as an environment variable.
|
|
55
57
|
Go to **Project Settings** > **Environment Variables** and add
|
|
@@ -67,11 +67,13 @@ use throughout your workflow.
|
|
|
67
67
|
## Prerequisites
|
|
68
68
|
|
|
69
69
|
1. **Disconnect the GitHub integration** — Custom CI/CD replaces automatic
|
|
70
|
-
deployments.
|
|
71
|
-
|
|
70
|
+
deployments. Open your
|
|
71
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
72
|
+
select **Source Control**, and click **Disconnect** to prevent double
|
|
73
|
+
deployments.
|
|
72
74
|
|
|
73
75
|
2. **Add your API key** — Store your Zuplo API key as a GitHub secret named
|
|
74
|
-
`ZUPLO_API_KEY`. Find your key in the Zuplo
|
|
76
|
+
`ZUPLO_API_KEY`. Find your key in the Zuplo Portal under your account
|
|
75
77
|
**Settings** > **API Keys**.
|
|
76
78
|
|
|
77
79
|
## Examples
|
|
@@ -49,8 +49,9 @@ in the deploy job and retrieve it in the test job.
|
|
|
49
49
|
|
|
50
50
|
1. **Disconnect Git integration** — If you're using GitLab CI/CD for
|
|
51
51
|
deployments, disconnect the native Git integration to avoid duplicate
|
|
52
|
-
deployments.
|
|
53
|
-
|
|
52
|
+
deployments. Open your
|
|
53
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
54
|
+
select **Source Control**, and click **Disconnect**.
|
|
54
55
|
|
|
55
56
|
2. **Add your API key** — Store your Zuplo API key as a CI/CD variable. Go to
|
|
56
57
|
**Settings** > **CI/CD** > **Variables** and add `ZUPLO_API_KEY`. Check
|
|
@@ -54,9 +54,9 @@ trivial to implement.
|
|
|
54
54
|
:::warning{title="GitHub Users: Disconnect Automatic Deployments"}
|
|
55
55
|
|
|
56
56
|
If you're using GitHub with custom CI/CD, disconnect the built-in integration to
|
|
57
|
-
prevent double deployments
|
|
58
|
-
|
|
59
|
-
|
|
57
|
+
prevent double deployments. Open your
|
|
58
|
+
[project settings](https://portal.zuplo.com/+/account/project/settings/general),
|
|
59
|
+
select **Source Control**, and click **Disconnect**.
|
|
60
60
|
|
|
61
61
|
GitLab, Bitbucket, and Azure DevOps don't have automatic deployments, so no
|
|
62
62
|
disconnection is needed.
|
|
@@ -65,11 +65,9 @@ disconnection is needed.
|
|
|
65
65
|
|
|
66
66
|
## Getting Your API Key
|
|
67
67
|
|
|
68
|
-
The CLI authenticates with an API key
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
2. Select your account
|
|
72
|
-
3. Navigate to **Settings** > **API Keys**
|
|
68
|
+
The CLI authenticates with an API key. Open
|
|
69
|
+
[**Account Settings → API Keys**](https://portal.zuplo.com/+/account/settings/api-keys)
|
|
70
|
+
in the Zuplo Portal to create one.
|
|
73
71
|
|
|
74
72
|
Store this as a secret in your CI/CD provider (typically `ZUPLO_API_KEY`). Never
|
|
75
73
|
commit API keys to your repository.
|
|
@@ -5,8 +5,9 @@ sidebar_label: Overview
|
|
|
5
5
|
|
|
6
6
|
This guide will walk you through the process of setting up a custom domain for
|
|
7
7
|
your project's edge deployment environment. You can manage all domain settings
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
in the
|
|
9
|
+
[**Custom Domains**](https://portal.zuplo.com/+/account/settings/custom-domains)
|
|
10
|
+
section of your account settings. Zuplo offers Custom Domains on
|
|
10
11
|
[Builder plans and above](https://zuplo.com/pricing).
|
|
11
12
|
|
|
12
13
|
## Types of Custom Domains
|
|
@@ -36,11 +37,12 @@ environment is development if the domain ends with `zuplo.dev`.
|
|
|
36
37
|
The following steps will guide you on how to add and configure a custom domain
|
|
37
38
|
for your Zuplo project.
|
|
38
39
|
|
|
39
|
-
### 1. Navigate to your
|
|
40
|
+
### 1. Navigate to your Custom Domain Settings
|
|
40
41
|
|
|
41
|
-
|
|
42
|
-
**Custom Domains**
|
|
43
|
-
the
|
|
42
|
+
Open
|
|
43
|
+
[**Account Settings → Custom Domains**](https://portal.zuplo.com/+/account/settings/custom-domains)
|
|
44
|
+
in the Zuplo Portal and click the **Add New Custom Domain** button to open the
|
|
45
|
+
`New Custom Domain` configuration modal.
|
|
44
46
|
|
|
45
47
|

|
|
46
48
|
|
|
@@ -98,9 +98,12 @@ relate to each other, see
|
|
|
98
98
|
|
|
99
99
|
## Navigating Environments
|
|
100
100
|
|
|
101
|
-
On the bottom toolbar of the Zuplo
|
|
101
|
+
On the bottom toolbar of the Zuplo Portal you will see a selector for the
|
|
102
102
|
current environment. You can switch between environments by clicking on the name
|
|
103
|
-
of the current environment and then selecting another environment.
|
|
103
|
+
of the current environment and then selecting another environment. To see the
|
|
104
|
+
full list, open the
|
|
105
|
+
[**Environments**](https://portal.zuplo.com/+/account/project/environments) tab
|
|
106
|
+
in your project.
|
|
104
107
|
|
|
105
108
|

|
|
106
109
|
|
|
@@ -13,8 +13,8 @@ If you're not familiar with Zuplo, it's recommended to go through the
|
|
|
13
13
|
|
|
14
14
|
1. Create a **new project**
|
|
15
15
|
|
|
16
|
-
Sign in to
|
|
17
|
-
project.
|
|
16
|
+
Sign in to the Zuplo Portal and
|
|
17
|
+
[create a new project](https://portal.zuplo.com/+/account/projects/new).
|
|
18
18
|
|
|
19
19
|
1. **Import** an **OpenAPI** document
|
|
20
20
|
|
|
@@ -221,8 +221,8 @@ Replace Kong's JWT plugin with one of Zuplo's JWT authentication policies:
|
|
|
221
221
|
|
|
222
222
|
### Step 5: Set up your project and deploy
|
|
223
223
|
|
|
224
|
-
1. Create a new project
|
|
225
|
-
or using the [Zuplo CLI](../cli/overview.md).
|
|
224
|
+
1. [Create a new project](https://portal.zuplo.com/+/account/projects/new) in
|
|
225
|
+
the Zuplo Portal or using the [Zuplo CLI](../cli/overview.md).
|
|
226
226
|
2. Import your OpenAPI spec as the route configuration file.
|
|
227
227
|
3. Add policies to your routes.
|
|
228
228
|
4. Connect your project to [source control](./source-control.md).
|