Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/adapters/aclara.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Aclara adapter uses SFTP to retrieve meter read data from an Aclara server.

Example:
```
python cli.py config add-source my_utility aclara America/Los_Angeles --sftp-host my-sftp-host --sftp-remote-data-directory ./data --sftp-local-download-directory ./output --sftp-local-known-hosts-file ./known-hosts --sinks my_snowflake
python cli.py config add-source my_utility aclara America/Los_Angeles --config sftp-host=my-sftp-host --config sftp-remote-data-directory=./data --config sftp-local-download-directory=./output --config sftp-local-known-hosts-file=./known-hosts --sinks my_snowflake
```

The `./known-hosts` file is a special SSH known hosts file that should contain info about the Aclara server at `sftp_host`. Its contents
Expand All @@ -21,7 +21,7 @@ are read into the database as the "sftp_known_hosts_str" value.

Example:
```
python cli.py config update-secret my_utility --source-type aclara --sftp-user my_user --sftp-password my_password
python cli.py config update-secret my_utility --source-type aclara --secret sftp-user=my_user --secret sftp-password=my_password
```

## Limitations
Expand Down
2 changes: 1 addition & 1 deletion docs/adapters/beacon.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ python cli.py config add-source my_utility beacon_360 America/Los_Angeles --sink

Example:
```
python cli.py config update-secret my_utility --source-type beacon_360 --user my_user --password my_password
python cli.py config update-secret my_utility --source-type beacon_360 --secret user=my_user --secret password=my_password
```

## Limitations
Expand Down
4 changes: 2 additions & 2 deletions docs/adapters/metersense.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Some setup outside of AMI Connect may include:

Example:
```
python cli.py config add-source my_utility metersense America/Los_Angeles --ssh-tunnel-server-host my-tunnel-host --ssh-tunnel-key-path ./key --database-host my-db-host --database-port 1521 --sinks my_snowflake
python cli.py config add-source my_utility metersense America/Los_Angeles --config ssh-tunnel-server-host=my-tunnel-host --config ssh-tunnel-key-path=./key --config database-host=my-db-host --config database-port=1521 --sinks my_snowflake
```

## Secrets
Expand All @@ -27,7 +27,7 @@ python cli.py config add-source my_utility metersense America/Los_Angeles --ssh-

Example:
```
python cli.py config update-secret my_utility --source-type metersense --ssh-tunnel-username my_user --database-db-name my_database --database-user my_db_user --database-password my_db_password
python cli.py config update-secret my_utility --source-type metersense --secret ssh-tunnel-username=my_user --secret database-db-name=my_database --secret database-user=my_db_user --secret database-password=my_db_password
```

## Limitations
Expand Down
4 changes: 2 additions & 2 deletions docs/adapters/neptune.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ server and add it as a [deploy key](https://docs.github.com/en/authentication/co

Example:
```
python cli.py config add-source my_utility neptune America/Los_Angeles --external-adapter-location ./neptune-ami-connect/neptune --sinks my_snowflake
python cli.py config add-source my_utility neptune America/Los_Angeles --config external-adapter-location=./neptune-ami-connect/neptune --sinks my_snowflake
```

## Secrets

Example:
```
python cli.py config update-secret my_utility --source-type neptune --api-key my_api_key --site-id 1234 --client-id api-client_my_client --client_secret my_secret
python cli.py config update-secret my_utility --source-type neptune --secret api-key=my_api_key --secret site-id=1234 --secret client-id=api-client_my_client --secret client_secret=my_secret
```

## Notes
Expand Down
4 changes: 2 additions & 2 deletions docs/adapters/sentryx.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ The Sentryx adapter retrieves data via Sentryx's HTTP API.

Example:
```
python cli.py config add-source my_utility sentryx America/Los_Angeles --utility-name name-of-my-utility-in-api-url ./neptune-ami-connect --sinks my_snowflake
python cli.py config add-source my_utility sentryx America/Los_Angeles --config utility-name=name-of-my-utility-in-api-url --sinks my_snowflake
```

## Secrets

Example:
```
python cli.py config update-secret my_utility --source-type sentryx --api-key my_api_key
python cli.py config update-secret my_utility --source-type sentryx --secret api-key=my_api_key
```

## Limitations
Expand Down
4 changes: 2 additions & 2 deletions docs/adapters/subeca.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ The Subeca adapter retrieves data via Subeca's HTTP API.

Example:
```
python cli.py config add-source my_utility subeca America/Los_Angeles --api-url https://my-source-name.api.subeca.online --sinks my_snowflake
python cli.py config add-source my_utility subeca America/Los_Angeles --config api-url=https://my-source-name.api.subeca.online --sinks my_snowflake
```

## Secrets

Example:
```
python cli.py config update-secret my_utility --source-type subeca --api-key my_api_key
python cli.py config update-secret my_utility --source-type subeca --secret api-key=my_api_key
```

## Limitations
Expand Down
4 changes: 2 additions & 2 deletions docs/adapters/xylem_moulton_niguel.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This adapter was built specially for MNWD and is not compatible for other utilit

Example:
```
python cli.py config add-source my_utility xylem_moulton_niguel America/Los_Angeles --ssh-tunnel-server-host my-tunnel-host --ssh-tunnel-key-path ./key --database-host my-db-host --database-port 1521 --sinks my_snowflake
python cli.py config add-source my_utility xylem_moulton_niguel America/Los_Angeles --config ssh-tunnel-server-host=my-tunnel-host --config ssh-tunnel-key-path=./key --config database-host=my-db-host --config database-port=1521 --sinks my_snowflake
```

## Secrets
Expand All @@ -25,7 +25,7 @@ python cli.py config add-source my_utility xylem_moulton_niguel America/Los_Ange

Example:
```
python cli.py config update-secret my_utility --source-type xylem_moulton_niguel --ssh-tunnel-username my_user --database-db-name my_database --database-user my_db_user --database-password my_db_password
python cli.py config update-secret my_utility --source-type xylem_moulton_niguel --secret ssh-tunnel-username=my_user --secret database-db-name=my_database --secret database-user=my_db_user --secret database-password=my_db_password
```

## Limitations
Expand Down
Loading