Skip to content

Commit

Permalink
Update table docs (#15)
Browse files Browse the repository at this point in the history
Co-authored-by: Puskar Basu <puskar@turbot.com>
  • Loading branch information
misraved and pskrbasu authored Dec 11, 2023
1 parent bd40abd commit e8f5918
Show file tree
Hide file tree
Showing 14 changed files with 1,205 additions and 70 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/steampipe-anywhere.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Release Steampipe Anywhere Components

on:
push:
tags:
- 'v*'


jobs:
anywhere_publish_workflow:
uses: turbot/steampipe-workflows/.github/workflows/steampipe-anywhere.yml@main
secrets: inherit
with:
plugin: aiven
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,18 @@ from
+--------------+-------------+-----------------+-----------+
```

## Engines

This plugin is available for the following engines:

| Engine | Description
|---------------|------------------------------------------
| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/index) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/index) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
| [Export](https://steampipe.io/docs/steampipe_export/index) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

## Developing

Prerequisites:
Expand Down Expand Up @@ -129,7 +141,7 @@ Further reading:

## Contributing

Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-plugin-aiven/blob/main/LICENSE).
Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). Contributions to the plugin are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-plugin-aiven/blob/main/LICENSE). Contributions to the plugin documentation are subject to the [CC BY-NC-ND license](https://github.com/turbot/steampipe-plugin-aiven/blob/main/docs/LICENSE).

`help wanted` issues:

Expand Down
402 changes: 402 additions & 0 deletions docs/LICENSE

Large diffs are not rendered by default.

6 changes: 2 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ short_name: "aiven"
description: "Steampipe plugin to query accounts, projects, teams, users and more from Aiven."
og_description: "Query Aiven with SQL! Open source CLI. No DB required."
og_image: "/images/plugins/turbot/aiven-social-graphic.png"
engines: ["steampipe", "sqlite", "postgres", "export"]
---

# Aiven + Steampipe

[Aiven](https://aiven.io) is the company that offers the best data infrastructure platform to the world.

[Steampipe](https://steampipe.io) is an open source CLI to instantly query cloud APIs using SQL.
[Steampipe](https://steampipe.io) is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

List your Aiven accounts:

Expand Down Expand Up @@ -135,7 +136,4 @@ connection "aiven" {
}
```

## Get involved

- Open source: https://github.com/turbot/steampipe-plugin-aiven
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
61 changes: 56 additions & 5 deletions docs/tables/aiven_account.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,33 @@
# Table: aiven_account
---
title: "Steampipe Table: aiven_account - Query Aiven Accounts using SQL"
description: "Allows users to query Aiven Accounts, providing detailed information about each account including its ID, name, owner and creation time."
---

Aiven account represents organizations and organizational units. When you sign up for Aiven, an organization is created for you. You can use that to create a hierarchical structure that fits your needs. Organizational units can be nested within an organization. This gives you greater flexibility to organize your setup to meet your specific use cases.
# Table: aiven_account - Query Aiven Accounts using SQL

Aiven Account is a resource within Aiven's cloud-native database management system that represents the account of a user or organization. It provides a centralized way to manage and monitor the usage of various Aiven services, including databases, data pipelines, and more. Aiven Account helps users stay informed about the status and performance of their Aiven resources.

## Table Usage Guide

The `aiven_account` table provides insights into Aiven Accounts within Aiven's cloud-native database management system. As a database administrator or DevOps engineer, explore account-specific details through this table, including account ID, name, owner, and creation time. Utilize it to uncover information about accounts, such as their current status, usage of Aiven services, and the management of resources.

## Examples

### Basic info
Explore which Aiven accounts have billing enabled and when they were created to manage and optimize your financial resources effectively. This is useful for assessing cost efficiency and tracking the timeline of account creation.

```sql
```sql+postgres
select
id,
name,
billing_enabled,
create_time,
tenant_id
from
aiven_account;
```

```sql+sqlite
select
id,
name,
Expand All @@ -18,8 +39,9 @@ from
```

### List accounts with billing enabled
Explore which accounts have billing enabled. This can be useful for financial auditing or to identify accounts that are incurring charges.

```sql
```sql+postgres
select
id,
name,
Expand All @@ -32,9 +54,23 @@ where
billing_enabled;
```

```sql+sqlite
select
id,
name,
billing_enabled,
create_time,
tenant_id
from
aiven_account
where
billing_enabled = 1;
```

### List projects of each account
Uncover the details of each account's projects, including their available credits, default cloud, estimated balance, and payment method. This information can be useful for financial management and resource allocation.

```sql
```sql+postgres
select
a.name as account_name,
p.name as project_name,
Expand All @@ -48,3 +84,18 @@ from
where
a.id = p.account_id;
```

```sql+sqlite
select
a.name as account_name,
p.name as project_name,
available_credits,
default_cloud,
estimated_balance,
payment_method
from
aiven_account as a,
aiven_project as p
where
a.id = p.account_id;
```
98 changes: 91 additions & 7 deletions docs/tables/aiven_account_authentication.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@
# Table: aiven_account_authentication
---
title: "Steampipe Table: aiven_account_authentication - Query Aiven Account Authentications using SQL"
description: "Allows users to query Aiven Account Authentications, providing insights into the authentication methods used across Aiven accounts."
---

You can authenticate directly with your email and password in the Aiven Console or use single sign-on through providers like GitHub, Google and Microsoft. You can also set up SAML authentication in Aiven with your company’s favorite authentication service.
# Table: aiven_account_authentication - Query Aiven Account Authentications using SQL

Aiven Account Authentication is a part of Aiven's account management system that handles the verification of identities and the management of access control. The authentication process ensures that the users are who they claim to be, thus providing a secure environment for data access and manipulation. It plays a crucial role in protecting sensitive data from unauthorized access and potential security threats.

## Table Usage Guide

The `aiven_account_authentication` table provides insights into the authentication methods used across Aiven accounts. As a security analyst, you can explore the details of each authentication method through this table, including the type of authentication, its status, and associated metadata. Utilize it to monitor and ensure the security of your Aiven accounts by verifying the authenticity of each user and their access controls.

## Examples

### Basic info
Explore which accounts are active and when they were created to manage access to your resources more effectively. This is useful for maintaining security and ensuring only authorized users have access.

```sql
```sql+postgres
select
id,
name,
enabled,
state,
type,
create_time
from
aiven_account_authentication;
```

```sql+sqlite
select
id,
name,
Expand All @@ -19,8 +41,9 @@ from
```

### List disabled authentication methods
Uncover the details of disabled authentication methods within your account. This can be useful for identifying potential security risks or areas for improvement within your authentication protocols.

```sql
```sql+postgres
select
id,
name,
Expand All @@ -34,9 +57,38 @@ where
not enabled;
```

```sql+sqlite
select
id,
name,
enabled,
state,
type,
create_time
from
aiven_account_authentication
where
enabled = 0;
```

### List pending authentication methods
Discover the segments that have authentication methods still in the process of being configured. This is useful to ensure all methods are set up correctly and promptly for secure access.

```sql
```sql+postgres
select
id,
name,
enabled,
state,
type,
create_time
from
aiven_account_authentication
where
state = 'pending_configuration';
```

```sql+sqlite
select
id,
name,
Expand All @@ -51,8 +103,23 @@ where
```

### List SAML authentication methods
Explore the SAML authentication methods in your Aiven account to determine which are enabled. This can be useful to identify potential security risks and maintain compliance with your organization's authentication policies.

```sql+postgres
select
id,
name,
enabled,
state,
type,
create_time
from
aiven_account_authentication
where
type = 'saml';
```

```sql
```sql+sqlite
select
id,
name,
Expand All @@ -67,8 +134,9 @@ where
```

### List expired SAML certificates
Assess the elements within your Aiven account authentication to identify expired SAML certificates. This is useful for maintaining security standards by ensuring all certificates are current and valid.

```sql
```sql+postgres
select
id,
name,
Expand All @@ -83,3 +151,19 @@ from
where
now() < saml_certificate_not_valid_after;
```

```sql+sqlite
select
id,
name,
enabled,
state,
type,
create_time,
saml_certificate_issuer,
saml_certificate_not_valid_after
from
aiven_account_authentication
where
datetime('now') < saml_certificate_not_valid_after;
```
Loading

0 comments on commit e8f5918

Please sign in to comment.