Skip to content

Commit 1f227b1

Browse files
example-automation
Summary: - Prelude to mega robust product.
1 parent 9f40160 commit 1f227b1

File tree

3 files changed

+46
-1
lines changed

3 files changed

+46
-1
lines changed

docs/CICD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ In lieu of a full implementation of [github actions best practices](https://secu
1818

1919
## API mocking
2020

21-
According to [this swagger-codegen example](https://github.com/swagger-api/swagger-codegen/blob/master/bin/python-flask-petstore.sh), it is not overly difficult to generate python mocks from openapi docs. This can then be used for credible regression testing against new provider docs and certainly the relationship of endpoints to stackql resources. Know weakness: will not detect defective transform from source (eg: MS-graph, AWS) top aponapi.
21+
According to [this swagger-codegen example](https://github.com/swagger-api/swagger-codegen/blob/master/bin/python-flask-petstore.sh), it is not overly difficult to generate python mocks from openapi docs. This can then be used for credible regression testing against new provider docs and certainly the relationship of endpoints to stackql resources. Know weakness: will not detect defective transform from source (eg: MS-graph, AWS) to openapi.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
```bash
3+
4+
export GOOOGLE_CREDENTIALS=""
5+
6+
```
7+
8+
9+
```sql
10+
11+
12+
13+
```

docs/examples/examples.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
11

2+
# stackql-examples
3+
4+
This repository serves as an aggregator for **working** examples of `stackql` and `stackql-deploy` in action.
5+
6+
If you find anything here that does not work or you do't like, the please raise an issue.
7+
8+
## Getting started is the hardest part
9+
10+
`stackql` needs credentials in order to execute queries. We do support a lot of
11+
the standard patterns. [Our provider registry docs](https://registry.stackql.io/) have the detail, for example [aws](https://aws.stackql.io/providers/aws/#authentication).
12+
This stuff largely emulates the various provider CLIs. But we do not to take too much of your precious time, setting environment variables like
13+
so will get you a long way with these examples:
14+
15+
```bash
16+
17+
export AWS_SECRET_ACCESS_KEY='<your aws secret>'
18+
export AWS_ACCESS_KEY_ID='<your aws key id>'
19+
20+
export GOOGLE_CREDENTIALS=$(cat </path/to/service/account/key.json>)
21+
22+
export AZURE_TENANT_ID='<your azure tenant id>'
23+
export AZURE_CLIENT_ID='<your azure client id>'
24+
export AZURE_CLIENT_SECRET='<your azure secret>'
25+
26+
```
27+
28+
Where more is required, the examples will say so.
29+
30+
## Let's begin
31+
32+
33+
234

335
# Examples
436

0 commit comments

Comments
 (0)