diff --git a/docs/docs/advanced-use/edge-api.md b/docs/docs/advanced-use/edge-api.md index 89fd6aa5e193..add07efa35d8 100644 --- a/docs/docs/advanced-use/edge-api.md +++ b/docs/docs/advanced-use/edge-api.md @@ -136,13 +136,7 @@ flag.feature_segment ## Architecture -### Core API Only - - - -### Core and Edge API - - +You can see our SaaS architecture [here](/system-administration/architecture.md#saas). ## How It Works diff --git a/docs/docs/deployment/overview.md b/docs/docs/deployment/overview.md index 008f8f1ae5e1..6d677899e69e 100644 --- a/docs/docs/deployment/overview.md +++ b/docs/docs/deployment/overview.md @@ -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. - + ## Dependencies diff --git a/docs/docs/diagrams/Architecture.drawio b/docs/docs/diagrams/Architecture.drawio index 34a328a08eb7..a1452c32b08b 100644 --- a/docs/docs/diagrams/Architecture.drawio +++ b/docs/docs/diagrams/Architecture.drawio @@ -1 +1,295 @@ -7Vnbcts2EP0azdgP1pAASVGP1s3N1G0VKzNtnzIQCVKIIYIFoVu+PosQvMuO41q2PK2kkYCD22KxZ3dB9fB4vb+RJF39JkLKe8gK9z086SE0dDF8a+CQAzb27RyJJQsNVgEL9pUa0DLohoU0a3RUQnDF0iYYiCShgWpgREqxa3aLBG+umpKYdoBFQHgX/ZOFapWjPhpU+C+UxatiZdsb5i1rUnQ2O8lWJBS7GoSnPTyWQqi8tN6PKdfKK/SSj5s90FoKJmminjJgTqOvQbplNx/vtgeENuFnN7oys2wJ35gN300XnwC5nn+A74vJF5LEAkp3NFPwM5NkTXdC3sM684NaieTS7E4dCpVJsUlCqle1e3i0WzFFFykJdOsOjASwlVpz0xwxzseCC/l9LA5d6ocO4JmS4p7WWny0xJ4HLd19F5ugUtF9DTJ6uKFiTZU8QBfTihxzJsYqsWfqu+qInaLPqna8RT9irCoup64UDwWj+585B9xRIw3BEE1VSFB1LBLCpxU6qhRtQa3qcytEatT7hSp1MKwiGyWays8UkepaswSAgJMsY0EBzxgvuoGi5eEvvUzf9kvgbwCurL5llchkb0TJa4d6bU4lA1VRacAHTzETGxnQR1RlNAUyxlT92LS1Gh+1CUk5UWzb5PuxAzZD54IlqrIljKw+smovt2la7qDvNefMJTfTtOymlOv5poQ7lJ5xEmdrBpaNrAnJVktBZNhDHgf1jZYSSrEuXdxRAh4UzX4HL/6ytKY2EHtwjNZDb4DJiWiN3C6tbe81aV36/leldY2vA8up89XuP4+tT3QUzye1XcT2V2f1v3Pb3fg5F5mKJV18vO0cPWQAqS4GB87ghCX+MY+WuS3cLkuABPfxdwv5Y6NgGlq48twYbPdITCXUj4Jj5PMCny6jlyGfazXJ5/hHyGcdIZ9/spg6eGPy+QO3Tj4dK9F5ss95n+xzOuwrolqWkqRx9N4/G51oj4Lc+q+1kPHyAmwPPrC8VStd6qLWp1Wx7ao1ELluOaBVvqxWK0LrYvIrtI0500djRIQt51LmXTq2KnJ+j8uLjZYpEomqERjeM62wUSxJqCcv2hKhPUPbE5Tdm57AdA4hNSgtXxOfwTXoliwpB5/GFBMJtClNg7L1mrNYo0uhlFhDAzFAALJo+23kBCC7oY2NirrZr16SZGm+0YjttRyjVKdIVE63MFlW+DnjQ9f7WF84+2SXOf21WDJOPwe5fvGIt4QupXkBP+fZTT9nH0kysNV3hl1P5/qnSjPsjvW8rqeDi34rzThXTzd8n55u2PF0H5KIb/aTUTeP/wQqhb4L0C3N/ltJCEbnloQg742p2UxBzpKU6KlXenxWpETdm/aEbikXKaiufegPxLL8iaDVjr6NZzRHQnWLXK6l348FvmeG86M5SCfGt2OyiCIW0H5It/CT9TlJ82VegOBoaDejr4c6BC/CbJ3f2DmVEbz1JcNDg/YTOds7T5q/z1sG6t4ymun8/0w/BdPL0F3m2V6H6YMjkdzxftoOoFr9DZM/hq3+zMLTbw==7VxbV+M2EP41eYTju53HkGRpu2yXkqXL9qVHtpXExbZSWQHSX1/JluOLlAvYJoYlHEAay4o839w0o2Sgj6OnSwxWyy/Ih+FAU/yngT4ZaOxl03+MsskotjPMCAsc+BlJLQiz4D/IiQqnrgMfJpWBBKGQBKsq0UNxDD1SoQGM0WN12ByF1XddgQUUCDMPhCL1e+CTZUZ1TKWg/wKDxTJ/Z1XhVyKQD+aEZAl89Fgi6dOBPsYIkawVPY1hyJiX8yW779OOq9uFYRiTY24Y3XjD6b1y8cdvHhyO//0ToL/RGUfnAYRr/sADzQLRaqBfxG7C/g3YtMeQRt9n/EHJJuceRuvYh2wBKh30uAwInK2Ax64+UnmhtCWJQn4ZhMEipu0QzukDXTxATAIKxIiTCWLjFyFIGKQKbSf3kHhL3gHY49JjpOupM4fzi80Kn0okzqxLiCJI8IYO4VfPdA4cl1wzB/KxkAPb5rRlSQb0IScCLnuL7dwFPLTBEdoBPpVxcPmIlFvdVuZ3n/8iiXVmay3DpVyGyAVhf3CbB2E4RiHC6Tr0ucl+GB3FpETPXmwqgtE9LF2x0tdWAgS4JUKxWwLUmgSYogTolkwCjM4kQG1PAj5IH6S3Ssqs1xWKfRR/WC+p9dJz37TPeuW01q2XNNp4kfuajl8jrqhB55vQ8Q0ZRI7m6iWIGoUY20iBQ2RJQgxdlUCkai1AJHUwjiEwG/o0IuZdhMkSLVAMwmlBvSjgYDpRjLlCjLcpCP9AQjZcVcCaoCpE8Ckgd/x21v7B2ucm702eSpcmm7wT0+e9yydgndJdrFvclvby+xICMBmxrQElxCiGOe1TwFjF7/DzER5T/cDLiHyIuoWf8Wa/flJWojX24B61UHW+sQF4AckecLShXJwwDAEJHqoraV1782U+T31vJidQ3/kcWp4nU1/fHrqK0o362jIL25n6yjFSBWa/hvrmqljSvh8V5ZOrYtq7hjigDw9xSclLc3FrkFsJuS2o6HShsWW1VvdhflhFRQ2Vj1OkdqGByqa30kcDm9KAFQpikpRmvmaEQjKt2t7Vtmq5gdr4bWwgH08b2QoKwdw+SgNXcxJZPVJUXtcDGMeKl9GGNAnwG0oVfsOuTZEtjN9VyMVzxdKop1T0/WJ5YHxjsdyHRcnL3UCWIlG+UTNFvVvIvJCLaWvBWjOCIYiCeEFHzCB+CCjQjfyd4Mrm2g5XZrmW2VIkWpcAyxJd2dZrlV2Z1ZknUwQcRmuMMKC0a5SQBYaJwOhkCVas6W3CgHIc64fZ7WbYXLlbAvDuFyliX9eETgNzw5FZFNUUMYIq3S/YMoyGlq2DtjByakbakWBkSDCyO9vPDU9uwV8ewOdxxplyrihGZeNhmAe2HrRTD1saxBYS6y93mE4nwYVgdjVbO7f1qkfQrPOhOdy+nKP8Q1smWRdtwQ2cUwOwFO3xpxAskl1mWiquV8CFoXzP4VEwGcLCriMKfD+TZkjtAnDT+ZgYcBdIJzcvBuZEKhh7dUmS8+G1Lf4ug3L5SJq2Vs5VQzMr+HE0GwpGXi7aSO9H83kCO8FfFX0yc7UUGeZz0xVOH2AaetRxH09+b+aOjxeFtrN/zfamVtVZ6DJnIXPonRWvdFmtsYYM87urZ+rBc3Ki6ik37HtSOi8o6Ew2MYgQa7BeXsdTvjHuiIFRfzIuB3Lae0RHRPV0sOliKnt6++bC0TaxyKfRz+2q65HtJHQJWGZnWEm8B1rTtWjKKKJRnAc+gJMBp5unBs4UgBslAUjXrClioeJnRK1W5Du9slkCZrczjpjo7z8QO72WmaYAyztNwx7cYFs7oGu4bVKtqmHdJnLyKbIUQRvbZ+ljSVJpLzt1wSSAec3rX+nfM/p7BSLXF91nH8rzlWMalfMb+TnMo2PSZ+0pelDDz4uAteC0leMyL81ONzvKwlJySulVTU5Zkm2cqg3Pc8tW5npnTLfEKDN1fGMq33OE46ChmvSS8XYfGL8zSvyyjlwQvEG2C1FdLwRczN9UzxArI8+DIcSAUJ6cJufmA+jMpfBYngPdeScW35Sk1qQWX+8MGkeAJk2DR0G6y52AZOkigP0ToeIqUIeWDBUFOorjtIOKUYuyZLCoMo3pDBZbtEypS/i6DNAbtEqHnMGwB0bKFrefs3KeR5kBljO9BuvwHUJgq32AQOInMn88C+IFWCF8ogMS7brkPoQ+tmj3c1ZDtG74sZ5+sLkXRkWs0eRs3vgx3LwDPvfCcjhigvA9nz3vy+HDY8+2Nj172Ow4mKCC49SRZMmoU+hfo/K8Wbdzr3neTq58YuQk8LXr8nydK7qMK6+bS8tX8LzcaXn3dZtAfIqCfMcfPtsjRHsL9a+Nn+wDszUs8irUOgpHHkteFCxOz4ZdoyQgAWKsdhEhKNqJQQkzlBWjxtvvJWh2BGIXZ7fndyuKY4h6I6spdWdM+nDWR+2dMXHEeP0IYzKbfP7ZzMjh8z6vjZzsmNZbNCP7i9M9MyP55u/9l6bLQfreOORwDduRI9w0TKfd4rtqssp08Y0/+vR/ \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/docs/system-administration/architecture.md b/docs/docs/system-administration/architecture.md new file mode 100644 index 000000000000..52acdeaf5517 --- /dev/null +++ b/docs/docs/system-administration/architecture.md @@ -0,0 +1,11 @@ +--- +title: Architecture +--- + +## Self Hosted / On Prem + + + +## SaaS + + diff --git a/docs/docs/system-administration/edge-proxy.md b/docs/docs/system-administration/edge-proxy.md index 8c1ee616094e..e62daa9ff029 100644 --- a/docs/docs/system-administration/edge-proxy.md +++ b/docs/docs/system-administration/edge-proxy.md @@ -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: diff --git a/docs/docs/system-administration/rbac.md b/docs/docs/system-administration/rbac.md index 23b31ab8276e..4f08760773ac 100644 --- a/docs/docs/system-administration/rbac.md +++ b/docs/docs/system-administration/rbac.md @@ -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 diff --git a/docs/docs/version-comparison.md b/docs/docs/version-comparison.md index da0b46fc6f9f..9afceac28074 100644 --- a/docs/docs/version-comparison.md +++ b/docs/docs/version-comparison.md @@ -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 - - - ## Enterprise Benefits You can run our Enterprise version either on-premise, or we can provide private cloud instance dedicated to your diff --git a/docs/static/img/saas-architecture.svg b/docs/static/img/saas-architecture.svg index d37acc202653..8ec9c1871ff7 100644 --- a/docs/static/img/saas-architecture.svg +++ b/docs/static/img/saas-architecture.svg @@ -1 +1,4 @@ -AWSAWSAWS GlobalAWS GlobalAWS London...ECSECSRDSRDSReal TimeStreaming ServiceReal Time...Aurora PostgresAurora PostgresRefreshFlagsStreamRefresh...Server Sent EventsCDNServer Sent Events...Dynamo DB Global TablesDynamo DB Global TablesEUEUSouth AmericaSouth AmericaAsia x 4Asia x 4US x 2US x 2Edge API - LambdaEdge API - LambdaEU LondonEU LondonUS CaliforniaUS CaliforniaAsia MumbaiAsia MumbaiAWS Global AcceleratorAWS Global AcceleratorFlagsmith DashboardFlagsmith DashboardUS OhioUS OhioS America Sao PauloS America Sao PauloAsia SingaporeAsia SingaporeAsia SeoulAsia SeoulAsia SydneyAsia SydneyCore APICore APIFlagsmith UsersFlagsmith UsersSDK UsersSDK UsersText is not SVG - cannot display \ No newline at end of file + + + + Vercel... AWS Global AWS Global AWS LondonAW... ECS ECS RDS RDSReal TimeStreaming ServiceReal Time...Aurora PostgresAurora PostgresRefreshFlagsStreamRefresh...Server Sent EventsCDNServer Sent Events... Dynamo DB Global Tables Dynamo DB Global TablesEUEUSouth AmericaSouth AmericaAsia x 4Asia x 4US x 2US x 2 Edge API - Lambda Edge API - LambdaEU LondonEU LondonUS CaliforniaUS CaliforniaAsia MumbaiAsia MumbaiAWS Global AcceleratorAWS Global AcceleratorFlagsmith DashboardFlagsmith DashboardUS OhioUS OhioS America Sao PauloS America Sao PauloAsia SingaporeAsia SingaporeAsia SeoulAsia SeoulAsia SydneyAsia SydneyCore APICore API Flagsmith Users Flagsmith Users SDK Users SDK UsersRedisRedisTask ProcessorTask ProcessorText is not SVG - cannot display \ No newline at end of file diff --git a/docs/static/img/self-hosted-architecture.svg b/docs/static/img/self-hosted-architecture.svg new file mode 100644 index 000000000000..91765fa3812f --- /dev/null +++ b/docs/static/img/self-hosted-architecture.svg @@ -0,0 +1,4 @@ + + + + Python Runtime Python RuntimePostgresPostgresDashboardDashboardCore APICore APIFlagsmith UsersFlagsmith UsersSDK ClientsSDK ClientsTask ProcessorTask ProcessorText is not SVG - cannot display \ No newline at end of file