Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 1237444

Browse files
tjholmjyecusch
andauthored
docs: locating resources deployed by nitric (#654)
Co-authored-by: Jye Cusch <[email protected]>
1 parent d9e6841 commit 1237444

File tree

6 files changed

+77
-0
lines changed

6 files changed

+77
-0
lines changed

docs/providers/pulumi/aws/index.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,38 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
5555
for full details on credentials and configuration.
5656
</Note>
5757

58+
## Locating deployed resources
59+
60+
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/).
61+
62+
Start by navigating to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home):
63+
64+
![resource group search image](/docs/images/docs/aws-rg.png)
65+
66+
Find your stack's resource group in the list and click it:
67+
68+
<Note>
69+
Resource groups are conventionally named `<project-name>-<stack-name>`
70+
71+
In this example the project name is `api-testing` and the stack name is `aws`.
72+
</Note>
73+
74+
![resource group list image](/docs/images/docs/aws-rg-screen.png)
75+
76+
More recent versions of the Nitric AWS provider also display a direct link to the resource group in output from `nitric up`.
77+
78+
Example:
79+
80+
```bash
81+
Deployed Resources:
82+
──────────────
83+
https://us-east-2.console.aws.amazon.com/resource-groups/group/arn%3Aaws%3Aresource-groups%3Aus-east-2%3A3123456789%3Agroup%2Fexample-aws
84+
85+
API Endpoints:
86+
──────────────
87+
main: https://example.execute-api.us-east-2.amazonaws.com
88+
```
89+
5890
## Stack Configuration
5991

6092
```yaml title:nitric.[stack ID].yaml

docs/providers/pulumi/azure/index.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,34 @@ brew update && brew install azure-cli
7575

7676
</OSTabs>
7777

78+
## Locating deployed resources
79+
80+
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.
81+
82+
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.
83+
84+
<Note>
85+
Resource groups are conventionally named `<project-name>-<stack-name>-<randomId>`
86+
87+
In this example the project name is `api-testing` and the stack name is `az`.
88+
</Note>
89+
90+
![resource group page screen](/docs/images/docs/az-rg.png)
91+
92+
More recent versions of the Nitric Azure provider display a direct link to the resource group in output from `nitric up`.
93+
94+
Example:
95+
96+
```bash
97+
Resource Group:
98+
──────────────
99+
https://portal.azure.com/#@your-tenant-id/resource/subscriptions/your-subscription-id/resourceGroups/your-resource-group/overview
100+
101+
API Endpoints:
102+
──────────────
103+
main: https://example-api865cb.azure-api.net
104+
```
105+
78106
## Stack Configuration
79107

80108
```yaml title:nitric.[stack ID].yaml

docs/providers/terraform/aws.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,23 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
7070
for full details on credentials and configuration.
7171
</Note>
7272

73+
## Locating deployed resources
74+
75+
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/)
76+
77+
Next, navigate to the [Resource Groups service](https://console.aws.amazon.com/resource-groups/home):
78+
79+
![resource group search image](/docs/images/docs/aws-rg.png)
80+
81+
Find your stack's resource group in the list and click it:
82+
83+
<Note>
84+
Resource groups are conventionally named `<project-name>-<stack-name>`
85+
86+
In this example the project name is `api-testing` and the stack name is `aws`.
87+
</Note>
88+
89+
![resource group list image](/docs/images/docs/aws-rg-screen.png)
7390
## Stack Configuration
7491

7592
```yaml title:nitric.[stack ID].yaml
26.3 KB
Loading

public/images/docs/aws-rg.png

84.6 KB
Loading

public/images/docs/az-rg.png

40.1 KB
Loading

0 commit comments

Comments
 (0)