Skip to content

Commit e3087ff

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #217 from stackql/feature/doc-updates
digitalocean update
2 parents 0d7b391 + 88843b8 commit e3087ff

File tree

228 files changed

+11309
-3469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

228 files changed

+11309
-3469
lines changed

‎docs/digitalocean-docs/index.md‎

Lines changed: 70 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,80 @@
1-
---
2-
title: digitalocean
3-
hide_title: false
4-
hide_table_of_contents: false
5-
keywords:
6-
- digitalocean
7-
- stackql
8-
- infrastructure-as-code
9-
- configuration-as-data
10-
- cloud inventory
11-
description: Query, deploy and manage Sumologic resources using SQL
12-
custom_edit_url: null
13-
image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
14-
id: digitalocean-doc
15-
slug: /providers/digitalocean
16-
---
17-
18-
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19-
20-
Cloud computing services and Infrastructure as a Service (IaaS).
21-
22-
:::info Provider Summary (v23.04.00139)
1+
---
2+
title: digitalocean
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- digitalocean
7+
- stackql
8+
- infrastructure-as-code
9+
- configuration-as-data
10+
- cloud inventory
11+
description: Query, deploy and manage Digital Ocean resources using SQL
12+
custom_edit_url: null
13+
image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
14+
id: digitalocean-doc
15+
slug: /providers/digitalocean
16+
17+
---
18+
19+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
20+
21+
DigitalOcean for managing cloud servers, databases, networking, and storage in a simplified, developer-friendly environment.
22+
23+
24+
:::info Provider Summary
2325

2426
<div class="row">
2527
<div class="providerDocColumn">
26-
<span>total services:&nbsp;<b>28</b></span><br />
27-
<span>total methods:&nbsp;<b>408</b></span><br />
28-
</div>
29-
<div class="providerDocColumn">
30-
<span>total resources:&nbsp;<b>104</b></span><br />
31-
<span>total selectable resources:&nbsp;<b>93</b></span><br />
28+
<span>total services:&nbsp;<b>29</b></span><br />
29+
<span>total resources:&nbsp;<b>179</b></span><br />
3230
</div>
3331
</div>
3432

3533
:::
3634

37-
See also:
38-
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
39-
* * *
40-
41-
## Installation
42-
43-
To pull the latest version of the `digitalocean` provider, run the following command:
44-
45-
```bash
46-
REGISTRY PULL digitalocean;
47-
```
48-
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
49-
50-
## Authentication
51-
52-
The following system environment variables are used for authentication by default:
53-
54-
- <CopyableCode code="DIGITALOCEAN_ACCESS_TOKEN" /> - DigitalOcean API token (see <a href="https://docs.digitalocean.com/reference/api/create-personal-access-token/">How to Create a Personal Access Token</a>)
55-
56-
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
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 `digitalocean` provider, run the following command:
42+
43+
```bash
44+
REGISTRY PULL digitalocean;
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+
- <CopyableCode code="DIGITALOCEAN_ACCESS_TOKEN" /> - DigitalOcean API token (see <a href="https://docs.digitalocean.com/reference/api/create-personal-access-token/">How to Create a Personal Access Token</a>)
53+
54+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
55+
56+
<details>
57+
58+
<summary>Using different environment variables</summary>
59+
60+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
61+
62+
```bash
63+
64+
AUTH='{ "digitalocean": { "type": "bearer", "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}'
65+
stackql shell --auth="${AUTH}"
66+
67+
```
68+
or using PowerShell:
69+
70+
```powershell
71+
72+
$Auth = "{ 'digitalocean': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}"
73+
stackql.exe shell --auth=$Auth
74+
75+
```
76+
</details>
5777

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='{ "digitalocean": { "type": "bearer", "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}'
67-
stackql shell --auth="${AUTH}"
68-
69-
```
70-
or using PowerShell:
71-
72-
```powershell
73-
74-
$Auth = "{ 'digitalocean': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}"
75-
stackql.exe shell --auth=$Auth
76-
77-
```
78-
</details>
7978

8079
## Services
8180
<div class="row">
@@ -94,9 +93,9 @@ stackql.exe shell --auth=$Auth
9493
<a href="/providers/digitalocean/firewalls/">firewalls</a><br />
9594
<a href="/providers/digitalocean/floating_ips/">floating_ips</a><br />
9695
<a href="/providers/digitalocean/functions/">functions</a><br />
96+
<a href="/providers/digitalocean/images/">images</a><br />
9797
</div>
9898
<div class="providerDocColumn">
99-
<a href="/providers/digitalocean/images/">images</a><br />
10099
<a href="/providers/digitalocean/kubernetes/">kubernetes</a><br />
101100
<a href="/providers/digitalocean/load_balancers/">load_balancers</a><br />
102101
<a href="/providers/digitalocean/monitoring/">monitoring</a><br />
@@ -109,6 +108,7 @@ stackql.exe shell --auth=$Auth
109108
<a href="/providers/digitalocean/ssh_keys/">ssh_keys</a><br />
110109
<a href="/providers/digitalocean/tags/">tags</a><br />
111110
<a href="/providers/digitalocean/uptime/">uptime</a><br />
111+
<a href="/providers/digitalocean/vpc_peerings/">vpc_peerings</a><br />
112112
<a href="/providers/digitalocean/vpcs/">vpcs</a><br />
113113
</div>
114114
</div>

‎docs/digitalocean-docs/providers/digitalocean/account/account/index.md‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: accounts
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- accounts
7+
- account
8+
- digitalocean
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy and manage digitalocean resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
15+
---
16+
17+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
18+
import Tabs from '@theme/Tabs';
19+
import TabItem from '@theme/TabItem';
20+
21+
Creates, updates, deletes, gets or lists a <code>accounts</code> resource.
22+
23+
## Overview
24+
<table><tbody>
25+
<tr><td><b>Name</b></td><td><code>accounts</code></td></tr>
26+
<tr><td><b>Type</b></td><td>Resource</td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.account.accounts" /></td></tr>
28+
</tbody></table>
29+
30+
## Fields
31+
| Name | Datatype | Description |
32+
|:-----|:---------|:------------|
33+
| <CopyableCode code="column_anon" /> | `` | |
34+
35+
## Methods
36+
| Name | Accessible by | Required Params | Description |
37+
|:-----|:--------------|:----------------|:------------|
38+
| <CopyableCode code="account_get" /> | `SELECT` | <CopyableCode code="" /> | To show information about the current user account, send a GET request to `/v2/account`. |
39+
40+
## `SELECT` examples
41+
42+
To show information about the current user account, send a GET request to `/v2/account`.
43+
44+
45+
```sql
46+
SELECT
47+
column_anon
48+
FROM digitalocean.account.accounts
49+
;
50+
```

‎docs/digitalocean-docs/providers/digitalocean/account/index.md‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,29 @@ keywords:
99
- infrastructure-as-code
1010
- configuration-as-data
1111
- cloud inventory
12-
description: Query, deploy and manage Sumologic resources using SQL
12+
description: Query, deploy and manage digitalocean resources using SQL
1313
custom_edit_url: null
1414
image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
1515
---
1616

17-
Account
18-
17+
account service documentation.
18+
1919
:::info Service Summary
2020

2121
<div class="row">
2222
<div class="providerDocColumn">
2323
<span>total resources:&nbsp;<b>1</b></span><br />
24-
<span>total selectable resources:&nbsp;<b>1</b></span><br />
25-
<span>total methods:&nbsp;<b>2</b></span><br />
2624
</div>
2725
</div>
2826

2927
:::
3028

31-
## Overview
32-
<table><tbody>
33-
<tr><td><b>Name</b></td><td><code>digitalocean.account</code></td></tr>
34-
<tr><td><b>Type</b></td><td>Service</td></tr>
35-
<tr><td><b>Title</b></td><td>DigitalOcean API - Account</td></tr>
36-
<tr><td><b>Description</b></td><td>Account</td></tr>
37-
<tr><td><b>Id</b></td><td><code>account:v23.04.00139</code></td></tr>
38-
</tbody></table>
39-
4029
## Resources
4130
<div class="row">
4231
<div class="providerDocColumn">
43-
<a href="/providers/digitalocean/account/account/">account</a><br />
32+
<a href="/providers/digitalocean/account/accounts/">accounts</a>
4433
</div>
4534
<div class="providerDocColumn">
35+
4636
</div>
47-
</div>
37+
</div>

‎docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ hide_table_of_contents: false
55
keywords:
66
- actions
77
- actions
8-
- digitalocean
9-
- stackql
8+
- digitalocean
109
- infrastructure-as-code
1110
- configuration-as-data
1211
- cloud inventory
13-
description: Query, deploy and manage Sumologic resources using SQL
12+
description: Query, deploy and manage digitalocean resources using SQL
1413
custom_edit_url: null
1514
image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
1615
---
1716

1817
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
18+
import Tabs from '@theme/Tabs';
19+
import TabItem from '@theme/TabItem';
1920

20-
21-
21+
Creates, updates, deletes, gets or lists a <code>actions</code> resource.
2222

2323
## Overview
2424
<table><tbody>
@@ -30,19 +30,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
3030
## Fields
3131
| Name | Datatype | Description |
3232
|:-----|:---------|:------------|
33-
| <CopyableCode code="id" /> | `integer` | A unique numeric ID that can be used to identify and reference an action. |
34-
| <CopyableCode code="completed_at" /> | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. |
35-
| <CopyableCode code="region" /> | `object` | |
36-
| <CopyableCode code="region_slug" /> | `string` | A human-readable string that is used as a unique identifier for each region. |
37-
| <CopyableCode code="resource_id" /> | `integer` | A unique identifier for the resource that the action is associated with. |
38-
| <CopyableCode code="resource_type" /> | `string` | The type of resource that the action is associated with. |
39-
| <CopyableCode code="started_at" /> | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. |
40-
| <CopyableCode code="status" /> | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". |
41-
| <CopyableCode code="type" /> | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. |
33+
| <CopyableCode code="column_anon" /> | `` | |
34+
4235
## Methods
4336
| Name | Accessible by | Required Params | Description |
4437
|:-----|:--------------|:----------------|:------------|
45-
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
46-
| <CopyableCode code="list" /> | `SELECT` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
47-
| <CopyableCode code="_get" /> | `EXEC` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
48-
| <CopyableCode code="_list" /> | `EXEC` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
38+
| <CopyableCode code="actions_get" /> | `SELECT` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
39+
| <CopyableCode code="actions_list" /> | `SELECT` | <CopyableCode code="" /> | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
40+
41+
## `SELECT` examples
42+
43+
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
44+
45+
46+
```sql
47+
SELECT
48+
column_anon
49+
FROM digitalocean.actions.actions
50+
;
51+
```

0 commit comments

Comments
 (0)