Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Registry for cloud and SaaS providers for StackQL, generated from extensions to the providers OpenAPI3 specification
https://github.com/stackql/stackql-provider-registry

asset-management cloud cloud-automation cloud-security devops devsecops gcp github hacktoberfest netlify okta openapi3 sql stackql

Last synced: 2 months ago
JSON representation

Registry for cloud and SaaS providers for StackQL, generated from extensions to the providers OpenAPI3 specification

Host: GitHub
URL: https://github.com/stackql/stackql-provider-registry
Owner: stackql
Created: 2021-12-23T06:39:01.000Z (about 3 years ago)
Default Branch: dev
Last Pushed: 2024-11-15T06:43:53.000Z (2 months ago)
Last Synced: 2024-11-15T07:30:41.750Z (2 months ago)
Topics: asset-management, cloud, cloud-automation, cloud-security, devops, devsecops, gcp, github, hacktoberfest, netlify, okta, openapi3, sql, stackql
Language: Go
Homepage: https://registry.stackql.io/
Size: 128 MB
Stars: 23
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md

Awesome Lists containing this project

README

        
[![GitHub Actions](https://github.com/stackql/stackql-provider-registry/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/stackql/stackql-provider-registry/actions/workflows/main.yml)

![License](https://img.shields.io/github/license/stackql/stackql)

# StackQL Provider Registry

A repository of `provider` interface documents supporting [stackql](https://stackql.io/) ([stackql GitHub repo](https://github.com/stackql/stackql)). 

## Context

StackQL provider interface documents inform the stackql application on how to interact with a given provider (like `aws`, `azure`, `google`, etc), including what methods are available in the provider and how to invoke these using SQL semantics.  Provider interface documents are `yaml` formatted, OpenAPI specifications with extensions.  

The documents are versioned per provider in this repository, and built as signed and compressed as packaged artifacts.  The packaged artifacts are registered and published to the StackQL Provider Registry Artifact Repository in AWS S3.  The provider registry API is a [Deno Deploy](https://deno.com/deploy) application that serves the provider interface documents to the stackql application using the `REGISTRY LIST` and `REGISTRY PULL` commands.  

The following diagram shows the context of the provider registry:  

```mermaid

C4Context

    System_Ext(github_repo, "stackql-provider-registry", "GitHub Repository")

    System_Ext(github_actions, "Build and Deploy", "GitHub Actions")

    SystemDb(artifact_repo, "Artifact Repository", "AWS S3")

    System(deno_registry, "Provider Registry API", "Deno Deploy")

    System(stackql, "StackQL Application", "stackql")

    Rel(github_repo, github_actions, "triggers...")

    Rel(github_actions, artifact_repo, "registers and pushes to...", "signed tgz package")

    Rel(github_actions, deno_registry, "pushes to...", "signed tgz package")

    Rel(stackql, deno_registry, "list and pulls registry docs from...", "REGISTRY LIST | REGISTRY PULL")

    UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="0")

    UpdateRelStyle(github_repo, github_actions, $offsetY="10", $offsetX="-20")

    UpdateRelStyle(github_actions, artifact_repo, $offsetY="44", $offsetX="-55")

    UpdateRelStyle(github_actions, deno_registry, $offsetY="-18", $offsetX="-130")

    UpdateRelStyle(stackql, deno_registry, $offsetY="40", $offsetX="-40")

```

The public StackQL Provider Registry is distributed via [Deno Deploy](https://deno.com/deploy), using the following endpoints:  

| Endpoint | Description |

| --- | --- |

| [registry.stackql.app](https://registry.stackql.app/ping) | Production registry (built from `main`) |

| [registry-dev.stackql.app](https://registry.stackql.app/ping) | Development registry (built from `develop`) |

## Contributing

Please see [.github/CONTRIBUTING.md](/.github/CONTRIBUTING.md).

## Developing a Provider

StackQL providers are generated from provider OpenAPI or Swagger specifications (either supplied by the provider or constituted through other scripts - for example, [google-discovery-to-openapi](https://github.com/stackql/google-discovery-to-openapi) or [stackql-azure-openapi](https://github.com/stackql/stackql-azure-openapi)).  

Once you have an OpenAPI specification, you can use the [openapisaurus](https://github.com/stackql/openapisaurus) utility project to generate a StackQL provider document.  

## Build and Deployment Workflow

The provider registry is built and deployed using GitHub Actions.  Provider documents are validated and tested in workflow steps and then packaged and stored in the artifact repository.  The most recent packaged versions are published to the registry API (a [Deno Deploy](https://deno.com/deploy) application), where they are available from the `stackql` application using `REGISTRY LIST` or `REGISTRY PULL`.  See [docs/build-and-deployment.md](docs/build-and-deployment.md) for more information.  

## Testing a Provider using the `dev` Registry

Use the following steps to test a provider using the `dev` registry:  

```bash

export DEV_REG="{ \"url\": \"https://registry-dev.stackql.app/providers\" }"

./stackql --registry="${DEV_REG}" shell

```