Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turbot/steampipe-plugin-nomad
Use SQL to instantly query Nomad ACLs, deployments, namespaces & more. Open source CLI. No DB required.
https://github.com/turbot/steampipe-plugin-nomad
backup etl hacktoberfest nomad postgresql postgresql-fdw sql sqlite steampipe steampipe-plugin zero-etl
Last synced: 7 days ago
JSON representation
Use SQL to instantly query Nomad ACLs, deployments, namespaces & more. Open source CLI. No DB required.
- Host: GitHub
- URL: https://github.com/turbot/steampipe-plugin-nomad
- Owner: turbot
- License: apache-2.0
- Created: 2023-04-26T13:27:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T13:54:18.000Z (7 months ago)
- Last Synced: 2024-04-14T10:36:49.493Z (7 months ago)
- Topics: backup, etl, hacktoberfest, nomad, postgresql, postgresql-fdw, sql, sqlite, steampipe, steampipe-plugin, zero-etl
- Language: Go
- Homepage: https://hub.steampipe.io/plugins/turbot/nomad
- Size: 284 KB
- Stars: 3
- Watchers: 8
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nomad Plugin for Steampipe
Use SQL to query nodes, jobs, deployments and more from Nomad.
- **[Get started →](https://hub.steampipe.io/plugins/turbot/nomad)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/nomad/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-nomad/issues)
## Quick start
### Install
Download and install the latest Nomad plugin:
```bash
steampipe plugin install nomad
```
Configure your [credentials](https://hub.steampipe.io/plugins/turbot/nomad#credentials) and [config file](https://hub.steampipe.io/plugins/turbot/nomad#configuration).
Add your configuration details in `~/.steampipe/config/nomad.spc`:
```hcl
connection "nomad" {
plugin = "nomad"
# Authentication information
address = "http://18.118.164.168:4646"
secret_id = "c178b810-8b18-6f38-016f-725ddec5d58"
}
```
- `secret_id` parameter is only required to query the ACL tables like `nomad_acl_auth_method`, `nomad_acl_binding_rule`, `nomad_acl_policy`, `nomad_acl_role` and `nomad_acl_token` tables.
- `namespace` parameter is only required to query the `nomad_namespace` table.
Or through environment variables:
```sh
export NOMAD_ADDR=http://18.118.144.168:4646
export NOMAD_TOKEN=c178b810-8b18-6f38-016f-725ddec5d58
```
Run steampipe:
```shell
steampipe query
```
List your Nomad jobs:
```sql
select
id,
name,
status,
dispatched,
namespace,
priority,
region
from
nomad_job;
```
```
+------+------+---------+------------+-----------+----------+--------+
| id | name | status | dispatched | namespace | priority | region |
+------+------+---------+------------+-----------+----------+--------+
| docs | docs | pending | false | default | 50 | global |
+------+------+---------+------------+-----------+----------+--------+
```
## 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/overview) | 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/overview) | 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/overview) | 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:
- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)
Clone:
```sh
git clone https://github.com/turbot/steampipe-plugin-nomad.git
cd steampipe-plugin-nomad
```
Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:
```
make
```
Configure the plugin:
```
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/nomad.spc
```
Try it!
```
steampipe query
> .inspect nomad
```
Further reading:
- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
## Open Source & Contributing
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!
[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).
## Get Involved
**[Join #steampipe on Slack →](https://turbot.com/community/join)**
Want to help but don't know where to start? Pick up one of the `help wanted` issues:
- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
- [Nomad Plugin](https://github.com/turbot/steampipe-plugin-nomad/labels/help%20wanted)