This repository was archived by the owner on May 20, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 17
Improve Cloud Mappings for Nitric Resources #682
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d046699
add link to each resource page to cloud services matrix
davemooreuws ae6314e
remove old aws pulumi config page
davemooreuws 029f291
add some missing breadcrumbs
davemooreuws 8f52665
delete old nav config
davemooreuws 82cc0b0
cloud mapping pages and nav
davemooreuws ce572f7
cloud mapping redirects
davemooreuws 79bcc32
fix spellcheck
davemooreuws f035ae6
fix broken links
davemooreuws 0f2ae95
change batch to coming soon for azure
davemooreuws File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -236,6 +236,7 @@ preflight | |
nav | ||
MacOS | ||
quantized | ||
VPC | ||
[0-9]+px | ||
^.+[-:_]\w+$ | ||
[a-z]+([A-Z0-9]|[A-Z0-9]\w+) | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
description: 'How Nitric deploys Batch Jobs to AWS' | ||
--- | ||
|
||
# AWS Resources - Batch | ||
|
||
Nitric Batch Jobs are deployed to AWS using [AWS Batch](https://aws.amazon.com/batch/). | ||
|
||
## AWS Resources | ||
|
||
The following resources are created when deploying Batch Jobs to AWS: | ||
|
||
- AWS Batch Compute Environments | ||
- AWS Batch Job Queues | ||
- AWS Batch Job Definitions | ||
- EC2 Instances | ||
- EC2 Security Groups | ||
- ECR Images | ||
- IAM Policies | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI deploys your batch jobs: | ||
|
||
- Built container images are pushed to the [Amazon Elastic Container Registry](https://aws.amazon.com/ecr/) as private images | ||
- Files referenced by the `batch-services` key in the `nitric.yaml` file are built into Job Definitions | ||
- IAM roles and policies are created | ||
- AWS Batch Compute Environments are created | ||
- AWS Batch Job Queues are created |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
description: 'How Nitric deploys SQL Databases to AWS' | ||
--- | ||
|
||
# AWS Resources - SQL Database | ||
|
||
Nitric SQL Databases are deployed to AWS using [Amazon RDS](https://aws.amazon.com/rds). | ||
|
||
## AWS Resources | ||
|
||
The following resources are created when deploying SQL Databases to AWS: | ||
|
||
- Virtual Private Cloud (VPC) | ||
- Security Group | ||
- Aurora PostgreSQL Cluster | ||
- Cluster Instance | ||
- Subnet Group | ||
- CodeBuild Project for migrations | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI deploys your SQL Databases: | ||
|
||
- Virtual Private Cloud (VPC) and Subnets are created | ||
- Declared databases are deployed as Aurora PostgreSQL Clusters | ||
- Creates new Subnet Groups for the Aurora PostgreSQL Cluster | ||
- Appropriate IAM policies are setup enabling VPC access to the database | ||
- Migration images are built and pushed to the [Amazon Elastic Container Registry](https://aws.amazon.com/ecr/) as private images | ||
- CodeBuild projects are created to run migrations on the database | ||
|
||
## Other Engine Support | ||
|
||
Currently, Nitric supports only PostgreSQL for AWS RDS databases. Support for other engines like MySQL is not available yet, but you can create a [custom provider](/providers/custom) to add support for your preferred database engine. | ||
|
||
If you'd like to see support for additional engines, please share your [feedback](https://github.com/nitrictech/nitric/issues/684) with the Nitric team! |
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
description: 'How Nitric deploys Websockets to AWS' | ||
--- | ||
|
||
# AWS Resources - Websockets | ||
|
||
Nitric Websockets are deployed to AWS using [Amazon API Gateway](https://aws.amazon.com/api-gateway/). | ||
|
||
## AWS Resources | ||
|
||
The following resources are created when deploying Websockets to AWS: | ||
|
||
- API Gateway v2 Websocket APIs | ||
- API Gateway v2 Stages | ||
- API Gateway Integration | ||
- Lambda Functions | ||
- ECR Images | ||
- IAM Policies | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI builds your Websockets API's routes, methods and handlers: | ||
|
||
- Files referenced by the `services` key in the `nitric.yaml` file are built into container images | ||
- Built container images are pushed to the [Amazon Elastic Container Registry](https://aws.amazon.com/ecr/) as private images | ||
- Functions in [AWS Lambda](https://aws.amazon.com/lambda/) are created to run the container images | ||
- IAM policies are created enabling Websocket API Gateway to execute the Lambdas | ||
- `$default`, `$connect`, and `$disconnect` routes are added to the Websocket API Gateway |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
description: 'How Nitric deploys SQL Databases to Azure' | ||
--- | ||
|
||
# Azure Resources - SQL Database | ||
|
||
Nitric SQL Databases are deployed to Azure using [Azure Database for PostgreSQL](https://azure.microsoft.com/en-us/products/postgresql). | ||
|
||
## Azure Resources | ||
|
||
The following resources are created when deploying SQL Databases to Azure: | ||
|
||
- Virtual Network | ||
- Subnet | ||
- PostgreSQL Databases | ||
- Container Instance Group for migrations | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI deploys your SQL Databases: | ||
|
||
- Virtual Network and Subnet are created | ||
- Declared databases are deployed as PostgreSQL databases | ||
- Container Group Instances are created to run migrations | ||
- Container Apps are setup to run the containers | ||
|
||
## Other Engine Support | ||
|
||
Currently, Nitric supports only PostgreSQL for Azure SQL databases. Support for other engines like MySQL is not available yet, but you can create a [custom provider](/providers/custom) to add support for your preferred database engine. | ||
|
||
If you'd like to see support for additional engines, please share your [feedback](https://github.com/nitrictech/nitric/issues/684) with the Nitric team! |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
description: 'How Nitric deploys Batch Jobs to Google Cloud' | ||
--- | ||
|
||
# Google Cloud Resources - Batch | ||
|
||
Nitric Batch Jobs are deployed to Google Cloud using [Batch](https://cloud.google.com/batch). | ||
|
||
## Google Cloud Resources | ||
|
||
The following resources are created when deploying Batch Jobs to Google Cloud: | ||
|
||
- Google Cloud Batch Compute Environments | ||
- Google Cloud Batch Job Queues | ||
- Google Cloud Batch Job Definitions | ||
- EC2 Instances | ||
- EC2 Security Groups | ||
- ECR Images | ||
- IAM Policies | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI deploys your batch jobs: | ||
|
||
- Built container images are pushed to the [Amazon Elastic Container Registry](https://aws.amazon.com/ecr/) as private images | ||
- Files referenced by the `batch-services` key in the `nitric.yaml` file are built into Job Definitions | ||
- IAM policies are created |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
description: 'How Nitric deploys SQL Databases to Google Cloud' | ||
--- | ||
|
||
# Google Cloud Resources - SQL Database | ||
|
||
Nitric SQL Databases are deployed to Google Cloud using [Cloud SQL](https://cloud.google.com/sql). | ||
|
||
## Google Cloud Resources | ||
|
||
The following resources are created when deploying SQL Databases to Google Cloud: | ||
|
||
- Private Network | ||
- Subnet | ||
- PostgreSQL Databases | ||
- Cloud Run Jobs for migrations | ||
|
||
## Deployment | ||
|
||
During deployment the Nitric CLI deploys your SQL Databases: | ||
|
||
- Private Network is created for the Google project | ||
- Subnet is created for the network | ||
- Declared databases are deployed as PostgreSQL databases | ||
- Migration images are built and deployed to the artifact registry | ||
- Migrations are run against the deployed databases using cloud run jobs | ||
|
||
## Other Engine Support | ||
|
||
Currently, Nitric supports only PostgreSQL for Google Cloud SQL databases. Support for other engines like MySQL is not available yet, but you can create a [custom provider](/providers/custom) to add support for your preferred database engine. | ||
|
||
If you'd like to see support for additional engines, please share your [feedback](https://github.com/nitrictech/nitric/issues/684) with the Nitric team! |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.