Skip to content

Commit

Permalink
docs: new architecture diagram (#2433)
Browse files Browse the repository at this point in the history
* updated architecture diagram and tidied things a bit around the diagrams

* docs/new architecture diagram
  • Loading branch information
dabeeeenster committed Jul 13, 2023
1 parent c55e675 commit 2169340
Show file tree
Hide file tree
Showing 9 changed files with 319 additions and 16 deletions.
8 changes: 1 addition & 7 deletions docs/docs/advanced-use/edge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,7 @@ flag.feature_segment

## Architecture

### Core API Only

![Image](/img/core-api-now.svg)

### Core and Edge API

![Image](/img/edge-api-now.svg)
You can see our SaaS architecture [here](/system-administration/architecture.md#saas).

## How It Works

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/deployment/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ We recommend running Flagsmith with [Docker](/deployment/hosting/docker). We hav
The Flagsmith architecture is based around a REST API that is accessed by both SDK clients and the Flagsmith Dashboard
Front End Web App.

![Application Architecture](/img/architecture.svg)
![Application Architecture](/img/self-hosted-architecture.svg)

## Dependencies

Expand Down
296 changes: 295 additions & 1 deletion docs/docs/diagrams/Architecture.drawio

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/docs/system-administration/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Architecture
---

## Self Hosted / On Prem

![Image](/img/self-hosted-architecture.svg)

## SaaS

![Image](/img/saas-architecture.svg)
4 changes: 3 additions & 1 deletion docs/docs/system-administration/edge-proxy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Edge Proxy
---
title: Edge Proxy
---

The Flagsmith Edge Proxy allows you to run an instance of the Flagsmith Engine close to your servers. If you are running
Flagsmith within a server-side environment and you want to have very low latency flags, you have two options:
Expand Down
1 change: 0 additions & 1 deletion docs/docs/system-administration/rbac.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Role Based Access Control
description: Team member and group permissions.
---

Flagsmith provides fine-grained permissions to help larger teams manage access and roles across projects and
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/version-comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ Our SaaS platform has a number of benefits:
- Get real-time flag updates to your clients, the moment they are changed in the dashboard.
- We deal with platform upgrades, security patches, scaling and backups.

### SaaS Architecture

![Image](/img/saas-architecture.svg)

## Enterprise Benefits

You can run our Enterprise version either on-premise, or we can provide private cloud instance dedicated to your
Expand Down
5 changes: 4 additions & 1 deletion docs/static/img/saas-architecture.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/static/img/self-hosted-architecture.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

3 comments on commit 2169340

@vercel
Copy link

@vercel vercel bot commented on 2169340 Jul 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on 2169340 Jul 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./docs

docs-git-main-flagsmith.vercel.app
docs-flagsmith.vercel.app
docs.flagsmith.com
docs.bullet-train.io

@vercel
Copy link

@vercel vercel bot commented on 2169340 Jul 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.