Skip to content

Commit 7f305d1

Browse files
bartrbartr
committed
added content docs for testing
1 parent 0e96f77 commit 7f305d1

File tree

6 files changed

+77
-0
lines changed

6 files changed

+77
-0
lines changed

‎docs/home.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Resilent Edge Overview
2+
3+
Resilient Edge (Res-Edge) is a composition of tools designed to streamline application manageability across a highly distributed application platform. The objective is to leverage a small platform team to support a highly distributed ecosystem of clusters and apps.
4+
5+
- Developer Productivity
6+
- Enable inner-loop and outer-loop development processes that provide a robust and low-friction way to manage the full code lifecycle which allows customers to evolve their SDLC to meet their business needs.
7+
- Res-Edge inner-loop is an extension of the Kubernetes in Codespaces inner-loop that we have been successful with for over 3 years now. The main extension is the ability to deploy, test, and observe Res-Edge within a developer's Codespace. This allows the Platform Team to get Res-Edge running with minimal friction - often within an hour.
8+
- Scalable Operations on the Edge
9+
- Enable customers to manage their distributed environments across geographies, franchisees, and stores in a way that maximizes flexibility, resiliency, and velocity while minimizing costs.
10+
- Res-Edge builds on top of concepts from Coral and PiB and also addresses the scale issues that both encountered. Specifically, the growth in config files as clusters * applications grows to 1M or more.
11+
- Res-Edge is the next step in getting to one platform. PiB is already retired in lieu of Res-Edge.
12+
13+
The Edge brings unique challenges. One of the first challenges is rather than a few large clusters the Edge has 10s of thousands of small clusters connected by a mostly reliable network. As examples, Chick-fil-A has 2500 stores, Walmart has 11K, Domino's has 30K, McDonald's has 39K, and Yum has over 60K. Our current, and immediate future, tooling is not designed to handle 30K clusters. Rather, it is targeted at 10s of clusters running in Azure.
14+
15+
Retailers like Walmart and CFA deploy multiple times per day to the Edge. This is a key differentiator vs. other industries like Manufacturing. Retail also has a constant stream of data flowing back to the Data Center.
16+
17+
As an example, the Domino's Pizza Tracker automatically updates during the delivery experience. The customer gets notified when the store gets the order, begins making the order, begins baking the order, sends the order for delivery, a 2 minute warning, driver arrived, and delivery completed. If any step doesn't meet the Domino's SLA, the customer gets an email with an apology and an offer for a discount or additional loyalty points. This requires near real-time data flows between the stores and the e-commerce system.
18+
19+
# Res-Edge System Diagram
20+
21+
![image](./images/res-edge-diagram.drawio.png)
22+
23+
- Res-Edge Data Service
24+
- The Data Service is a REST API and is the core of the system
25+
- The Data Service is flexible enough to promote additional scenarios and rigid enough to be repeatable
26+
- The CLI, Dashboard, and GitHub Actions use the Data Service
27+
- We expect customers will build tools that use the Data Service
28+
- SQL Azure
29+
- SQL Azure is used to store the Res-Edge data
30+
- GitOps
31+
- The GitHub Action is used for GitOps CI-CD
32+
- The Action combines the values from the Data Service with the GitOps repo to create Kubernetes manifests for each cluster
33+
- These manifests are applied by Flux running on each Cluster
34+
- Res-Edge Dashboard
35+
- The Dashboard is a Web UI used by the Platform and Application teams
36+
- CLI
37+
- The CLI is used by advanced users and for automation

‎docs/license.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) Microsoft Corporation.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE

‎docs/links.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# More Information
2+
3+
- [Home](/)
4+
- [Res-Edge Whitepaper](/?doc=Res-Edge-Overview)
5+
- [ Sample Page 1](/?doc=page1)
6+
- [ Sample Page 2](/?doc=page2)
7+
- [ Sample Page 3](/?doc=page3)
8+
- [Res-Edge Labs on GitHub](https://github.com/cse-labs/res-edge-labs)
9+
- [Email Us](mailto:[email protected])
10+
- [MIT License](/?doc=license)

‎docs/page1.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Page 1
2+
3+
This is sample page 1

‎docs/page2.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Page 2
2+
3+
This is sample page 2

‎docs/page3.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Page 3
2+
3+
This is sample page 3

0 commit comments

Comments
 (0)