Skip to content

Commit

Permalink
docs updates for granted v0.16.0 (#281)
Browse files Browse the repository at this point in the history
* docs updates for granted v0.16.0

* Update src/pages/granted-cli/browsers.md

---------

Co-authored-by: Chris Norman <17420369+chrnorm@users.noreply.github.com>
  • Loading branch information
shwethaumashanker and chrnorm committed Sep 21, 2023
1 parent 77260ac commit 7b57576
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"terminal.integrated.automationProfile.linux": {}
}
7 changes: 7 additions & 0 deletions docs/granted/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,17 @@ You will get a response like this:
Edge
Firefox
Chromium
Safari
Firefox Developer Edition
Arc
```

Select which browser you would like to use and press Enter.

## Using specific browser profiles

Launching a specific browser profile is possible with `--browser-profile` flag for supported browsers such as Chrome, Edge, and Chromium Variants. Example useage: `assume profile-name -c --browser-profile "<your_browser_profile>"`

## Setting color and icon preferences for profiles

If you use Firefox with the [Granted Firefox Addon](https://addons.mozilla.org/en-GB/firefox/addon/granted/), you can set the color and icon preference for each profile. This is useful for distinguishing between profiles at a glance.
Expand Down
2 changes: 1 addition & 1 deletion docs/granted/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ On AWS, Granted works with both IAM roles and with AWS SSO. We highly recommend

## Supported browsers

Granted currently supports Firefox and Chromium-based browsers (such as Chrome, Brave, and Edge).
Granted currently supports Firefox, Chromium-based browsers (such as Chrome, Brave, and Edge), Safari and Arc.

:::tip

Expand Down
4 changes: 2 additions & 2 deletions docs/granted/usage/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To open the web console for a role, add the `--console` or `-c` flag to your `as
assume -c role-a
```

This will open a session in the AWS console for the specified profile. On Firefox, the session will open in a [Container Tab](https://support.mozilla.org/en-US/kb/containers). On Chrome, Brave, and Edge, the session will open in a new profile.
This will open a session in the AWS console for the specified profile. On Firefox, the session will open in a [Container Tab](https://support.mozilla.org/en-US/kb/containers). On Chrome, Brave, Edge, Safari and Arc the session will open in a new profile.

:::info
If the console does not open on Firefox, ensure that you have installed the [Granted addon](https://addons.mozilla.org/en-GB/firefox/addon/granted/).
Expand Down Expand Up @@ -97,7 +97,7 @@ You can open a console for a profile at a specific destination by adding the `--
assume -cd "https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=ServiceDashboard" role-a
```

Will open the _us-west-2_ console for the CloudWatch Dashboard called _ServiceDashboard_. This provides the ability to bookmark or create shell aliases for specific console destinations you use frequently.
Will open the _us-west-2_ console for the CloudWatch Dashboard called _ServiceDashboard_. This provides the ability to bookmark or create shell aliases for specific console destinations you use frequently.

## Opening the console with an active role

Expand Down
21 changes: 21 additions & 0 deletions docs/granted/usage/storing-iam-credentials-securely.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,21 @@ If you already have a profile in your AWS config file, the credential_process en
You can now assume the profile by running `assume example`
## `import-from-env` command
The `import-from-env` command enables you to create a new AWS config profile with IAM credentials imported from environment.
**Example Usage**
```bash
granted credentials import-from-env --profile my-profile
```
Upon execution, this command will generate an AWS configuration profile named my-profile. The credentials for this profile will be sourced from the following environment variables:
- `$AWS_ACCESS_KEY_ID`: Your AWS access key ID.
- `$AWS_SECRET_ACCESS_KEY`: Your AWS secret access key.
## `update` command
Update credentials stored in secure storage.
Expand Down Expand Up @@ -172,3 +187,9 @@ aws_secret_access_key = secret
```
It will also remove the `credential_process` entry from the profile in the AWS config file.
## Using IAM Credentials with Multi-Factor Authentication (MFA)
For those using an AWS profile that requires an MFA prompt, Granted will cache your credentials, eliminating the need to repeatedly enter the MFA token code as long as the cached credentials remain valid.
Moreover, if you can obtain an MFA token through a script, you can now utilize the `mfa-token` flag with `assume` to bypass the MFA prompt like `assume dev --mfa-token 123456`
2 changes: 1 addition & 1 deletion src/pages/granted-cli/browsers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Browsers

Granted currently supports Firefox and Chromium-based browsers (such as Chrome, Brave, and Edge).
Granted currently supports Firefox, Chromium-based browsers (such as Chrome, Brave, and Edge), Safari and Arc.

:::tip

Expand Down

0 comments on commit 7b57576

Please sign in to comment.