Skip to content

Commit 7c467e1

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #127 from stackql/feature/doc-updates
awscc updates
2 parents b04604a + 8fe2792 commit 7c467e1

File tree

5 files changed

+143
-141
lines changed

5 files changed

+143
-141
lines changed

‎.github/workflows/build-docs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
outputs:
1111
providers: ${{ steps.provider-to-deploy.outputs.provider_to_deploy }}
1212
steps:
13-
- uses: actions/checkout@v3
13+
- uses: actions/checkout@v4.1.1
1414
with:
1515
fetch-depth: 0
1616

@@ -60,7 +60,7 @@ jobs:
6060

6161
steps:
6262
- name: Checkout
63-
uses: actions/checkout@v3
63+
uses: actions/checkout@v4.1.1
6464

6565
- name: install
6666
run:

‎docs/aws-docs/index.md

Lines changed: 70 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
---
2-
title: aws
3-
hide_title: false
4-
hide_table_of_contents: false
5-
keywords:
6-
- aws
7-
- stackql
8-
- infrastructure-as-code
9-
- configuration-as-data
10-
- cloud inventory
11-
description: Query, deploy and manage AWS resources using SQL
12-
custom_edit_url: null
13-
image: /img/providers/aws/stackql-aws-provider-featured-image.png
14-
id: aws-doc
15-
slug: /providers/aws
16-
17-
---
1+
---
2+
title: aws
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- aws
7+
- stackql
8+
- infrastructure-as-code
9+
- configuration-as-data
10+
- cloud inventory
11+
description: Query, deploy and manage AWS resources using SQL
12+
custom_edit_url: null
13+
image: /img/providers/aws/stackql-aws-provider-featured-image.png
14+
id: aws-doc
15+
slug: /providers/aws
16+
17+
---
1818
Cloud services from AWS.
1919

2020
:::info Provider Summary (v23.11.00181)
@@ -32,58 +32,59 @@ Cloud services from AWS.
3232

3333
:::
3434

35-
See also:
36-
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37-
* * *
38-
39-
## Installation
40-
41-
To pull the latest version of the `aws` provider, run the following command:
42-
43-
```bash
44-
REGISTRY PULL aws;
45-
```
46-
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47-
48-
## Authentication
49-
50-
The following system environment variables are used for authentication by default:
51-
52-
- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
53-
- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
54-
55-
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
56-
57-
<details>
58-
59-
<summary>Using different environment variables</summary>
60-
61-
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
62-
63-
```bash
64-
65-
AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
66-
stackql shell --auth="${AUTH}"
67-
68-
```
69-
or using PowerShell:
70-
71-
```powershell
72-
73-
$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
74-
stackql.exe shell --auth=$Auth
75-
76-
```
77-
</details>
78-
79-
80-
## Server Parameters
81-
82-
83-
The following parameter is required for the `aws` provider:
84-
85-
- `region` - AWS region (e.g. `us-east-1`)
86-
35+
See also:
36+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37+
* * *
38+
39+
## Installation
40+
41+
To pull the latest version of the `aws` provider, run the following command:
42+
43+
```bash
44+
REGISTRY PULL aws;
45+
```
46+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47+
48+
## Authentication
49+
50+
The following system environment variables are used for authentication by default:
51+
52+
- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
53+
- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
54+
- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html))
55+
56+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
57+
58+
<details>
59+
60+
<summary>Using different environment variables</summary>
61+
62+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
63+
64+
```bash
65+
66+
AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
67+
stackql shell --auth="${AUTH}"
68+
69+
```
70+
or using PowerShell:
71+
72+
```powershell
73+
74+
$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
75+
stackql.exe shell --auth=$Auth
76+
77+
```
78+
</details>
79+
80+
81+
## Server Parameters
82+
83+
84+
The following parameter is required for the `aws` provider:
85+
86+
- `region` - AWS region (e.g. `us-east-1`)
87+
8788
This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
8889

8990
## Services

‎docs/awscc-docs/index.md

Lines changed: 71 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
---
2-
title: aws
3-
hide_title: false
4-
hide_table_of_contents: false
5-
keywords:
6-
- aws
7-
- stackql
8-
- infrastructure-as-code
9-
- configuration-as-data
10-
- cloud inventory
11-
description: Query, deploy and manage AWS resources using SQL
12-
custom_edit_url: null
13-
image: /img/providers/aws/stackql-aws-provider-featured-image.png
14-
id: aws-doc
15-
slug: /providers/aws
16-
17-
---
1+
---
2+
title: awscc
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- aws
7+
- stackql
8+
- infrastructure-as-code
9+
- configuration-as-data
10+
- cloud inventory
11+
description: Query, deploy and manage AWS resources using SQL
12+
custom_edit_url: null
13+
image: /img/providers/aws/stackql-aws-provider-featured-image.png
14+
id: awscc-doc
15+
slug: /providers/awscc
16+
17+
---
1818
Cloud services from AWS.
1919

2020
:::info Provider Summary (v24.03.00206)
@@ -32,59 +32,60 @@ Cloud services from AWS.
3232

3333
:::
3434

35-
See also:
36-
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37-
* * *
38-
39-
## Installation
40-
41-
To pull the latest version of the `aws` provider, run the following command:
42-
43-
```bash
44-
REGISTRY PULL aws;
45-
```
46-
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47-
48-
## Authentication
49-
50-
The following system environment variables are used for authentication by default:
51-
52-
- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
53-
- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
54-
55-
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
56-
57-
<details>
58-
59-
<summary>Using different environment variables</summary>
60-
61-
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
62-
63-
```bash
64-
65-
AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
66-
stackql shell --auth="${AUTH}"
67-
68-
```
69-
or using PowerShell:
70-
71-
```powershell
72-
73-
$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
74-
stackql.exe shell --auth=$Auth
75-
76-
```
77-
</details>
78-
79-
80-
## Server Parameters
81-
82-
83-
The following parameter is required for the `aws` provider:
84-
85-
- `region` - AWS region (e.g. `us-east-1`)
86-
87-
This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
35+
See also:
36+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37+
* * *
38+
39+
## Installation
40+
41+
To pull the latest version of the `awscc` provider, run the following command:
42+
43+
```bash
44+
REGISTRY PULL awscc;
45+
```
46+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47+
48+
## Authentication
49+
50+
The following system environment variables are used for authentication by default:
51+
52+
- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
53+
- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
54+
- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html))
55+
56+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
57+
58+
<details>
59+
60+
<summary>Using different environment variables</summary>
61+
62+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
63+
64+
```bash
65+
66+
AUTH='{ "awscc": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
67+
stackql shell --auth="${AUTH}"
68+
69+
```
70+
or using PowerShell:
71+
72+
```powershell
73+
74+
$Auth = "{ 'awscc': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
75+
stackql.exe shell --auth=$Auth
76+
77+
```
78+
</details>
79+
80+
81+
## Server Parameters
82+
83+
84+
The following parameter is required for the `awscc` provider:
85+
86+
- `region` - AWS region (e.g. `us-east-1`)
87+
88+
This parameter must be supplied to the `WHERE` clause of each `SELECT` statement, with the exception of global services such as `iam`, `route53`, `cloudfront`, etc.
8889

8990
## Services
9091
<div class="row">

‎static/img/providers/awscc/awscc.png

781 Bytes
Loading

‎static/img/providers/awscc/stackql-awscc-provider-featured-image.png

35.3 KB
Loading

0 commit comments

Comments
 (0)