Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
30 changes: 30 additions & 0 deletions docs/providers/pulumi/aws/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,36 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
for full details on credentials and configuration.
</Note>

## Locating resources deployed with Nitric

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/)

Navigate to the resource groups service:

![resource group search image](/docs/images/docs/aws-rg.png)

Find your resource group in the resource groups list and click it:

![resource group list image](/docs/images/docs/aws-rg-screen.png)

Resource groups are conventionally named `<project-name>-<stack-name>`

So in the example above, the project name is `api-testing` and the stack name is `aws`.

More recent versions of the Nitric AWS provider also output a direct link to it's resource group in the console from running `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
Expand Down
27 changes: 27 additions & 0 deletions docs/providers/pulumi/azure/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,33 @@ brew update && brew install azure-cli

</OSTabs>

## Locating resources deployed with Nitric

Nitric deploys all Azure 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 nitric stack is 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 your portal. Assuming it was deployed to a subscription you have access to.

Resource groups are named conventionally `<project-name>-<stack-name>-<randomId>`

For example:
![resource group page screen](/docs/images/docs/az-rg.png)

So in the example above, the project name is `api-testing` and the stack name is `az`.

More recent versions of the Nitric Azure provider also output a direct link to it's resource group in the console from running `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
Expand Down
16 changes: 16 additions & 0 deletions docs/providers/terraform/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,22 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
for full details on credentials and configuration.
</Note>

## Locating resources deployed with Nitric

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/)

Navigate to the resource groups service:

![resource group search image](/docs/images/docs/aws-rg.png)

Find your resource group in the resource groups list and click it:

![resource group list image](/docs/images/docs/aws-rg-screen.png)

Resource groups are conventionally named `<project-name>-<stack-name>`

So in the example above, the project name is `api-testing` and the stack name is `aws`.

## Stack Configuration

```yaml title:nitric.[stack ID].yaml
Expand Down
Binary file added public/images/docs/aws-rg-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/docs/aws-rg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/docs/az-rg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading