Skip to content

Commit

Permalink
add(alloydbomni): avn client commands (#526)
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik-dorota authored Oct 28, 2024
1 parent baf22d6 commit 39a463e
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 0 deletions.
95 changes: 95 additions & 0 deletions docs/tools/cli/service/alloydbomni.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: avn service alloydbomni
---

List of commands for `avn service alloydbomni`

## Manage Google service account credentials

Manage a Google service account private key in Aiven for AlloyDB Omni.

### `avn service alloydbomni google-cloud-private-key set`

Add or update a Google service account private key for your Aiven for AlloyDB Omni service.

```bash
avn service alloydbomni google-cloud-private-key set SERVICE_NAME \
--private-key-file PRIVATE_KEY_FILE
```

| Parameter | Information |
| ------------------------ | --------------------------------------------------------------------- |
| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service |
| `PRIVATE_KEY_FILE` | Path to a JSON file including your Google service account private key |

**Example**

```bash
avn service alloydbomni google-cloud-private-key set alloydbomni-test \
--private-key-file /Users/john.doe/documents/private-key.json
```

**Output**

This command outputs a Google service account email and a key ID, for example:

```txt
CLIENT_EMAIL PRIVATE_KEY_ID
============================================================ ========================================
[email protected] 1a2b3c4d5e6f7g8h9i0j1a2b3c4d5e6f7g8h9i0j
```

### `avn service alloydbomni google-cloud-private-key delete`

Delete a Google service account private key uploaded to your Aiven for AlloyDB Omni service.

```bash
avn service alloydbomni google-cloud-private-key delete SERVICE_NAME
```

| Parameter | Information |
| ------------------------ | --------------------------------------------------------------------- |
| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service |

**Example**

```bash
avn service alloydbomni google-cloud-private-key delete alloydbomni-test
```

**Output**

This command outputs:

```txt
Service account key has been removed
```

### `avn service alloydbomni google-cloud-private-key show`

Display the key ID and the client email associated with your Google service account private
key.

```bash
avn service alloydbomni google-cloud-private-key show SERVICE_NAME
```

| Parameter | Information |
| ------------------------ | --------------------------------------------------------------------- |
| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service |

**Example**

```bash
avn service alloydbomni google-cloud-private-key show alloydbomni-test
```

**Output**

This command outputs a Google service account email and a key ID, for example:

```txt
CLIENT_EMAIL PRIVATE_KEY_ID
============================================================ ========================================
[email protected] 1a2b3c4d5e6f7g8h9i0j1a2b3c4d5e6f7g8h9i0j
```
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,7 @@ const sidebars: SidebarsConfig = {
},
items: [
'tools/cli/service/acl',
'tools/cli/service/alloydbomni',
'tools/cli/service/connection-info',
'tools/cli/service/connection-pool',
'tools/cli/service/connector',
Expand Down

0 comments on commit 39a463e

Please sign in to comment.