Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create AWS architectural guidance #6489

Merged
merged 92 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
92 commits
Select commit Hold shift + click to select a range
ebaa429
Add first draft
kbaley Mar 12, 2024
b6e20d8
Removing warnings
NChaganlal Mar 13, 2024
dfd7e21
Improvements on the queue worker architecture style intro
NChaganlal Mar 13, 2024
05c7c98
Improved SQS information on AWS architecture guidance
NChaganlal Mar 13, 2024
5fbc290
Add AWS data stores and microservices docs
kbaley Mar 13, 2024
957952b
Move well-architected to index
WilliamBZA Mar 14, 2024
f91ed1e
Move compute to own file
WilliamBZA Mar 14, 2024
97f072c
Move event driven to own file
WilliamBZA Mar 14, 2024
af99698
AWS: Extracted queue based architecture style from base document
NChaganlal Mar 14, 2024
927f2f1
AWS: Extract multi tier architecture style from the base document
NChaganlal Mar 14, 2024
d197085
AWS: Update multi tier architecture title
NChaganlal Mar 14, 2024
e591d1f
Move well-archicted to it's own file
WilliamBZA Mar 14, 2024
57f085f
Merge branches 'master' and 'tf-cloudxp-aws-arch-guidance-258' of git…
WilliamBZA Mar 14, 2024
82e63e2
AWS: Improve queue-based-architecture - additional resources
NChaganlal Mar 14, 2024
e1bbb1a
AWS: Extracted Messaging from base document and standardized titles
NChaganlal Mar 14, 2024
1381401
AWS: Extract observability from base document
NChaganlal Mar 14, 2024
6c0a4c1
AWS: Moving content from base-document.md to index.md and add links t…
NChaganlal Mar 14, 2024
1f7ab9a
AWS: Delete base-document.md
NChaganlal Mar 14, 2024
73c41fa
AWS: Add metadata to well architected page
NChaganlal Mar 14, 2024
df0eac0
AWS: Replacing "you" from well-architected.md
NChaganlal Mar 15, 2024
bca371e
AWS: Replacing reference to "your" on well-architected.md
NChaganlal Mar 15, 2024
721c8d9
AWS: Replace reference to "you" and "your"
NChaganlal Mar 15, 2024
d5a0bb6
AWS: Replacing "you" and "your" references in the observability.md
NChaganlal Mar 15, 2024
0a7db62
AWS: Remove word "Please" from queue-based-architecture.md
NChaganlal Mar 15, 2024
5e204fa
AWS: Replacing "we" on observability.md
NChaganlal Mar 15, 2024
0a68b0a
AWS: Replace "you" and "your" from messaging.md
NChaganlal Mar 15, 2024
50eed22
AWS: Remove "?" from headers
NChaganlal Mar 15, 2024
922e90c
AWS: Removing url prefix from index.md
NChaganlal Mar 15, 2024
3dc3d2f
AWS: Replacing "you" and "your" in compute.md
NChaganlal Mar 15, 2024
c7946f8
AWS: Replaced word "your" in data-stores.md
NChaganlal Mar 15, 2024
e88f34c
AWS: Fixed data-stores.md urls
NChaganlal Mar 15, 2024
bb126ed
AWS: Fix `pay-as-you-go` in messaging.md
NChaganlal Mar 15, 2024
99b53b7
AWS: Created images folder and image on queue-based-architecture.md
NChaganlal Mar 15, 2024
c156476
AWS: Fix event-driven-architecture links
NChaganlal Mar 15, 2024
b12852d
AWS: Lowecase AWS in event-driven-architecture.md
NChaganlal Mar 15, 2024
399f8be
AWS: Fix urls in compute.md
NChaganlal Mar 15, 2024
50f20c2
AWS: Fix URL fix in event-driven-architecture.md
NChaganlal Mar 15, 2024
4ecd855
AWS: Replacing word "our" in observability.md
NChaganlal Mar 15, 2024
a132280
AWS: Fix urls in messaging.md
NChaganlal Mar 15, 2024
cb15c27
AWS: Fix urls in microservices.md
NChaganlal Mar 15, 2024
3872b44
AWS: Replace "us" in observability.md
NChaganlal Mar 15, 2024
ed74b70
AWS: Fix urls in observability.md
NChaganlal Mar 15, 2024
2835a7a
AWS: Fix URLs in well-architected.md
NChaganlal Mar 15, 2024
25e9369
AWS: Fix urls in multi-tier-architecture.md
NChaganlal Mar 15, 2024
3c92892
AWS: Added data-stores link to multi-tier-architecture.md
NChaganlal Mar 15, 2024
c1f8194
AWS: Fix urls in observability.md
NChaganlal Mar 15, 2024
c6159e2
AWS: Fix opentelemetry link in observability.md
NChaganlal Mar 15, 2024
c9bfe3f
Fix content errors
kbaley Mar 15, 2024
9c58eaf
remove concept from aws section
lailabougria Mar 20, 2024
40444e1
add observability as a concept
lailabougria Mar 20, 2024
b0de64a
add azure section for observability
lailabougria Mar 20, 2024
f133a40
add menu items
lailabougria Mar 20, 2024
c5cea01
fix wording
lailabougria Mar 20, 2024
3f4e39b
fix link
lailabougria Mar 20, 2024
da591ce
Edit aws observability content
WilliamBZA Mar 20, 2024
c77762e
Update architecture/aws/observability.md
WilliamBZA Mar 20, 2024
1c4e12a
AWS: Fix observability link
NChaganlal Mar 21, 2024
5f58e54
Update architecture/aws/observability.md
NChaganlal Mar 21, 2024
a9e0aa2
AWS: Improve architecture/aws/observability.md
NChaganlal Mar 22, 2024
c8c7775
Update architecture/aws/observability.md
WilliamBZA Mar 25, 2024
3725c2b
Update architecture/aws/observability.md
WilliamBZA Mar 25, 2024
5d06877
Apply suggestions from code review
WilliamBZA Mar 25, 2024
663759f
Update observability.md
WilliamBZA Mar 25, 2024
da788c1
Add missing words
WilliamBZA Mar 25, 2024
a642a46
Edit first paragraph
WilliamBZA Mar 26, 2024
afd8b5c
Review other sections and tweak azure content
WilliamBZA Mar 26, 2024
57e9ded
Update architecture/azure/web-queue-worker.md
kbaley Mar 27, 2024
f7d3705
Review of AWS Compute section (#6521)
kbaley Mar 27, 2024
6ae1fd7
Update queue-based-architecture diagram and replace visio document wi…
NChaganlal Mar 28, 2024
56ab2ba
Merge pull request #6529 from Particular/queue-based-review
WilliamBZA Mar 28, 2024
8592c04
Update architecture/aws/observability.md
lailabougria Mar 28, 2024
64397d0
Review of AWS Well-Architected article (#6532)
kbaley Mar 28, 2024
069250a
Update observability.md to remove sample TODOs
NChaganlal Mar 28, 2024
424c796
Update architecture/aws/observability.md
kbaley Mar 28, 2024
5e4510c
Merge pull request #6519 from Particular/observability-edit
WilliamBZA Apr 2, 2024
b9a6f7c
Edit messaging page (#6535)
WilliamBZA Apr 4, 2024
ea3fa4c
AWS: Update messaging.md to fix the anchor
NChaganlal Apr 4, 2024
4bff322
Editorial Review event-driven
NChaganlal Apr 4, 2024
7345b5d
Edit the multi-tier content
WilliamBZA Apr 4, 2024
7ee7226
Reflect improvements done on AWS on the Azure docs
NChaganlal Apr 5, 2024
11ebb1a
Merge pull request #6551 from Particular/event-driven
WilliamBZA Apr 9, 2024
d8a09ee
AWS summaries (#6556)
kbaley Apr 9, 2024
72cb073
Summaries for Azure architecture articles (#6563)
kbaley Apr 9, 2024
d06531e
Fix heading indentation on architecture articles
kbaley Apr 9, 2024
38a48d4
Edit data store (#6562)
WilliamBZA Apr 9, 2024
58c52a6
Add CTAs to AWS articles
kbaley Apr 9, 2024
2a957a8
Merge pull request #6564 from Particular/aws-ctas
WilliamBZA Apr 10, 2024
38a951f
AWS: Add diagrams, references and miro board backup
NChaganlal Apr 10, 2024
847be51
Apply suggestions from code review
WilliamBZA Apr 11, 2024
3aa228a
Merge pull request #6566 from Particular/aws-add-diagrams
WilliamBZA Apr 11, 2024
2036219
Review of AWS microservices (#6555)
kbaley Apr 11, 2024
a348b9b
Flesh out AWS architecture intro (#6568)
kbaley Apr 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
AWS summaries (#6556)
Co-authored-by: Nisha Chaganlal <nisha.chaganlal@gmail.com>
  • Loading branch information
kbaley and NChaganlal authored Apr 9, 2024
commit d8a09eede26eb99b08811a16135f110ea7da96c0
2 changes: 1 addition & 1 deletion architecture/aws/compute.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS compute services
summary:
summary: Describes multiple options (Serverless, PaaS, Containers, IaaS) offered by AWS to host the Particular Service Platform.
reviewed: 2024-03-14
callsToAction: ['solution-architect', 'poc-help']
---
Expand Down
2 changes: 1 addition & 1 deletion architecture/aws/data-stores.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS data stores
summary:
summary: Gives an overview of the data storage options offered by AWS and how to use them with the Particular Service Platform
reviewed: 2024-03-13
callsToAction: ['solution-architect', 'poc-help']
---
Expand Down
4 changes: 2 additions & 2 deletions architecture/aws/event-driven-architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Event-driven architecture style on AWS
summary:
summary: Describes event-driven architecture including the components, challenges, and technology options for AWS
reviewed: 2024-04-04
callsToAction: ['solution-architect', 'ADSD']
---
Expand All @@ -12,7 +12,7 @@ The Particular Service Platform implements the [publish/subscribe model](/nservi
### Components

- **NServiceBus publisher (event producer)**

Publishes events with business meaning in a reliable fire-and-forget style and has no knowledge of subscribers (there may be none).
- **NServiceBus subscriber (event consumer)**

Expand Down
2 changes: 1 addition & 1 deletion architecture/aws/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS Architectures
summary:
summary: Gives an overview of the architectural styles (microservices, event-driven, multi-tier, queue-based) and technology options offered by AWS
reviewed: 2024-03-14
suppressRelated: true
callsToAction: ['architecture-review']
Expand Down
4 changes: 2 additions & 2 deletions architecture/aws/messaging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS messaging services
summary:
summary: Describes the AWS messaging options available for the Particular Service Platform
reviewed: 2024-03-28
callsToAction: ['solution-architect', 'poc-help']
---
Expand All @@ -21,7 +21,7 @@ AWS offers [multiple messaging services](https://aws.amazon.com/messaging/). The

:heavy_minus_sign: Cons:

- Limited message size (256Kb per message).
- Limited message size (256Kb per message).
- Limited control over retry policies which forces delegation of handling retries to consumers increasing the overall complexity of the system
- SQS supports a subset of protocols and formats which can cause compatibility issues with third-party applications
- No local store-and-forward mechanism available
Expand Down
2 changes: 1 addition & 1 deletion architecture/aws/microservices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Microservice architecture style on AWS
summary:
summary: Gives an overview of how the Particular Service Platform can help build microservices on AWS
reviewed: 2024-03-13
callsToAction: ['solution-architect', 'ADSD']
---
Expand Down
12 changes: 6 additions & 6 deletions architecture/aws/multi-tier-architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Multi tier architecture style on AWS
summary:
title: Multi-tier architecture style on AWS
summary: Gives a description of multi-tier architecture including the components, challenges, and technology options for AWS
reviewed: 2024-04-04
callsToAction: ['solution-architect', 'ADSD']
---
Expand Down Expand Up @@ -35,10 +35,10 @@ Multi-tier architectures come with many benefits, but there are also trade-offs

Technology choices are often dictated by the tier you are working in. For example:

- [Infrastructure-as-a-Service](/architecture/azure/compute.md#infrastructure-as-a-service) services offer flexibility for creating environments.
- Web-focused front-end or API layers might use managed hosted options like [Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk) or [LightSail](https://aws.amazon.com/lightsail).
- [Multiple data store options](/architecture/aws/data-stores.md) exist within AWS which allow moving data persistence to the cloud with little effort.
- [Messaging options](/architecture/aws/messaging.md) allow for asynchronous communication between tiers.
- [Infrastructure-as-a-Service](/architecture/azure/compute.md#infrastructure-as-a-service) services offer flexibility for creating environments.
- Web-focused front-end or API layers might use managed hosted options like [Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk) or [LightSail](https://aws.amazon.com/lightsail).
- [Multiple data store options](/architecture/aws/data-stores.md) exist within AWS which allow moving data persistence to the cloud with little effort.
- [Messaging options](/architecture/aws/messaging.md) allow for asynchronous communication between tiers.

### Related content

Expand Down
2 changes: 1 addition & 1 deletion architecture/aws/observability.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS observability services
summary:
summary: Gives an overview of the observability options offered by AWS and how to use them with the Particular Service Platform
reviewed: 2024-03-28
callsToAction: ['solution-architect', 'poc-help']
---
Expand Down
4 changes: 2 additions & 2 deletions architecture/aws/queue-based-architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Queue based architecture style on AWS
summary:
title: Queue-based architecture style on AWS
summary: Gives a description of queue-based architecture including the components, challenges, and technology options for AWS
reviewed: 2024-03-14
callsToAction: ['solution-architect', 'ADSD']
---
Expand Down
2 changes: 1 addition & 1 deletion architecture/aws/well-architected.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS Well-Architected Framework
summary:
summary: Gives an overview of the framework and how it can help build performant, resilient, and secure systems
reviewed: 2024-03-27
callsToAction: ['ADSD']
---
Expand Down