Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stackql/stackql

Query, provision and operate Cloud and SaaS resources and APIs using an extensible SQL based framework
https://github.com/stackql/stackql

asset-management cloud cloud-automation cloud-config cloud-operations cloud-security cspm devops devsecops hacktoberfest infrastructure-as-code openapi3 sql stackql

Last synced: 3 months ago
JSON representation

Query, provision and operate Cloud and SaaS resources and APIs using an extensible SQL based framework

Host: GitHub
URL: https://github.com/stackql/stackql
Owner: stackql
License: mit
Created: 2022-01-03T08:20:06.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-04-24T21:56:01.000Z (7 months ago)
Last Synced: 2024-05-01T11:44:48.203Z (6 months ago)
Topics: asset-management, cloud, cloud-automation, cloud-config, cloud-operations, cloud-security, cspm, devops, devsecops, hacktoberfest, infrastructure-as-code, openapi3, sql, stackql
Language: Go
Homepage: https://stackql.io/
Size: 16.9 MB
Stars: 435
Watchers: 11
Forks: 44
Open Issues: 106
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[logo]: https://stackql.io/img/stackql-logo-bold.png "stackql logo"

[homepage]: https://stackql.io/

[docs]: https://stackql.io/docs

[blog]: https://stackql.io/blog

[registry]: https://github.com/stackql/stackql-provider-registry

[variables]: https://stackql.io/docs/getting-started/variables

[macpkg]: https://storage.googleapis.com/stackql-public-releases/latest/stackql_darwin_multiarch.pkg

[winmsi]: https://releases.stackql.io/stackql/latest/stackql_windows_amd64.msi

[winzip]: https://releases.stackql.io/stackql/latest/stackql_windows_amd64.zip

[tuxzip]: https://releases.stackql.io/stackql/latest/stackql_linux_amd64.zip

[dockerhub]: https://hub.docker.com/u/stackql

[dockerstackql]: https://hub.docker.com/r/stackql/stackql

[dockerjupyter]: https://hub.docker.com/r/stackql/stackql-jupyter-demo

[setupaction]: https://github.com/marketplace/actions/stackql-studios-setup-stackql

[execaction]: https://github.com/marketplace/actions/stackql-studios-stackql-exec

[badge1]: https://img.shields.io/badge/platform-windows%20macos%20linux-brightgreen "Platforms"

[badge2]: https://github.com/stackql/stackql/workflows/Go/badge.svg "Go"

[badge3]: https://img.shields.io/github/license/stackql/stackql "License"

[badge4]: https://img.shields.io/tokei/lines/github/stackql/stackql "Lines"    

[issues]: https://github.com/stackql/stackql/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D

[features]: https://github.com/stackql/stackql/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D

[developers]: /docs/developer_guide.md

[registrycont]: /docs/registry_contribution.md

[designdocs]: /docs/high-level-design.md

[contributing]: /CONTRIBUTING.md

[discussions]: https://github.com/orgs/stackql/discussions

[darkmodeterm]: /docs/images/stackql-light-term.gif#gh-dark-mode-only

[lightmodeterm]: /docs/images/stackql-dark-term.gif#gh-light-mode-only

[twitter]: https://twitter.com/stackql



[![logo]][homepage]  

![badge1]

![badge2]

![badge3]

![badge4]





### Deploy, manage and query cloud resources and interact with APIs using SQL



[__Read the docs »__][docs]  

[Raise an Issue][issues] · 

[Request a Feature][features] · 

[Developer Guide][developers] · 

[BYO Providers][registrycont]





Contents



About The Project

Installation

Usage


Contributing

License

Contact

Acknowledgements



## About The Project

[__StackQL__][homepage] is an open-source project built with Golang that allows you to create, modify and query the state of services and resources across different cloud and SaaS providers (Google, AWS, Azure, Okta, GitHub, etc.) using SQL semantics







![stackql-shell][darkmodeterm]

![stackql-shell][lightmodeterm]

### How it works

StackQL is a standalone application that can be used in client mode (via __`exec`__ or __`shell`__) or accessed via a Postgres wire protocol client (`psycopg2`, etc.) using server mode (__`srv`__).  

StackQL parses SQL statements and transpiles them into API requests to the cloud provider.  The API calls are then executed and the results are returned to the user.  

StackQL provider definitions are defined in OpenAPI extensions to the providers specification.  These definitions are then used to generate the SQL schema and the API client.  The source for the provider definitions are stored in the [__StackQL Registry__][registry].  

StackQL Context Diagram




The following context diagram describes the StackQL architecture at a high level:  

```mermaid

flowchart LR

  subgraph StackQL

    direction BT

    subgraph ProviderDefs

        Registry[Provider Registry Docs]    

    end

    subgraph App

        Proc[$ stackql exec\n$ stackql shell\n$ stackql srv]

        style Proc fill:#000,stroke:#000,color:#fff,text-align:left;

        %% ,font-family:'Courier New', Courier, monospace

    end

  end

  User((User)) <--> StackQL <--> Provider[Cloud Provider API]

  ProviderDefs --> App

```

More detailed design documentation can be found in the [here][designdocs].

## Installation

StackQL is available for Windows, MacOS, Linux, Docker, GitHub Actions and more.  See the installation instructions below for your platform.  

Installing on MacOS

- Homebrew (`amd64` and `arm64`)

  - `brew install stackql` *or* `brew tap stackql/tap && brew install stackql/tap/stackql`

- MacOS PKG Installer (`amd64` and `arm64`)

  - download the latest [MacOS PKG installer for StackQL][macpkg]

  - run the installer and follow the prompts

Installing on Windows

- MSI Installer

  - download the latest [MSI installer for StackQL][winmsi]

  - run the installer and follow the prompts

- Chocolatey

  - install [Chocolatey](https://chocolatey.org/install)

  - run `choco install stackql`

- ZIP Archive

  - download the latest [Windows ZIP archive for StackQL][winzip]

  - extract the archive (code signed `stackql.exe` file) to a directory of your choice

  - add the directory to your `PATH` environment variable (optional)

Installing on Linux

- ZIP Archive

  - download the latest [Linux ZIP archive for StackQL][tuxzip]

    - or via `curl -L https://bit.ly/stackql-zip -O && unzip stackql-zip`

  - extract the archive (`stackql` file) to a directory of your choice

  - add the directory to your `PATH` environment variable (optional)

Getting StackQL from DockerHub

> View all available StackQL images on [__DockerHub__][dockerhub].  Images available include [__`stackql`__][dockerstackql], [__`stackql-jupyter-demo`__][dockerjupyter] and more.  Pull the latest StackQL base image using:  

```bash

docker pull stackql/stackql

```

Using StackQL with GitHub Actions

> Use StackQL in your GitHub Actions workflows to automate cloud infrastructure provisioning, IaC assurance, or compliance/security.  Available GitHub Actions include: [`setup-stackql`][setupaction], [`stackql-exec`][execaction] and more

## Usage

StackQL can be used via the interactive REPL shell, or via the `exec` command or ran as a server using the [Postgres wire protocol](https://www.postgresql.org/docs/current/protocol.html).  

> ℹ️ StackQL does not require or install a database.

* Interactive Shell

  ```sh

  # run interactive stackql queries

  stackql shell --auth="${AUTH}"

  ```

* Execute a statement or file

  ```sh

  stackql exec --auth="${AUTH}" -i myscript.iql --iqldata vars.jsonnet --output json

  

  # or

  

  stackql exec --auth="${AUTH}" "SELECT id, status FROM aws.ec2.instances WHERE region = 'us-east-1'"

  ```

  > ℹ️ output options of `json`, `csv`, `table` and `text` are available for the `exec` command using the `--output` flag

  > ℹ️ StackQL supports passing parameters using `jsonnet` or `json`, see [__Using Variables__][variables]

* Server

  ```sh

  # serve client requests over the Postgres wire protocol (psycopg2, etc.) 

  stackql srv --auth="${AUTH}"

  ```

_For more examples, please check our [Blog][blog]_

## Contributing

Contributions are welcome and encouraged.  For more information on how to contribute, please see our [__contributing guide__][contributing].

## License

Distributed under the MIT License. See [`LICENSE`](https://github.com/stackql/stackql/blob/main/LICENSE) for more information.  Licenses for third party software we are using are included in the [/docs/licenses](/docs/licenses) directory.

## Contact

Get in touch with us via Twitter at [__@stackql__][twitter], email us at [[email protected]__]([email protected]) or start a conversation using [__discussions__][discussions].

## Acknowledgements

Forks of the following support our work:

* [vitess](https://vitess.io/)

* [kin-openapi](https://github.com/getkin/kin-openapi)

* [gorilla/mux](https://github.com/gorilla/mux)

* [readline](https://github.com/chzyer/readline)

* [color](https://github.com/fatih/color)

* [psql-wire](https://github.com/jeroenrinzema/psql-wire)

We gratefully acknowledge these pieces of work.