Skip to content

Commit

Permalink
docs: update usage guides
Browse files Browse the repository at this point in the history
  • Loading branch information
narenaryan committed Jan 15, 2025
1 parent 029c899 commit a68b484
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 7 deletions.
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ dependencies = [
"hvac==2.3.0",
]
[project.urls]
Documentation = "https://github.com/narenaryan/whispr/blob/main/README.md"
Issues = "https://github.com/narenaryan/whispr/issues"
Source = "https://github.com/narenaryan/whispr"
Documentation = "https://github.com/cybrota/whispr/blob/main/README.md"
Issues = "https://github.com/cybrota/whispr/issues"
Source = "https://github.com/cybrota/whispr"

[tool.hatch.version]
path = "src/whispr/__about__.py"
Expand Down
10 changes: 9 additions & 1 deletion usage-guides/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,15 @@ Step 2: Initialize a whispr configuration file for AWS.
whispr init aws
```

This creates a file called `whispr.yaml`. Update the details.
This creates a file called `whispr.yaml`. Update the below details.

```yaml
env_file: .env
secret_name: my-secret
vault: aws
region: us-west-2 # Required for AWS
sso_profile: my_profile # Set in case using a SSO profile for authentication
```
Step 3: Define a `.env` file with secrets stored in AWS (Assuming secrets with below names exist in remote secret as key value pair)
```bash
Expand Down
11 changes: 9 additions & 2 deletions usage-guides/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ Step 2: Initialize a whispr configuration file for Azure.
```bash
whispr init azure
```
This creates a file called `whispr.yaml`. Update the details.
This creates a file called `whispr.yaml`. Update the below details.

```yaml
env_file: .env
secret_name: my-secret
vault: azure
vault_url: https://my-creds.vault.azure.net/ # Required for Azure
```
Step 3: Define a `.env` file with secrets stored in Azure (Assuming secrets with below names exist in remote secret as key value pair)
```bash
Expand All @@ -34,4 +41,4 @@ whispr run 'node script.js'
DB_USERNAME & DB_PASSWORD are now available in Node.js program environment.

## References:
* https://learn.microsoft.com/en-gb/cli/azure/authenticate-azure-cli-interactively
* https://learn.microsoft.com/en-gb/cli/azure/authenticate-azure-cli-interactively
9 changes: 8 additions & 1 deletion usage-guides/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ Step 2: Initialize a whispr configuration file for GCP.
```bash
whispr init gcp
```
This creates a file called `whispr.yaml`. Update the details.
This creates a file called `whispr.yaml`. Update with the below details.

```yaml
env_file: .env
secret_name: my-secret
vault: gcp
project_id: project-12345 # Required for GCP
```
Step 3: Define a `.env` file with secrets stored in GCP (Assuming secrets with below names exist in remote secret as key value pair)
```bash
Expand Down

0 comments on commit a68b484

Please sign in to comment.