diff --git a/docs/providers/pulumi/aws/index.mdx b/docs/providers/pulumi/aws/index.mdx index 5789834b2..f0c40412e 100644 --- a/docs/providers/pulumi/aws/index.mdx +++ b/docs/providers/pulumi/aws/index.mdx @@ -55,6 +55,38 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo for full details on credentials and configuration. +## Locating deployed resources + +This Nitric AWS provider creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources using the [AWS Console](https://console.aws.amazon.com/). + +Start by navigating to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home): + +![resource group search image](/docs/images/docs/aws-rg.png) + +Find your stack's resource group in the list and click it: + + + Resource groups are conventionally named `-` + + In this example the project name is `api-testing` and the stack name is `aws`. + + +![resource group list image](/docs/images/docs/aws-rg-screen.png) + +More recent versions of the Nitric AWS provider also display a direct link to the resource group in output from `nitric up`. + +Example: + +```bash +Deployed Resources: +────────────── +https://us-east-2.console.aws.amazon.com/resource-groups/group/arn%3Aaws%3Aresource-groups%3Aus-east-2%3A3123456789%3Agroup%2Fexample-aws + +API Endpoints: +────────────── +main: https://example.execute-api.us-east-2.amazonaws.com +``` + ## Stack Configuration ```yaml title:nitric.[stack ID].yaml diff --git a/docs/providers/pulumi/azure/index.mdx b/docs/providers/pulumi/azure/index.mdx index 9fa6a0f1a..449c24192 100644 --- a/docs/providers/pulumi/azure/index.mdx +++ b/docs/providers/pulumi/azure/index.mdx @@ -75,6 +75,34 @@ brew update && brew install azure-cli +## Locating deployed resources + +This Nitric Azure provider deploys resources for a stack into a resource group dedicated to that stack. You can either use one your already have by configuring it in the stack configuration or let Nitric create one for you. + +Once a stack has been deployed to Azure it's resource group should be present in the [Resource groups](https://portal.azure.com/#blade/HubsExtension/BrowseResourceGroupBlade/resourceType/Microsoft.Resources%2Fsubscriptions%2FresourceGroups) page of the portal. Assuming it was deployed to a subscription you have access to. + + + Resource groups are conventionally named `--` + + In this example the project name is `api-testing` and the stack name is `az`. + + +![resource group page screen](/docs/images/docs/az-rg.png) + +More recent versions of the Nitric Azure provider display a direct link to the resource group in output from `nitric up`. + +Example: + +```bash +Resource Group: +────────────── +https://portal.azure.com/#@your-tenant-id/resource/subscriptions/your-subscription-id/resourceGroups/your-resource-group/overview + +API Endpoints: +────────────── +main: https://example-api865cb.azure-api.net +``` + ## Stack Configuration ```yaml title:nitric.[stack ID].yaml diff --git a/docs/providers/terraform/aws.mdx b/docs/providers/terraform/aws.mdx index 96c068b74..68f025c4e 100644 --- a/docs/providers/terraform/aws.mdx +++ b/docs/providers/terraform/aws.mdx @@ -70,6 +70,23 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo for full details on credentials and configuration. +## Locating deployed resources + +Nitric creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources in the console by going to the [AWS Console](https://console.aws.amazon.com/) + +Next, navigate to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home): + +![resource group search image](/docs/images/docs/aws-rg.png) + +Find your stack's resource group in the list and click it: + + + Resource groups are conventionally named `-` + + In this example the project name is `api-testing` and the stack name is `aws`. + + +![resource group list image](/docs/images/docs/aws-rg-screen.png) ## Stack Configuration ```yaml title:nitric.[stack ID].yaml diff --git a/public/images/docs/aws-rg-screen.png b/public/images/docs/aws-rg-screen.png new file mode 100644 index 000000000..c5520629c Binary files /dev/null and b/public/images/docs/aws-rg-screen.png differ diff --git a/public/images/docs/aws-rg.png b/public/images/docs/aws-rg.png new file mode 100644 index 000000000..f966e447d Binary files /dev/null and b/public/images/docs/aws-rg.png differ diff --git a/public/images/docs/az-rg.png b/public/images/docs/az-rg.png new file mode 100644 index 000000000..35c606860 Binary files /dev/null and b/public/images/docs/az-rg.png differ