Skip to content

Commit

Permalink
update README (#221)
Browse files Browse the repository at this point in the history
  • Loading branch information
theganyo authored Jul 25, 2023
1 parent 591c60a commit 69938de
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions cmd/registry-connect/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
# registry-connect

`registry-connect` is a command-line tool for extracting proxy data from an
Apigee X instance to be applied onto an API Registry.
Apigee instance to be applied onto an API Registry.

## Usage

Running one of these commands retrieves either products or proxies,
respectively, from an Apigee X, Hybrid, SaaS, OPDK runtime instance and formats
it as an API Registry-compatible YAML:
Running one of these commands retrieves products and proxies from an Apigee,
Hybrid, SaaS, OPDK runtime instance and formats it as an API Registry-compatible
YAML:

registry-connect discover apigee products ORGANIZATION
registry-connect discover apigee proxies ORGANIZATION
registry-connect discover apigee ORGANIZATION --project PROJECT_NAME

The output from this command can be piped to `registry apply -` like so:

registry-connect discover apigee products ORGANIZATION | registry apply -
registry-connect discover apigee ORGANIZATION | registry apply -

Alternatively, the output may be sent to a file for inspection or processing, at
which point `registry apply -f FILE` can be run against it to apply it to the
registry. Example:

registry-connect discover apigee products ORGANIZATION > apigee-apis.yaml
registry-connect discover apigee ORGANIZATION --project PROJECT_NAME > apigee-apis.yaml
registry apply -f apigee-apis.yaml

See `registry apply --help` for more information.
Expand All @@ -29,8 +28,8 @@ See `registry apply --help` for more information.

`registry-connect` uses
[Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials)
to connect to Apigee X. These are stored in your local environment when you
login with `gcloud`:
to connect to Apigee. These are stored in your local environment when you login
with `gcloud`:

`gcloud auth application-default login`

Expand Down

0 comments on commit 69938de

Please sign in to comment.