diff --git a/pyproject.toml b/pyproject.toml index 83ca5a7..e43f203 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" diff --git a/usage-guides/aws.md b/usage-guides/aws.md index 94a262e..107f7b8 100644 --- a/usage-guides/aws.md +++ b/usage-guides/aws.md @@ -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 diff --git a/usage-guides/azure.md b/usage-guides/azure.md index 002ca54..d0245d2 100644 --- a/usage-guides/azure.md +++ b/usage-guides/azure.md @@ -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 @@ -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 \ No newline at end of file +* https://learn.microsoft.com/en-gb/cli/azure/authenticate-azure-cli-interactively diff --git a/usage-guides/gcp.md b/usage-guides/gcp.md index 9c2cbc6..04140c4 100644 --- a/usage-guides/gcp.md +++ b/usage-guides/gcp.md @@ -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