Skip to content

Commit

Permalink
feat: adds readme for GDAC #317
Browse files Browse the repository at this point in the history
  • Loading branch information
srinandan committed Oct 17, 2023
1 parent e62a924 commit f6d72d4
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ curl -L https://raw.githubusercontent.com/apigee/apigeecli/main/downloadLatest.s
## Getting Started

### User Tokens

The simplest way to get started with `apigeecli` is

```
Expand All @@ -33,6 +34,15 @@ If you are using `apigeecli` on Cloud Shell, GCE instances, Cloud Build, then yo
apigeecli orgs list --metadata-token
```

### Google Default Application Credentials

You can configure gcloud to setup/create default application credentials. These credentials can be used by `apigeecli`.

```sh
gcloud auth application-default login
apigeecli orgs list --default-token
```

### Access Token Generation from Service Accounts

`apigeecli` can use the service account directly and obtain an access token.
Expand All @@ -57,17 +67,20 @@ apigeecli token cache -a serviceaccount.json
```

or

```bash
token=$(gcloud auth print-access-token)
apigeecli token cache -t $token
```

or

```bash
apigeecli token cache --metadata-token
```

## Set Preferences

If you are using the same GCP project for Apigee, then consider setting up preferences so they don't have to be included in every command. Preferences are written to the `$HOME/.apigeecli` folder

```
Expand All @@ -92,8 +105,8 @@ The following preferences can be set:
| `-p, --proxy string` | Use http proxy before contacting the control plane |
| `--nocheck` | Don't check for newer versions of cmd |


## Container download

The lastest container version for apigeecli can be downloaded via

```sh
Expand Down Expand Up @@ -156,6 +169,7 @@ The following environment variables may be set to control the behavior of `apige
* `APIGEECLI_DRYRUN=true` does not execute Apigee control plane APIs

## Generating API Proxies

`apigeecli` can generate API proxies from:

* OpenAPI 3.0 Specification
Expand Down Expand Up @@ -196,7 +210,6 @@ components:
is interpreted as OAuth-v20 (verification only) policy and the VerifyAPIKey policy.
These security schemes can be added to the PreFlow by enabling the scheme globally
```yaml
Expand Down Expand Up @@ -381,6 +394,7 @@ C8gzi5q3xsycjI7if5FABk7bfciR4+g32H8xTl4mVHhHuz6I6FBG24/nuQ==

cosign verify --key=cosign.pub ghcr.io/apigee/apigeecli:latest
```

___

## Support
Expand Down

0 comments on commit f6d72d4

Please sign in to comment.