Skip to content

Commit e88bfa3

Browse files
securitypedantcrwaters16
securitypedant
and
crwaters16
authored
Suggested changes to ref arch nav and description (#17083)
* Initial changes * Adding the solutions section * Minor grammar edits * Adding content and updating format * Fixing links * Fixing case of some titles * Minor change * Converting IGs to links * Update src/content/docs/reference-architecture/how-to-use.mdx Co-authored-by: Claire W <[email protected]> * Update src/content/docs/reference-architecture/how-to-use.mdx Co-authored-by: Claire W <[email protected]> * Update src/content/docs/reference-architecture/how-to-use.mdx Co-authored-by: Claire W <[email protected]> * Update src/content/docs/reference-architecture/implementation-guides/index.mdx Co-authored-by: Claire W <[email protected]> * Minor text update --------- Co-authored-by: Claire W <[email protected]>
1 parent d39edfa commit e88bfa3

File tree

15 files changed

+452
-31
lines changed

15 files changed

+452
-31
lines changed

‎src/assets/images/reference-architecture/reference-architecture-hero.svg‎

Lines changed: 214 additions & 0 deletions
Loading

‎src/content/docs/reference-architecture/architectures/index.mdx‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22
title: Reference Architectures
33
pcx_content_type: navigation
44
sidebar:
5-
order: 1
6-
5+
order: 4
76
---
87

9-
import { Description, DirectoryListing, Render } from "~/components"
8+
import { Description, DirectoryListing, Render } from "~/components";
109

1110
<Description>
1211

13-
Diagrams, design patterns and detailed best practices to help you generate solutions with Cloudflare products.
12+
Diagrams, design patterns and detailed best practices to help you generate solutions with Cloudflare products.
13+
1414
</Description>
1515

16-
<Render file="description-of-ref-architectures" product="reference-architecture" /> <br/>
16+
<Render
17+
file="description-of-ref-architectures"
18+
product="reference-architecture"
19+
/> <br />
1720

1821
<DirectoryListing />

‎src/content/docs/reference-architecture/by-solution.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: Find by solution
3+
pcx_content_type: overview
4+
sidebar:
5+
order: 3
6+
---
7+
8+
import { CardGrid, LinkTitleCard, Render } from "~/components";
9+
10+
Use the list below for reference architecture documentation that relates to a solution area you are interested in.
11+
12+
### Cloudflare Connectivity Cloud
13+
14+
Content that pertains to the Cloudflare platform in general.
15+
16+
#### Reference architectures
17+
18+
- [Cloudflare security reference architecture](/reference-architecture/architectures/security/)
19+
- [Multi-vendor Application Security and Performance Reference Architecture](/reference-architecture/architectures/multi-vendor/)
20+
- [Protect network infrastructure with Magic Transit](/reference-architecture/architectures/magic-transit/)
21+
- [Protect Hybrid Cloud Networks with Cloudflare Magic Transit](/reference-architecture/diagrams/network/protect-hybrid-cloud-networks-with-cloudflare-magic-transit/)
22+
23+
#### Reference architecture diagrams
24+
25+
- [Protecting ISP and telecommunications networks from DDoS attacks](/reference-architecture/diagrams/network/protecting-sp-networks-from-ddos/)
26+
27+
#### Design guides
28+
29+
- [Extend Cloudflare's Benefits to SaaS Providers' End-Customers](/reference-architecture/design-guides/extending-cloudflares-benefits-to-saas-providers-end-customers/)
30+
31+
### Zero Trust / SASE
32+
33+
Architecture documentation related to using Cloudflare for Zero Trust, SSE and SASE initiatives for protecting your applications, data, employees and the corporate network.
34+
35+
#### Reference architectures
36+
37+
- [Evolving to a SASE architecture with Cloudflare](/reference-architecture/architectures/sase/)
38+
- [Using Cloudflare SASE with Microsoft](/reference-architecture/architectures/cloudflare-sase-with-microsoft/)
39+
40+
#### Reference architecture diagrams
41+
42+
- [Access to private apps without having to deploy client agents](/reference-architecture/diagrams/sase/sase-clientless-access-private-dns/)
43+
- [Securing data at rest](/reference-architecture/diagrams/security/securing-data-at-rest/)
44+
- [Securing data in transit](/reference-architecture/diagrams/security/securing-data-in-transit/)
45+
- [Securing data in use](/reference-architecture/diagrams/security/securing-data-in-use/)
46+
47+
#### Design guides
48+
49+
- [Building zero trust architecture into your startup](/reference-architecture/design-guides/zero-trust-for-startups/)
50+
- [Network-focused migration from VPN concentrators to Zero Trust Network Access](/reference-architecture/design-guides/network-vpn-migration/)
51+
52+
#### Implementation guides
53+
54+
- [Secure your Internet traffic and SaaS apps](/learning-paths/secure-internet-traffic/)
55+
- [Replace your VPN](/learning-paths/replace-vpn/)
56+
- [Deploy Zero Trust Web Access](/learning-paths/zero-trust-web-access/)
57+
58+
### Application Performance
59+
60+
Content related to DNS, caching, load balancing and other Cloudflare services designed to improve application reliability and performance.
61+
62+
#### Reference architectures
63+
64+
- [Content Delivery Network](/reference-architecture/architectures/cdn/)
65+
- [Load Balancing](/reference-architecture/architectures/load-balancing/)
66+
67+
### Application Security
68+
69+
#### Design guides
70+
71+
- [Secure application delivery](/reference-architecture/design-guides/secure-application-delivery/)
72+
73+
### Developer Platform
74+
75+
Architecture content for our developer platform.
76+
77+
#### Reference architecture diagrams
78+
79+
- [Automatic captioning for video uploads](/reference-architecture/diagrams/ai/ai-video-caption/)
80+
- [Composable AI architecture](/reference-architecture/diagrams/ai/ai-composable/)
81+
- [Content-based asset creation](/reference-architecture/diagrams/ai/ai-asset-creation/)
82+
- [Multi-vendor AI observability and control](/reference-architecture/diagrams/ai/ai-multivendor-observability-control/)
83+
- [Retrieval Augmented Generation (RAG)](/reference-architecture/diagrams/ai/ai-rag/)
84+
- [Optimizing Image Delivery with Cloudflare Image Resizing and R2](/reference-architecture/diagrams/content-delivery/optimizing-image-delivery-with-cloudflare-image-resizing-and-r2/)
85+
- [A/B-testing using Workers](/reference-architecture/diagrams/serverless/a-b-testing-using-workers/)
86+
- [Fullstack Applications](/reference-architecture/diagrams/serverless/fullstack-application/)
87+
- [Serverless ETL pipelines](/reference-architecture/diagrams/serverless/serverless-etl/)
88+
- [Serverless global APIs](/reference-architecture/diagrams/serverless/serverless-global-apis/)
89+
- [Serverless image content management](/reference-architecture/diagrams/serverless/serverless-image-content-management/)
90+
- [Egress-free object storage in multi-cloud setups](/reference-architecture/diagrams/storage/egress-free-storage-multi-cloud/)
91+
- [On-demand Object Storage Data Migration](/reference-architecture/diagrams/storage/on-demand-object-storage-migration/)

‎src/content/docs/reference-architecture/design-guides/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
title: Design Guides
33
pcx_content_type: navigation
44
sidebar:
5-
order: 3
6-
5+
order: 6
76
---
87

9-
import { Description, DirectoryListing, Render } from "~/components"
8+
import { Description, DirectoryListing, Render } from "~/components";
109

1110
<Description>
1211

13-
Diagrams, design patterns and detailed best practices to help you generate solutions with Cloudflare products.
12+
Diagrams, design patterns and detailed best practices to help you generate solutions with Cloudflare products.
13+
1414
</Description>
1515

16-
<Render file="description-of-design-guides" product="reference-architecture" /> <br/>
16+
<Render file="description-of-design-guides" product="reference-architecture" /> <br />
1717

1818
<DirectoryListing />

‎src/content/docs/reference-architecture/diagrams/content-delivery/optimizing-image-delivery-with-cloudflare-image-resizing-and-r2.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Optimizing Image Delivery with Cloudflare Image Resizing and R2
2+
title: Optimizing image delivery with Cloudflare mage resizing and R2
33
pcx_content_type: reference-architecture-diagram
44
products:
55
- Images
@@ -8,7 +8,7 @@ products:
88
- Transform Rules
99
sidebar:
1010
order: 1
11-
label: Optimizing Image Delivery
11+
label: Optimizing image delivery
1212
updated: 2024-06-12
1313
---
1414

‎src/content/docs/reference-architecture/diagrams/index.mdx‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22
title: Reference Architecture Diagrams
33
pcx_content_type: navigation
44
sidebar:
5-
order: 2
6-
5+
order: 5
76
---
87

9-
import { Description, DirectoryListing, Render } from "~/components"
8+
import { Description, DirectoryListing, Render } from "~/components";
109

1110
<Description>
1211

13-
Diagrams, design patterns, and detailed best practices to help you generate solutions with Cloudflare products.
12+
Diagrams, design patterns, and detailed best practices to help you generate solutions with Cloudflare products.
13+
1414
</Description>
1515

16-
<Render file="description-of-ref-architecture-diagrams" product="reference-architecture" /> <br/>
16+
<Render
17+
file="description-of-ref-architecture-diagrams"
18+
product="reference-architecture"
19+
/> <br />
1720

1821
<DirectoryListing />

‎src/content/docs/reference-architecture/diagrams/network/protect-hybrid-cloud-networks-with-cloudflare-magic-transit.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Protect Hybrid Cloud Networks with Cloudflare Magic Transit
2+
title: Protect hybrid cloud networks with Cloudflare Magic Transit
33
pcx_content_type: reference-architecture-diagram
44
products:
55
- Magic Firewall
@@ -9,7 +9,7 @@ products:
99
- BYOIP
1010
sidebar:
1111
order: 1
12-
label: Protect Hybrid Cloud Networks
12+
label: Protect hybrid cloud networks
1313
updated: 2024-09-09
1414
---
1515

‎src/content/docs/reference-architecture/diagrams/serverless/fullstack-application.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Fullstack Applications
2+
title: Fullstack applications
33
pcx_content_type: reference-architecture-diagram
44
products:
55
- Workers
@@ -18,7 +18,7 @@ products:
1818
- DDoS protection
1919
sidebar:
2020
order: 1
21-
label: Fullstack Applications
21+
label: Fullstack applications
2222
updated: 2024-04-29
2323
---
2424

‎src/content/docs/reference-architecture/how-to-use.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: How to use
3+
pcx_content_type: overview
4+
sidebar:
5+
order: 2
6+
---
7+
8+
import { CardGrid, Description, LinkTitleCard, Render } from "~/components";
9+
10+
<Description>
11+
The reference architecture content in our documentation is designed to help you understand how Cloudflare has been designed and built,
12+
and how our products and services integrate with your current IT architecture.
13+
14+
</Description>
15+
16+
Below are the different types of architecture content and information is organized from high level reference architectures, to design guides with best practices and guidelines to implementation guides which provide detailed steps to deploy a specific solution.
17+
18+
## Reference architectures
19+
20+
[Reference architecture](/reference-architecture/architectures/) provide a foundational knowledge of the Cloudflare platform and products while offering a description for how they relate to your existing infrastructure and business challenges. They are high-level, conceptual documents that walk through the concepts of an area of our platform, mapping our network, products and features to the typical architecture of a customer's environment. Detailed diagrams with supporting content explain how our technology works and how it can be integrated with your own infrastructure. The goal of a reference architecture is:
21+
22+
- Present thought leadership for a broad technology area
23+
- Visualize the architecture of Cloudflare and understand how it's been designed
24+
- Explain integration points between Cloudflare and your infrastructure
25+
26+
## Reference architecture diagrams
27+
28+
A [reference architecture diagram](/reference-architecture/diagrams/) focusses on a specific solution or use case where Cloudflare can be used. One or more diagrams are the primary content with supporting introduction and summary. These can focus on sections from a reference architecture that are not fully developed. The goal of this type of document is:
29+
30+
- Visualize the components of a specific solution's architecture
31+
- Provide a quick answer to a specific question around a use case
32+
33+
## Design guides
34+
35+
These [guides](/reference-architecture/design-guides/) are typically aimed at architects, developers, and IT professionals who are tasked with designing and deploying systems that leverage the company's technologies. They typically focus on a specific solution that would be a subset of the greater architecture. For example, if you have read our [SASE Reference Architecture](/reference-architecture/architectures/sase/), but are a startup, you may want to understand the details of using a [SASE approach for a small startup](/reference-architecture/design-guides/zero-trust-for-startups/). These documents are:
36+
37+
- Helping you think through how to design a deployment of Cloudflare as part of an overall solution.
38+
- More prescriptive than reference architectures, sharing best practices and guidelines.
39+
- Focused on a solution design that you are trying to achieve, such as connecting private networks to Cloudflare, or using a web application firewall to secure a public website.
40+
- Not a replacement for product documentation and do not describe specific product configuration or commands to run.
41+
42+
## Implementation guides
43+
44+
Implementation guides provide [step-by-step instructions](/reference-architecture/implementation-guides/) and practical guidance for how to effectively deploy and configure specific solutions or services. Implementation guides are focused on a specific implementation goal. While a design guide provides the overall best practices for designing a solution, an implementation guide details the actual steps to deploy in the context of a specific job-to-be-done. These documents are:
45+
46+
- Focused on a specific implementation outcome, such as connecting a remote office using the Magic WAN Connector.
47+
- Provide information about the exact commands and configuration steps to take.

‎src/content/docs/reference-architecture/implementation-guides/index.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Implementation Guides
3+
pcx_content_type: navigation
4+
sidebar:
5+
order: 7
6+
---
7+
8+
import { Description, DirectoryListing, Render } from "~/components";
9+
10+
Implementation guides provide [step-by-step instructions](/reference-architecture/implementation-guides/) and practical guidance for how to effectively deploy and configure specific solutions or services. Implementation guides are focused on a specific implementation goal.
11+
12+
## Zero Trust
13+
14+
- [Secure your Internet traffic and SaaS apps](/learning-paths/secure-internet-traffic/)
15+
- [Replace your VPN](/learning-paths/replace-vpn/)
16+
- [Deploy Zero Trust Web Access](/learning-paths/zero-trust-web-access/)

0 commit comments

Comments
 (0)