Skip to content

Commit 22b43c8

Browse files
authored
Improve table docs (#85)
1 parent 2db9cb6 commit 22b43c8

File tree

11 files changed

+859
-63
lines changed

11 files changed

+859
-63
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Release Steampipe Anywhere Components
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
9+
jobs:
10+
anywhere_publish_workflow:
11+
uses: turbot/steampipe-workflows/.github/workflows/steampipe-anywhere.yml@main
12+
secrets: inherit

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright [2022] [Turbot]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Net Plugin for Steampipe
44

5-
Use SQL to query DNS records, certificates and other network information. Open source CLI. No DB required.
5+
Use SQL to query DNS records, certificates and other network information. Zero ETL CLI. No DB required.
66

77
* **[Get started →](https://hub.steampipe.io/plugins/turbot/net)**
88
* Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/net/tables)
@@ -21,6 +21,18 @@ Run a query:
2121
select * from net_certificate where domain = 'steampipe.io';
2222
```
2323

24+
## Engines
25+
26+
This plugin is available for the following engines:
27+
28+
| Engine | Description
29+
|---------------|------------------------------------------
30+
| [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.
31+
| [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.
32+
| [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.
33+
| [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.
34+
| [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.
35+
2436
## Developing
2537

2638
Prerequisites:
@@ -54,10 +66,16 @@ Further reading:
5466
* [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
5567
* [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
5668

57-
## Contributing
69+
## Open Source & Contributing
70+
71+
This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
72+
73+
[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
74+
75+
## Get Involved
5876

59-
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-net/blob/main/LICENSE).
77+
**[Join #steampipe on Slack →](https://turbot.com/community/join)**
6078

61-
`help wanted` issues:
79+
Want to help but don't know where to start? Pick up one of the `help wanted` issues:
6280
- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
6381
- [Net Plugin](https://github.com/turbot/steampipe-plugin-net/labels/help%20wanted)

0 commit comments

Comments
 (0)