Metadata-Version: 2.1
Name: awscli-plugin-granica
Version: 2.0.5
Summary: Granica plugin for AWS CLI
Home-page: https://gitlab.com/projectn-oss/projectn-bolt-awscli
Author: Project N
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: awscli (>=1.12.13)
Requires-Dist: botocore (>=1.12.13)

# awscli-plugin-granica

This AWS CLI plugin provides an authentication and authorization solution for accessing Granica securely using the AWS CLI.

It uses the standard AWS CLI configuration to store the URL for accessing Granica. Active profiles disable regular S3 request signing, and instead provide a presigned STS `GetCallerIdentity` API call to securely authenticate requests using Granica.

## Prerequisites

The minimum supported version of Python is version 3.

`awscli` must be installed. e.g. `pip3 install awscli --user`

## Installation

To install the plugin package, run: `python3 -m pip install awscli-plugin-granica --user`.

## Configuration

To configure the plugin after it has been installed, use `aws configure`:

```bash
aws configure set plugins.granica awscli-plugin-granica
aws [--profile PROFILE] configure set granica_custom_domain <Granica custom domain>
aws [--profile PROFILE] configure set granica_az <preferred availability zone ID>
```
`granica_custom_domain`

For example, to activate a Granica service using an internal load balancer hosted at `https://quicksilver.us-east-1.mydomain.mycompany.com` for the `staging` AWS profile, run:
```bash
aws --profile staging configure set granica_custom_domain mydomain.mycompany.com
aws --profile staging configure set granica_az use1-az1
```

## AWS CLI v2

This plugin has been tested for compatibility with [AWS CLI version 2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html), but please take note of the [[plugins] configuration breaking changes](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-profile-plugins). In particular, you will need to add a block like:

```
[plugins]
cli_legacy_plugin_path = /Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages
```

in your `~/.aws/config` file for the plugin registration to succeed.

To find the correct location for `cli_legacy_plugin_path` after installing the plugin, run:

```bash
pip3 show awscli-plugin-granica | grep Location:
```
