Skip to content

Commit 705bfa1

Browse files
committed
fixed gitignore
1 parent f349598 commit 705bfa1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+64
-1302
lines changed

.gitignore

+6-6
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ docs/dev-portal/zudoku/
5757
# We want to ignore our StylesPath *except* for our local
5858
# `vocabularies/Base` directory.
5959

60-
.github/styles/*
61-
!.github/styles/config/
60+
.styles/*
61+
!.styles/config/
6262

63-
.github/styles/config/*
64-
!.github/styles/config/vocabularies/
63+
.styles/config/*
64+
!.styles/config/vocabularies/
6565

66-
.github/styles/config/vocabularies/*
67-
!.github/styles/config/vocabularies/Base
66+
.styles/config/vocabularies/*
67+
!.styles/config/vocabularies/Base

.vale.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
StylesPath = styles
1+
StylesPath = .styles
22

33
MinAlertLevel = suggestion
44

docs/dedicated/architecture.md

+57-60
Original file line numberDiff line numberDiff line change
@@ -3,56 +3,54 @@ title: Managed Dedicated Architecture
33
sidebar_label: Architecture
44
---
55

6-
Zuplo's managed dedicated instances are designed to be highly available,
7-
scalable, and secure. With a managed dedicated instance of Zuplo, your API
8-
Gateway is isolated to its own instances and when running in on a cloud provider
9-
that supports it, a dedicated VPC as well. This document outlines the components
10-
and architecture of a managed dedicated instance of a Zuplo API Gateway.
6+
Zuplo's managed dedicated instances are highly available, scalable, and secure.
7+
With a managed dedicated instance of Zuplo, your API Gateway runs on isolated
8+
instances and, when running on a cloud provider that supports it, a dedicated
9+
VPC. This document outlines the components and architecture of a managed
10+
dedicated instance of a Zuplo API Gateway.
1111

1212
## Components
1313

1414
A managed dedicated instance of Zuplo consists of the following components:
1515

16-
- **API Gateway**: The API Gateway is the core component of Zuplo. It's the
17-
component that receives incoming requests, routes them to the appropriate
18-
backend, and returns the response to the client. The API Gateway is
19-
responsible for authentication, authorization, rate limiting, and other
20-
features.
21-
- **Gateway Services**: Because Zuplo is a highly distributed API Gateway,
22-
services are used to facilitate features such as
16+
- **API Gateway**: The API Gateway is the core component of Zuplo. It receives
17+
incoming requests, routes them to the appropriate backend, and returns the
18+
response to the client. The API Gateway handles authentication, authorization,
19+
rate limiting, and other features.
20+
- **Gateway Services**: Zuplo, being a highly distributed API Gateway, uses
21+
services to facilitate features such as
2322
[Rate Limiting](../articles/rate-limiting.md),
2423
[API Key Authentication](../articles/api-key-management.md), and
2524
[Monetization](../articles/monetization.md).
26-
- **Control Plane**: The Control Plane is the component that manages the
27-
configuration of the API Gateway. It's responsible for deploying new
28-
configurations, managing the lifecycle of the API Gateway, and monitoring the
29-
health of the API Gateway.
30-
- **Analytics and Logging**: Zuplo can provide analytics and logging for your
31-
API Gateway. This includes request/response logging, error logging, and
32-
analytics on request volume, latency, and other metrics.
25+
- **Control Plane**: The Control Plane manages the configuration of the API
26+
Gateway. It deploys new configurations, manages the lifecycle of the API
27+
Gateway, and monitors its health.
28+
- **Analytics and Logging**: Zuplo provides analytics and logging for your API
29+
Gateway. This includes request/response logging, error logging, and analytics
30+
on request volume, latency, and other metrics.
3331
- **Developer Portal**: The Developer Portal is a web-based interface that
3432
allows developers to interact with your API. It provides documentation,
3533
testing tools, and other features to help developers integrate with your API.
3634

3735
## Custom requirements
3836

39-
A managed dedicated instance of Zuplo can be customized to meet your specific
40-
requirements. Examples of custom requirements include:
37+
Customize a managed dedicated instance of Zuplo to meet your specific
38+
requirements. Examples include:
4139

4240
- **Regions & Availability Zones** - Zuplo can deploy to multiple regions,
4341
availability zones, or data centers to provide high availability and low
4442
latency.
45-
- **Developer Portal Hosting** - The developer portal is typically hosted from a
46-
CDN managed by Zuplo. Our default configuration serves the developer portal's
43+
- **Developer Portal Hosting** - The developer portal typically hosts from a CDN
44+
managed by Zuplo. Our default configuration serves the developer portal's
4745
static assets from a global CDN, but we can configure your developer portal to
4846
use only regional CDN locations if required.
49-
- **Networking** - Zuplo can be deployed with a variety of network
50-
configurations. To learn more see [Networking](./networking.md).
47+
- **Networking** - Zuplo can deploy with a variety of network configurations. To
48+
learn more, see [Networking](./networking.md).
5149
- **Disabling Features** - Zuplo can disable features that aren't needed for
5250
your use case or that don't meet your security or compliance requirements. For
5351
example, if you don't want to use the built-in API analytics and instead want
54-
to use your own analytics, we can disable the built-in analytics. When our
55-
built-in analytics is disabled, we don't collect or store analytics data for
52+
to use your own analytics, we can disable the built-in analytics. When we
53+
disable our built-in analytics, we don't collect or store analytics data for
5654
your APIs.
5755
- **Custom Logging & Monitoring** - Zuplo can integrate with your existing
5856
logging and monitoring systems. Logs and other data are sent directly from the
@@ -62,29 +60,28 @@ requirements. Examples of custom requirements include:
6260
## Security
6361

6462
Security is a top priority for Zuplo. A managed dedicated instance of Zuplo is
65-
isolated from other customers and is designed to be secure by default. Some of
66-
the security features of a managed dedicated instance of Zuplo include:
63+
isolated from other customers and is secure by default. Some security features
64+
of a managed dedicated instance of Zuplo include:
6765

6866
- **Isolation**: Each dedicated managed instance of Zuplo runs on its own VPC or
69-
network. This provides isolation from other customers and ensures that your
70-
data is secure.
67+
network. This isolates it from other customers and ensures that your data is
68+
secure.
7169
- **Encryption**: Zuplo encrypts data in transit and at rest. All data sent to
7270
or from the API Gateway is encrypted using TLS. Data stored by Zuplo is
7371
encrypted at rest.
7472
- **Access Control**: Zuplo provides robust authentication and access control
75-
mechanisms. You can control who has access to your API Gateway management
73+
mechanisms. You control who has access to your API Gateway management
7674
capabilities, what they can do, and what data they can access.
77-
- **Audit Logs**: Zuplo can provide detailed audit logs of all management
75+
- **Audit Logs**: Zuplo provides detailed audit logs of all management
7876
operations. You can see who did what, when they did it, and what data they
7977
accessed. Additionally, Zuplo maintains internal audit logs of all activity
8078
performed by the Zuplo team.
8179

8280
## Architecture
8381

84-
The architecture of a managed dedicated instance of Zuplo is designed to provide
85-
you will all the benefits of a SaaS platform, while also giving you the control
86-
and isolation of a dedicated instance. The architecture is designed to be highly
87-
available, scalable, and secure.
82+
The architecture of a managed dedicated instance of Zuplo provides you with all
83+
the benefits of a SaaS platform while giving you the control and isolation of a
84+
dedicated instance. The architecture is highly available, scalable, and secure.
8885

8986
The following diagram shows the high-level architecture of a managed dedicated
9087
instance of Zuplo.
@@ -93,55 +90,55 @@ instance of Zuplo.
9390

9491
### Deployments
9592

96-
When you deploy to your managed dedicated instance of Zuplo, your source code
97-
and configuration files are uploaded to the Control Plane. The Control Plane
98-
then deploys your API Gateway to the appropriate infrastructure. The API Gateway
99-
is deployed to multiple nodes in multiple regions to provide high availability
100-
and low latency. If you are running in multiple regions, the Control Plane
101-
manages the deployment to each region without any downtime.
93+
When you deploy to your managed dedicated instance of Zuplo, you upload your
94+
source code and configuration files to the Control Plane. The Control Plane then
95+
deploys your API Gateway to the appropriate infrastructure. The API Gateway
96+
deploys to multiple nodes in multiple regions to provide high availability and
97+
low latency. If you run in multiple regions, the Control Plane manages the
98+
deployment to each region without any downtime.
10299

103-
If you are using Zuplo's Developer Portal, the control plane also deploys the
104-
web application that powers the Developer Portal. The Developer Portal is hosted
105-
on a CDN to provide low latency access to end-users. The CDN configuration can
106-
be customized to meet your specific requirements.
100+
If you use Zuplo's Developer Portal, the control plane also deploys the web
101+
application that powers the Developer Portal. The Developer Portal hosts on a
102+
CDN to provide low latency access to end-users. The CDN configuration can be
103+
customized to meet your specific requirements.
107104

108105
<ManagedDedicatedDeploymentArchitecture />
109106

110107
### Multiple regions
111108

112109
It's common practice to deploy your API Gateway to multiple regions to provide
113-
higher available, lower latency, and to meet regulatory requirements. Zuplo can
110+
higher availability, lower latency, and meet regulatory requirements. Zuplo can
114111
deploy your API Gateway to multiple regions and manage the deployment to each
115112
region without any downtime.
116113

117-
When your API Gateway is deployed to multiple regions, Zuplo uses a global load
114+
When you deploy your API Gateway to multiple regions, Zuplo uses a global load
118115
balancer to route traffic to the closest region. This provides low latency
119-
access to your APIs for end-users around the world. The load balancer is also
120-
configured to handle fail over in case of an outage in one region.
116+
access to your API's for end-users around the world. The load balancer also
117+
handles fail over in case of an outage in one region.
121118

122119
<ManagedDedicatedMultiRegionArchitecture />
123120

124121
### Environments
125122

126123
Customers running managed dedicated Zuplo typically have multiple instances of
127-
Zuplo deployed. The most common case is to have a production instances and a
124+
Zuplo deployed. The most common case is to have a production instance and a
128125
non-production instance. The non-production instance is used to deploy and test
129126
changes to your API Gateway before deploying them to production.
130127

131128
Each instance is isolated and runs in its own VPC or network.
132129

133130
It's possible to have multiple instances depending on your requirements. For
134131
example, some customers have separate instances for production, staging, and
135-
development. For most customer though, a single production and a single
136-
development instance is sufficient.
132+
development. For most customers, though, a single production and a single
133+
development instance are sufficient.
137134

138135
When you onboard to Zuplo, you will work with your account manager to determine
139-
the configuration that best meets your requirements. When your project is
140-
created it will be pre-configured with the agreed upon number of instances and
141-
setup with rules that determine where each environment gets deployed.
136+
the configuration that best meets your requirements. When we create your
137+
project, we pre-configure it with the agreed-upon number of instances and set up
138+
rules that determine where each environment gets deployed.
142139

143-
The most common setup is where your `main` branch is deployed to production and
144-
all other branches are deployed to a non-production environment, but this is
145-
fully customizable.
140+
The most common setup is where your `main` branch deploys to production and all
141+
other branches deploy to a non-production environment, but this is fully
142+
customizable.
146143

147144
<ManagedDedicatedEnvironmentsArchitecture />

styles/.vale-config/1-MDX.ini

-21
This file was deleted.

styles/Custom/Dictionary.yml

-11
This file was deleted.

styles/Microsoft/AMPM.yml

-9
This file was deleted.

styles/Microsoft/Accessibility.yml

-30
This file was deleted.

styles/Microsoft/Acronyms.yml

-64
This file was deleted.

0 commit comments

Comments
 (0)