diff --git a/docs/digitalocean-docs/index.md b/docs/digitalocean-docs/index.md index 392c8d2f54..72e05d2d16 100644 --- a/docs/digitalocean-docs/index.md +++ b/docs/digitalocean-docs/index.md @@ -1,81 +1,80 @@ ---- -title: digitalocean -hide_title: false -hide_table_of_contents: false -keywords: - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png -id: digitalocean-doc -slug: /providers/digitalocean ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - -Cloud computing services and Infrastructure as a Service (IaaS). - -:::info Provider Summary (v23.04.00139) +--- +title: digitalocean +hide_title: false +hide_table_of_contents: false +keywords: + - digitalocean + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Digital Ocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +id: digitalocean-doc +slug: /providers/digitalocean + +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +DigitalOcean for managing cloud servers, databases, networking, and storage in a simplified, developer-friendly environment. + + +:::info Provider Summary
-total services: 28
-total methods: 408
-
-
-total resources: 104
-total selectable resources: 93
+total services: 29
+total resources: 179
::: -See also: -[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) -* * * - -## Installation - -To pull the latest version of the `digitalocean` provider, run the following command: - -```bash -REGISTRY PULL digitalocean; -``` -> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). - -## Authentication - -The following system environment variables are used for authentication by default: - -- - DigitalOcean API token (see How to Create a Personal Access Token) - -These variables are sourced at runtime (from the local machine or as CI variables/secrets). +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `digitalocean` provider, run the following command: + +```bash +REGISTRY PULL digitalocean; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - DigitalOcean API token (see How to Create a Personal Access Token) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "digitalocean": { "type": "bearer", "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}' +stackql shell --auth="${AUTH}" + +``` +or using PowerShell: + +```powershell + +$Auth = "{ 'digitalocean': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}" +stackql.exe shell --auth=$Auth + +``` +
-
- -Using different environment variables - -To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: - -```bash - -AUTH='{ "digitalocean": { "type": "bearer", "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}' -stackql shell --auth="${AUTH}" - -``` -or using PowerShell: - -```powershell - -$Auth = "{ 'digitalocean': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}" -stackql.exe shell --auth=$Auth - -``` -
## Services
@@ -94,9 +93,9 @@ stackql.exe shell --auth=$Auth firewalls
floating_ips
functions
+images
-images
kubernetes
load_balancers
monitoring
@@ -109,6 +108,7 @@ stackql.exe shell --auth=$Auth ssh_keys
tags
uptime
+vpc_peerings
vpcs
diff --git a/docs/digitalocean-docs/providers/digitalocean/account/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/account/index.md deleted file mode 100644 index 422c037ede..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/account/account/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: account -hide_title: false -hide_table_of_contents: false -keywords: - - account - - account - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameaccount
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The total number of Droplets current user or team may have active at one time. | -| | `string` | The email address used by the current user to register for DigitalOcean. | -| | `boolean` | If true, the user has verified their account via email. False otherwise. | -| | `integer` | The total number of Floating IPs the current user or team may have. | -| | `string` | This value is one of "active", "warning" or "locked". | -| | `string` | A human-readable message giving more details about the status of the account. | -| | `object` | When authorized in a team context, includes information about the current team. | -| | `string` | The unique universal identifier for the current user. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md b/docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md new file mode 100644 index 0000000000..f7e78f26af --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md @@ -0,0 +1,50 @@ +--- +title: accounts +hide_title: false +hide_table_of_contents: false +keywords: + - accounts + - account + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a accounts resource. + +## Overview + + + + +
Nameaccounts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about the current user account, send a GET request to `/v2/account`. | + +## `SELECT` examples + +To show information about the current user account, send a GET request to `/v2/account`. + + +```sql +SELECT +column_anon +FROM digitalocean.account.accounts +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/index.md index 31d078bf91..e5770e8c6e 100644 --- a/docs/digitalocean-docs/providers/digitalocean/account/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/account/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Account - +account service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 2
::: -## Overview - - - - - - -
Namedigitalocean.account
TypeService
TitleDigitalOcean API - Account
DescriptionAccount
Idaccount:v23.04.00139
- ## Resources
-account
+accounts
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md index 3ff29495e2..c723d449f7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - actions - actions - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a actions resource. ## Overview @@ -30,19 +30,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| | `object` | | -| | `string` | A human-readable string that is used as a unique identifier for each region. | -| | `integer` | A unique identifier for the resource that the action is associated with. | -| | `string` | The type of resource that the action is associated with. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| | `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. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | -| | `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. | -| | `EXEC` | | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | -| | `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. | +| | `SELECT` | | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | +| | `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. | + +## `SELECT` examples + +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. + + +```sql +SELECT +column_anon +FROM digitalocean.actions.actions +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/actions/index.md index 3cc8217b1d..c1dabbac76 100644 --- a/docs/digitalocean-docs/providers/digitalocean/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/actions/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Actions - +actions service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 4
::: -## Overview -
- - - - - -
Namedigitalocean.actions
TypeService
TitleDigitalOcean API - Actions
DescriptionActions
Idactions:v23.04.00139
- ## Resources
-actions
+actions
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md index 9e418f1136..ac4583e95d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - alerts - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a alerts resource. ## Overview @@ -28,18 +28,36 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `array` | -| | `string` | -| | `object` | -| | `array` | -| | `object` | +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | | +| | `string` | | +| | `array` | | +| | `string` | | +| | `object` | | +| | `array` | | +| | `object` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | -| | `EXEC` | | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | -| | `EXEC` | | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. | +| | `SELECT` | | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | +| | `EXEC` | | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. | + +## `SELECT` examples + +List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. + + +```sql +SELECT +id, +component_name, +emails, +phase, +progress, +slack_webhooks, +spec +FROM digitalocean.apps.alerts +WHERE app_id = '{{ app_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md index 01ba88d18a..53e8b11005 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - apps - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a apps resource. ## Overview @@ -33,6 +33,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | | | | `object` | | | | `string` | | +| | `array` | | | | `string` | | | | `array` | | | | `object` | | @@ -48,14 +49,864 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `object` | The desired configuration of an application. | | | `string` | | | | `string` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | -| | `SELECT` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | -| | `INSERT` | | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | -| | `DELETE` | | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. | -| | `EXEC` | | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | -| | `EXEC` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | -| | `EXEC` | | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | -| | `EXEC` | | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. | +| | `SELECT` | | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | +| | `SELECT` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | +| | `INSERT` | | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | +| | `DELETE` | | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. | +| | `EXEC` | | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | +| | `EXEC` | | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. | + +## `SELECT` examples + +List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. + + +```sql +SELECT +id, +active_deployment, +created_at, +dedicated_ips, +default_ingress, +domains, +in_progress_deployment, +last_deployment_created_at, +live_domain, +live_url, +live_url_base, +owner_uuid, +pending_deployment, +pinned_deployment, +project_id, +region, +spec, +tier_slug, +updated_at +FROM digitalocean.apps.apps +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new apps resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.apps ( +data__spec, +data__project_id +) +SELECT +'{{ spec }}', +'{{ project_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.apps ( +data__spec +) +SELECT +'{{ spec }}' +; +``` + + + + +```yaml +- name: apps + props: + - name: data__spec + value: string + - name: spec + props: + - name: name + value: string + - name: region + value: string + - name: domains + value: array + props: + - name: domain + value: string + - name: type + value: string + - name: wildcard + value: boolean + - name: zone + value: string + - name: minimum_tls_version + value: string + - name: services + value: array + props: + - name: name + value: string + - name: git + props: + - name: branch + value: string + - name: repo_clone_url + value: string + - name: github + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: gitlab + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: image + props: + - name: registry + value: string + - name: registry_type + value: string + - name: registry_credentials + value: string + - name: repository + value: string + - name: tag + value: string + - name: digest + value: string + - name: deploy_on_push + props: + - name: enabled + value: boolean + - name: dockerfile_path + value: string + - name: build_command + value: string + - name: run_command + value: string + - name: source_dir + value: string + - name: envs + value: array + props: + - name: key + value: string + - name: scope + value: string + - name: type + value: string + - name: value + value: string + - name: environment_slug + value: string + - name: log_destinations + value: array + props: + - name: name + value: string + - name: papertrail + props: + - name: endpoint + value: string + - name: datadog + props: + - name: endpoint + value: string + - name: api_key + value: string + - name: logtail + props: + - name: token + value: string + - name: open_search + props: + - name: endpoint + value: string + - name: basic_auth + props: + - name: user + value: string + - name: password + value: string + - name: index_name + value: string + - name: cluster_name + value: string + - name: instance_count + value: integer + - name: instance_size_slug + value: string + - name: autoscaling + props: + - name: min_instance_count + value: integer + - name: max_instance_count + value: integer + - name: metrics + props: + - name: cpu + props: + - name: percent + value: integer + - name: cors + props: + - name: allow_origins + value: array + props: + - name: exact + value: string + - name: prefix + value: string + - name: regex + value: string + - name: allow_methods + value: array + - name: allow_headers + value: array + - name: expose_headers + value: array + - name: max_age + value: string + - name: allow_credentials + value: boolean + - name: health_check + props: + - name: failure_threshold + value: integer + - name: port + value: integer + - name: http_path + value: string + - name: initial_delay_seconds + value: integer + - name: period_seconds + value: integer + - name: success_threshold + value: integer + - name: timeout_seconds + value: integer + - name: protocol + value: string + - name: http_port + value: integer + - name: internal_ports + value: array + - name: routes + value: array + props: + - name: path + value: string + - name: preserve_path_prefix + value: boolean + - name: termination + props: + - name: drain_seconds + value: integer + - name: grace_period_seconds + value: integer + - name: static_sites + value: array + props: + - name: name + value: string + - name: git + props: + - name: branch + value: string + - name: repo_clone_url + value: string + - name: github + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: gitlab + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: image + props: + - name: registry + value: string + - name: registry_type + value: string + - name: registry_credentials + value: string + - name: repository + value: string + - name: tag + value: string + - name: digest + value: string + - name: deploy_on_push + props: + - name: enabled + value: boolean + - name: dockerfile_path + value: string + - name: build_command + value: string + - name: run_command + value: string + - name: source_dir + value: string + - name: envs + value: array + props: + - name: key + value: string + - name: scope + value: string + - name: type + value: string + - name: value + value: string + - name: environment_slug + value: string + - name: log_destinations + value: array + props: + - name: name + value: string + - name: papertrail + props: + - name: endpoint + value: string + - name: datadog + props: + - name: endpoint + value: string + - name: api_key + value: string + - name: logtail + props: + - name: token + value: string + - name: open_search + props: + - name: endpoint + value: string + - name: basic_auth + props: + - name: user + value: string + - name: password + value: string + - name: index_name + value: string + - name: cluster_name + value: string + - name: index_document + value: string + - name: error_document + value: string + - name: catchall_document + value: string + - name: output_dir + value: string + - name: cors + props: + - name: allow_origins + value: array + props: + - name: exact + value: string + - name: prefix + value: string + - name: regex + value: string + - name: allow_methods + value: array + - name: allow_headers + value: array + - name: expose_headers + value: array + - name: max_age + value: string + - name: allow_credentials + value: boolean + - name: routes + value: array + props: + - name: path + value: string + - name: preserve_path_prefix + value: boolean + - name: jobs + value: array + props: + - name: name + value: string + - name: git + props: + - name: branch + value: string + - name: repo_clone_url + value: string + - name: github + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: gitlab + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: image + props: + - name: registry + value: string + - name: registry_type + value: string + - name: registry_credentials + value: string + - name: repository + value: string + - name: tag + value: string + - name: digest + value: string + - name: deploy_on_push + props: + - name: enabled + value: boolean + - name: dockerfile_path + value: string + - name: build_command + value: string + - name: run_command + value: string + - name: source_dir + value: string + - name: envs + value: array + props: + - name: key + value: string + - name: scope + value: string + - name: type + value: string + - name: value + value: string + - name: environment_slug + value: string + - name: log_destinations + value: array + props: + - name: name + value: string + - name: papertrail + props: + - name: endpoint + value: string + - name: datadog + props: + - name: endpoint + value: string + - name: api_key + value: string + - name: logtail + props: + - name: token + value: string + - name: open_search + props: + - name: endpoint + value: string + - name: basic_auth + props: + - name: user + value: string + - name: password + value: string + - name: index_name + value: string + - name: cluster_name + value: string + - name: instance_count + value: integer + - name: instance_size_slug + value: string + - name: autoscaling + props: + - name: min_instance_count + value: integer + - name: max_instance_count + value: integer + - name: metrics + props: + - name: cpu + props: + - name: percent + value: integer + - name: kind + value: string + - name: termination + props: + - name: grace_period_seconds + value: integer + - name: workers + value: array + props: + - name: name + value: string + - name: git + props: + - name: branch + value: string + - name: repo_clone_url + value: string + - name: github + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: gitlab + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: image + props: + - name: registry + value: string + - name: registry_type + value: string + - name: registry_credentials + value: string + - name: repository + value: string + - name: tag + value: string + - name: digest + value: string + - name: deploy_on_push + props: + - name: enabled + value: boolean + - name: dockerfile_path + value: string + - name: build_command + value: string + - name: run_command + value: string + - name: source_dir + value: string + - name: envs + value: array + props: + - name: key + value: string + - name: scope + value: string + - name: type + value: string + - name: value + value: string + - name: environment_slug + value: string + - name: log_destinations + value: array + props: + - name: name + value: string + - name: papertrail + props: + - name: endpoint + value: string + - name: datadog + props: + - name: endpoint + value: string + - name: api_key + value: string + - name: logtail + props: + - name: token + value: string + - name: open_search + props: + - name: endpoint + value: string + - name: basic_auth + props: + - name: user + value: string + - name: password + value: string + - name: index_name + value: string + - name: cluster_name + value: string + - name: instance_count + value: integer + - name: instance_size_slug + value: string + - name: autoscaling + props: + - name: min_instance_count + value: integer + - name: max_instance_count + value: integer + - name: metrics + props: + - name: cpu + props: + - name: percent + value: integer + - name: termination + props: + - name: grace_period_seconds + value: integer + - name: functions + value: array + props: + - name: cors + props: + - name: allow_origins + value: array + props: + - name: exact + value: string + - name: prefix + value: string + - name: regex + value: string + - name: allow_methods + value: array + - name: allow_headers + value: array + - name: expose_headers + value: array + - name: max_age + value: string + - name: allow_credentials + value: boolean + - name: routes + value: array + props: + - name: path + value: string + - name: preserve_path_prefix + value: boolean + - name: name + value: string + - name: source_dir + value: string + - name: alerts + value: array + props: + - name: rule + value: string + - name: disabled + value: boolean + - name: operator + value: string + - name: value + value: number + - name: window + value: string + - name: envs + value: array + props: + - name: key + value: string + - name: scope + value: string + - name: type + value: string + - name: value + value: string + - name: git + props: + - name: branch + value: string + - name: repo_clone_url + value: string + - name: github + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: gitlab + props: + - name: branch + value: string + - name: deploy_on_push + value: boolean + - name: repo + value: string + - name: log_destinations + value: array + props: + - name: name + value: string + - name: papertrail + props: + - name: endpoint + value: string + - name: datadog + props: + - name: endpoint + value: string + - name: api_key + value: string + - name: logtail + props: + - name: token + value: string + - name: open_search + props: + - name: endpoint + value: string + - name: basic_auth + props: + - name: user + value: string + - name: password + value: string + - name: index_name + value: string + - name: cluster_name + value: string + - name: databases + value: array + props: + - name: cluster_name + value: string + - name: db_name + value: string + - name: db_user + value: string + - name: engine + value: string + - name: name + value: string + - name: production + value: boolean + - name: version + value: string + - name: ingress + props: + - name: rules + value: array + props: + - name: match + props: + - name: path + props: + - name: prefix + value: string + - name: cors + props: + - name: allow_origins + value: array + props: + - name: exact + value: string + - name: prefix + value: string + - name: regex + value: string + - name: allow_methods + value: array + - name: allow_headers + value: array + - name: expose_headers + value: array + - name: max_age + value: string + - name: allow_credentials + value: boolean + - name: component + props: + - name: name + value: string + - name: preserve_path_prefix + value: string + - name: rewrite + value: string + - name: redirect + props: + - name: uri + value: string + - name: authority + value: string + - name: port + value: integer + - name: scheme + value: string + - name: redirect_code + value: integer + - name: egress + props: + - name: type + value: string + - name: maintenance + props: + - name: enabled + value: boolean + - name: archive + value: boolean + - name: project_id + value: string + +``` + + + +## `DELETE` example + +Deletes the specified apps resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.apps.apps +WHERE id = '{{ id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/components_logs/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/components_logs/index.md new file mode 100644 index 0000000000..048ed826a4 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/apps/components_logs/index.md @@ -0,0 +1,54 @@ +--- +title: components_logs +hide_title: false +hide_table_of_contents: false +keywords: + - components_logs + - apps + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a components_logs resource. + +## Overview +
+ + + +
Namecomponents_logs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | | +| | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | + +## `SELECT` examples + +Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. + + +```sql +SELECT +historic_urls, +live_url +FROM digitalocean.apps.components_logs +WHERE app_id = '{{ app_id }}' +AND component_name = '{{ component_name }}' +AND type = '{{ type }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md deleted file mode 100644 index 51c384d809..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: daily_metrics_bandwidth -hide_title: false -hide_table_of_contents: false -keywords: - - daily_metrics_bandwidth - - apps - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedaily_metrics_bandwidth
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | A list of bandwidth usage details by app. | -| | `string` | The date for the metrics data. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve daily bandwidth usage metrics for a single app. | -| | `EXEC` | | Retrieve daily bandwidth usage metrics for multiple apps. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidths/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidths/index.md new file mode 100644 index 0000000000..a4231fbf97 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidths/index.md @@ -0,0 +1,53 @@ +--- +title: daily_metrics_bandwidths +hide_title: false +hide_table_of_contents: false +keywords: + - daily_metrics_bandwidths + - apps + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a daily_metrics_bandwidths resource. + +## Overview + + + + +
Namedaily_metrics_bandwidths
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | A list of bandwidth usage details by app. | +| | `string` | The date for the metrics data. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve daily bandwidth usage metrics for a single app. | +| | `SELECT` | | Retrieve daily bandwidth usage metrics for multiple apps. | + +## `SELECT` examples + +Retrieve daily bandwidth usage metrics for a single app. + + +```sql +SELECT +app_bandwidth_usage, +date +FROM digitalocean.apps.daily_metrics_bandwidths +WHERE app_id = '{{ app_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md index 7a8206ba12..32e6a7417c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - deployments - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a deployments resource. ## Overview @@ -45,12 +45,90 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | | | | `string` | | | | `array` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve information about an app deployment. | -| | `SELECT` | | List all deployments of an app. | -| | `INSERT` | | Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app. | -| | `EXEC` | | Retrieve information about an app deployment. | -| | `EXEC` | | List all deployments of an app. | -| | `EXEC` | | Immediately cancel an in-progress deployment. | +| | `SELECT` | | Retrieve information about an app deployment. | +| | `SELECT` | | List all deployments of an app. | +| | `INSERT` | | Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app. | +| | `EXEC` | | Immediately cancel an in-progress deployment. | + +## `SELECT` examples + +List all deployments of an app. + + +```sql +SELECT +id, +cause, +cloned_from, +created_at, +functions, +jobs, +phase, +phase_last_updated_at, +progress, +services, +spec, +static_sites, +tier_slug, +updated_at, +workers +FROM digitalocean.apps.deployments +WHERE app_id = '{{ app_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployments resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.deployments ( +data__force_build, +app_id +) +SELECT +'{{ force_build }}', +'{{ app_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.deployments ( +app_id +) +SELECT +'{{ app_id }}' +; +``` + + + + +```yaml +- name: deployments + props: + - name: app_id + value: string + - name: force_build + value: boolean + +``` + + diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/deployments_components_logs/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/deployments_components_logs/index.md new file mode 100644 index 0000000000..7b11578e97 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/apps/deployments_components_logs/index.md @@ -0,0 +1,55 @@ +--- +title: deployments_components_logs +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_components_logs + - apps + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a deployments_components_logs resource. + +## Overview +
+ + + +
Namedeployments_components_logs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | | +| | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | + +## `SELECT` examples + +Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. + + +```sql +SELECT +historic_urls, +live_url +FROM digitalocean.apps.deployments_components_logs +WHERE app_id = '{{ app_id }}' +AND component_name = '{{ component_name }}' +AND deployment_id = '{{ deployment_id }}' +AND type = '{{ type }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/deployments_logs/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/deployments_logs/index.md new file mode 100644 index 0000000000..2fde6aeba2 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/apps/deployments_logs/index.md @@ -0,0 +1,54 @@ +--- +title: deployments_logs +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_logs + - apps + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a deployments_logs resource. + +## Overview + + + + +
Namedeployments_logs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | | +| | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | + +## `SELECT` examples + +Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. + + +```sql +SELECT +historic_urls, +live_url +FROM digitalocean.apps.deployments_logs +WHERE app_id = '{{ app_id }}' +AND deployment_id = '{{ deployment_id }}' +AND type = '{{ type }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/index.md index cdbe55c9a7..706a06c6e4 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/index.md @@ -9,47 +9,38 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Apps - +apps service documentation. + :::info Service Summary
-total resources: 9
-total selectable resources: 8
-total methods: 37
+total resources: 11
::: -## Overview - - - - - - -
Namedigitalocean.apps
TypeService
TitleDigitalOcean API - Apps
DescriptionApps
Idapps:v23.04.00139
- ## Resources
alerts
apps
-daily_metrics_bandwidth
+components_logs
+daily_metrics_bandwidths
deployments
-instance_sizes
+deployments_components_logs
+deployments_logs
logs
regions
rollbacks
-tiers
-
+tiers_instance_sizes
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md deleted file mode 100644 index 4ed0852bf1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: instance_sizes -hide_title: false -hide_table_of_contents: false -keywords: - - instance_sizes - - apps - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameinstance_sizes
TypeResource
Id
- -## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | -| | `SELECT` | | List all instance sizes for `service`, `worker`, and `job` components. | -| | `EXEC` | | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | -| | `EXEC` | | List all instance sizes for `service`, `worker`, and `job` components. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md index 3b147aee51..878c78ae7e 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - logs - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a logs resource. ## Overview @@ -32,10 +32,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; |:-----|:---------|:------------| | | `array` | | | | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | -| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | -| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | -| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | +| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | + +## `SELECT` examples + +Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. + + +```sql +SELECT +historic_urls, +live_url +FROM digitalocean.apps.logs +WHERE app_id = '{{ app_id }}' +AND type = '{{ type }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md index d1ab768a50..2f64c735b1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - regions - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a regions resource. ## Overview
@@ -38,8 +38,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | | | | `string` | | | | `string` | | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all regions supported by App Platform. | + +## `SELECT` examples + +List all regions supported by App Platform. + + +```sql +SELECT +continent, +data_centers, +default, +disabled, +flag, +label, +reason, +slug +FROM digitalocean.apps.regions +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md index b68b88f91a..eff071288d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - rollbacks - apps - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a rollbacks resource. ## Overview
@@ -28,11 +28,71 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `INSERT` | | Rollback an app to a previous deployment. A new deployment will be created to perform the rollback.
The app will be pinned to the rollback deployment preventing any new deployments from being created,
either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be
either committed or reverted.

It is recommended to use the Validate App Rollback endpoint to double check if the rollback is
valid and if there are any warnings.
| -| | `EXEC` | | Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| -| | `EXEC` | | Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| -| | `EXEC` | | Check whether an app can be rolled back to a specific deployment. This endpoint can also be used
to check if there are any warnings or validation conditions that will cause the rollback to proceed
under unideal circumstances. For example, if a component must be rebuilt as part of the rollback
causing it to take longer than usual.
| +| | `INSERT` | | Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed or reverted. It is recommended to use the Validate App Rollback endpoint to double check if the rollback is valid and if there are any warnings. | +| | `EXEC` | | Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments. | +| | `EXEC` | | Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments. | +| | `EXEC` | | Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer than usual. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rollbacks resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.rollbacks ( +data__deployment_id, +data__skip_pin, +app_id +) +SELECT +'{{ deployment_id }}', +'{{ skip_pin }}', +'{{ app_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.apps.rollbacks ( +app_id +) +SELECT +'{{ app_id }}' +; +``` + + + + +```yaml +- name: rollbacks + props: + - name: app_id + value: string + - name: deployment_id + value: string + - name: skip_pin + value: boolean + +``` + + diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md deleted file mode 100644 index 7c0555804d..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: tiers -hide_title: false -hide_table_of_contents: false -keywords: - - tiers - - apps - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nametiers
TypeResource
Id
- -## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieve information about a specific app tier. | -| | `SELECT` | | List all app tiers. | -| | `EXEC` | | Retrieve information about a specific app tier. | -| | `EXEC` | | List all app tiers. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/tiers_instance_sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/tiers_instance_sizes/index.md new file mode 100644 index 0000000000..ebb31e1331 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/apps/tiers_instance_sizes/index.md @@ -0,0 +1,77 @@ +--- +title: tiers_instance_sizes +hide_title: false +hide_table_of_contents: false +keywords: + - tiers_instance_sizes + - apps + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tiers_instance_sizes resource. + +## Overview + + + + +
Nametiers_instance_sizes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `boolean` | | +| | `string` | | +| | `boolean` | | +| | `boolean` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | +| | `SELECT` | | List all instance sizes for `service`, `worker`, and `job` components. | + +## `SELECT` examples + +List all instance sizes for `service`, `worker`, and `job` components. + + +```sql +SELECT +name, +bandwidth_allowance_gib, +cpu_type, +cpus, +deprecation_intent, +memory_bytes, +scalable, +single_instance_only, +slug, +tier_downgrade_to, +tier_slug, +tier_upgrade_to, +usd_per_month, +usd_per_second +FROM digitalocean.apps.tiers_instance_sizes +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md index 164c54a4b1..2e4b698e50 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - balances - billing - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a balances resource. ## Overview @@ -30,11 +30,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | Current balance of the customer's most recent billing activity. Does not reflect `month_to_date_usage`. | +| | `string` | Current balance of the customer's most recent billing activity. Does not reflect `month_to_date_usage`. | | | `string` | The time at which balances were most recently generated. | -| | `string` | Balance as of the `generated_at` time. This value includes the `account_balance` and `month_to_date_usage`. | +| | `string` | Balance as of the `generated_at` time. This value includes the `account_balance` and `month_to_date_usage`. | | | `string` | Amount used in the current billing period as of the `generated_at` time. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the balances on a customer's account, send a GET request to `/v2/customers/my/balance`. | + +## `SELECT` examples + +To retrieve the balances on a customer's account, send a GET request to `/v2/customers/my/balance`. + + +```sql +SELECT +account_balance, +generated_at, +month_to_date_balance, +month_to_date_usage +FROM digitalocean.billing.balances +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/billing_history/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/billing_history/index.md new file mode 100644 index 0000000000..f22398a530 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/billing/billing_history/index.md @@ -0,0 +1,60 @@ +--- +title: billing_history +hide_title: false +hide_table_of_contents: false +keywords: + - billing_history + - billing + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a billing_history resource. + +## Overview +
+ + + +
Namebilling_history
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Description of the billing history entry. | +| | `string` | Amount of the billing history entry. | +| | `string` | Time the billing history entry occurred. | +| | `string` | ID of the invoice associated with the billing history entry, if applicable. | +| | `string` | UUID of the invoice associated with the billing history entry, if applicable. | +| | `string` | Type of billing history entry. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of all billing history entries, send a GET request to `/v2/customers/my/billing_history`. | + +## `SELECT` examples + +To retrieve a list of all billing history entries, send a GET request to `/v2/customers/my/billing_history`. + + +```sql +SELECT +description, +amount, +date, +invoice_id, +invoice_uuid, +type +FROM digitalocean.billing.billing_history +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md deleted file mode 100644 index 83c362e8b5..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: history -hide_title: false -hide_table_of_contents: false -keywords: - - history - - billing - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namehistory
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | | -| | `object` | | -| | `object` | Information about the response itself. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/index.md index 24e0cf893a..ef8d9e4517 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/index.md @@ -9,42 +9,31 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Billing - +billing service documentation. + :::info Service Summary
total resources: 4
-total selectable resources: 4
-total methods: 7
::: -## Overview - - - - - - -
Namedigitalocean.billing
TypeService
TitleDigitalOcean API - Billing
DescriptionBilling
Idbilling:v23.04.00139
- ## Resources
balances
-history
+billing_history
invoices
-invoices_summary
-
+invoices_summaries
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md index bf08540ab8..96b9326ab5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - invoices - billing - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a invoices resource. ## Overview @@ -30,14 +30,44 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `object` | The invoice preview. | -| | `array` | | -| | `object` | | -| | `object` | Information about the response itself. | +| | `string` | Description of the invoice item. | +| | `string` | Billed amount of this invoice item. Billed in USD. | +| | `string` | Duration of time this invoice item was used and subsequently billed. | +| | `string` | Unit of time for duration. | +| | `string` | Time the invoice item stopped being billed for usage. | +| | `string` | Description of the invoice item when it is a grouped set of usage, such as DOKS or databases. | +| | `string` | Name of the product being billed in the invoice item. | +| | `string` | Name of the DigitalOcean Project this resource belongs to. | +| | `string` | ID of the resource billing in the invoice item if available. | +| | `string` | UUID of the resource billing in the invoice item if available. | +| | `string` | Time the invoice item began to be billed for usage. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the invoice items for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`. | -| | `SELECT` | | To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. | -| | `EXEC` | | To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`. | -| | `EXEC` | | To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`. | +| | `SELECT` | | To retrieve the invoice items for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`. | +| | `SELECT` | | To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. | +| | `EXEC` | | To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`. | +| | `EXEC` | | To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`. | + +## `SELECT` examples + +To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. + + +```sql +SELECT +description, +amount, +duration, +duration_unit, +end_time, +group_description, +product, +project_name, +resource_id, +resource_uuid, +start_time +FROM digitalocean.billing.invoices +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summaries/index.md similarity index 51% rename from docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md rename to docs/digitalocean-docs/providers/digitalocean/billing/invoices_summaries/index.md index 561005c879..19f0d061dd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summaries/index.md @@ -1,47 +1,72 @@ --- -title: invoices_summary +title: invoices_summaries hide_title: false hide_table_of_contents: false keywords: - - invoices_summary + - invoices_summaries - billing - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a invoices_summaries resource. ## Overview
- + - +
Nameinvoices_summary
Nameinvoices_summaries
TypeResource
Id
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview. | -| | `string` | Billing period of usage for which the invoice is issued, in `YYYY-MM` format. | +| | `string` | Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview. | +| | `string` | Billing period of usage for which the invoice is issued, in `YYYY-MM` format. | | | `object` | A summary of the credits and adjustments contributing to the invoice. | +| | `string` | ID of the invoice | | | `string` | UUID of the invoice | | | `object` | A summary of the overages contributing to the invoice. | -| | `object` | A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the `items` key. | +| | `object` | A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the `items` key. | | | `object` | A summary of the taxes contributing to the invoice. | | | `object` | The billing address of the customer being invoiced. | | | `string` | Company of the DigitalOcean customer being invoiced, if set. | | | `string` | Email of the DigitalOcean customer being invoiced. | | | `string` | Name of the DigitalOcean customer being invoiced. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. | + +## `SELECT` examples + +To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. + + +```sql +SELECT +amount, +billing_period, +credits_and_adjustments, +invoice_id, +invoice_uuid, +overages, +product_charges, +taxes, +user_billing_address, +user_company, +user_email, +user_name +FROM digitalocean.billing.invoices_summaries +WHERE invoice_uuid = '{{ invoice_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md index 709872d4cf..a25aafbb6c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md @@ -9,41 +9,30 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Block Storage - +block_storage service documentation. + :::info Service Summary
total resources: 3
-total selectable resources: 3
-total methods: 19
::: -## Overview - - - - - - -
Namedigitalocean.block_storage
TypeService
TitleDigitalOcean API - Block Storage
DescriptionBlock Storage
Idblock_storage:v23.04.00139
- ## Resources
-volume_actions
-volume_snapshots
-
-
volumes
+volumes_actions
+
+volumes_snapshots
+
\ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md deleted file mode 100644 index fac9c8b2f9..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: volume_actions -hide_title: false -hide_table_of_contents: false -keywords: - - volume_actions - - block_storage - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namevolume_actions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| | `integer` | A unique identifier for the resource that the action is associated with. | -| | `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. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| | `object` | | -| | `string` | A human-readable string that is used as a unique identifier for each region. | -| | `integer` | | -| | `string` | The type of resource that the action is associated with. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| | `string` | This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| -| | `SELECT` | | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| -| | `INSERT` | | To initiate an action on a block storage volume by Name, send a POST request to
`~/v2/volumes/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to five
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|
| -| | `EXEC` | | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| -| | `EXEC` | | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| -| | `EXEC` | | To initiate an action on a block storage volume by Id, send a POST request to
`~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to seven
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

## Resize a Volume

\| Attribute \| Details \|
\| -------------- \| ------------------------------------------------------------------- \|
\| type \| This must be `resize` \|
\| size_gigabytes \| The new size of the block storage volume in GiB (1024^3) \|
\| region \| Set to the slug representing the region where the volume is located \|

Volumes may only be resized upwards. The maximum size for a volume is 16TiB.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md deleted file mode 100644 index 96ca0aa4e5..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: volume_snapshots -hide_title: false -hide_table_of_contents: false -keywords: - - volume_snapshots - - block_storage - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namevolume_snapshots
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The unique identifier for the snapshot. | -| | `string` | A human-readable name for the snapshot. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | -| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | -| | `string` | The unique identifier for the resource that the snapshot originated from. | -| | `string` | The type of resource that the snapshot originated from. | -| | `number` | The billable size of the snapshot in gigabytes. | -| | `array` | An array of Tags the snapshot has been tagged with. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| -| | `SELECT` | | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| -| | `INSERT` | | To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. | -| | `DELETE` | | To delete a volume snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| | `EXEC` | | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| -| | `EXEC` | | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md index faaa09a871..5a75c68ae2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - volumes - block_storage - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a volumes resource. ## Overview @@ -30,23 +30,116 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The unique identifier for the block storage volume. | -| | `string` | A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. | -| | `string` | An optional free-form text field to describe a block storage volume. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the block storage volume was created. | -| | `array` | An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet. | -| | `string` | The label currently applied to the filesystem. | -| | `string` | The type of filesystem currently in-use on the volume. | -| | `object` | The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned. | -| | `integer` | The size of the block storage volume in GiB (1024^3). | -| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| -| | `SELECT` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| -| | `INSERT` | | To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. | -| | `DELETE` | | To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| -| | `DELETE` | | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| -| | `EXEC` | | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| -| | `EXEC` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| +| | `SELECT` | | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`. | +| | `SELECT` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. ## Filtering Results ### By Region The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` ### By Name It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. **Note:** You can only create one volume per region with the same name. ### By Name and Region It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. | +| | `INSERT` | | To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. | +| | `DELETE` | | To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `DELETE` | | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `SELECT` examples + +To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. ## Filtering Results ### By Region The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` ### By Name It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. **Note:** You can only create one volume per region with the same name. ### By Name and Region It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. + + +```sql +SELECT +column_anon +FROM digitalocean.block_storage.volumes +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new volumes resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.block_storage.volumes ( +data__name, +data__description, +data__size_gigabytes, +data__tags, +data__snapshot_id, +data__filesystem_type, +data__region, +data__filesystem_label +) +SELECT +'{{ name }}', +'{{ description }}', +'{{ size_gigabytes }}', +'{{ tags }}', +'{{ snapshot_id }}', +'{{ filesystem_type }}', +'{{ region }}', +'{{ filesystem_label }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.block_storage.volumes ( +data__name, +data__size_gigabytes, +data__region +) +SELECT +'{{ name }}', +'{{ size_gigabytes }}', +'{{ region }}' +; +``` + + + + +```yaml +- name: volumes + props: + - name: name + value: string + - name: description + value: string + - name: size_gigabytes + value: integer + - name: tags + value: array + - name: snapshot_id + value: string + - name: filesystem_type + value: string + - name: region + value: string + - name: filesystem_label + value: string + +``` + + + +## `DELETE` example + +Deletes the specified volumes resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.block_storage.volumes +WHERE = '{{ }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_actions/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_actions/index.md new file mode 100644 index 0000000000..96cb8ee1f5 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_actions/index.md @@ -0,0 +1,53 @@ +--- +title: volumes_actions +hide_title: false +hide_table_of_contents: false +keywords: + - volumes_actions + - block_storage + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a volumes_actions resource. + +## Overview +
+ + + +
Namevolumes_actions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. | +| | `EXEC` | | To initiate an action on a block storage volume by Name, send a POST request to `~/v2/volumes/actions`. The body should contain the appropriate attributes for the respective action. ## Attach a Block Storage Volume to a Droplet \| Attribute \| Details \| \| ----------- \| ------------------------------------------------------------------- \| \| type \| This must be `attach` \| \| volume_name \| The name of the block storage volume \| \| droplet_id \| Set to the Droplet's ID \| \| region \| Set to the slug representing the region where the volume is located \| Each volume may only be attached to a single Droplet. However, up to fifteen volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) is required. ## Remove a Block Storage Volume from a Droplet \| Attribute \| Details \| \| ----------- \| ------------------------------------------------------------------- \| \| type \| This must be `detach` \| \| volume_name \| The name of the block storage volume \| \| droplet_id \| Set to the Droplet's ID \| \| region \| Set to the slug representing the region where the volume is located \| | +| | `EXEC` | | To initiate an action on a block storage volume by Id, send a POST request to `~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate attributes for the respective action. ## Attach a Block Storage Volume to a Droplet \| Attribute \| Details \| \| ---------- \| ------------------------------------------------------------------- \| \| type \| This must be `attach` \| \| droplet_id \| Set to the Droplet's ID \| \| region \| Set to the slug representing the region where the volume is located \| Each volume may only be attached to a single Droplet. However, up to fifteen volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) is required. ## Remove a Block Storage Volume from a Droplet \| Attribute \| Details \| \| ---------- \| ------------------------------------------------------------------- \| \| type \| This must be `detach` \| \| droplet_id \| Set to the Droplet's ID \| \| region \| Set to the slug representing the region where the volume is located \| ## Resize a Volume \| Attribute \| Details \| \| -------------- \| ------------------------------------------------------------------- \| \| type \| This must be `resize` \| \| size_gigabytes \| The new size of the block storage volume in GiB (1024^3) \| \| region \| Set to the slug representing the region where the volume is located \| Volumes may only be resized upwards. The maximum size for a volume is 16TiB. | + +## `SELECT` examples + +To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. + + +```sql +SELECT +column_anon +FROM digitalocean.block_storage.volumes_actions +WHERE volume_id = '{{ volume_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_snapshots/index.md new file mode 100644 index 0000000000..64104ad5d3 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes_snapshots/index.md @@ -0,0 +1,124 @@ +--- +title: volumes_snapshots +hide_title: false +hide_table_of_contents: false +keywords: + - volumes_snapshots + - block_storage + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a volumes_snapshots resource. + +## Overview + + + + +
Namevolumes_snapshots
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. | +| | `SELECT` | | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. | +| | `INSERT` | | To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. | +| | `DELETE` | | To delete a volume snapshot, send a DELETE request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | + +## `SELECT` examples + +To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. + + +```sql +SELECT +column_anon +FROM digitalocean.block_storage.volumes_snapshots +WHERE volume_id = '{{ volume_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new volumes_snapshots resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.block_storage.volumes_snapshots ( +data__name, +data__tags, +volume_id +) +SELECT +'{{ name }}', +'{{ tags }}', +'{{ volume_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.block_storage.volumes_snapshots ( +data__name, +volume_id +) +SELECT +'{{ name }}', +'{{ volume_id }}' +; +``` + + + + +```yaml +- name: volumes_snapshots + props: + - name: volume_id + value: string + - name: data__name + value: string + - name: name + value: string + - name: tags + value: array + +``` + + + +## `DELETE` example + +Deletes the specified volumes_snapshots resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.block_storage.volumes_snapshots +WHERE snapshot_id = '{{ snapshot_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md b/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md index e099ded6b5..f38663f81c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - endpoints - cdn - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a endpoints resource. ## Overview @@ -30,21 +30,99 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a CDN endpoint. | -| | `string` | The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created. | -| | `string` | The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. | -| | `string` | The fully qualified domain name (FQDN) from which the CDN-backed content is served. | -| | `string` | The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space. | -| | `integer` | The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | -| | `SELECT` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | -| | `INSERT` | | To create a new CDN endpoint, send a POST request to `/v2/cdn/endpoints`. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the `ttl`
attribute.

A custom subdomain may be configured by specifying the `custom_domain` and
`certificate_id` attributes.
| -| | `DELETE` | | To delete a specific CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| | `EXEC` | | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | -| | `EXEC` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | -| | `EXEC` | | To purge cached content from a CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include
a `files` attribute containing a list of cached file paths to be purged. A
path may be for a single file or may contain a wildcard (`*`) to recursively
purge all files under a directory. When only a wildcard is provided, all
cached files will be purged. There is a rate limit of 50 files per 20 seconds
that can be purged.
| -| | `EXEC` | | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.
| +| | `SELECT` | | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | +| | `SELECT` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | +| | `INSERT` | | To create a new CDN endpoint, send a POST request to `/v2/cdn/endpoints`. The origin attribute must be set to the fully qualified domain name (FQDN) of a DigitalOcean Space. Optionally, the TTL may be configured by setting the `ttl` attribute. A custom subdomain may be configured by specifying the `custom_domain` and `certificate_id` attributes. | +| | `DELETE` | | To delete a specific CDN endpoint, send a DELETE request to `/v2/cdn/endpoints/$ENDPOINT_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To purge cached content from a CDN endpoint, send a DELETE request to `/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include a `files` attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (`*`) to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged. There is a rate limit of 50 files per 20 seconds that can be purged. CDN endpoints have a rate limit of 5 requests per 10 seconds. Purging files using a wildcard path counts as a single request against the API's rate limit. Two identical purge requests cannot be sent at the same time. | +| | `EXEC` | | To update the TTL, certificate ID, or the FQDN of the custom subdomain for an existing CDN endpoint, send a PUT request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | + +## `SELECT` examples + +To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. + + +```sql +SELECT +column_anon +FROM digitalocean.cdn.endpoints +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoints resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.cdn.endpoints ( +data__origin, +data__ttl, +data__certificate_id, +data__custom_domain +) +SELECT +'{{ origin }}', +'{{ ttl }}', +'{{ certificate_id }}', +'{{ custom_domain }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.cdn.endpoints ( +data__origin +) +SELECT +'{{ origin }}' +; +``` + + + + +```yaml +- name: endpoints + props: + - name: data__origin + value: string + - name: origin + value: string + - name: ttl + value: integer + - name: certificate_id + value: string + - name: custom_domain + value: string + +``` + + + +## `DELETE` example + +Deletes the specified endpoints resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.cdn.endpoints +WHERE cdn_id = '{{ cdn_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/cdn/index.md b/docs/digitalocean-docs/providers/digitalocean/cdn/index.md index de4d838737..8b58d4d548 100644 --- a/docs/digitalocean-docs/providers/digitalocean/cdn/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/cdn/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -CDN Endpoints - +cdn service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 8
::: -## Overview -
- - - - - -
Namedigitalocean.cdn
TypeService
TitleDigitalOcean API - Cdn
DescriptionCDN Endpoints
Idcdn:v23.04.00139
- ## Resources
-endpoints
+endpoints
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md b/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md index 74f0505911..58db122f33 100644 --- a/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - certificates - certificates - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a certificates resource. ## Overview @@ -38,12 +38,97 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | A unique identifier generated from the SHA-1 fingerprint of the certificate. | | | `string` | A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`. | | | `string` | A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | -| | `SELECT` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | -| | `INSERT` | | To upload new SSL certificate which you have previously generated, send a POST
request to `/v2/certificates`.

When uploading a user-generated certificate, the `private_key`,
`leaf_certificate`, and optionally the `certificate_chain` attributes should
be provided. The type must be set to `custom`.

When using Let's Encrypt to create a certificate, the `dns_names` attribute
must be provided, and the type must be set to `lets_encrypt`.
| -| | `DELETE` | | To delete a specific certificate, send a DELETE request to
`/v2/certificates/$CERTIFICATE_ID`.
| -| | `EXEC` | | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | -| | `EXEC` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | +| | `SELECT` | | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | +| | `SELECT` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | +| | `INSERT` | | To upload new SSL certificate which you have previously generated, send a POST request to `/v2/certificates`. When uploading a user-generated certificate, the `private_key`, `leaf_certificate`, and optionally the `certificate_chain` attributes should be provided. The type must be set to `custom`. When using Let's Encrypt to create a certificate, the `dns_names` attribute must be provided, and the type must be set to `lets_encrypt`. | +| | `DELETE` | | To delete a specific certificate, send a DELETE request to `/v2/certificates/$CERTIFICATE_ID`. | + +## `SELECT` examples + +To list all of the certificates available on your account, send a GET request to `/v2/certificates`. + + +```sql +SELECT +id, +name, +created_at, +dns_names, +not_after, +sha1_fingerprint, +state, +type +FROM digitalocean.certificates.certificates +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificates resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.certificates.certificates ( +data__name, +data__type, +data__dns_names +) +SELECT +'{{ name }}', +'{{ type }}', +'{{ dns_names }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.certificates.certificates ( +data__dns_names +) +SELECT +'{{ dns_names }}' +; +``` + + + + +```yaml +- name: certificates + props: + - name: name + value: string + - name: type + value: string + - name: dns_names + value: array + +``` + + + +## `DELETE` example + +Deletes the specified certificates resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.certificates.certificates +WHERE certificate_id = '{{ certificate_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/certificates/index.md b/docs/digitalocean-docs/providers/digitalocean/certificates/index.md index 5355069fad..2d8c6fbaf2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/certificates/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/certificates/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Certificates - +certificates service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 6
::: -## Overview -
- - - - - -
Namedigitalocean.certificates
TypeService
TitleDigitalOcean API - Certificates
DescriptionCertificates
Idcertificates:v23.04.00139
- ## Resources
-certificates
+certificates
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md deleted file mode 100644 index f5a52c21c8..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: container_registry -hide_title: false -hide_table_of_contents: false -keywords: - - container_registry - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecontainer_registry
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the registry was created. | -| | `string` | Slug of the region where registry data is stored | -| | `integer` | The amount of storage used in the registry in bytes. | -| | `string` | The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. | -| | `object` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get information about your container registry, send a GET request to `/v2/registry`. | -| | `INSERT` | | To create your container registry, send a POST request to `/v2/registry`.

The `name` becomes part of the URL for images stored in the registry. For
example, if your registry is called `example`, an image in it will have the
URL `registry.digitalocean.com/example/image:tag`.
| -| | `DELETE` | | To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. | -| | `EXEC` | | To get information about your container registry, send a GET request to `/v2/registry`. | -| | `EXEC` | | To validate that a container registry name is available for use, send a POST
request to `/v2/registry/validate-name`.

If the name is both formatted correctly and available, the response code will
be 204 and contain no body. If the name is already in use, the response will
be a 409 Conflict.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md deleted file mode 100644 index 17c84b76b6..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: digests -hide_title: false -hide_table_of_contents: false -keywords: - - digests - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedigests
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | All blobs associated with this manifest | -| | `integer` | The compressed size of the manifest in bytes. | -| | `string` | The manifest digest | -| | `string` | The name of the container registry. | -| | `string` | The name of the repository. | -| | `integer` | The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available). | -| | `array` | All tags associated with this manifest | -| | `string` | The time the manifest was last updated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| -| | `DELETE` | | To delete a container repository manifest by digest, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md deleted file mode 100644 index d0534b6fbf..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: docker_credentials -hide_title: false -hide_table_of_contents: false -keywords: - - docker_credentials - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedocker_credentials
TypeResource
Id
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md deleted file mode 100644 index 887e327bf1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: garbage_collection -hide_title: false -hide_table_of_contents: false -keywords: - - garbage_collection - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namegarbage_collection
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The number of blobs deleted as a result of this garbage collection. | -| | `string` | The time the garbage collection was created. | -| | `integer` | The number of bytes freed as a result of this garbage collection. | -| | `string` | The name of the container registry. | -| | `string` | The current status of this garbage collection. | -| | `string` | The time the garbage collection was last updated. | -| | `string` | A string specifying the UUID of the garbage collection. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | -| | `EXEC` | | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | -| | `EXEC` | | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | -| | `EXEC` | | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | -| | `EXEC` | | Garbage collection enables users to clear out unreferenced blobs (layer &
manifest data) after deleting one or more manifests from a repository. If
there are no unreferenced blobs resulting from the deletion of one or more
manifests, garbage collection is effectively a noop.
[See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/)
about how and why you should clean up your container registry periodically.

To request a garbage collection run on your registry, send a POST request to
`/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the
following sequence of events on your registry.

* Set the registry to read-only mode, meaning no further write-scoped
JWTs will be issued to registry clients. Existing write-scoped JWTs will
continue to work until they expire which can take up to 15 minutes.
* Wait until all existing write-scoped JWTs have expired.
* Scan all registry manifests to determine which blobs are unreferenced.
* Delete all unreferenced blobs from the registry.
* Record the number of blobs deleted and bytes freed, mark the garbage
collection status as `success`.
* Remove the read-only mode restriction from the registry, meaning write-scoped
JWTs will once again be issued to registry clients.
| -| | `EXEC` | | To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md index 995b15b351..217a4718cf 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md @@ -9,47 +9,36 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Container Registry - +container_registry service documentation. + :::info Service Summary
total resources: 9
-total selectable resources: 9
-total methods: 27
::: -## Overview - - - - - - -
Namedigitalocean.container_registry
TypeService
TitleDigitalOcean API - Container Registry
DescriptionContainer Registry
Idcontainer_registry:v23.04.00139
- ## Resources
-container_registry
-digests
-docker_credentials
-garbage_collection
-options
+registries
+registry_docker_credentials
+registry_garbage_collections
+registry_options
+registry_repositories
-repositories
-repositories_v2
-subscription
-tags
-
+registry_repositories_digests
+registry_repositories_tags
+registry_repositories_v2
+registry_subscriptions
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md deleted file mode 100644 index 0d33e7df1d..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: options -hide_title: false -hide_table_of_contents: false -keywords: - - options - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameoptions
TypeResource
Id
- -## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `array` | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registries/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registries/index.md new file mode 100644 index 0000000000..13ab02f66a --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registries/index.md @@ -0,0 +1,126 @@ +--- +title: registries +hide_title: false +hide_table_of_contents: false +keywords: + - registries + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registries resource. + +## Overview + + + + +
Nameregistries
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get information about your container registry, send a GET request to `/v2/registry`. | +| | `INSERT` | | To create your container registry, send a POST request to `/v2/registry`. The `name` becomes part of the URL for images stored in the registry. For example, if your registry is called `example`, an image in it will have the URL `registry.digitalocean.com/example/image:tag`. | +| | `DELETE` | | To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. | +| | `EXEC` | | To validate that a container registry name is available for use, send a POST request to `/v2/registry/validate-name`. If the name is both formatted correctly and available, the response code will be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict. | + +## `SELECT` examples + +To get information about your container registry, send a GET request to `/v2/registry`. + + +```sql +SELECT +column_anon +FROM digitalocean.container_registry.registries +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registries resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.container_registry.registries ( +data__name, +data__subscription_tier_slug, +data__region +) +SELECT +'{{ name }}', +'{{ subscription_tier_slug }}', +'{{ region }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.container_registry.registries ( +data__name, +data__subscription_tier_slug +) +SELECT +'{{ name }}', +'{{ subscription_tier_slug }}' +; +``` + + + + +```yaml +- name: registries + props: + - name: data__name + value: string + - name: data__subscription_tier_slug + value: string + - name: name + value: string + - name: subscription_tier_slug + value: string + - name: region + value: string + +``` + + + +## `DELETE` example + +Deletes the specified registries resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.container_registry.registries +WHERE = '{{ }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_docker_credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_docker_credentials/index.md new file mode 100644 index 0000000000..110f006e86 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_docker_credentials/index.md @@ -0,0 +1,50 @@ +--- +title: registry_docker_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - registry_docker_credentials + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_docker_credentials resource. + +## Overview + + + + +
Nameregistry_docker_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | In order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication. The necessary JSON configuration can be retrieved by sending a GET request to `/v2/registry/docker-credentials`. The response will be in the format of a Docker `config.json` file. To use the config in your Kubernetes cluster, create a Secret with: kubectl create secret generic docr \ --from-file=.dockerconfigjson=config.json \ --type=kubernetes.io/dockerconfigjson By default, the returned credentials have read-only access to your registry and cannot be used to push images. This is appropriate for most Kubernetes clusters. To retrieve read/write credentials, suitable for use with the Docker client or in a CI system, read_write may be provided as query parameter. For example: `/v2/registry/docker-credentials?read_write=true` By default, the returned credentials will not expire. To retrieve credentials with an expiry set, expiry_seconds may be provided as a query parameter. For example: `/v2/registry/docker-credentials?expiry_seconds=3600` will return credentials that expire after one hour. | + +## `SELECT` examples + +In order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication. The necessary JSON configuration can be retrieved by sending a GET request to `/v2/registry/docker-credentials`. The response will be in the format of a Docker `config.json` file. To use the config in your Kubernetes cluster, create a Secret with: kubectl create secret generic docr \ --from-file=.dockerconfigjson=config.json \ --type=kubernetes.io/dockerconfigjson By default, the returned credentials have read-only access to your registry and cannot be used to push images. This is appropriate for most Kubernetes clusters. To retrieve read/write credentials, suitable for use with the Docker client or in a CI system, read_write may be provided as query parameter. For example: `/v2/registry/docker-credentials?read_write=true` By default, the returned credentials will not expire. To retrieve credentials with an expiry set, expiry_seconds may be provided as a query parameter. For example: `/v2/registry/docker-credentials?expiry_seconds=3600` will return credentials that expire after one hour. + + +```sql +SELECT +registry.digitalocean.com +FROM digitalocean.container_registry.registry_docker_credentials +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_garbage_collections/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_garbage_collections/index.md new file mode 100644 index 0000000000..716fe78069 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_garbage_collections/index.md @@ -0,0 +1,65 @@ +--- +title: registry_garbage_collections +hide_title: false +hide_table_of_contents: false +keywords: + - registry_garbage_collections + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_garbage_collections resource. + +## Overview + + + + +
Nameregistry_garbage_collections
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `integer` | The number of blobs deleted as a result of this garbage collection. | +| | `string` | The time the garbage collection was created. | +| | `integer` | The number of bytes freed as a result of this garbage collection. | +| | `string` | The name of the container registry. | +| | `string` | The current status of this garbage collection. | +| | `string` | The time the garbage collection was last updated. | +| | `string` | A string specifying the UUID of the garbage collection. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | +| | `EXEC` | | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | +| | `EXEC` | | Garbage collection enables users to clear out unreferenced blobs (layer & manifest data) after deleting one or more manifests from a repository. If there are no unreferenced blobs resulting from the deletion of one or more manifests, garbage collection is effectively a noop. [See here for more information](https://docs.digitalocean.com/products/container-registry/how-to/clean-up-container-registry/) about how and why you should clean up your container registry periodically. To request a garbage collection run on your registry, send a POST request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the following sequence of events on your registry. * Set the registry to read-only mode, meaning no further write-scoped JWTs will be issued to registry clients. Existing write-scoped JWTs will continue to work until they expire which can take up to 15 minutes. * Wait until all existing write-scoped JWTs have expired. * Scan all registry manifests to determine which blobs are unreferenced. * Delete all unreferenced blobs from the registry. * Record the number of blobs deleted and bytes freed, mark the garbage collection status as `success`. * Remove the read-only mode restriction from the registry, meaning write-scoped JWTs will once again be issued to registry clients. | +| | `EXEC` | | To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. | + +## `SELECT` examples + +To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. + + +```sql +SELECT +blobs_deleted, +created_at, +freed_bytes, +registry_name, +status, +updated_at, +uuid +FROM digitalocean.container_registry.registry_garbage_collections +WHERE registry_name = '{{ registry_name }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_options/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_options/index.md new file mode 100644 index 0000000000..f3af039c56 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_options/index.md @@ -0,0 +1,52 @@ +--- +title: registry_options +hide_title: false +hide_table_of_contents: false +keywords: + - registry_options + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_options resource. + +## Overview + + + + +
Nameregistry_options
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | | +| | `array` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This endpoint serves to provide additional information as to which option values are available when creating a container registry. There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. There are multiple regions available for container registry and controls where your data is stored. To list the available options, send a GET request to `/v2/registry/options`. | + +## `SELECT` examples + +This endpoint serves to provide additional information as to which option values are available when creating a container registry. There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. There are multiple regions available for container registry and controls where your data is stored. To list the available options, send a GET request to `/v2/registry/options`. + + +```sql +SELECT +available_regions, +subscription_tiers +FROM digitalocean.container_registry.registry_options +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories/index.md new file mode 100644 index 0000000000..d1ed5eae41 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories/index.md @@ -0,0 +1,56 @@ +--- +title: registry_repositories +hide_title: false +hide_table_of_contents: false +keywords: + - registry_repositories + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_repositories resource. + +## Overview + + + + +
Nameregistry_repositories
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the repository. | +| | `object` | | +| | `string` | The name of the container registry. | +| | `integer` | The number of tags in the repository. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories`. | + +## `SELECT` examples + +This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories`. + + +```sql +SELECT +name, +latest_tag, +registry_name, +tag_count +FROM digitalocean.container_registry.registry_repositories +WHERE registry_name = '{{ registry_name }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_digests/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_digests/index.md new file mode 100644 index 0000000000..84eda320a6 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_digests/index.md @@ -0,0 +1,77 @@ +--- +title: registry_repositories_digests +hide_title: false +hide_table_of_contents: false +keywords: + - registry_repositories_digests + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_repositories_digests resource. + +## Overview + + + + +
Nameregistry_repositories_digests
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | All blobs associated with this manifest | +| | `integer` | The compressed size of the manifest in bytes. | +| | `string` | The manifest digest | +| | `string` | The name of the container registry. | +| | `string` | The name of the repository. | +| | `integer` | The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available). | +| | `array` | All tags associated with this manifest | +| | `string` | The time the manifest was last updated. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all manifests in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to list manifests for `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/digests`. | +| | `DELETE` | | To delete a container repository manifest by digest, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to delete `registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be `/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | + +## `SELECT` examples + +To list all manifests in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to list manifests for `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/digests`. + + +```sql +SELECT +blobs, +compressed_size_bytes, +digest, +registry_name, +repository, +size_bytes, +tags, +updated_at +FROM digitalocean.container_registry.registry_repositories_digests +WHERE registry_name = '{{ registry_name }}' +AND repository_name = '{{ repository_name }}'; +``` +## `DELETE` example + +Deletes the specified registry_repositories_digests resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.container_registry.registry_repositories_digests +WHERE manifest_digest = '{{ manifest_digest }}' +AND registry_name = '{{ registry_name }}' +AND repository_name = '{{ repository_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_tags/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_tags/index.md new file mode 100644 index 0000000000..f776a036bc --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_tags/index.md @@ -0,0 +1,75 @@ +--- +title: registry_repositories_tags +hide_title: false +hide_table_of_contents: false +keywords: + - registry_repositories_tags + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_repositories_tags resource. + +## Overview + + + + +
Nameregistry_repositories_tags
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `integer` | The compressed size of the tag in bytes. | +| | `string` | The digest of the manifest associated with the tag. | +| | `string` | The name of the container registry. | +| | `string` | The name of the repository. | +| | `integer` | The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). | +| | `string` | The name of the tag. | +| | `string` | The time the tag was last updated. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all tags in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to list tags for `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/tags`. | +| | `DELETE` | | To delete a container repository tag, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to delete `registry.digitalocean.com/example/my/repo:mytag`, the path would be `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | + +## `SELECT` examples + +To list all tags in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. Note that if your repository name contains `/` characters, it must be URL-encoded in the request URL. For example, to list tags for `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/tags`. + + +```sql +SELECT +compressed_size_bytes, +manifest_digest, +registry_name, +repository, +size_bytes, +tag, +updated_at +FROM digitalocean.container_registry.registry_repositories_tags +WHERE registry_name = '{{ registry_name }}' +AND repository_name = '{{ repository_name }}'; +``` +## `DELETE` example + +Deletes the specified registry_repositories_tags resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.container_registry.registry_repositories_tags +WHERE registry_name = '{{ registry_name }}' +AND repository_name = '{{ repository_name }}' +AND repository_tag = '{{ repository_tag }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_v2/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_v2/index.md new file mode 100644 index 0000000000..7fe425b24f --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_repositories_v2/index.md @@ -0,0 +1,58 @@ +--- +title: registry_repositories_v2 +hide_title: false +hide_table_of_contents: false +keywords: + - registry_repositories_v2 + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_repositories_v2 resource. + +## Overview + + + + +
Nameregistry_repositories_v2
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the repository. | +| | `object` | | +| | `integer` | The number of manifests in the repository. | +| | `string` | The name of the container registry. | +| | `integer` | The number of tags in the repository. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. | + +## `SELECT` examples + +To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. + + +```sql +SELECT +name, +latest_manifest, +manifest_count, +registry_name, +tag_count +FROM digitalocean.container_registry.registry_repositories_v2 +WHERE registry_name = '{{ registry_name }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_subscriptions/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_subscriptions/index.md new file mode 100644 index 0000000000..6f75909a59 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/registry_subscriptions/index.md @@ -0,0 +1,63 @@ +--- +title: registry_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - registry_subscriptions + - container_registry + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registry_subscriptions resource. + +## Overview + + + + +
Nameregistry_subscriptions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | +| | `UPDATE` | | After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. | + +## `SELECT` examples + +A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. + + +```sql +SELECT +column_anon +FROM digitalocean.container_registry.registry_subscriptions +; +``` +## `UPDATE` example + +Updates a registry_subscriptions resource. + +```sql +/*+ update */ +UPDATE digitalocean.container_registry.registry_subscriptions +SET +tier_slug = '{{ tier_slug }}' +WHERE +; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md deleted file mode 100644 index 2f1acc428c..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: repositories -hide_title: false -hide_table_of_contents: false -keywords: - - repositories - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepositories
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the repository. | -| | `object` | | -| | `string` | The name of the container registry. | -| | `integer` | The number of tags in the repository. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md deleted file mode 100644 index e0dbe33505..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: repositories_v2 -hide_title: false -hide_table_of_contents: false -keywords: - - repositories_v2 - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepositories_v2
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the repository. | -| | `object` | | -| | `integer` | The number of manifests in the repository. | -| | `string` | The name of the container registry. | -| | `integer` | The number of tags in the repository. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md deleted file mode 100644 index d0cd135898..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: subscription -hide_title: false -hide_table_of_contents: false -keywords: - - subscription - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namesubscription
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time at which the subscription was created. | -| | `object` | | -| | `string` | The time at which the subscription was last updated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | -| | `EXEC` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | -| | `EXEC` | | After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md deleted file mode 100644 index fd4ecd82b7..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: tags -hide_title: false -hide_table_of_contents: false -keywords: - - tags - - container_registry - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nametags
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The compressed size of the tag in bytes. | -| | `string` | The digest of the manifest associated with the tag. | -| | `string` | The name of the container registry. | -| | `string` | The name of the repository. | -| | `integer` | The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). | -| | `string` | The name of the tag. | -| | `string` | The time the tag was last updated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| -| | `DELETE` | | To delete a container repository tag, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo:mytag`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags/mytag`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md index a8c8afb1f4..8f476a1c8b 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - backups - databases - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a backups resource. ## Overview @@ -32,8 +32,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; |:-----|:---------|:------------| | | `string` | A time value given in ISO8601 combined date and time format at which the backup was created. | | | `number` | The size of the database backup in GBs. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`. **Note**: Backups are not supported for Redis clusters. The result will be a JSON object with a `backups key`. This will be set to an array of backup objects, each of which will contain the size of the backup and the timestamp at which it was created. | + +## `SELECT` examples + +To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`. **Note**: Backups are not supported for Redis clusters. The result will be a JSON object with a `backups key`. This will be set to an array of backup objects, each of which will contain the size of the backup and the timestamp at which it was created. + + +```sql +SELECT +created_at, +size_gigabytes +FROM digitalocean.databases.backups +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md deleted file mode 100644 index a6086215ae..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ca -hide_title: false -hide_table_of_contents: false -keywords: - - ca - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview -
- - - -
Nameca
TypeResource
Id
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/cas/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/cas/index.md new file mode 100644 index 0000000000..8c4b5f5b2a --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/cas/index.md @@ -0,0 +1,50 @@ +--- +title: cas +hide_title: false +hide_table_of_contents: false +keywords: + - cas + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a cas resource. + +## Overview + + + + +
Namecas
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | base64 encoding of the certificate used to secure database connections | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the public certificate used to secure the connection to the database cluster send a GET request to `/v2/databases/$DATABASE_ID/ca`. The response will be a JSON object with a `ca` key. This will be set to an object containing the base64 encoding of the public key certificate. | + +## `SELECT` examples + +To retrieve the public certificate used to secure the connection to the database cluster send a GET request to `/v2/databases/$DATABASE_ID/ca`. The response will be a JSON object with a `ca` key. This will be set to an object containing the base64 encoding of the public key certificate. + + +```sql +SELECT +certificate +FROM digitalocean.databases.cas +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md deleted file mode 100644 index a154e24f25..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: clusters -hide_title: false -hide_table_of_contents: false -keywords: - - clusters - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameclusters
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a database cluster. | -| | `string` | A unique, human-readable name referring to a database cluster. | -| | `object` | | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | -| | `array` | An array of strings containing the names of databases created in the database cluster. | -| | `string` | A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, and "mongodb" for MongoDB. | -| | `object` | | -| | `integer` | The number of nodes in the database cluster. | -| | `object` | | -| | `string` | A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. | -| | `string` | The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. | -| | `string` | The slug identifier for the region where the database cluster is located. | -| | `array` | | -| | `string` | The slug identifier representing the size of the nodes in the database cluster. | -| | `string` | A string representing the current status of the database cluster. | -| | `array` | An array of tags that have been applied to the database cluster. | -| | `array` | | -| | `string` | A string representing the version of the database engine in use for the cluster. | -| | `string` | A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. | -| | `string` | A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | -| | `SELECT` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | -| | `INSERT` | | To create a database cluster, send a POST request to `/v2/databases`.
The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster.
DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel.
Note: Backups are not supported for Redis clusters. | -| | `EXEC` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | -| | `EXEC` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | -| | `EXEC` | | To destroy a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID`.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | -| | `EXEC` | | To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`.
The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. | -| | `EXEC` | | To resize a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/resize`. The body of the request must specify both the size and num_nodes attributes.
A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed. | -| | `EXEC` | | To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. | -| | `EXEC` | | To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/maintenance`.
A successful request will receive a 204 No Content status code with no body in response. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md deleted file mode 100644 index bbc2635bc1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: config -hide_title: false -hide_table_of_contents: false -keywords: - - config - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameconfig
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size). | -| | `integer` | Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples. | -| | `integer` | Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. | -| | `integer` | Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start. | -| | `integer` | Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute. | -| | `integer` | Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds. | -| | `integer` | Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used. | -| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size). | -| | `integer` | Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples. | -| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | -| | `integer` | The minute of the backup hour when backup for the service starts. New backup only starts if previous backup has already completed. | -| | `integer` | Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms. | -| | `integer` | The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. | -| | `integer` | The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100. | -| | `number` | The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. | -| | `number` | The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. | -| | `integer` | The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake. | -| | `integer` | The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. | -| | `string` | Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or 'SYSTEM' to use the MySQL server default. | -| | `string` | Specifies the default TOAST compression method for values of compressible columns (the default is lz4). | -| | `integer` | The maximum permitted result length, in bytes, for the GROUP_CONCAT() function. | -| | `integer` | Time out sessions with open transactions after this number of milliseconds | -| | `integer` | The time, in seconds, before cached statistics expire. | -| | `integer` | The minimum length of words that an InnoDB FULLTEXT index stores. | -| | `string` | The InnoDB FULLTEXT index stopword list for all InnoDB tables. | -| | `integer` | The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up. | -| | `integer` | The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk. | -| | `integer` | The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables. | -| | `boolean` | When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default. | -| | `boolean` | When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction. | -| | `integer` | The time, in seconds, the server waits for activity on an interactive. connection before closing it. | -| | `string` | The storage engine for in-memory internal temporary tables. | -| | `boolean` | Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT). | -| | `integer` | Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions. | -| | `string` | Controls the amount of detail written in the server log for each message that is logged. | -| | `string` | Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. | -| | `integer` | Log statements that take more than this number of milliseconds to run. If -1, disables. | -| | `number` | The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds. | -| | `integer` | The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M). | -| | `integer` | PostgreSQL maximum number of files that can be open per process. | -| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M) | -| | `integer` | PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value. | -| | `integer` | PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). | -| | `integer` | Sets the maximum number of workers that the system can support for parallel queries. | -| | `integer` | Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. | -| | `integer` | PostgreSQL maximum predicate locks per transaction. | -| | `integer` | PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value. | -| | `integer` | PostgreSQL maximum replication slots. | -| | `integer` | Maximum depth of the stack in bytes. | -| | `integer` | Max standby archive delay in milliseconds. | -| | `integer` | Max standby streaming delay in milliseconds. | -| | `integer` | PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value. | -| | `integer` | Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value. | -| | `integer` | The time, in seconds, to wait for more data from an existing connection. aborting the read. | -| | `integer` | The number of seconds to wait for a block to be written to a connection before aborting the write. | -| | `integer` | Sets the time interval to run pg_partman's scheduled tasks. | -| | `string` | Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters. | -| | `string` | Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. | -| | `object` | PGBouncer connection pooling settings | -| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | -| | `integer` | The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed. | -| | `string` | Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default. | -| | `integer` | Redis IO thread count | -| | `integer` | LFU maxmemory-policy counter decay time in minutes | -| | `integer` | Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies | -| | `string` | A string specifying the desired eviction policy for the Redis cluster.

- `noeviction`: Don't evict any data, returns error when memory limit is reached.
- `allkeys_lru:` Evict any key, least recently used (LRU) first.
- `allkeys_random`: Evict keys in a random order.
- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.
- `volatile_random`: Evict keys with expiration only in a random order.
- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. | -| | `string` | Set notify-keyspace-events option | -| | `integer` | Set number of redis databases. Changing this will cause a restart of redis service. | -| | `string` | When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. | -| | `integer` | Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. | -| | `boolean` | Require SSL to access Redis | -| | `integer` | Redis idle connection timeout in seconds | -| | `number` | Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. | -| | `boolean` | When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false. | -| | `integer` | The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K). | -| | `string` | Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas. | -| | `boolean` | Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them. | -| | `boolean` | Enable the pg_stat_monitor extension. <b>Enabling this extension will cause the cluster to be restarted.</b> When this extension is enabled, pg_stat_statements results for utility commands are unreliable. | -| | `string` | Synchronous replication type. Note that the service plan also needs to support synchronous replication. | -| | `integer` | PostgreSQL temporary file limit in KiB. If -1, sets to unlimited. | -| | `object` | TimescaleDB extension configuration values | -| | `string` | PostgreSQL service timezone | -| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M). | -| | `integer` | Specifies the number of bytes reserved to track the currently executing command for each active session. | -| | `string` | Record commit time of transactions. | -| | `string` | Enables tracking of function call counts and time used. | -| | `string` | Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. | -| | `integer` | The number of seconds the server waits for activity on a noninteractive connection before closing it. | -| | `integer` | Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000. | -| | `integer` | WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance | -| | `integer` | The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| -| | `EXEC` | | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| -| | `EXEC` | | To update the configuration for an existing database cluster, send a PATCH request to
`/v2/databases/$DATABASE_ID/config`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/configs/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/configs/index.md new file mode 100644 index 0000000000..454c602f8d --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/configs/index.md @@ -0,0 +1,421 @@ +--- +title: configs +hide_title: false +hide_table_of_contents: false +keywords: + - configs + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a configs resource. + +## Overview + + + + +
Nameconfigs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed. | +| | `boolean` | Specifices whether to allow automatic creation of indices. | +| | `boolean` | Specifies whether to require explicit index names when deleting indices. | +| | `boolean` | Enable auto creation of topics | +| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size). | +| | `integer` | Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples. | +| | `integer` | Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. | +| | `integer` | Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start. | +| | `integer` | Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute. | +| | `integer` | Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds. | +| | `integer` | Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used. | +| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size). | +| | `integer` | Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples. | +| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | The minute of the backup hour when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms. | +| | `integer` | The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. | +| | `integer` | The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100. | +| | `number` | The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. | +| | `number` | The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. | +| | `integer` | Maximum number of shards allowed per data node. | +| | `integer` | Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node . | +| | `string` | Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. | +| | `integer` | The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake. | +| | `integer` | Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. | +| | `integer` | The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. | +| | `string` | Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). | +| | `integer` | Replication factor for autocreated topics | +| | `string` | Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or 'SYSTEM' to use the MySQL server default. | +| | `string` | Specifies the default TOAST compression method for values of compressible columns (the default is lz4). | +| | `string` | Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. Setting to `0` will request no acknowledgement of the write operation. Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). | +| | `boolean` | Specifies whether to allow security audit logging. | +| | `integer` | The maximum permitted result length, in bytes, for the GROUP_CONCAT() function. | +| | `integer` | The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. | +| | `integer` | The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. | +| | `integer` | The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. | +| | `integer` | Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. | +| | `integer` | Maximum size of allowed headers, in bytes. | +| | `integer` | Maximum length of an HTTP URL, in bytes. | +| | `integer` | Time out sessions with open transactions after this number of milliseconds | +| | `integer` | Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations. | +| | `integer` | Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. | +| | `integer` | Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded. | +| | `integer` | Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. | +| | `integer` | Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. | +| | `integer` | Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. | +| | `integer` | Maximum number of file chunks sent in parallel for each recovery. | +| | `integer` | Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). | +| | `integer` | The time, in seconds, before cached statistics expire. | +| | `integer` | Specifies the maximum size of the InnoDB change buffer as a percentage of the buffer pool. | +| | `integer` | Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent. - 0 — disables this functionality, dirty pages in the same extent are not flushed. - 1 — flushes contiguous dirty pages in the same extent. - 2 — flushes dirty pages in the same extent. | +| | `integer` | The minimum length of words that an InnoDB FULLTEXT index stores. | +| | `string` | The InnoDB FULLTEXT index stopword list for all InnoDB tables. | +| | `integer` | The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up. | +| | `integer` | The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk. | +| | `integer` | The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables. | +| | `boolean` | When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default. | +| | `integer` | The number of I/O threads for read operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service. | +| | `boolean` | When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction. | +| | `integer` | Defines the maximum number of threads permitted inside of InnoDB. A value of 0 (the default) is interpreted as infinite concurrency (no limit). This variable is intended for performance tuning on high concurrency systems. | +| | `integer` | The number of I/O threads for write operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service. | +| | `integer` | The time, in seconds, the server waits for activity on an interactive. connection before closing it. | +| | `string` | The storage engine for in-memory internal temporary tables. | +| | `boolean` | Specifies whether ISM is enabled or not. | +| | `boolean` | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. | +| | `integer` | Maximum age before rolling over the audit history index, in hours. | +| | `integer` | Maximum number of documents before rolling over the audit history index. | +| | `integer` | The time between rollover checks for the audit history index, in hours. | +| | `integer` | Length of time long audit history indices are kept, in days. | +| | `boolean` | Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT). | +| | `integer` | Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions. | +| | `integer` | How long are delete records retained? | +| | `integer` | The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted | +| | `number` | Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner, instead of setting a very high value for this option. | +| | `integer` | The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. | +| | `string` | The default cleanup policy for segments beyond the retention window | +| | `string` | Controls the amount of detail written in the server log for each message that is logged. | +| | `integer` | The number of messages accumulated on a log partition before messages are flushed to disk | +| | `integer` | The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used | +| | `integer` | The interval with which Kafka adds an entry to the offset index | +| | `integer` | The maximum size in bytes of the offset index | +| | `string` | Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. | +| | `boolean` | This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. | +| | `integer` | The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message | +| | `string` | Define whether the timestamp in the message is message create time or log append time. | +| | `integer` | Log statements that take more than this number of milliseconds to run. If -1, disables. | +| | `boolean` | Controls whether to preallocate a file when creating a new segment | +| | `integer` | The maximum size of the log before deleting messages | +| | `integer` | The number of hours to keep a log file before deleting it | +| | `integer` | The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. | +| | `integer` | The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used | +| | `integer` | The maximum time before a new log segment is rolled out (in milliseconds). | +| | `integer` | The maximum size of a single log file | +| | `integer` | The amount of time to wait before deleting a file from the filesystem | +| | `number` | The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds. | +| | `integer` | The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M). | +| | `integer` | The maximum number of connections allowed from each ip address (defaults to 2147483647). | +| | `integer` | Number of seconds of master unavailability before triggering database failover to standby. The default value is 60. | +| | `integer` | PostgreSQL maximum number of files that can be open per process. | +| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M) | +| | `integer` | The maximum number of incremental fetch sessions that the broker will maintain. | +| | `integer` | PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). | +| | `integer` | Sets the maximum number of workers that the system can support for parallel queries. | +| | `integer` | Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. | +| | `integer` | PostgreSQL maximum predicate locks per transaction. | +| | `integer` | PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | PostgreSQL maximum replication slots. | +| | `integer` | Maximum depth of the stack in bytes. | +| | `integer` | Max standby archive delay in milliseconds. | +| | `integer` | Max standby streaming delay in milliseconds. | +| | `integer` | PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | The maximum size of message that the server can receive. | +| | `integer` | When a producer sets acks to 'all' (or '-1'), min_insync_replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. | +| | `integer` | Start sizes of connection buffer and result buffer, must be multiple of 1024. Changing this parameter will lead to a restart of the MySQL service. | +| | `integer` | The time, in seconds, to wait for more data from an existing connection. aborting the read. | +| | `integer` | The number of seconds to wait for a block to be written to a connection before aborting the write. | +| | `integer` | Number of partitions for autocreated topics | +| | `integer` | Log retention window in minutes for offsets topic | +| | `boolean` | Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. | +| | `integer` | Sets the time interval to run pg_partman's scheduled tasks. | +| | `string` | Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters. | +| | `string` | Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. | +| | `object` | PGBouncer connection pooling settings | +| | `boolean` | Enable or disable filtering of alerting by backend roles. | +| | `integer` | The purge interval (in number of requests) of the producer request purgatory (defaults to 1000). | +| | `string` | Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default. | +| | `integer` | Redis IO thread count | +| | `integer` | LFU maxmemory-policy counter decay time in minutes | +| | `integer` | Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies | +| | `string` | A string specifying the desired eviction policy for the Redis cluster. - `noeviction`: Don't evict any data, returns error when memory limit is reached. - `allkeys_lru:` Evict any key, least recently used (LRU) first. - `allkeys_random`: Evict keys in a random order. - `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first. - `volatile_random`: Evict keys with expiration only in a random order. - `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. | +| | `string` | Set notify-keyspace-events option. Requires at least `K` or `E` and accepts any combination of the following options. Setting the parameter to `""` disables notifications. - `K` — Keyspace events - `E` — Keyevent events - `g` — Generic commands (e.g. `DEL`, `EXPIRE`, `RENAME`, ...) - `$` — String commands - `l` — List commands - `s` — Set commands - `h` — Hash commands - `z` — Sorted set commands - `t` — Stream commands - `d` — Module key type events - `x` — Expired events - `e` — Evicted events - `m` — Key miss events - `n` — New key events - `A` — Alias for `"g$lshztxed"` | +| | `integer` | Set number of redis databases. Changing this will cause a restart of redis service. | +| | `string` | When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. | +| | `integer` | Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. | +| | `boolean` | Require SSL to access Redis. - When enabled, Redis accepts only SSL connections on port `25061`. - When disabled, port `25060` is opened for non-SSL connections, while port `25061` remains available for SSL connections. | +| | `integer` | Redis idle connection timeout in seconds | +| | `array` | Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. | +| | `integer` | The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. | +| | `integer` | Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. | +| | `string` | Limits the number of inline script compilations within a period of time. Default is use-context | +| | `integer` | Maximum number of aggregation buckets allowed in a single response. | +| | `number` | Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. | +| | `integer` | Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). | +| | `boolean` | When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false. | +| | `integer` | The maximum number of bytes in a socket request (defaults to 104857600). | +| | `integer` | The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K). | +| | `string` | Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas. | +| | `boolean` | Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them. | +| | `boolean` | Enable the pg_stat_monitor extension. Enabling this extension will cause the cluster to be restarted. When this extension is enabled, pg_stat_statements results for utility commands are unreliable. | +| | `string` | Synchronous replication type. Note that the service plan also needs to support synchronous replication. | +| | `integer` | PostgreSQL temporary file limit in KiB. If -1, sets to unlimited. | +| | `integer` | Size of queue for operations in the analyze thread pool. | +| | `integer` | Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `integer` | Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `integer` | Size of queue for operations in the get thread pool. | +| | `integer` | Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `integer` | Size of queue for operations in the search thread pool. | +| | `integer` | Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `integer` | Size of queue for operations in the search throttled thread pool. | +| | `integer` | Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `integer` | Size of queue for operations in the write thread pool. | +| | `integer` | Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. | +| | `object` | TimescaleDB extension configuration values | +| | `string` | PostgreSQL service timezone | +| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M). | +| | `integer` | Specifies the number of bytes reserved to track the currently executing command for each active session. | +| | `string` | Record commit time of transactions. | +| | `string` | Enables tracking of function call counts and time used. | +| | `string` | Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. | +| | `integer` | Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). | +| | `integer` | The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). | +| | `integer` | The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)). | +| | `integer` | The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. 0 includes informational messages while 1...5 increases the level to include debug messages. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). | +| | `integer` | The number of seconds the server waits for activity on a noninteractive connection before closing it. | +| | `integer` | Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000. | +| | `integer` | WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance | +| | `integer` | The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB). | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Shows configuration parameters for an existing database cluster by sending a GET request to `/v2/databases/$DATABASE_ID/config`. The response is a JSON object with a `config` key, which is set to an object containing any database configuration parameters. | +| | `UPDATE` | | To update the configuration for an existing database cluster, send a PATCH request to `/v2/databases/$DATABASE_ID/config`. | + +## `SELECT` examples + +Shows configuration parameters for an existing database cluster by sending a GET request to `/v2/databases/$DATABASE_ID/config`. The response is a JSON object with a `config` key, which is set to an object containing any database configuration parameters. + + +```sql +SELECT +_backup_hour, +_backup_minute, +action_auto_create_index_enabled, +action_destructive_requires_name, +auto_create_topics_enable, +autovacuum_analyze_scale_factor, +autovacuum_analyze_threshold, +autovacuum_freeze_max_age, +autovacuum_max_workers, +autovacuum_naptime, +autovacuum_vacuum_cost_delay, +autovacuum_vacuum_cost_limit, +autovacuum_vacuum_scale_factor, +autovacuum_vacuum_threshold, +backup_hour, +backup_minute, +bgwriter_delay, +bgwriter_flush_after, +bgwriter_lru_maxpages, +bgwriter_lru_multiplier, +binlog_retention_period, +cluster_max_shards_per_node, +cluster_routing_allocation_node_concurrent_recoveries, +compression_type, +connect_timeout, +connections_max_idle_ms, +deadlock_timeout, +default_read_concern, +default_replication_factor, +default_time_zone, +default_toast_compression, +default_write_concern, +enable_security_audit, +group_concat_max_len, +group_initial_rebalance_delay_ms, +group_max_session_timeout_ms, +group_min_session_timeout_ms, +http_max_content_length_bytes, +http_max_header_size_bytes, +http_max_initial_line_length_bytes, +idle_in_transaction_session_timeout, +indices_fielddata_cache_size_percentage, +indices_memory_index_buffer_size_percentage, +indices_memory_max_index_buffer_size_mb, +indices_memory_min_index_buffer_size_mb, +indices_queries_cache_size_percentage, +indices_query_bool_max_clause_count, +indices_recovery_max_concurrent_file_chunks, +indices_recovery_max_mb_per_sec, +information_schema_stats_expiry, +innodb_change_buffer_max_size, +innodb_flush_neighbors, +innodb_ft_min_token_size, +innodb_ft_server_stopword_table, +innodb_lock_wait_timeout, +innodb_log_buffer_size, +innodb_online_alter_log_max_size, +innodb_print_all_deadlocks, +innodb_read_io_threads, +innodb_rollback_on_timeout, +innodb_thread_concurrency, +innodb_write_io_threads, +interactive_timeout, +internal_tmp_mem_storage_engine, +ism_enabled, +ism_history_enabled, +ism_history_max_age_hours, +ism_history_max_docs, +ism_history_rollover_check_period_hours, +ism_history_rollover_retention_period_days, +jit, +log_autovacuum_min_duration, +log_cleaner_delete_retention_ms, +log_cleaner_max_compaction_lag_ms, +log_cleaner_min_cleanable_ratio, +log_cleaner_min_compaction_lag_ms, +log_cleanup_policy, +log_error_verbosity, +log_flush_interval_messages, +log_flush_interval_ms, +log_index_interval_bytes, +log_index_size_max_bytes, +log_line_prefix, +log_message_downconversion_enable, +log_message_timestamp_difference_max_ms, +log_message_timestamp_type, +log_min_duration_statement, +log_preallocate, +log_retention_bytes, +log_retention_hours, +log_retention_ms, +log_roll_jitter_ms, +log_roll_ms, +log_segment_bytes, +log_segment_delete_delay_ms, +long_query_time, +max_allowed_packet, +max_connections_per_ip, +max_failover_replication_time_lag, +max_files_per_process, +max_heap_table_size, +max_incremental_fetch_session_cache_slots, +max_locks_per_transaction, +max_logical_replication_workers, +max_parallel_workers, +max_parallel_workers_per_gather, +max_pred_locks_per_transaction, +max_prepared_transactions, +max_replication_slots, +max_stack_depth, +max_standby_archive_delay, +max_standby_streaming_delay, +max_wal_senders, +max_worker_processes, +message_max_bytes, +min_insync_replicas, +net_buffer_length, +net_read_timeout, +net_write_timeout, +num_partitions, +offsets_retention_minutes, +override_main_response_version, +pg_partman_bgw.interval, +pg_partman_bgw.role, +pg_stat_statements.track, +pgbouncer, +plugins_alerting_filter_by_backend_roles_enabled, +producer_purgatory_purge_interval_requests, +redis_acl_channels_default, +redis_io_threads, +redis_lfu_decay_time, +redis_lfu_log_factor, +redis_maxmemory_policy, +redis_notify_keyspace_events, +redis_number_of_databases, +redis_persistence, +redis_pubsub_client_output_buffer_limit, +redis_ssl, +redis_timeout, +reindex_remote_whitelist, +replica_fetch_max_bytes, +replica_fetch_response_max_bytes, +script_max_compilations_rate, +search_max_buckets, +shared_buffers_percentage, +slow_op_threshold_ms, +slow_query_log, +socket_request_max_bytes, +sort_buffer_size, +sql_mode, +sql_require_primary_key, +stat_monitor_enable, +synchronous_replication, +temp_file_limit, +thread_pool_analyze_queue_size, +thread_pool_analyze_size, +thread_pool_force_merge_size, +thread_pool_get_queue_size, +thread_pool_get_size, +thread_pool_search_queue_size, +thread_pool_search_size, +thread_pool_search_throttled_queue_size, +thread_pool_search_throttled_size, +thread_pool_write_queue_size, +thread_pool_write_size, +timescaledb, +timezone, +tmp_table_size, +track_activity_query_size, +track_commit_timestamp, +track_functions, +track_io_timing, +transaction_lifetime_limit_seconds, +transaction_remove_expired_transaction_cleanup_interval_ms, +transaction_state_log_segment_bytes, +verbosity, +wait_timeout, +wal_sender_timeout, +wal_writer_delay, +work_mem +FROM digitalocean.databases.configs +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `UPDATE` example + +Updates a configs resource. + +```sql +/*+ update */ +UPDATE digitalocean.databases.configs +SET +config = '{{ config }}' +WHERE +database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md deleted file mode 100644 index 66a69f3df5..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: connection_pools -hide_title: false -hide_table_of_contents: false -keywords: - - connection_pools - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameconnection_pools
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A unique name for the connection pool. Must be between 3 and 60 characters. | -| | `object` | | -| | `string` | The database for use with the connection pool. | -| | `string` | The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement. | -| | `object` | | -| | `integer` | The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. | -| | `string` | The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | -| | `SELECT` | | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | -| | `INSERT` | | For PostgreSQL database clusters, connection pools can be used to allow a
database to share its idle connections. The popular PostgreSQL connection
pooling utility PgBouncer is used to provide this service. [See here for more information](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/)
about how and why to use PgBouncer connection pooling including
details about the available transaction modes.

To add a new connection pool to a PostgreSQL database cluster, send a POST
request to `/v2/databases/$DATABASE_ID/pools` specifying a name for the pool,
the user to connect with, the database to connect to, as well as its desired
size and transaction mode.
| -| | `DELETE` | | To delete a specific connection pool for a PostgreSQL database cluster, send
a DELETE request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| | `EXEC` | | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | -| | `EXEC` | | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | -| | `EXEC` | | To update a connection pool for a PostgreSQL database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/database_clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/database_clusters/index.md new file mode 100644 index 0000000000..85ff1dee99 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/database_clusters/index.md @@ -0,0 +1,199 @@ +--- +title: database_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - database_clusters + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a database_clusters resource. + +## Overview + + + + +
Namedatabase_clusters
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A unique ID that can be used to identify and reference a database cluster. | +| | `string` | A unique, human-readable name referring to a database cluster. | +| | `object` | | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | +| | `array` | An array of strings containing the names of databases created in the database cluster. | +| | `string` | A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka, and "opensearch" for OpenSearch. | +| | `object` | | +| | `array` | Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and a second entry for the cluster's standby node(s). | +| | `integer` | The number of nodes in the database cluster. | +| | `object` | | +| | `string` | A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. | +| | `string` | The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. | +| | `string` | The slug identifier for the region where the database cluster is located. | +| | `array` | | +| | `string` | A string representing the semantic version of the database engine in use for the cluster. | +| | `string` | The slug identifier representing the size of the nodes in the database cluster. | +| | `object` | | +| | `object` | | +| | `string` | A string representing the current status of the database cluster. | +| | `integer` | Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. | +| | `array` | An array of tags that have been applied to the database cluster. | +| | `object` | | +| | `array` | | +| | `string` | A string representing the version of the database engine in use for the cluster. | +| | `string` | A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. | +| | `string` | A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`. The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects contain the information needed to connect to the cluster's standby node(s). The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | +| | `SELECT` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`. The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes. The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | +| | `INSERT` | | To create a database cluster, send a POST request to `/v2/databases`. The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`. The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. | +| | `DELETE` | | To destroy a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To start the installation of updates for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/install_update`. A successful request will receive a 204 No Content status code with no body in response. | +| | `EXEC` | | To resize a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/resize`. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed. | +| | `EXEC` | | To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/maintenance`. A successful request will receive a 204 No Content status code with no body in response. | +| | `EXEC` | | To upgrade the major version of a database, send a PUT request to `/v2/databases/$DATABASE_ID/upgrade`, specifying the target version. A successful request will receive a 204 No Content status code with no body in response. | +| | `EXEC` | | To migrate a database cluster to a new region, send a `PUT` request to `/v2/databases/$DATABASE_ID/migrate`. The body of the request must specify a `region` attribute. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its `status` attribute will now be set to `migrating`. This will transition back to `online` when the migration has completed. | + +## `SELECT` examples + +To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`. The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes. The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. + + +```sql +SELECT +id, +name, +connection, +created_at, +db_names, +engine, +maintenance_window, +metrics_endpoints, +num_nodes, +private_connection, +private_network_uuid, +project_id, +region, +rules, +semantic_version, +size, +standby_connection, +standby_private_connection, +status, +storage_size_mib, +tags, +ui_connection, +users, +version, +version_end_of_availability, +version_end_of_life +FROM digitalocean.databases.database_clusters +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new database_clusters resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.database_clusters ( +data__backup_restore, +data__engine, +data__name, +data__num_nodes, +data__region, +data__size +) +SELECT +'{{ backup_restore }}', +'{{ engine }}', +'{{ name }}', +'{{ num_nodes }}', +'{{ region }}', +'{{ size }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.database_clusters ( +data__name, +data__engine, +data__num_nodes, +data__size, +data__region +) +SELECT +'{{ name }}', +'{{ engine }}', +'{{ num_nodes }}', +'{{ size }}', +'{{ region }}' +; +``` + + + + +```yaml +- name: database_clusters + props: + - name: data__engine + value: string + - name: data__name + value: string + - name: data__num_nodes + value: string + - name: data__region + value: string + - name: data__size + value: string + - name: backup_restore + props: + - name: database_name + value: string + - name: backup_created_at + value: string + +``` + + + +## `DELETE` example + +Deletes the specified database_clusters resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.database_clusters +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md deleted file mode 100644 index 84b91c3cd1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: databases -hide_title: false -hide_table_of_contents: false -keywords: - - databases - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedatabases
TypeResource
Id
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| -| | `SELECT` | | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| -| | `INSERT` | | To add a new database to an existing cluster, send a POST request to
`/v2/databases/$DATABASE_ID/dbs`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a key called `db`. The value of this will be
an object that contains the standard attributes associated with a database.
| -| | `DELETE` | | To delete a specific database, send a DELETE request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: Database management is not supported for Redis clusters.
| -| | `EXEC` | | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| -| | `EXEC` | | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/dbs/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/dbs/index.md new file mode 100644 index 0000000000..d0cfab2353 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/dbs/index.md @@ -0,0 +1,106 @@ +--- +title: dbs +hide_title: false +hide_table_of_contents: false +keywords: + - dbs + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a dbs resource. + +## Overview + + + + +
Namedbs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the database. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID/dbs/$DB_NAME`. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a `db` key. This will be set to an object containing the standard database attributes. | +| | `SELECT` | | To list all of the databases in a clusters, send a GET request to `/v2/databases/$DATABASE_ID/dbs`. The result will be a JSON object with a `dbs` key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters. | +| | `INSERT` | | To add a new database to an existing cluster, send a POST request to `/v2/databases/$DATABASE_ID/dbs`. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called `db`. The value of this will be an object that contains the standard attributes associated with a database. | +| | `DELETE` | | To delete a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID/dbs/$DB_NAME`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters. | + +## `SELECT` examples + +To list all of the databases in a clusters, send a GET request to `/v2/databases/$DATABASE_ID/dbs`. The result will be a JSON object with a `dbs` key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters. + + +```sql +SELECT +name +FROM digitalocean.databases.dbs +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dbs resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.dbs ( +data__name, +database_cluster_uuid +) +SELECT +'{{ name }}', +'{{ database_cluster_uuid }}' +; +``` + + + + +```yaml +- name: dbs + props: + - name: database_cluster_uuid + value: string + - name: data__name + value: string + - name: name + value: string + +``` + + + +## `DELETE` example + +Deletes the specified dbs resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.dbs +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND database_name = '{{ database_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/events/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/events/index.md new file mode 100644 index 0000000000..b32552a8bc --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/events/index.md @@ -0,0 +1,50 @@ +--- +title: events +hide_title: false +hide_table_of_contents: false +keywords: + - events + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a events resource. + +## Overview + + + + +
Nameevents
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of the cluster events, send a GET request to `/v2/databases/$DATABASE_ID/events`. The result will be a JSON object with a `events` key. | + +## `SELECT` examples + +To list all of the cluster events, send a GET request to `/v2/databases/$DATABASE_ID/events`. The result will be a JSON object with a `events` key. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.events +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/eviction_policies/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/eviction_policies/index.md new file mode 100644 index 0000000000..4156f112f6 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/eviction_policies/index.md @@ -0,0 +1,51 @@ +--- +title: eviction_policies +hide_title: false +hide_table_of_contents: false +keywords: + - eviction_policies + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a eviction_policies resource. + +## Overview + + + + +
Nameeviction_policies
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`. The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. | +| | `EXEC` | | To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. | + +## `SELECT` examples + +To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`. The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.eviction_policies +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md deleted file mode 100644 index 7fed58e6cd..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: firewall_rules -hide_title: false -hide_table_of_contents: false -keywords: - - firewall_rules - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namefirewall_rules
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A unique ID for the database cluster to which the rule is applied. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall rule was created. | -| | `string` | The type of resource that the firewall rule allows to access the database cluster. | -| | `string` | A unique ID for the firewall rule itself. | -| | `string` | The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | -| | `EXEC` | | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | -| | `EXEC` | | To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://www.digitalocean.com/docs/networking/vpc/) to limit access to them instead of using a firewall.
A successful | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/firewalls/index.md new file mode 100644 index 0000000000..b791a512a5 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/firewalls/index.md @@ -0,0 +1,51 @@ +--- +title: firewalls +hide_title: false +hide_table_of_contents: false +keywords: + - firewalls + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a firewalls resource. + +## Overview + + + + +
Namefirewalls
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`. The result will be a JSON object with a `rules` key. | +| | `EXEC` | | To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://docs.digitalocean.com/products/networking/vpc/) to limit access to them instead of using a firewall. A successful | + +## `SELECT` examples + +To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`. The result will be a JSON object with a `rules` key. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.firewalls +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/index.md index bc6c420030..bd7c623911 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/index.md @@ -9,51 +9,45 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Databases - +databases service documentation. + :::info Service Summary
-total resources: 13
-total selectable resources: 12
-total methods: 56
+total resources: 18
::: -## Overview - - - - - - -
Namedigitalocean.databases
TypeService
TitleDigitalOcean API - Databases
DescriptionDatabases
Iddatabases:v23.04.00139
- ## Resources
backups
-ca
-clusters
-config
-connection_pools
-databases
-firewall_rules
+cas
+configs
+database_clusters
+dbs
+events
+eviction_policies
+firewalls
+indexes
-migrations
+logsinks
+metrics_credentials
+online_migrations
options
+pools
replicas
-sql_mode
-upgrade
-users
-
+sql_modes
+topics
+users
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/indexes/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/indexes/index.md new file mode 100644 index 0000000000..01d4e373c9 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/indexes/index.md @@ -0,0 +1,61 @@ +--- +title: indexes +hide_title: false +hide_table_of_contents: false +keywords: + - indexes + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a indexes resource. + +## Overview + + + + +
Nameindexes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of a OpenSearch cluster's indexes, send a GET request to `/v2/databases/$DATABASE_ID/indexes`. The result will be a JSON object with a `indexes` key. | +| | `DELETE` | | To delete a single index within OpenSearch cluster, send a DELETE request to `/v2/databases/$DATABASE_ID/indexes/$INDEX_NAME`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | + +## `SELECT` examples + +To list all of a OpenSearch cluster's indexes, send a GET request to `/v2/databases/$DATABASE_ID/indexes`. The result will be a JSON object with a `indexes` key. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.indexes +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `DELETE` example + +Deletes the specified indexes resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.indexes +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND index_name = '{{ index_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/logsinks/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/logsinks/index.md new file mode 100644 index 0000000000..e17c842483 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/logsinks/index.md @@ -0,0 +1,101 @@ +--- +title: logsinks +hide_title: false +hide_table_of_contents: false +keywords: + - logsinks + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a logsinks resource. + +## Overview + + + + +
Namelogsinks
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get a logsink for a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. | +| | `SELECT` | | To list logsinks for a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/logsink`. | +| | `INSERT` | | To create logsink for a database cluster, send a POST request to `/v2/databases/$DATABASE_ID/logsink`. | +| | `DELETE` | | To delete a logsink for a database cluster, send a DELETE request to `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. | +| | `EXEC` | | To update a logsink for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. | + +## `SELECT` examples + +To list logsinks for a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/logsink`. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.logsinks +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logsinks resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.logsinks ( +database_cluster_uuid +) +SELECT +'{{ database_cluster_uuid }}' +; +``` + + + + +```yaml +- name: logsinks + props: + - name: database_cluster_uuid + value: string + +``` + + + +## `DELETE` example + +Deletes the specified logsinks resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.logsinks +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND logsink_id = '{{ logsink_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/metrics_credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/metrics_credentials/index.md new file mode 100644 index 0000000000..b9fff054f8 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/metrics_credentials/index.md @@ -0,0 +1,51 @@ +--- +title: metrics_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_credentials + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_credentials resource. + +## Overview + + + + +
Namemetrics_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show the credentials for all database clusters' metrics endpoints, send a GET request to `/v2/databases/metrics/credentials`. The result will be a JSON object with a `credentials` key. | +| | `EXEC` | | To update the credentials for all database clusters' metrics endpoints, send a PUT request to `/v2/databases/metrics/credentials`. A successful request will receive a 204 No Content status code with no body in response. | + +## `SELECT` examples + +To show the credentials for all database clusters' metrics endpoints, send a GET request to `/v2/databases/metrics/credentials`. The result will be a JSON object with a `credentials` key. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.metrics_credentials +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md deleted file mode 100644 index bd77f07490..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: migrations -hide_title: false -hide_table_of_contents: false -keywords: - - migrations - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namemigrations
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The ID of the most recent migration. | -| | `string` | The time the migration was initiated, in ISO 8601 format. | -| | `string` | The current status of the migration. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. | -| | `DELETE` | | To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| -| | `EXEC` | | To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters. | -| | `EXEC` | | To migrate a database cluster to a new region, send a `PUT` request to
`/v2/databases/$DATABASE_ID/migrate`. The body of the request must specify a
`region` attribute.

A successful request will receive a 202 Accepted status code with no body in
response. Querying the database cluster will show that its `status` attribute
will now be set to `migrating`. This will transition back to `online` when the
migration has completed.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/online_migrations/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/online_migrations/index.md new file mode 100644 index 0000000000..54b06434b7 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/online_migrations/index.md @@ -0,0 +1,66 @@ +--- +title: online_migrations +hide_title: false +hide_table_of_contents: false +keywords: + - online_migrations + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a online_migrations resource. + +## Overview + + + + +
Nameonline_migrations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The ID of the most recent migration. | +| | `string` | The time the migration was initiated, in ISO 8601 format. | +| | `string` | The current status of the migration. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. | +| | `DELETE` | | To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters. | + +## `SELECT` examples + +To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. + + +```sql +SELECT +id, +created_at, +status +FROM digitalocean.databases.online_migrations +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `DELETE` example + +Deletes the specified online_migrations resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.online_migrations +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND migration_id = '{{ migration_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md index a1c36bab2f..c9a082a00c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - options - databases - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a options resource. ## Overview @@ -28,14 +28,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -| Name | Datatype | -|:-----|:---------| -| | `object` | -| | `object` | -| | `object` | -| | `object` | +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `object` | | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of the options available for the offered database engines, send a GET request to `/v2/databases/options`. The result will be a JSON object with an `options` key. | + +## `SELECT` examples + +To list all of the options available for the offered database engines, send a GET request to `/v2/databases/options`. The result will be a JSON object with an `options` key. + + +```sql +SELECT +options, +version_availability +FROM digitalocean.databases.options +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/pools/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/pools/index.md new file mode 100644 index 0000000000..3aee793bd3 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/pools/index.md @@ -0,0 +1,166 @@ +--- +title: pools +hide_title: false +hide_table_of_contents: false +keywords: + - pools + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a pools resource. + +## Overview + + + + +
Namepools
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A unique name for the connection pool. Must be between 3 and 60 characters. | +| | `object` | | +| | `string` | The database for use with the connection pool. | +| | `string` | The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement. | +| | `object` | | +| | `integer` | The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. | +| | `object` | | +| | `object` | | +| | `string` | The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. The response will be a JSON object with a `pool` key. | +| | `SELECT` | | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`. The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | +| | `INSERT` | | For PostgreSQL database clusters, connection pools can be used to allow a database to share its idle connections. The popular PostgreSQL connection pooling utility PgBouncer is used to provide this service. [See here for more information](https://docs.digitalocean.com/products/databases/postgresql/how-to/manage-connection-pools/) about how and why to use PgBouncer connection pooling including details about the available transaction modes. To add a new connection pool to a PostgreSQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/pools` specifying a name for the pool, the user to connect with, the database to connect to, as well as its desired size and transaction mode. | +| | `DELETE` | | To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To update a connection pool for a PostgreSQL database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. | + +## `SELECT` examples + +To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`. The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. + + +```sql +SELECT +name, +connection, +db, +mode, +private_connection, +size, +standby_connection, +standby_private_connection, +user +FROM digitalocean.databases.pools +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pools resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.pools ( +data__name, +data__mode, +data__size, +data__db, +data__user, +database_cluster_uuid +) +SELECT +'{{ name }}', +'{{ mode }}', +'{{ size }}', +'{{ db }}', +'{{ user }}', +'{{ database_cluster_uuid }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.pools ( +data__name, +data__mode, +data__size, +data__db, +database_cluster_uuid +) +SELECT +'{{ name }}', +'{{ mode }}', +'{{ size }}', +'{{ db }}', +'{{ database_cluster_uuid }}' +; +``` + + + + +```yaml +- name: pools + props: + - name: database_cluster_uuid + value: string + - name: data__db + value: string + - name: data__mode + value: string + - name: data__name + value: string + - name: data__size + value: string + - name: name + value: string + - name: mode + value: string + - name: size + value: integer + - name: db + value: string + - name: user + value: string + +``` + + + +## `DELETE` example + +Deletes the specified pools resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.pools +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND pool_name = '{{ pool_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md index 70bb111d82..fb33d0c4e4 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - replicas - databases - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a replicas resource. ## Overview @@ -39,14 +39,87 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster. | | | `string` | A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating. | | | `string` | A string representing the current status of the database cluster. | +| | `integer` | Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. | | | `array` | A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | -| | `SELECT` | | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | -| | `INSERT` | | To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given, the size of the node to be used, and the region where it will be located.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a key called `replica`. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's `status` attribute will be `forking`. When the replica is ready to receive traffic, this will transition to `active`. | -| | `EXEC` | | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | -| | `EXEC` | | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | -| | `EXEC` | | To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | -| | `EXEC` | | To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `SELECT` | | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. **Note**: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | +| | `SELECT` | | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`. **Note**: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | +| | `INSERT` | | To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given, the size of the node to be used, and the region where it will be located. **Note**: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a key called `replica`. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's `status` attribute will be `forking`. When the replica is ready to receive traffic, this will transition to `active`. | +| | `DELETE` | | To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. **Note**: Read-only replicas are not supported for Redis clusters. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`. **Note**: Read-only replicas are not supported for Redis clusters. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | + +## `SELECT` examples + +To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`. **Note**: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. + + +```sql +SELECT +id, +name, +connection, +created_at, +private_connection, +private_network_uuid, +region, +size, +status, +storage_size_mib, +tags +FROM digitalocean.databases.replicas +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replicas resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.replicas ( +database_cluster_uuid, +data__name +) +SELECT +'{{ database_cluster_uuid }}', +'{{ name }}' +; +``` + + + + +```yaml +- name: replicas + props: + - name: database_cluster_uuid + value: string + - name: data__name + value: string + +``` + + + +## `DELETE` example + +Deletes the specified replicas resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.replicas +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND replica_name = '{{ replica_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md deleted file mode 100644 index 6ae2e8a7b1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: sql_mode -hide_title: false -hide_table_of_contents: false -keywords: - - sql_mode - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview -
- - - -
Namesql_mode
TypeResource
Id
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`.
The response will be a JSON object with a `sql_mode` key. This will be set to a string representing the configured SQL modes. | -| | `EXEC` | | To configure the SQL modes for an existing MySQL cluster, send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired modes. See the official MySQL 8 documentation for a [full list of supported SQL modes](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sql-mode-full).
A successful request will receive a 204 No Content status code with no body in response. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/sql_modes/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/sql_modes/index.md new file mode 100644 index 0000000000..44478e4d2b --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/sql_modes/index.md @@ -0,0 +1,51 @@ +--- +title: sql_modes +hide_title: false +hide_table_of_contents: false +keywords: + - sql_modes + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a sql_modes resource. + +## Overview + + + + +
Namesql_modes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A string specifying the configured SQL modes for the MySQL cluster. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`. The response will be a JSON object with a `sql_mode` key. This will be set to a string representing the configured SQL modes. | +| | `EXEC` | | To configure the SQL modes for an existing MySQL cluster, send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired modes. See the official MySQL 8 documentation for a [full list of supported SQL modes](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sql-mode-full). A successful request will receive a 204 No Content status code with no body in response. | + +## `SELECT` examples + +To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`. The response will be a JSON object with a `sql_mode` key. This will be set to a string representing the configured SQL modes. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.sql_modes +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/topics/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/topics/index.md new file mode 100644 index 0000000000..3de8fc36d1 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/databases/topics/index.md @@ -0,0 +1,101 @@ +--- +title: topics +hide_title: false +hide_table_of_contents: false +keywords: + - topics + - databases + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a topics resource. + +## Overview + + + + +
Nametopics
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a given topic by name from the set of a Kafka cluster's topics, send a GET request to `/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME`. The result will be a JSON object with a `topic` key. | +| | `SELECT` | | To list all of a Kafka cluster's topics, send a GET request to `/v2/databases/$DATABASE_ID/topics`. The result will be a JSON object with a `topics` key. | +| | `INSERT` | | To create a topic attached to a Kafka cluster, send a POST request to `/v2/databases/$DATABASE_ID/topics`. The result will be a JSON object with a `topic` key. | +| | `DELETE` | | To delete a single topic within a Kafka cluster, send a DELETE request to `/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To update a topic attached to a Kafka cluster, send a PUT request to `/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME`. The result will be a JSON object with a `topic` key. | + +## `SELECT` examples + +To list all of a Kafka cluster's topics, send a GET request to `/v2/databases/$DATABASE_ID/topics`. The result will be a JSON object with a `topics` key. + + +```sql +SELECT +column_anon +FROM digitalocean.databases.topics +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topics resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.topics ( +database_cluster_uuid +) +SELECT +'{{ database_cluster_uuid }}' +; +``` + + + + +```yaml +- name: topics + props: + - name: database_cluster_uuid + value: string + +``` + + + +## `DELETE` example + +Deletes the specified topics resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.topics +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND topic_name = '{{ topic_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md deleted file mode 100644 index adeff632a9..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: upgrade -hide_title: false -hide_table_of_contents: false -keywords: - - upgrade - - databases - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameupgrade
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md index 81524cd15d..f650174538 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - users - databases - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a users resource. ## Overview @@ -31,16 +31,107 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | Name | Datatype | Description | |:-----|:---------|:------------| | | `string` | The name of a database user. | +| | `string` | Access certificate for TLS client authentication. (Kafka only) | +| | `string` | Access key for TLS client authentication. (Kafka only) | | | `object` | | | | `string` | A randomly generated password for the database user. | -| | `string` | A string representing the database user's role. The value will be either
"primary" or "normal".
| +| | `string` | A string representing the database user's role. The value will be either "primary" or "normal". | +| | `object` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| -| | `SELECT` | | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| -| | `INSERT` | | To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users`
with the desired username.

Note: User management is not supported for Redis clusters.

When adding a user to a MySQL cluster, additional options can be configured in the
`mysql_settings` object.

The response will be a JSON object with a key called `user`. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| -| | `DELETE` | | To remove a specific database user, send a DELETE request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: User management is not supported for Redis clusters.
| -| | `EXEC` | | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| -| | `EXEC` | | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| -| | `EXEC` | | To reset the password for a database user, send a POST request to
`/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth`.

For `mysql` databases, the authentication method can be specifying by
including a key in the JSON body called `mysql_settings` with the `auth_plugin`
value specified.

The response will be a JSON object with a `user` key. This will be set to an
object containing the standard database user attributes.
| +| | `SELECT` | | To show information about an existing database user, send a GET request to `/v2/databases/$DATABASE_ID/users/$USERNAME`. Note: User management is not supported for Redis clusters. The response will be a JSON object with a `user` key. This will be set to an object containing the standard database user attributes. For MySQL clusters, additional options will be contained in the `mysql_settings` object. For Kafka clusters, additional options will be contained in the `settings` object. | +| | `SELECT` | | To list all of the users for your database cluster, send a GET request to `/v2/databases/$DATABASE_ID/users`. Note: User management is not supported for Redis clusters. The result will be a JSON object with a `users` key. This will be set to an array of database user objects, each of which will contain the standard database user attributes. For MySQL clusters, additional options will be contained in the mysql_settings object. | +| | `INSERT` | | To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users` with the desired username. Note: User management is not supported for Redis clusters. When adding a user to a MySQL cluster, additional options can be configured in the `mysql_settings` object. When adding a user to a Kafka cluster, additional options can be configured in the `settings` object. The response will be a JSON object with a key called `user`. The value of this will be an object that contains the standard attributes associated with a database user including its randomly generated password. | +| | `DELETE` | | To remove a specific database user, send a DELETE request to `/v2/databases/$DATABASE_ID/users/$USERNAME`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: User management is not supported for Redis clusters. | +| | `EXEC` | | To reset the password for a database user, send a POST request to `/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth`. For `mysql` databases, the authentication method can be specifying by including a key in the JSON body called `mysql_settings` with the `auth_plugin` value specified. The response will be a JSON object with a `user` key. This will be set to an object containing the standard database user attributes. | +| | `EXEC` | | To update an existing database user, send a PUT request to `/v2/databases/$DATABASE_ID/users/$USERNAME` with the desired settings. **Note**: only `settings` can be updated via this type of request. If you wish to change the name of a user, you must recreate a new user. The response will be a JSON object with a key called `user`. The value of this will be an object that contains the name of the update database user, along with the `settings` object that has been updated. | + +## `SELECT` examples + +To list all of the users for your database cluster, send a GET request to `/v2/databases/$DATABASE_ID/users`. Note: User management is not supported for Redis clusters. The result will be a JSON object with a `users` key. This will be set to an array of database user objects, each of which will contain the standard database user attributes. For MySQL clusters, additional options will be contained in the mysql_settings object. + + +```sql +SELECT +name, +access_cert, +access_key, +mysql_settings, +password, +role, +settings +FROM digitalocean.databases.users +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new users resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.users ( +data__readonly, +database_cluster_uuid, +data__name +) +SELECT +'{{ readonly }}', +'{{ database_cluster_uuid }}', +'{{ name }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.databases.users ( +data__name, +database_cluster_uuid +) +SELECT +'{{ name }}', +'{{ database_cluster_uuid }}' +; +``` + + + + +```yaml +- name: users + props: + - name: database_cluster_uuid + value: string + - name: data__name + value: string + - name: readonly + value: boolean + +``` + + + +## `DELETE` example + +Deletes the specified users resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.databases.users +WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' +AND username = '{{ username }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md index f0789e52ec..acd2660b35 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - domains - domains - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a domains resource. ## Overview
@@ -30,16 +30,74 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. | -| | `string` | This optional attribute may contain an IP address. When provided, an A record will be automatically created pointing to the apex domain. | -| | `integer` | This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | -| | `string` | This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | -| | `SELECT` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | -| | `INSERT` | | To create a new domain, send a POST request to `/v2/domains`. Set the "name"
attribute to the domain name you are adding. Optionally, you may set the
"ip_address" attribute, and an A record will be automatically created pointing
to the apex domain.
| -| | `DELETE` | | To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`.
| -| | `EXEC` | | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | -| | `EXEC` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | +| | `SELECT` | | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | +| | `SELECT` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | +| | `INSERT` | | To create a new domain, send a POST request to `/v2/domains`. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain. | +| | `DELETE` | | To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`. | + +## `SELECT` examples + +To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. + + +```sql +SELECT +column_anon +FROM digitalocean.domains.domains +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domains resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.domains.domains ( +data__name, +data__ip_address +) +SELECT +'{{ name }}', +'{{ ip_address }}' +; +``` + + + + +```yaml +- name: domains + props: + - name: name + value: string + - name: ip_address + value: string + +``` + + + +## `DELETE` example + +Deletes the specified domains resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.domains.domains +WHERE domain_name = '{{ domain_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/index.md index c657abff53..2e10e3cafd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Domains - +domains service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 14
::: -## Overview -
- - - - - -
Namedigitalocean.domains
TypeService
TitleDigitalOcean API - Domains
DescriptionDomains
Iddomains:v23.04.00139
- ## Resources
-domains
+domains
-records
-
+records
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md index 6955dee207..77cb96922f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - records - domains - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a records resource. ## Overview @@ -30,24 +30,151 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique identifier for each domain record. | -| | `string` | The host name, alias, or service being defined by the record. | -| | `string` | Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates. | -| | `integer` | An unsigned integer between 0-255 used for CAA records. | -| | `integer` | The port for SRV records. | -| | `integer` | The priority for SRV and MX records. | -| | `string` | The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef" | -| | `integer` | This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | -| | `string` | The type of the DNS record. For example: A, CNAME, TXT, ... | -| | `integer` | The weight for SRV records. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | -| | `SELECT` | | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| -| | `INSERT` | | To create a new record to a domain, send a POST request to
`/v2/domains/$DOMAIN_NAME/records`.

The request must include all of the required fields for the domain record type
being added.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective required attributes.
| -| | `DELETE` | | To delete a record for a domain, send a DELETE request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.

The record will be deleted and the response status will be a 204. This
indicates a successful request with no body returned.
| -| | `EXEC` | | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | -| | `EXEC` | | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| -| | `EXEC` | | To update an existing record, send a PATCH request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| -| | `EXEC` | | To update an existing record, send a PUT request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| +| | `SELECT` | | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | +| | `SELECT` | | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`. The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together. | +| | `INSERT` | | To create a new record to a domain, send a POST request to `/v2/domains/$DOMAIN_NAME/records`. The request must include all of the required fields for the domain record type being added. See the [attribute table](#tag/Domain-Records) for details regarding record types and their respective required attributes. | +| | `DELETE` | | To delete a record for a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned. | +| | `UPDATE` | | To update an existing record, send a PATCH request to `/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for the record type can be set to a new value for the record. See the [attribute table](#tag/Domain-Records) for details regarding record types and their respective attributes. | +| | `EXEC` | | To update an existing record, send a PUT request to `/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for the record type can be set to a new value for the record. See the [attribute table](#tag/Domain-Records) for details regarding record types and their respective attributes. | + +## `SELECT` examples + +To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`. The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together. + + +```sql +SELECT +column_anon +FROM digitalocean.domains.records +WHERE domain_name = '{{ domain_name }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new records resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.domains.records ( +data__type, +data__name, +data__data, +data__priority, +data__port, +data__ttl, +data__weight, +data__flags, +data__tag, +domain_name +) +SELECT +'{{ type }}', +'{{ name }}', +'{{ data }}', +'{{ priority }}', +'{{ port }}', +'{{ ttl }}', +'{{ weight }}', +'{{ flags }}', +'{{ tag }}', +'{{ domain_name }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.domains.records ( +data__type, +data__name, +data__data, +domain_name +) +SELECT +'{{ type }}', +'{{ name }}', +'{{ data }}', +'{{ domain_name }}' +; +``` + + + + +```yaml +- name: records + props: + - name: domain_name + value: string + - name: type + value: string + - name: name + value: string + - name: data + value: string + - name: priority + value: integer + - name: port + value: integer + - name: ttl + value: integer + - name: weight + value: integer + - name: flags + value: integer + - name: tag + value: string + +``` + + + +## `UPDATE` example + +Updates a records resource. + +```sql +/*+ update */ +UPDATE digitalocean.domains.records +SET +type = '{{ type }}', +name = '{{ name }}', +data = '{{ data }}', +priority = '{{ priority }}', +port = '{{ port }}', +ttl = '{{ ttl }}', +weight = '{{ weight }}', +flags = '{{ flags }}', +tag = '{{ tag }}' +WHERE +domain_name = '{{ domain_name }}' +AND domain_record_id = '{{ domain_record_id }}' +AND data__type = '{{ data__type }}'; +``` + +## `DELETE` example + +Deletes the specified records resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.domains.records +WHERE domain_name = '{{ domain_name }}' +AND domain_record_id = '{{ domain_record_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md index 0e24d18bbb..c1ca41bff5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - actions - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a actions resource. ## Overview
@@ -30,21 +30,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| | `object` | | -| | `string` | A human-readable string that is used as a unique identifier for each region. | -| | `integer` | A unique identifier for the resource that the action is associated with. | -| | `string` | The type of resource that the action is associated with. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| | `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. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| -| | `SELECT` | | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| -| | `INSERT` | | To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details \|
\| ---------------------------------------- \| ----------- \|
\| <nobr>`enable_backups`</nobr> \| Enables backups for a Droplet \|
\| <nobr>`disable_backups`</nobr> \| Disables backups for a Droplet \|
\| <nobr>`reboot`</nobr> \| Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. \|
\| <nobr>`power_cycle`</nobr> \| Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. \|
\| <nobr>`shutdown`</nobr> \| Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. \|
\| <nobr>`power_off`</nobr> \| Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. \|
\| <nobr>`power_on`</nobr> \| Powers on a Droplet. \|
\| <nobr>`restore`</nobr> \| Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. \|
\| <nobr>`password_reset`</nobr> \| Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. \|
\| <nobr>`resize`</nobr> \| Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. \|
\| <nobr>`rebuild`</nobr> \| Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. \|
\| <nobr>`rename`</nobr> \| Renames a Droplet. \|
\| <nobr>`change_kernel`</nobr> \| Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. \|
\| <nobr>`enable_ipv6`</nobr> \| Enables IPv6 for a Droplet. \|
\| <nobr>`snapshot`</nobr> \| Takes a snapshot of a Droplet. \|
| -| | `EXEC` | | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| -| | `EXEC` | | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| -| | `EXEC` | | Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to `/v2/droplets/actions?tag_name=$TAG_NAME` with
the action arguments.

Only a sub-set of action types are supported:

- `power_cycle`
- `power_on`
- `power_off`
- `shutdown`
- `enable_ipv6`
- `enable_backups`
- `disable_backups`
- `snapshot`
| +| | `SELECT` | | To retrieve a Droplet action, send a GET request to `/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`. The response will be a JSON object with a key called `action`. The value will be a Droplet action object. | +| | `SELECT` | | To retrieve a list of all actions that have been executed for a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/actions`. The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with `action` objects containing the standard `action` attributes. | +| | `EXEC` | | To initiate an action on a Droplet send a POST request to `/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request, set the `type` attribute to on of the supported action types: \| Action \| Details \| \| ---------------------------------------- \| ----------- \| \| `enable_backups` \| Enables backups for a Droplet \| \| `disable_backups` \| Disables backups for a Droplet \| \| `change_backup_policy` \| Update the backup policy for a Droplet \| \| `reboot` \| Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. \| \| `power_cycle` \| Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. \| \| `shutdown` \| Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. \| \| `power_off` \| Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. \| \| `power_on` \| Powers on a Droplet. \| \| `restore` \| Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. \| \| `password_reset` \| Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. \| \| `resize` \| Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. \| \| `rebuild` \| Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. \| \| `rename` \| Renames a Droplet. \| \| `change_kernel` \| Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. \| \| `enable_ipv6` \| Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. \| \| `snapshot` \| Takes a snapshot of a Droplet. \| | +| | `EXEC` | | Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to `/v2/droplets/actions?tag_name=$TAG_NAME` with the action arguments. Only a sub-set of action types are supported: - `power_cycle` - `power_on` - `power_off` - `shutdown` - `enable_ipv6` - `enable_backups` - `disable_backups` - `snapshot` | + +## `SELECT` examples + +To retrieve a list of all actions that have been executed for a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/actions`. The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with `action` objects containing the standard `action` attributes. + + +```sql +SELECT +column_anon +FROM digitalocean.droplets.actions +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md index a7e4448bbe..7ca247a0bc 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - backups - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a backups resource. ## Overview
@@ -37,8 +37,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | | | `number` | The billable size of the snapshot in gigabytes. | | | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve any backups associated with a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/backups`. You will get back a JSON object that has a `backups` key. This will be set to an array of backup objects, each of which contain the standard Droplet backup attributes. | + +## `SELECT` examples + +To retrieve any backups associated with a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/backups`. You will get back a JSON object that has a `backups` key. This will be set to an array of backup objects, each of which contain the standard Droplet backup attributes. + + +```sql +SELECT +id, +name, +created_at, +min_disk_size, +regions, +size_gigabytes, +type +FROM digitalocean.droplets.backups +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/backups_policies/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/backups_policies/index.md new file mode 100644 index 0000000000..372176e6e9 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/backups_policies/index.md @@ -0,0 +1,51 @@ +--- +title: backups_policies +hide_title: false +hide_table_of_contents: false +keywords: + - backups_policies + - droplets + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a backups_policies resource. + +## Overview +
+ + + +
Namebackups_policies
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an individual Droplet's backup policy, send a GET request to `/v2/droplets/$DROPLET_ID/backups/policy`. | +| | `SELECT` | | To list information about the backup policies for all Droplets in the account, send a GET request to `/v2/droplets/backups/policies`. | + +## `SELECT` examples + +To list information about the backup policies for all Droplets in the account, send a GET request to `/v2/droplets/backups/policies`. + + +```sql +SELECT +column_anon +FROM digitalocean.droplets.backups_policies +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/backups_supported_policies/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/backups_supported_policies/index.md new file mode 100644 index 0000000000..8e6d295c5e --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/backups_supported_policies/index.md @@ -0,0 +1,58 @@ +--- +title: backups_supported_policies +hide_title: false +hide_table_of_contents: false +keywords: + - backups_supported_policies + - droplets + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a backups_supported_policies resource. + +## Overview + + + + +
Namebackups_supported_policies
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The name of the Droplet backup plan. | +| | `array` | The day of the week the backup will occur. | +| | `array` | An array of integers representing the hours of the day that a backup can start. | +| | `integer` | The number of days that a backup will be kept. | +| | `integer` | The number of hours that a backup window is open. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of all supported Droplet backup policies, send a GET request to `/v2/droplets/backups/supported_policies`. | + +## `SELECT` examples + +To retrieve a list of all supported Droplet backup policies, send a GET request to `/v2/droplets/backups/supported_policies`. + + +```sql +SELECT +name, +possible_days, +possible_window_starts, +retention_period_days, +window_length_hours +FROM digitalocean.droplets.backups_supported_policies +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md index 71bb6bc5ff..fa296d3787 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - droplets - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a droplets resource. ## Overview @@ -30,40 +30,151 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | -| | `string` | The human-readable name set for the Droplet instance. | -| | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | -| | `integer` | The size of the Droplet's disk in gigabytes. | -| | `array` | An array of features enabled on this Droplet. | -| | `object` | | -| | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| -| | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | -| | `integer` | Memory of the Droplet in megabytes. | -| | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | -| | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | -| | `object` | | -| | `object` | | -| | `string` | The unique slug identifier for the size of this Droplet. | -| | `array` | An array of snapshot IDs of any snapshots created from the Droplet instance. | -| | `string` | A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". | -| | `array` | An array of Tags the Droplet has been tagged with. | -| | `integer` | The number of virtual CPUs. | -| | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | -| | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| -| | `SELECT` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| -| | `INSERT` | | To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.

A Droplet will be created using the provided information. The response body
will contain a JSON object with a key called `droplet`. The value will be an
object containing the standard attributes for your new Droplet. The response
code, 202 Accepted, does not indicate the success or failure of the operation,
just that the request has been accepted for processing. The `actions` returned
as part of the response's `links` object can be used to check the status
of the Droplet create event.

### Create Multiple Droplets

Creating multiple Droplets is very similar to creating a single Droplet.
Instead of sending `name` as a string, send `names` as an array of strings. A
Droplet will be created for each name you send using the associated
information. Up to ten Droplets may be created this way at a time.

Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array
of `actions` returned as part of the response's `links` object can be used to
check the status of each individual Droplet create event.
| -| | `EXEC` | | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| -| | `EXEC` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| -| | `EXEC` | | To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To delete **all** Droplets assigned to a specific tag, include the `tag_name`
query parameter set to the name of the tag in your DELETE request. For
example, `/v2/droplets?tag_name=$TAG_NAME`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | If the status of a request to destroy a Droplet with its associated resources
reported any errors, it can be retried by sending a POST request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry` endpoint.

Only one destroy can be active at a time per Droplet. If a retry is issued
while another destroy is in progress for the Droplet a 409 status code will
be returned. A successful response will include a 202 response code and no
content.
| -| | `EXEC` | | To destroy a Droplet along with all of its associated resources, send a DELETE
request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous`
endpoint. The headers of this request must include an `X-Dangerous` key set to
`true`. To preview which resources will be destroyed, first query the
Droplet's associated resources. This operation _can not_ be reverse and should
be used with caution.

A successful response will include a 202 response code and no content. Use the
status endpoint to check on the success or failure of the destruction of the
individual resources.
| -| | `EXEC` | | To destroy a Droplet along with a sub-set of its associated resources, send a
DELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective`
endpoint. The JSON body of the request should include `reserved_ips`, `snapshots`, `volumes`,
or `volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed. The IDs can be found by querying the Droplet's
associated resources. Any associated resource not included in the request
will remain and continue to accrue changes on your account.

A successful response will include a 202 response code and no content. Use
the status endpoint to check on the success or failure of the destruction of
the individual resources.
| -| | `EXEC` | | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint.
| -| | `EXEC` | | To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint.

The response will be a JSON object containing `snapshots`, `volumes`, and
`volume_snapshots` keys. Each will be set to an array of objects containing
information about the associated resources.
| -| | `EXEC` | | To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`.

The results will be returned as a JSON object with a key of `neighbor_ids`.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| +| | `SELECT` | | To show information about an individual Droplet, send a GET request to `/v2/droplets/$DROPLET_ID`. | +| | `SELECT` | | To list all Droplets in your account, send a GET request to `/v2/droplets`. The response body will be a JSON object with a key of `droplets`. This will be set to an array containing objects each representing a Droplet. These will contain the standard Droplet attributes. ### Filtering Results by Tag It's possible to request filtered results by including certain query parameters. To only list Droplets assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/droplets?tag_name=$TAG_NAME`. ### GPU Droplets By default, only non-GPU Droplets are returned. To list only GPU Droplets, set the `type` query parameter to `gpus`. For example, `/v2/droplets?type=gpus`. | +| | `INSERT` | | To create a new Droplet, send a POST request to `/v2/droplets` setting the required attributes. A Droplet will be created using the provided information. The response body will contain a JSON object with a key called `droplet`. The value will be an object containing the standard attributes for your new Droplet. The response code, 202 Accepted, does not indicate the success or failure of the operation, just that the request has been accepted for processing. The `actions` returned as part of the response's `links` object can be used to check the status of the Droplet create event. ### Create Multiple Droplets Creating multiple Droplets is very similar to creating a single Droplet. Instead of sending `name` as a string, send `names` as an array of strings. A Droplet will be created for each name you send using the associated information. Up to ten Droplets may be created this way at a time. Rather than returning a single Droplet, the response body will contain a JSON array with a key called `droplets`. This will be set to an array of JSON objects, each of which will contain the standard Droplet attributes. The response code, 202 Accepted, does not indicate the success or failure of any operation, just that the request has been accepted for processing. The array of `actions` returned as part of the response's `links` object can be used to check the status of each individual Droplet create event. | +| | `DELETE` | | To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | +| | `DELETE` | | To delete **all** Droplets assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your DELETE request. For example, `/v2/droplets?tag_name=$TAG_NAME`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | +| | `EXEC` | | If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry` endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content. | +| | `EXEC` | | To destroy a Droplet along with all of its associated resources, send a DELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous` endpoint. The headers of this request must include an `X-Dangerous` key set to `true`. To preview which resources will be destroyed, first query the Droplet's associated resources. This operation _can not_ be reverse and should be used with caution. A successful response will include a 202 response code and no content. Use the status endpoint to check on the success or failure of the destruction of the individual resources. | +| | `EXEC` | | To destroy a Droplet along with a sub-set of its associated resources, send a DELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective` endpoint. The JSON body of the request should include `reserved_ips`, `snapshots`, `volumes`, or `volume_snapshots` keys each set to an array of IDs for the associated resources to be destroyed. The IDs can be found by querying the Droplet's associated resources. Any associated resource not included in the request will remain and continue to accrue changes on your account. A successful response will include a 202 response code and no content. Use the status endpoint to check on the success or failure of the destruction of the individual resources. | + +## `SELECT` examples + +To list all Droplets in your account, send a GET request to `/v2/droplets`. The response body will be a JSON object with a key of `droplets`. This will be set to an array containing objects each representing a Droplet. These will contain the standard Droplet attributes. ### Filtering Results by Tag It's possible to request filtered results by including certain query parameters. To only list Droplets assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/droplets?tag_name=$TAG_NAME`. ### GPU Droplets By default, only non-GPU Droplets are returned. To list only GPU Droplets, set the `type` query parameter to `gpus`. For example, `/v2/droplets?type=gpus`. + + +```sql +SELECT +column_anon +FROM digitalocean.droplets.droplets +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new droplets resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.droplets.droplets ( +data__name, +data__region, +data__size, +data__image, +data__ssh_keys, +data__backups, +data__backup_policy, +data__ipv6, +data__monitoring, +data__tags, +data__user_data, +data__private_networking, +data__volumes, +data__vpc_uuid, +data__with_droplet_agent +) +SELECT +'{{ name }}', +'{{ region }}', +'{{ size }}', +'{{ image }}', +'{{ ssh_keys }}', +'{{ backups }}', +'{{ backup_policy }}', +'{{ ipv6 }}', +'{{ monitoring }}', +'{{ tags }}', +'{{ user_data }}', +'{{ private_networking }}', +'{{ volumes }}', +'{{ vpc_uuid }}', +'{{ with_droplet_agent }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.droplets.droplets ( +data__size, +data__image +) +SELECT +'{{ size }}', +'{{ image }}' +; +``` + + + + +```yaml +- name: droplets + props: + - name: name + value: string + - name: region + value: string + - name: size + value: string + - name: image + value: string + - name: ssh_keys + value: array + - name: backups + value: boolean + - name: backup_policy + props: + - name: plan + value: string + - name: weekday + value: string + - name: hour + value: integer + - name: ipv6 + value: boolean + - name: monitoring + value: boolean + - name: tags + value: array + - name: user_data + value: string + - name: private_networking + value: boolean + - name: volumes + value: array + - name: vpc_uuid + value: string + - name: with_droplet_agent + value: boolean + +``` + + + +## `DELETE` example + +Deletes the specified droplets resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.droplets.droplets +WHERE tag_name = '{{ tag_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources/index.md new file mode 100644 index 0000000000..4ec6f14086 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources/index.md @@ -0,0 +1,58 @@ +--- +title: droplets_associated_resources +hide_title: false +hide_table_of_contents: false +keywords: + - droplets_associated_resources + - droplets + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a droplets_associated_resources resource. + +## Overview +
+ + + +
Namedroplets_associated_resources
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | | +| | `array` | | +| | `array` | | +| | `array` | | +| | `array` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list the associated billable resources that can be destroyed along with a Droplet, send a GET request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint. The response will be a JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing information about the associated resources. | + +## `SELECT` examples + +To list the associated billable resources that can be destroyed along with a Droplet, send a GET request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint. The response will be a JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing information about the associated resources. + + +```sql +SELECT +floating_ips, +reserved_ips, +snapshots, +volume_snapshots, +volumes +FROM digitalocean.droplets.droplets_associated_resources +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources_delete_status/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources_delete_status/index.md new file mode 100644 index 0000000000..a7a0fdfdf0 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets_associated_resources_delete_status/index.md @@ -0,0 +1,56 @@ +--- +title: droplets_associated_resources_delete_status +hide_title: false +hide_table_of_contents: false +keywords: + - droplets_associated_resources_delete_status + - droplets + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a droplets_associated_resources_delete_status resource. + +## Overview + + + + +
Namedroplets_associated_resources_delete_status
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A time value given in ISO8601 combined date and time format indicating when the requested action was completed. | +| | `object` | An object containing information about a resource scheduled for deletion. | +| | `integer` | A count of the associated resources that failed to be destroyed, if any. | +| | `object` | An object containing additional information about resource related to a Droplet requested to be destroyed. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To check on the status of a request to destroy a Droplet with its associated resources, send a GET request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint. | + +## `SELECT` examples + +To check on the status of a request to destroy a Droplet with its associated resources, send a GET request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint. + + +```sql +SELECT +completed_at, +droplet, +failures, +resources +FROM digitalocean.droplets.droplets_associated_resources_delete_status +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md index cc55286652..77e4b2d461 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - firewalls - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a firewalls resource. ## Overview @@ -38,9 +38,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `array` | | | | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | | | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | -| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | +| | `array` | An array containing the names of the Tags assigned to the firewall. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of all firewalls available to a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/firewalls` The response will be a JSON object that has a key called `firewalls`. This will be set to an array of `firewall` objects, each of which contain the standard `firewall` attributes. | + +## `SELECT` examples + +To retrieve a list of all firewalls available to a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/firewalls` The response will be a JSON object that has a key called `firewalls`. This will be set to an array of `firewall` objects, each of which contain the standard `firewall` attributes. + + +```sql +SELECT +id, +name, +created_at, +droplet_ids, +inbound_rules, +outbound_rules, +pending_changes, +status, +tags +FROM digitalocean.droplets.firewalls +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/index.md index aa577036df..aea1205868 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/index.md @@ -9,45 +9,39 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Droplets - +droplets service documentation. + :::info Service Summary
-total resources: 7
-total selectable resources: 7
-total methods: 29
+total resources: 12
::: -## Overview -
- - - - - -
Namedigitalocean.droplets
TypeService
TitleDigitalOcean API - Droplets
DescriptionDroplets
Iddroplets:v23.04.00139
- ## Resources
actions
backups
+backups_policies
+backups_supported_policies
droplets
-firewalls
+droplets_associated_resources
+droplets_associated_resources_delete_status
+firewalls
kernels
neighbors
-snapshots
-
+reports_droplet_neighbors_ids
+snapshots
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md index bf5b90b3dd..97f870d248 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - kernels - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a kernels resource. ## Overview @@ -33,8 +33,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `integer` | A unique number used to identify and reference a specific kernel. | | | `string` | The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question. | | | `string` | A standard kernel version string representing the version, patch, and release information. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of all kernels available to a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/kernels` The response will be a JSON object that has a key called `kernels`. This will be set to an array of `kernel` objects, each of which contain the standard `kernel` attributes. | + +## `SELECT` examples + +To retrieve a list of all kernels available to a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/kernels` The response will be a JSON object that has a key called `kernels`. This will be set to an array of `kernel` objects, each of which contain the standard `kernel` attributes. + + +```sql +SELECT +id, +name, +version +FROM digitalocean.droplets.kernels +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md index b67f070bd3..174c1a4a60 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - neighbors - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a neighbors resource. ## Overview
@@ -32,15 +32,17 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; |:-----|:---------|:------------| | | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | | | `string` | The human-readable name set for the Droplet instance. | -| | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | +| | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | | | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | | | `integer` | The size of the Droplet's disk in gigabytes. | +| | `array` | An array of objects containing information about the disks available to the Droplet. | | | `array` | An array of features enabled on this Droplet. | +| | `object` | An object containing information about the GPU capabilities of Droplets created with this size. | | | `object` | | -| | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| +| | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to `null`. The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/) for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created. | | | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | | | `integer` | Memory of the Droplet in megabytes. | -| | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | +| | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | | | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | | | `object` | | | | `object` | | @@ -51,8 +53,42 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `integer` | The number of virtual CPUs. | | | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | | | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on the same physical hardware) for a specific Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/neighbors`. The results will be returned as a JSON object with a key of `droplets`. This will be set to an array containing objects representing any other Droplets that share the same physical hardware. An empty array indicates that the Droplet is not co-located any other Droplets associated with your account. | + +## `SELECT` examples + +To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on the same physical hardware) for a specific Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/neighbors`. The results will be returned as a JSON object with a key of `droplets`. This will be set to an array containing objects representing any other Droplets that share the same physical hardware. An empty array indicates that the Droplet is not co-located any other Droplets associated with your account. + + +```sql +SELECT +id, +name, +backup_ids, +created_at, +disk, +disk_info, +features, +gpu_info, +image, +kernel, +locked, +memory, +networks, +next_backup_window, +region, +size, +size_slug, +snapshot_ids, +status, +tags, +vcpus, +volume_ids, +vpc_uuid +FROM digitalocean.droplets.neighbors +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/reports_droplet_neighbors_ids/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/reports_droplet_neighbors_ids/index.md new file mode 100644 index 0000000000..0dd6fcabbf --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/reports_droplet_neighbors_ids/index.md @@ -0,0 +1,50 @@ +--- +title: reports_droplet_neighbors_ids +hide_title: false +hide_table_of_contents: false +keywords: + - reports_droplet_neighbors_ids + - droplets + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a reports_droplet_neighbors_ids resource. + +## Overview +
+ + + +
Namereports_droplet_neighbors_ids
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `integer` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`. The results will be returned as a JSON object with a key of `neighbor_ids`. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server. An empty array indicates that all Droplets associated with your account are located on separate physical hardware. | + +## `SELECT` examples + +To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`. The results will be returned as a JSON object with a key of `neighbor_ids`. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server. An empty array indicates that all Droplets associated with your account are located on separate physical hardware. + + +```sql +SELECT +column_anon +FROM digitalocean.droplets.reports_droplet_neighbors_ids +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md index 40cb5e4fd5..a1cf886e96 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - snapshots - droplets - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a snapshots resource. ## Overview @@ -37,8 +37,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | | | `number` | The billable size of the snapshot in gigabytes. | | | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve the snapshots that have been created from a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/snapshots`. You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot attributes. | + +## `SELECT` examples + +To retrieve the snapshots that have been created from a Droplet, send a GET request to `/v2/droplets/$DROPLET_ID/snapshots`. You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot attributes. + + +```sql +SELECT +id, +name, +created_at, +min_disk_size, +regions, +size_gigabytes, +type +FROM digitalocean.droplets.snapshots +WHERE droplet_id = '{{ droplet_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md index 66164d509c..51bb721c30 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - droplets - firewalls - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a droplets resource. ## Overview
@@ -28,9 +28,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `DELETE` | | To remove a Droplet from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there should
be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `EXEC` | | To assign a Droplet to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there
should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove a Droplet from a firewall, send a DELETE request to `/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there should be a `droplet_ids` attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `EXEC` | | To assign a Droplet to a firewall, send a POST request to `/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there should be a `droplet_ids` attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `DELETE` example + +Deletes the specified droplets resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.firewalls.droplets +WHERE firewall_id = '{{ firewall_id }}' +AND data__droplet_ids = '{{ data__droplet_ids }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md index 070a437797..50e64e78f7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - firewalls - firewalls - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a firewalls resource. ## Overview @@ -30,22 +30,82 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a firewall. | -| | `string` | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall was created. | -| | `array` | An array containing the IDs of the Droplets assigned to the firewall. | -| | `array` | | -| | `array` | | -| | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | -| | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | -| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | -| | `SELECT` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | -| | `INSERT` | | To create a new firewall, send a POST request to `/v2/firewalls`. The request
must contain at least one inbound or outbound access rule.
| -| | `DELETE` | | To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `EXEC` | | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | -| | `EXEC` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | -| | `EXEC` | | To update the configuration of an existing firewall, send a PUT request to
`/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation
of the firewall including existing attributes. **Note that any attributes that
are not provided will be reset to their default values.**
| +| | `SELECT` | | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | +| | `SELECT` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | +| | `INSERT` | | To create a new firewall, send a POST request to `/v2/firewalls`. The request must contain at least one inbound or outbound access rule. | +| | `DELETE` | | To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `EXEC` | | To update the configuration of an existing firewall, send a PUT request to `/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation of the firewall including existing attributes. **Note that any attributes that are not provided will be reset to their default values.** | + +## `SELECT` examples + +To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. + + +```sql +SELECT +column_anon +FROM digitalocean.firewalls.firewalls +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewalls resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.firewalls.firewalls ( + +) +SELECT + +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.firewalls.firewalls ( +data__inbound_rules +) +SELECT +'{{ inbound_rules }}' +; +``` + + + + +```yaml +- name: firewalls + props: [] + +``` + + + +## `DELETE` example + +Deletes the specified firewalls resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.firewalls.firewalls +WHERE firewall_id = '{{ firewall_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md index 295843a2b0..0cd485fa60 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md @@ -9,42 +9,31 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Firewalls - +firewalls service documentation. + :::info Service Summary
total resources: 4
-total selectable resources: 1
-total methods: 13
::: -## Overview -
- - - - - -
Namedigitalocean.firewalls
TypeService
TitleDigitalOcean API - Firewalls
DescriptionFirewalls
Idfirewalls:v23.04.00139
- ## Resources
droplets
-firewalls
+firewalls
rules
-tags
-
+tags
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md index 692dcb30a7..dffaa3cc80 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - rules - firewalls - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a rules resource. ## Overview @@ -28,9 +28,73 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `INSERT` | | To add additional access rules to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
inbound_rules and/or outbound_rules attribute containing an array of rules to
be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `DELETE` | | To remove access rules from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
`inbound_rules` and/or `outbound_rules` attribute containing an array of rules
to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To add additional access rules to a firewall, send a POST request to `/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `DELETE` | | To remove access rules from a firewall, send a DELETE request to `/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an `inbound_rules` and/or `outbound_rules` attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rules resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.firewalls.rules ( +firewall_id +) +SELECT +'{{ firewall_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.firewalls.rules ( +data__inbound_rules, +firewall_id +) +SELECT +'{{ inbound_rules }}', +'{{ firewall_id }}' +; +``` + + + + +```yaml +- name: rules + props: + - name: firewall_id + value: string + +``` + + + +## `DELETE` example + +Deletes the specified rules resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.firewalls.rules +WHERE firewall_id = '{{ firewall_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md index f1488b3ce1..3d69bc0de7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - tags - firewalls - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a tags resource. ## Overview @@ -28,9 +28,65 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `INSERT` | | To assign a tag representing a group of Droplets to a firewall, send a POST
request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the request,
there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `DELETE` | | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the
request, there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To assign a tag representing a group of Droplets to a firewall, send a POST request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the request, there should be a `tags` attribute containing a list of tag names. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `DELETE` | | To remove a tag representing a group of Droplets from a firewall, send a DELETE request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the request, there should be a `tags` attribute containing a list of tag names. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tags resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.firewalls.tags ( +data__tags, +firewall_id +) +SELECT +'{{ tags }}', +'{{ firewall_id }}' +; +``` + + + + +```yaml +- name: tags + props: + - name: firewall_id + value: string + - name: data__tags + value: string + - name: tags + value: array + +``` + + + +## `DELETE` example + +Deletes the specified tags resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.firewalls.tags +WHERE firewall_id = '{{ firewall_id }}' +AND data__tags = '{{ data__tags }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md index e691a10bf6..fd609de09f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - actions - floating_ips - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a actions resource. ## Overview @@ -30,20 +30,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| | `object` | | -| | `string` | A human-readable string that is used as a unique identifier for each region. | -| | `integer` | A unique identifier for the resource that the action is associated with. | -| | `string` | The type of resource that the action is associated with. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| | `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. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | -| | `SELECT` | | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | -| | `INSERT` | | To initiate an action on a floating IP send a POST request to
`/v2/floating_ips/$FLOATING_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a floating IP to a Droplet
\| `unassign` \| Unassign a floating IP from a Droplet
| -| | `EXEC` | | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | -| | `EXEC` | | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | +| | `SELECT` | | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | +| | `EXEC` | | To initiate an action on a floating IP send a POST request to `/v2/floating_ips/$FLOATING_IP/actions`. In the JSON body to the request, set the `type` attribute to on of the supported action types: \| Action \| Details \|------------\|-------- \| `assign` \| Assigns a floating IP to a Droplet \| `unassign` \| Unassign a floating IP from a Droplet | + +## `SELECT` examples + +To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. + + +```sql +SELECT +column_anon +FROM digitalocean.floating_ips.actions +WHERE floating_ip = '{{ floating_ip }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md index d6982c3d3e..bcbd08ceb6 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - floating_ips - floating_ips - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a floating_ips resource. ## Overview
@@ -35,12 +35,73 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `boolean` | A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted. | | | `string` | The UUID of the project to which the reserved IP currently belongs. | | | `object` | The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | -| | `SELECT` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | -| | `INSERT` | | On creation, a floating IP must be either assigned to a Droplet or reserved to a region.
* To create a new floating IP assigned to a Droplet, send a POST
request to `/v2/floating_ips` with the `droplet_id` attribute.

* To create a new floating IP reserved to a region, send a POST request to
`/v2/floating_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. | -| | `DELETE` | | To delete a floating IP and remove it from your account, send a DELETE request
to `/v2/floating_ips/$FLOATING_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | -| | `EXEC` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | +| | `SELECT` | | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | +| | `SELECT` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | +| | `INSERT` | | On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to `/v2/floating_ips` with the `droplet_id` attribute. * To create a new floating IP reserved to a region, send a POST request to `/v2/floating_ips` with the `region` attribute. **Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. | +| | `DELETE` | | To delete a floating IP and remove it from your account, send a DELETE request to `/v2/floating_ips/$FLOATING_IP_ADDR`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | + +## `SELECT` examples + +To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. + + +```sql +SELECT +droplet, +ip, +locked, +project_id, +region +FROM digitalocean.floating_ips.floating_ips +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new floating_ips resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.floating_ips.floating_ips ( +data__droplet_id +) +SELECT +'{{ droplet_id }}' +; +``` + + + + +```yaml +- name: floating_ips + props: + - name: droplet_id + value: integer + +``` + + + +## `DELETE` example + +Deletes the specified floating_ips resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.floating_ips.floating_ips +WHERE floating_ip = '{{ floating_ip }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md index 682d04dd2e..1d4160faab 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Floating IPs - +floating_ips service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 11
::: -## Overview -
- - - - - -
Namedigitalocean.floating_ips
TypeService
TitleDigitalOcean API - Floating Ips
DescriptionFloating IPs
Idfloating_ips:v23.04.00139
- ## Resources
-actions
+actions
-floating_ips
-
+floating_ips
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/index.md index 59afd309a7..54e05ed8b2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/functions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/functions/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Functions - +functions service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 13
::: -## Overview - - - - - - -
Namedigitalocean.functions
TypeService
TitleDigitalOcean API - Functions
DescriptionFunctions
Idfunctions:v23.04.00139
- ## Resources
-namespace_triggers
+namespaces
-namespaces
-
+namespaces_triggers
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md deleted file mode 100644 index 85ba4770a1..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: namespace_triggers -hide_title: false -hide_table_of_contents: false -keywords: - - namespace_triggers - - functions - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namenamespace_triggers
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The trigger's unique name within the namespace. | -| | `string` | UTC time string. | -| | `string` | Name of function(action) that exists in the given namespace. | -| | `boolean` | Indicates weather the trigger is paused or unpaused. | -| | `string` | A unique string format of UUID with a prefix fn-. | -| | `object` | Trigger details for SCHEDULED type, where body is optional.
| -| | `object` | | -| | `string` | String which indicates the type of trigger source like SCHEDULED. | -| | `string` | UTC time string. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | -| | `SELECT` | | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | -| | `INSERT` | | Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers` with the `name`, `function`, `type`, `is_enabled` and `scheduled_details` properties. | -| | `DELETE` | | Deletes the given trigger.
To delete trigger, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`.
A successful deletion returns a 204 response. | -| | `EXEC` | | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | -| | `EXEC` | | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | -| | `EXEC` | | Updates the details of the given trigger. To update a trigger, send a PUT request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME` with new values for the `is_enabled ` or `scheduled_details` properties. | diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md index 87cadb23eb..d45f6f7107 100644 --- a/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - namespaces - functions - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a namespaces resource. ## Overview @@ -32,18 +32,90 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; |:-----|:---------|:------------| | | `string` | The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. | | | `string` | UTC time string. | -| | `string` | A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate
a user to use the namespace via `doctl`, DigitalOcean's official CLI. | +| | `string` | A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate a user to use the namespace via `doctl`, DigitalOcean's official CLI. | | | `string` | The namespace's unique name. | | | `string` | A unique string format of UUID with a prefix fn-. | | | `string` | The namespace's datacenter region. | | | `string` | UTC time string. | | | `string` | The namespace's Universally Unique Identifier. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | -| | `SELECT` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | -| | `INSERT` | | Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to `/v2/functions/namespaces` with the `region` and `label` properties. | -| | `DELETE` | | Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes.
To delete namespace, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID`.
A successful deletion returns a 204 response. | -| | `EXEC` | | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | -| | `EXEC` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | +| | `SELECT` | | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | +| | `SELECT` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | +| | `INSERT` | | Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to `/v2/functions/namespaces` with the `region` and `label` properties. | +| | `DELETE` | | Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID`. A successful deletion returns a 204 response. | + +## `SELECT` examples + +Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. + + +```sql +SELECT +api_host, +created_at, +key, +label, +namespace, +region, +updated_at, +uuid +FROM digitalocean.functions.namespaces +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new namespaces resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.functions.namespaces ( +data__region, +data__label +) +SELECT +'{{ region }}', +'{{ label }}' +; +``` + + + + +```yaml +- name: namespaces + props: + - name: data__label + value: string + - name: data__region + value: string + - name: region + value: string + - name: label + value: string + +``` + + + +## `DELETE` example + +Deletes the specified namespaces resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.functions.namespaces +WHERE namespace_id = '{{ namespace_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/namespaces_triggers/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces_triggers/index.md new file mode 100644 index 0000000000..07a22ad0dd --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces_triggers/index.md @@ -0,0 +1,153 @@ +--- +title: namespaces_triggers +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces_triggers + - functions + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a namespaces_triggers resource. + +## Overview +
+ + + +
Namenamespaces_triggers
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The trigger's unique name within the namespace. | +| | `string` | UTC time string. | +| | `string` | Name of function(action) that exists in the given namespace. | +| | `boolean` | Indicates weather the trigger is paused or unpaused. | +| | `string` | A unique string format of UUID with a prefix fn-. | +| | `object` | Trigger details for SCHEDULED type, where body is optional. | +| | `object` | | +| | `string` | String which indicates the type of trigger source like SCHEDULED. | +| | `string` | UTC time string. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | +| | `SELECT` | | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | +| | `INSERT` | | Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers` with the `name`, `function`, `type`, `is_enabled` and `scheduled_details` properties. | +| | `DELETE` | | Deletes the given trigger. To delete trigger, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. A successful deletion returns a 204 response. | +| | `EXEC` | | Updates the details of the given trigger. To update a trigger, send a PUT request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME` with new values for the `is_enabled ` or `scheduled_details` properties. | + +## `SELECT` examples + +Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. + + +```sql +SELECT +name, +created_at, +function, +is_enabled, +namespace, +scheduled_details, +scheduled_runs, +type, +updated_at +FROM digitalocean.functions.namespaces_triggers +WHERE namespace_id = '{{ namespace_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new namespaces_triggers resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.functions.namespaces_triggers ( +data__name, +data__function, +data__type, +data__is_enabled, +data__scheduled_details, +namespace_id +) +SELECT +'{{ name }}', +'{{ function }}', +'{{ type }}', +'{{ is_enabled }}', +'{{ scheduled_details }}', +'{{ namespace_id }}' +; +``` + + + + +```yaml +- name: namespaces_triggers + props: + - name: namespace_id + value: string + - name: data__function + value: string + - name: data__is_enabled + value: string + - name: data__name + value: string + - name: data__scheduled_details + value: string + - name: data__type + value: string + - name: name + value: string + - name: function + value: string + - name: type + value: string + - name: is_enabled + value: boolean + - name: scheduled_details + props: + - name: cron + value: string + - name: body + props: + - name: name + value: string + +``` + + + +## `DELETE` example + +Deletes the specified namespaces_triggers resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.functions.namespaces_triggers +WHERE namespace_id = '{{ namespace_id }}' +AND trigger_name = '{{ trigger_name }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md index 079d6da623..667c32c10b 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - actions - images - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a actions resource. ## Overview @@ -39,11 +39,30 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | | | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | | | `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. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | -| | `SELECT` | | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | -| | `INSERT` | | The following actions are available on an Image.

## Convert an Image to a Snapshot

To convert an image, for example, a backup to a snapshot, send a POST request
to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `convert`.

## Transfer an Image

To transfer an image to another region, send a POST request to
`/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `transfer` and set
`region` attribute to the slug identifier of the region you wish to transfer
to.
| -| | `EXEC` | | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | -| | `EXEC` | | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | +| | `SELECT` | | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | +| | `EXEC` | | The following actions are available on an Image. ## Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `convert`. ## Transfer an Image To transfer an image to another region, send a POST request to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `transfer` and set `region` attribute to the slug identifier of the region you wish to transfer to. | + +## `SELECT` examples + +To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. + + +```sql +SELECT +id, +completed_at, +region, +region_slug, +resource_id, +resource_type, +started_at, +status, +type +FROM digitalocean.images.actions +WHERE image_id = '{{ image_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/images/images/index.md b/docs/digitalocean-docs/providers/digitalocean/images/images/index.md index fd52226411..a09fb38a26 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/images/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/images/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - images - images - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a images resource. ## Overview
@@ -31,26 +31,116 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | Name | Datatype | Description | |:-----|:---------|:------------| | | `integer` | A unique number that can be used to identify and reference a specific image. | -| | `string` | The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. | +| | `string` | The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. | | | `string` | An optional free-form text field to describe an image. | | | `string` | A time value given in ISO8601 combined date and time format that represents when the image was created. | -| | `string` | The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. | -| | `string` | A string containing information about errors that may occur when importing
a custom image. | +| | `string` | The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. | +| | `string` | A string containing information about errors that may occur when importing a custom image. | | | `integer` | The minimum disk size in GB required for a Droplet to use this image. | | | `boolean` | This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account. | | | `array` | This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. | | | `number` | The size of the image in gigabytes. | | | `string` | A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. | -| | `string` | A status string indicating the state of a custom image. This may be `NEW`,
`available`, `pending`, `deleted`, or `retired`. | +| | `string` | A status string indicating the state of a custom image. This may be `NEW`, `available`, `pending`, `deleted`, or `retired`. | | | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | | | `string` | Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes). | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| -| | `SELECT` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| -| | `INSERT` | | To create a new custom image, send a POST request to /v2/images.
The body must contain a url attribute pointing to a Linux virtual machine
image to be imported into DigitalOcean.
The image must be in the raw, qcow2, vhdx, vdi, or vmdk format.
It may be compressed using gzip or bzip2 and must be smaller than 100 GB after
being decompressed.
| -| | `DELETE` | | To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IMAGE_ID`.
| -| | `EXEC` | | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| -| | `EXEC` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| -| | `EXEC` | | To update an image, send a `PUT` request to `/v2/images/$IMAGE_ID`.
Set the `name` attribute to the new value you would like to use.
For custom images, the `description` and `distribution` attributes may also be updated.
| +| | `SELECT` | | To retrieve information about an image, send a `GET` request to `/v2/images/$IDENTIFIER`. | +| | `SELECT` | | To list all of the images available on your account, send a GET request to /v2/images. ## Filtering Results ----- It's possible to request filtered results by including certain query parameters. **Image Type** Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter. > Important: The `type` query parameter does not directly relate to the `type` attribute. To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`. To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`. **User Images** To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`. **Tags** To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`. | +| | `INSERT` | | To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB after being decompressed. | +| | `DELETE` | | To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IMAGE_ID`. | +| | `EXEC` | | To update an image, send a `PUT` request to `/v2/images/$IMAGE_ID`. Set the `name` attribute to the new value you would like to use. For custom images, the `description` and `distribution` attributes may also be updated. | + +## `SELECT` examples + +To list all of the images available on your account, send a GET request to /v2/images. ## Filtering Results ----- It's possible to request filtered results by including certain query parameters. **Image Type** Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter. > Important: The `type` query parameter does not directly relate to the `type` attribute. To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`. To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`. **User Images** To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`. **Tags** To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`. + + +```sql +SELECT +id, +name, +description, +created_at, +distribution, +error_message, +min_disk_size, +public, +regions, +size_gigabytes, +slug, +status, +tags, +type +FROM digitalocean.images.images +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new images resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.images.images ( +data__name, +data__distribution, +data__description, +data__url, +data__region, +data__tags +) +SELECT +'{{ name }}', +'{{ distribution }}', +'{{ description }}', +'{{ url }}', +'{{ region }}', +'{{ tags }}' +; +``` + + + + +```yaml +- name: images + props: + - name: name + value: string + - name: distribution + value: string + - name: description + value: string + - name: url + value: string + - name: region + value: string + - name: tags + value: array + +``` + + + +## `DELETE` example + +Deletes the specified images resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.images.images +WHERE image_id = '{{ image_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/images/index.md b/docs/digitalocean-docs/providers/digitalocean/images/index.md index 2642e17808..ddfe23ba79 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Images - +images service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 12
::: -## Overview -
- - - - - -
Namedigitalocean.images
TypeService
TitleDigitalOcean API - Images
DescriptionImages
Idimages:v23.04.00139
- ## Resources
-actions
+actions
-images
-
+images
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md deleted file mode 100644 index fc505b6b80..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: clusterlint -hide_title: false -hide_table_of_contents: false -keywords: - - clusterlint - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameclusterlint
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed. | -| | `array` | An array of diagnostics reporting potential problems for the given cluster. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made. | -| | `string` | Id of the clusterlint run that can be used later to fetch the diagnostics. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To request clusterlint diagnostics for your cluster, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. If the `run_id` query
parameter is provided, then the diagnostics for the specific run is fetched.
By default, the latest results are shown.

To find out how to address clusterlint feedback, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| -| | `EXEC` | | Clusterlint helps operators conform to Kubernetes best practices around
resources, security and reliability to avoid common problems while operating
or upgrading the clusters.

To request a clusterlint run on your cluster, send a POST request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. This will run all
checks present in the `doks` group by default, if a request body is not
specified. Optionally specify the below attributes.

For information about the available checks, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md index ba6723bef4..8383f1029a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - clusters - kubernetes - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a clusters resource. ## Overview @@ -30,37 +30,184 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a Kubernetes cluster. | -| | `string` | A human-readable name for a Kubernetes cluster. | -| | `boolean` | A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. | -| | `string` | The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created. | -| | `string` | The base URL of the API server on the Kubernetes master node. | -| | `boolean` | A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. | -| | `string` | The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+) | -| | `object` | An object specifying the maintenance window policy for the Kubernetes cluster. | -| | `array` | An object specifying the details of the worker nodes available to the Kubernetes cluster. | -| | `string` | The slug identifier for the region where the Kubernetes cluster is located. | -| | `boolean` | A read-only boolean value indicating if a container registry is integrated with the cluster. | -| | `string` | The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. | -| | `object` | An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster. | -| | `boolean` | A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. | -| | `array` | An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. | -| | `string` | The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. "1.14"), the latest version within it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions. | -| | `string` | A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| -| | `SELECT` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| -| | `INSERT` | | To create a new Kubernetes cluster, send a POST request to
`/v2/kubernetes/clusters`. The request must contain at least one node pool
with at least one worker.

The request may contain a maintenance window policy describing a time period
when disruptive maintenance tasks may be carried out. Omitting the policy
implies that a window will be chosen automatically. See
[here](https://www.digitalocean.com/docs/kubernetes/how-to/upgrade-cluster/)
for details.
| -| | `DELETE` | | To delete a Kubernetes cluster and all services deployed to it, send a DELETE
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.

A 204 status code with no body will be returned in response to a successful
request.
| -| | `EXEC` | | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| -| | `EXEC` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| -| | `EXEC` | | To delete a Kubernetes cluster with all of its associated resources, send a
DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous`.
A 204 status code with no body will be returned in response to a successful request.
| -| | `EXEC` | | To delete a Kubernetes cluster along with a subset of its associated resources,
send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective`.

The JSON body of the request should include `load_balancers`, `volumes`, or
`volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed.

The IDs can be found by querying the cluster's associated resources endpoint.
Any associated resource not included in the request will remain and continue
to accrue changes on your account.
| -| | `EXEC` | | This endpoint returns a kubeconfig file in YAML format. It can be used to
connect to and administer the cluster using the Kubernetes command line tool,
`kubectl`, or other programs supporting kubeconfig files (e.g., client libraries).

The resulting kubeconfig file uses token-based authentication for clusters
supporting it, and certificate-based authentication otherwise. For a list of
supported versions and more information, see "[How to Connect to a DigitalOcean
Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)".

To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`.

Clusters supporting token-based authentication may define an expiration by
passing a duration in seconds as a query parameter to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS`.
If not set or 0, then the token will have a 7 day expiry. The query parameter
has no impact in certificate-based authentication.
| -| | `EXEC` | | To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint. | -| | `EXEC` | | To update a Kubernetes cluster, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the
attributes below.
| -| | `EXEC` | | To immediately upgrade a Kubernetes cluster to a newer patch release of
Kubernetes, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade`.
The body of the request must specify a version attribute.

Available upgrade versions for a cluster can be fetched from
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`.
| +| | `SELECT` | | To show information about an existing Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`. | +| | `SELECT` | | To list all of the Kubernetes clusters on your account, send a GET request to `/v2/kubernetes/clusters`. | +| | `INSERT` | | To create a new Kubernetes cluster, send a POST request to `/v2/kubernetes/clusters`. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See [here](https://docs.digitalocean.com/products/kubernetes/how-to/upgrade-cluster/) for details. | +| | `DELETE` | | To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`. A 204 status code with no body will be returned in response to a successful request. | +| | `EXEC` | | To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous`. A 204 status code with no body will be returned in response to a successful request. | +| | `EXEC` | | To delete a Kubernetes cluster along with a subset of its associated resources, send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective`. The JSON body of the request should include `load_balancers`, `volumes`, or `volume_snapshots` keys each set to an array of IDs for the associated resources to be destroyed. The IDs can be found by querying the cluster's associated resources endpoint. Any associated resource not included in the request will remain and continue to accrue changes on your account. | +| | `EXEC` | | This endpoint returns a kubeconfig file in YAML format. It can be used to connect to and administer the cluster using the Kubernetes command line tool, `kubectl`, or other programs supporting kubeconfig files (e.g., client libraries). The resulting kubeconfig file uses token-based authentication for clusters supporting it, and certificate-based authentication otherwise. For a list of supported versions and more information, see "[How to Connect to a DigitalOcean Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`. Clusters supporting token-based authentication may define an expiration by passing a duration in seconds as a query parameter to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS`. If not set or 0, then the token will have a 7 day expiry. The query parameter has no impact in certificate-based authentication. | +| | `EXEC` | | To update a Kubernetes cluster, send a PUT request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the attributes below. | +| | `EXEC` | | To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade`. The body of the request must specify a version attribute. Available upgrade versions for a cluster can be fetched from `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`. | + +## `SELECT` examples + +To list all of the Kubernetes clusters on your account, send a GET request to `/v2/kubernetes/clusters`. + + +```sql +SELECT +column_anon +FROM digitalocean.kubernetes.clusters +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new clusters resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.kubernetes.clusters ( +data__name, +data__region, +data__version, +data__cluster_subnet, +data__service_subnet, +data__vpc_uuid, +data__tags, +data__node_pools, +data__maintenance_policy, +data__auto_upgrade, +data__surge_upgrade, +data__ha, +data__control_plane_firewall +) +SELECT +'{{ name }}', +'{{ region }}', +'{{ version }}', +'{{ cluster_subnet }}', +'{{ service_subnet }}', +'{{ vpc_uuid }}', +'{{ tags }}', +'{{ node_pools }}', +'{{ maintenance_policy }}', +'{{ auto_upgrade }}', +'{{ surge_upgrade }}', +'{{ ha }}', +'{{ control_plane_firewall }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.kubernetes.clusters ( +data__name, +data__region, +data__version, +data__node_pools +) +SELECT +'{{ name }}', +'{{ region }}', +'{{ version }}', +'{{ node_pools }}' +; +``` + + + + +```yaml +- name: clusters + props: + - name: data__name + value: string + - name: data__node_pools + value: string + - name: data__region + value: string + - name: data__version + value: string + - name: name + value: string + - name: region + value: string + - name: version + value: string + - name: cluster_subnet + value: string + - name: service_subnet + value: string + - name: vpc_uuid + value: string + - name: tags + value: array + - name: node_pools + value: array + props: + - name: size + value: string + - name: name + value: string + - name: count + value: integer + - name: tags + value: array + - name: labels + value: object + - name: taints + value: array + props: + - name: key + value: string + - name: value + value: string + - name: effect + value: string + - name: auto_scale + value: boolean + - name: min_nodes + value: integer + - name: max_nodes + value: integer + - name: maintenance_policy + props: + - name: start_time + value: string + - name: day + value: string + - name: auto_upgrade + value: boolean + - name: surge_upgrade + value: boolean + - name: ha + value: boolean + - name: control_plane_firewall + props: + - name: enable + value: boolean + - name: allowed_addresses + value: array + +``` + + + +## `DELETE` example + +Deletes the specified clusters resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.kubernetes.clusters +WHERE cluster_id = '{{ cluster_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_associated_resources/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_associated_resources/index.md new file mode 100644 index 0000000000..0eaae1982a --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_associated_resources/index.md @@ -0,0 +1,54 @@ +--- +title: clusters_associated_resources +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_associated_resources + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_associated_resources resource. + +## Overview +
+ + + +
Nameclusters_associated_resources
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | A list of names and IDs for associated load balancers that can be destroyed along with the cluster. | +| | `array` | A list of names and IDs for associated volume snapshots that can be destroyed along with the cluster. | +| | `array` | A list of names and IDs for associated volumes that can be destroyed along with the cluster. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint. | + +## `SELECT` examples + +To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint. + + +```sql +SELECT +load_balancers, +volume_snapshots, +volumes +FROM digitalocean.kubernetes.clusters_associated_resources +WHERE cluster_id = '{{ cluster_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_available_upgrades/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_available_upgrades/index.md new file mode 100644 index 0000000000..3f9a6ba7fc --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_available_upgrades/index.md @@ -0,0 +1,54 @@ +--- +title: clusters_available_upgrades +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_available_upgrades + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_available_upgrades resource. + +## Overview + + + + +
Nameclusters_available_upgrades
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The upstream version string for the version of Kubernetes provided by a given slug. | +| | `string` | The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision. | +| | `array` | The features available with the version of Kubernetes provided by a given slug. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`. | + +## `SELECT` examples + +To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`. + + +```sql +SELECT +kubernetes_version, +slug, +supported_features +FROM digitalocean.kubernetes.clusters_available_upgrades +WHERE cluster_id = '{{ cluster_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_clusterlints/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_clusterlints/index.md new file mode 100644 index 0000000000..9db29d5468 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_clusterlints/index.md @@ -0,0 +1,57 @@ +--- +title: clusters_clusterlints +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_clusterlints + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_clusterlints resource. + +## Overview + + + + +
Nameclusters_clusterlints
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed. | +| | `array` | An array of diagnostics reporting potential problems for the given cluster. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made. | +| | `string` | Id of the clusterlint run that can be used later to fetch the diagnostics. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To request clusterlint diagnostics for your cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. If the `run_id` query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to [the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md). | +| | `EXEC` | | Clusterlint helps operators conform to Kubernetes best practices around resources, security and reliability to avoid common problems while operating or upgrading the clusters. To request a clusterlint run on your cluster, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. This will run all checks present in the `doks` group by default, if a request body is not specified. Optionally specify the below attributes. For information about the available checks, please refer to [the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md). | + +## `SELECT` examples + +To request clusterlint diagnostics for your cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. If the `run_id` query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to [the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md). + + +```sql +SELECT +completed_at, +diagnostics, +requested_at, +run_id +FROM digitalocean.kubernetes.clusters_clusterlints +WHERE cluster_id = '{{ cluster_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_credentials/index.md new file mode 100644 index 0000000000..c732499fd8 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_credentials/index.md @@ -0,0 +1,60 @@ +--- +title: clusters_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_credentials + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_credentials resource. + +## Overview + + + + +
Nameclusters_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A base64 encoding of bytes representing the certificate authority data for accessing the cluster. | +| | `string` | A base64 encoding of bytes representing the x509 client certificate data for access the cluster. This is only returned for clusters without support for token-based authentication. Newly created Kubernetes clusters do not return credentials using certificate-based authentication. For additional information, [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). | +| | `string` | A base64 encoding of bytes representing the x509 client key data for access the cluster. This is only returned for clusters without support for token-based authentication. Newly created Kubernetes clusters do not return credentials using certificate-based authentication. For additional information, [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the access token expires. | +| | `string` | The URL used to access the cluster API server. | +| | `string` | An access token used to authenticate with the cluster. This is only returned for clusters with support for token-based authentication. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This endpoint returns a JSON object . It can be used to programmatically construct Kubernetes clients which cannot parse kubeconfig files. The resulting JSON object contains token-based authentication for clusters supporting it, and certificate-based authentication otherwise. For a list of supported versions and more information, see "[How to Connect to a DigitalOcean Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". To retrieve credentials for accessing a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials`. Clusters supporting token-based authentication may define an expiration by passing a duration in seconds as a query parameter to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials?expiry_seconds=$DURATION_IN_SECONDS`. If not set or 0, then the token will have a 7 day expiry. The query parameter has no impact in certificate-based authentication. | + +## `SELECT` examples + +This endpoint returns a JSON object . It can be used to programmatically construct Kubernetes clients which cannot parse kubeconfig files. The resulting JSON object contains token-based authentication for clusters supporting it, and certificate-based authentication otherwise. For a list of supported versions and more information, see "[How to Connect to a DigitalOcean Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". To retrieve credentials for accessing a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials`. Clusters supporting token-based authentication may define an expiration by passing a duration in seconds as a query parameter to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials?expiry_seconds=$DURATION_IN_SECONDS`. If not set or 0, then the token will have a 7 day expiry. The query parameter has no impact in certificate-based authentication. + + +```sql +SELECT +certificate_authority_data, +client_certificate_data, +client_key_data, +expires_at, +server, +token +FROM digitalocean.kubernetes.clusters_credentials +WHERE cluster_id = '{{ cluster_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools/index.md new file mode 100644 index 0000000000..475e7ae08d --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools/index.md @@ -0,0 +1,158 @@ +--- +title: clusters_node_pools +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_node_pools + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_node_pools resource. + +## Overview + + + + +
Nameclusters_node_pools
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about a specific node pool in a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`. | +| | `SELECT` | | To list all of the node pools in a Kubernetes clusters, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`. | +| | `INSERT` | | To add an additional node pool to a Kubernetes clusters, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools` with the following attributes. | +| | `DELETE` | | To delete a node pool, send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted. | +| | `EXEC` | | The endpoint has been deprecated. Please use the DELETE `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID` method instead. | +| | `EXEC` | | To update the name of a node pool, edit the tags applied to it, or adjust its number of nodes, send a PUT request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID` with the following attributes. | + +## `SELECT` examples + +To list all of the node pools in a Kubernetes clusters, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`. + + +```sql +SELECT +column_anon +FROM digitalocean.kubernetes.clusters_node_pools +WHERE cluster_id = '{{ cluster_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new clusters_node_pools resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.kubernetes.clusters_node_pools ( +data__size, +data__name, +data__count, +data__tags, +data__labels, +data__taints, +data__auto_scale, +data__min_nodes, +data__max_nodes, +cluster_id +) +SELECT +'{{ size }}', +'{{ name }}', +'{{ count }}', +'{{ tags }}', +'{{ labels }}', +'{{ taints }}', +'{{ auto_scale }}', +'{{ min_nodes }}', +'{{ max_nodes }}', +'{{ cluster_id }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.kubernetes.clusters_node_pools ( +cluster_id +) +SELECT +'{{ cluster_id }}' +; +``` + + + + +```yaml +- name: clusters_node_pools + props: + - name: cluster_id + value: string + - name: size + value: string + - name: name + value: string + - name: count + value: integer + - name: tags + value: array + - name: labels + value: object + - name: taints + value: array + props: + - name: key + value: string + - name: value + value: string + - name: effect + value: string + - name: auto_scale + value: boolean + - name: min_nodes + value: integer + - name: max_nodes + value: integer + +``` + + + +## `DELETE` example + +Deletes the specified clusters_node_pools resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.kubernetes.clusters_node_pools +WHERE cluster_id = '{{ cluster_id }}' +AND node_pool_id = '{{ node_pool_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools_nodes/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools_nodes/index.md new file mode 100644 index 0000000000..6a7690162b --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_node_pools_nodes/index.md @@ -0,0 +1,49 @@ +--- +title: clusters_node_pools_nodes +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_node_pools_nodes + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_node_pools_nodes resource. + +## Overview + + + + +
Nameclusters_node_pools_nodes
TypeResource
Id
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | To delete a single node in a pool, send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID`. Appending the `skip_drain=1` query parameter to the request causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. Appending the `replace=1` query parameter to the request causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. | + +## `DELETE` example + +Deletes the specified clusters_node_pools_nodes resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.kubernetes.clusters_node_pools_nodes +WHERE cluster_id = '{{ cluster_id }}' +AND node_id = '{{ node_id }}' +AND node_pool_id = '{{ node_pool_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_users/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_users/index.md new file mode 100644 index 0000000000..1c1601a2a9 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters_users/index.md @@ -0,0 +1,52 @@ +--- +title: clusters_users +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_users + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a clusters_users resource. + +## Overview + + + + +
Nameclusters_users
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `array` | A list of in-cluster groups that the user belongs to. | +| | `string` | The username for the cluster admin user. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information the user associated with a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/user`. | + +## `SELECT` examples + +To show information the user associated with a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/user`. + + +```sql +SELECT +groups, +username +FROM digitalocean.kubernetes.clusters_users +WHERE cluster_id = '{{ cluster_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md deleted file mode 100644 index 7883f8a044..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: container_registry -hide_title: false -hide_table_of_contents: false -keywords: - - container_registry - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecontainer_registry
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `INSERT` | | To integrate the container registry with Kubernetes clusters, send a POST request to `/v2/kubernetes/registry`. | -| | `DELETE` | | To remove the container registry from Kubernetes clusters, send a DELETE request to `/v2/kubernetes/registry`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md deleted file mode 100644 index 77dfaea518..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: credentials -hide_title: false -hide_table_of_contents: false -keywords: - - credentials - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecredentials
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A base64 encoding of bytes representing the certificate authority data for accessing the cluster. | -| | `string` | A base64 encoding of bytes representing the x509 client
certificate data for access the cluster. This is only returned for clusters
without support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| -| | `string` | A base64 encoding of bytes representing the x509 client key
data for access the cluster. This is only returned for clusters without
support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| -| | `string` | A time value given in ISO8601 combined date and time format that represents when the access token expires. | -| | `string` | The URL used to access the cluster API server. | -| | `string` | An access token used to authenticate with the cluster. This is only returned for clusters with support for token-based authentication. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md index 9b9fcbe427..5afd191619 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md @@ -9,47 +9,37 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Kubernetes - +kubernetes service documentation. + :::info Service Summary
-total resources: 9
-total selectable resources: 7
-total methods: 31
+total resources: 10
::: -## Overview - - - - - - -
Namedigitalocean.kubernetes
TypeService
TitleDigitalOcean API - Kubernetes
DescriptionKubernetes
Idkubernetes:v23.04.00139
- ## Resources
-clusterlint
clusters
-container_registry
-credentials
-node_pools
+clusters_associated_resources
+clusters_available_upgrades
+clusters_clusterlints
+clusters_credentials
-nodes
+clusters_node_pools
+clusters_node_pools_nodes
+clusters_users
options
-upgrades
-user
-
+registries
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md deleted file mode 100644 index 87238af330..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: node_pools -hide_title: false -hide_table_of_contents: false -keywords: - - node_pools - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namenode_pools
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a specific node pool. | -| | `string` | A human-readable name for the node pool. | -| | `boolean` | A boolean value indicating whether auto-scaling is enabled for this node pool. | -| | `integer` | The number of Droplet instances in the node pool. | -| | `object` | An object containing a set of Kubernetes labels. The keys and are values are both user-defined. | -| | `integer` | The maximum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | -| | `integer` | The minimum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | -| | `array` | An object specifying the details of a specific worker node in a node pool. | -| | `string` | The slug identifier for the type of Droplet used as workers in the node pool. | -| | `array` | An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`. | -| | `array` | An array of taints to apply to all nodes in a pool. Taints will automatically be applied to all existing nodes and any subsequent nodes added to the pool. When a taint is removed, it is removed from all nodes in the pool. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| -| | `SELECT` | | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| -| | `INSERT` | | To add an additional node pool to a Kubernetes clusters, send a POST request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools` with the following
attributes.
| -| | `DELETE` | | To delete a node pool, send a DELETE request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.

A 204 status code with no body will be returned in response to a successful
request. Nodes in the pool will subsequently be drained and deleted.
| -| | `EXEC` | | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| -| | `EXEC` | | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| -| | `EXEC` | | The endpoint has been deprecated. Please use the DELETE
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID`
method instead.
| -| | `EXEC` | | To update the name of a node pool, edit the tags applied to it, or adjust its
number of nodes, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID` with the
following attributes.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md deleted file mode 100644 index f3b7414658..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: nodes -hide_title: false -hide_table_of_contents: false -keywords: - - nodes - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namenodes
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `DELETE` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md index 42eab0688c..222520eeae 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - options - kubernetes - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a options resource. ## Overview @@ -28,7 +28,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to `/v2/kubernetes/options`. | + +## `SELECT` examples + +To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to `/v2/kubernetes/options`. + + +```sql +SELECT +column_anon +FROM digitalocean.kubernetes.options +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/registries/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/registries/index.md new file mode 100644 index 0000000000..76e34517a0 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/registries/index.md @@ -0,0 +1,85 @@ +--- +title: registries +hide_title: false +hide_table_of_contents: false +keywords: + - registries + - kubernetes + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a registries resource. + +## Overview + + + + +
Nameregistries
TypeResource
Id
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | To integrate the container registry with Kubernetes clusters, send a POST request to `/v2/kubernetes/registry`. | +| | `DELETE` | | To remove the container registry from Kubernetes clusters, send a DELETE request to `/v2/kubernetes/registry`. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registries resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.kubernetes.registries ( +data__cluster_uuids +) +SELECT +'{{ cluster_uuids }}' +; +``` + + + + +```yaml +- name: registries + props: + - name: cluster_uuids + value: array + +``` + + + +## `DELETE` example + +Deletes the specified registries resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.kubernetes.registries +WHERE = '{{ }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md deleted file mode 100644 index 1e86701614..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: upgrades -hide_title: false -hide_table_of_contents: false -keywords: - - upgrades - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameupgrades
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The upstream version string for the version of Kubernetes provided by a given slug. | -| | `string` | The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision. | -| | `array` | The features available with the version of Kubernetes provided by a given slug. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md deleted file mode 100644 index 47ad2db106..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: user -hide_title: false -hide_table_of_contents: false -keywords: - - user - - kubernetes - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameuser
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | A list of in-cluster groups that the user belongs to. | -| | `string` | The username for the cluster admin user. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md index 7abfdc39a3..871daf3027 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - droplets - load_balancers - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a droplets resource. ## Overview @@ -28,9 +28,65 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `DELETE` | | To remove a Droplet from a load balancer instance, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `EXEC` | | To assign a Droplet to a load balancer instance, send a POST request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.
Individual Droplets can not be added to a load balancer configured with a
Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity"
response from the API.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To assign a Droplet to a load balancer instance, send a POST request to `/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request, there should be a `droplet_ids` attribute containing a list of Droplet IDs. Individual Droplets can not be added to a load balancer configured with a Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity" response from the API. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `DELETE` | | To remove a Droplet from a load balancer instance, send a DELETE request to `/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request, there should be a `droplet_ids` attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new droplets resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.load_balancers.droplets ( +data__droplet_ids, +lb_id +) +SELECT +'{{ droplet_ids }}', +'{{ lb_id }}' +; +``` + + + + +```yaml +- name: droplets + props: + - name: lb_id + value: string + - name: data__droplet_ids + value: string + - name: droplet_ids + value: array + +``` + + + +## `DELETE` example + +Deletes the specified droplets resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.load_balancers.droplets +WHERE lb_id = '{{ lb_id }}' +AND data__droplet_ids = '{{ data__droplet_ids }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md index 5748391147..cbd06580d2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - forwarding_rules - load_balancers - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a forwarding_rules resource. ## Overview @@ -28,9 +28,78 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `DELETE` | | To remove forwarding rules from a load balancer instance, send a DELETE
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the
body of the request, there should be a `forwarding_rules` attribute containing
an array of rules to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| | `EXEC` | | To add an additional forwarding rule to a load balancer instance, send a POST
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the body
of the request, there should be a `forwarding_rules` attribute containing an
array of rules to be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To add an additional forwarding rule to a load balancer instance, send a POST request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the body of the request, there should be a `forwarding_rules` attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | +| | `DELETE` | | To remove forwarding rules from a load balancer instance, send a DELETE request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the body of the request, there should be a `forwarding_rules` attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new forwarding_rules resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.load_balancers.forwarding_rules ( +data__forwarding_rules, +lb_id +) +SELECT +'{{ forwarding_rules }}', +'{{ lb_id }}' +; +``` + + + + +```yaml +- name: forwarding_rules + props: + - name: lb_id + value: string + - name: data__forwarding_rules + value: string + - name: forwarding_rules + value: array + props: + - name: entry_protocol + value: string + - name: entry_port + value: integer + - name: target_protocol + value: string + - name: target_port + value: integer + - name: certificate_id + value: string + - name: tls_passthrough + value: boolean + +``` + + + +## `DELETE` example + +Deletes the specified forwarding_rules resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.load_balancers.forwarding_rules +WHERE lb_id = '{{ lb_id }}' +AND data__forwarding_rules = '{{ data__forwarding_rules }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md index 8c560710cf..b974e4d833 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md @@ -9,41 +9,30 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Load Balancers - +load_balancers service documentation. + :::info Service Summary
total resources: 3
-total selectable resources: 1
-total methods: 11
::: -## Overview - - - - - - -
Namedigitalocean.load_balancers
TypeService
TitleDigitalOcean API - Load Balancers
DescriptionLoad Balancers
Idload_balancers:v23.04.00139
- ## Resources
droplets
-forwarding_rules
+forwarding_rules
-load_balancers
-
+load_balancers
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md index ded8142b48..3da241a1f0 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - load_balancers - load_balancers - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a load_balancers resource. ## Overview @@ -30,35 +30,189 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference a load balancer. | -| | `string` | A human-readable name for a load balancer instance. | -| | `string` | This field has been deprecated. You can no longer specify an algorithm for load balancers. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the load balancer was created. | -| | `boolean` | A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. | -| | `array` | An array containing the IDs of the Droplets assigned to the load balancer. | -| | `boolean` | A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. | -| | `boolean` | A boolean value indicating whether PROXY Protocol is in use. | -| | `object` | An object specifying allow and deny rules to control traffic to the load balancer. | -| | `array` | An array of objects specifying the forwarding rules for a load balancer. | -| | `object` | An object specifying health check settings for the load balancer. | -| | `integer` | An integer value which configures the idle timeout for HTTP requests to the target droplets. | -| | `string` | An attribute containing the public-facing IP address of the load balancer. | -| | `string` | The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. | -| | `boolean` | A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443. | -| | `object` | The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned. | -| | `string` | This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.
* `lb-small` = 1 node
* `lb-medium` = 3 nodes
* `lb-large` = 6 nodes

You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation. | -| | `integer` | How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. | -| | `string` | A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`. | -| | `object` | An object specifying sticky sessions settings for the load balancer. | -| | `string` | The name of a Droplet tag corresponding to Droplets assigned to the load balancer. | -| | `string` | A string specifying the UUID of the VPC to which the load balancer is assigned. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| -| | `SELECT` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| -| | `INSERT` | | To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.

You can specify the Droplets that will sit behind the load balancer using one
of two methods:

* Set `droplet_ids` to a list of specific Droplet IDs.
* Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.

These methods are mutually exclusive.
| -| | `DELETE` | | To delete a load balancer instance, disassociating any Droplets assigned to it
and removing it from your account, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| -| | `EXEC` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| -| | `EXEC` | | To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
| +| | `SELECT` | | To show information about a load balancer instance, send a GET request to `/v2/load_balancers/$LOAD_BALANCER_ID`. | +| | `SELECT` | | To list all of the load balancer instances on your account, send a GET request to `/v2/load_balancers`. | +| | `INSERT` | | To create a new load balancer instance, send a POST request to `/v2/load_balancers`. You can specify the Droplets that will sit behind the load balancer using one of two methods: * Set `droplet_ids` to a list of specific Droplet IDs. * Set `tag` to the name of a tag. All Droplets with this tag applied will be assigned to the load balancer. Additional Droplets will be automatically assigned as they are tagged. These methods are mutually exclusive. | +| | `DELETE` | | To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to `/v2/load_balancers/$LOAD_BALANCER_ID`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | +| | `EXEC` | | To update a load balancer's settings, send a PUT request to `/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full representation of the load balancer including existing attributes. It may contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually exclusive. **Note that any attribute that is not provided will be reset to its default value.** | + +## `SELECT` examples + +To list all of the load balancer instances on your account, send a GET request to `/v2/load_balancers`. + + +```sql +SELECT +column_anon +FROM digitalocean.load_balancers.load_balancers +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new load_balancers resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.load_balancers.load_balancers ( +data__droplet_ids, +data__region, +data__name, +data__project_id, +data__size_unit, +data__size, +data__algorithm, +data__forwarding_rules, +data__health_check, +data__sticky_sessions, +data__redirect_http_to_https, +data__enable_proxy_protocol, +data__enable_backend_keepalive, +data__http_idle_timeout_seconds, +data__vpc_uuid, +data__disable_lets_encrypt_dns_records, +data__firewall, +data__network +) +SELECT +'{{ droplet_ids }}', +'{{ region }}', +'{{ name }}', +'{{ project_id }}', +'{{ size_unit }}', +'{{ size }}', +'{{ algorithm }}', +'{{ forwarding_rules }}', +'{{ health_check }}', +'{{ sticky_sessions }}', +'{{ redirect_http_to_https }}', +'{{ enable_proxy_protocol }}', +'{{ enable_backend_keepalive }}', +'{{ http_idle_timeout_seconds }}', +'{{ vpc_uuid }}', +'{{ disable_lets_encrypt_dns_records }}', +'{{ firewall }}', +'{{ network }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.load_balancers.load_balancers ( +data__forwarding_rules +) +SELECT +'{{ forwarding_rules }}' +; +``` + + + + +```yaml +- name: load_balancers + props: + - name: droplet_ids + value: array + - name: region + value: string + - name: name + value: string + - name: project_id + value: string + - name: size_unit + value: integer + - name: size + value: string + - name: algorithm + value: string + - name: forwarding_rules + value: array + props: + - name: entry_protocol + value: string + - name: entry_port + value: integer + - name: target_protocol + value: string + - name: target_port + value: integer + - name: certificate_id + value: string + - name: tls_passthrough + value: boolean + - name: health_check + props: + - name: protocol + value: string + - name: port + value: integer + - name: path + value: string + - name: check_interval_seconds + value: integer + - name: response_timeout_seconds + value: integer + - name: unhealthy_threshold + value: integer + - name: healthy_threshold + value: integer + - name: sticky_sessions + props: + - name: type + value: string + - name: cookie_name + value: string + - name: cookie_ttl_seconds + value: integer + - name: redirect_http_to_https + value: boolean + - name: enable_proxy_protocol + value: boolean + - name: enable_backend_keepalive + value: boolean + - name: http_idle_timeout_seconds + value: integer + - name: vpc_uuid + value: string + - name: disable_lets_encrypt_dns_records + value: boolean + - name: firewall + props: + - name: deny + value: array + - name: allow + value: array + - name: network + value: string + +``` + + + +## `DELETE` example + +Deletes the specified load_balancers resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.load_balancers.load_balancers +WHERE lb_id = '{{ lb_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md index f3b3f07564..3cd4f97dd9 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - alerts - monitoring - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a alerts resource. ## Overview
@@ -30,14 +30,130 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `object` | | -| | `object` | Information about the response itself. | -| | `array` | | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve a given alert policy, send a GET request to `/v2/monitoring/alerts/{alert_uuid}` | -| | `SELECT` | | Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. | -| | `INSERT` | | To create a new alert, send a POST request to `/v2/monitoring/alerts`. | -| | `DELETE` | | To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}` | -| | `EXEC` | | To update en existing policy, send a PUT request to `v2/monitoring/alerts/{alert_uuid}`. | +| | `SELECT` | | To retrieve a given alert policy, send a GET request to `/v2/monitoring/alerts/{alert_uuid}` | +| | `SELECT` | | Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. | +| | `INSERT` | | To create a new alert, send a POST request to `/v2/monitoring/alerts`. | +| | `DELETE` | | To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}` | +| | `EXEC` | | To update en existing policy, send a PUT request to `v2/monitoring/alerts/{alert_uuid}`. | + +## `SELECT` examples + +Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. + + +```sql +SELECT +column_anon +FROM digitalocean.monitoring.alerts +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alerts resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.monitoring.alerts ( +data__alerts, +data__compare, +data__description, +data__enabled, +data__entities, +data__tags, +data__type, +data__value, +data__window +) +SELECT +'{{ alerts }}', +'{{ compare }}', +'{{ description }}', +'{{ enabled }}', +'{{ entities }}', +'{{ tags }}', +'{{ type }}', +'{{ value }}', +'{{ window }}' +; +``` + + + + +```yaml +- name: alerts + props: + - name: data__alerts + value: string + - name: data__compare + value: string + - name: data__description + value: string + - name: data__enabled + value: string + - name: data__entities + value: string + - name: data__tags + value: string + - name: data__type + value: string + - name: data__value + value: string + - name: data__window + value: string + - name: alerts + props: + - name: email + value: array + - name: slack + value: array + props: + - name: channel + value: string + - name: url + value: string + - name: compare + value: string + - name: description + value: string + - name: enabled + value: boolean + - name: entities + value: array + - name: tags + value: array + - name: type + value: string + - name: value + value: number + - name: window + value: string + +``` + + + +## `DELETE` example + +Deletes the specified alerts resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.monitoring.alerts +WHERE alert_uuid = '{{ alert_uuid }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md deleted file mode 100644 index 60fbfec7b9..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_bandwidth -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_bandwidth - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview -
- - - -
Namedroplet_bandwidth
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md deleted file mode 100644 index d3b507e626..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_cpu -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_cpu - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_cpu
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md deleted file mode 100644 index 6c19125c66..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_filesystem_free -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_filesystem_free - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_filesystem_free
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md deleted file mode 100644 index 2b5e6e4b67..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_filesystem_size -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_filesystem_size - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_filesystem_size
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md deleted file mode 100644 index b4472ba268..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_load_15_min -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_load_15_min - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_load_15_min
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md deleted file mode 100644 index e0cf1e05ab..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_load_1_min -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_load_1_min - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_load_1_min
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md deleted file mode 100644 index 953b1d28f7..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_load_5_min -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_load_5_min - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_load_5_min
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md deleted file mode 100644 index 6da7c357c2..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_memory_available -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_memory_available - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_memory_available
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md deleted file mode 100644 index c88b497fd2..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_memory_cached -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_memory_cached - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_memory_cached
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md deleted file mode 100644 index 954b7ef74f..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_memory_free -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_memory_free - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_memory_free
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md deleted file mode 100644 index cdc64e898b..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: droplet_memory_total -hide_title: false -hide_table_of_contents: false -keywords: - - droplet_memory_total - - monitoring - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namedroplet_memory_total
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | An object containing the metric labels. | -| | `array` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md index 93aab77126..0bc8e07f6c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md @@ -9,50 +9,71 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Monitoring - +monitoring service documentation. + :::info Service Summary
-total resources: 12
-total selectable resources: 12
-total methods: 27
+total resources: 44
::: -## Overview - - - - - - -
Namedigitalocean.monitoring
TypeService
TitleDigitalOcean API - Monitoring
DescriptionMonitoring
Idmonitoring:v23.04.00139
- ## Resources
alerts
-droplet_bandwidth
-droplet_cpu
-droplet_filesystem_free
-droplet_filesystem_size
-droplet_load_15_min
+metrics_apps_cpu_percentages
+metrics_apps_memory_percentages
+metrics_apps_restart_counts
+metrics_droplet_bandwidths
+metrics_droplet_cpus
+metrics_droplet_filesystem_free
+metrics_droplet_filesystem_sizes
+metrics_droplet_load_15s
+metrics_droplet_load_1s
+metrics_droplet_load_5s
+metrics_droplet_memory_available
+metrics_droplet_memory_cached
+metrics_droplet_memory_free
+metrics_droplet_memory_totals
+metrics_load_balancer_droplets_connections
+metrics_load_balancer_droplets_downtimes
+metrics_load_balancer_droplets_health_checks
+metrics_load_balancer_droplets_http_response_time_50ps
+metrics_load_balancer_droplets_http_response_time_95ps
+metrics_load_balancer_droplets_http_response_time_99ps
+metrics_load_balancer_droplets_http_response_time_avgs
-droplet_load_1_min
-droplet_load_5_min
-droplet_memory_available
-droplet_memory_cached
-droplet_memory_free
-droplet_memory_total
-
+metrics_load_balancer_droplets_http_responses
+metrics_load_balancer_droplets_http_session_duration_50ps
+metrics_load_balancer_droplets_http_session_duration_95ps
+metrics_load_balancer_droplets_http_session_duration_avgs
+metrics_load_balancer_droplets_queue_sizes
+metrics_load_balancer_frontend_connections_current
+metrics_load_balancer_frontend_connections_limits
+metrics_load_balancer_frontend_cpu_utilization
+metrics_load_balancer_frontend_firewall_dropped_bytes
+metrics_load_balancer_frontend_firewall_dropped_packets
+metrics_load_balancer_frontend_http_requests_per_seconds
+metrics_load_balancer_frontend_http_responses
+metrics_load_balancer_frontend_network_throughput_http
+metrics_load_balancer_frontend_network_throughput_tcp
+metrics_load_balancer_frontend_network_throughput_udp
+metrics_load_balancer_frontend_nlb_tcp_network_throughput
+metrics_load_balancer_frontend_nlb_udp_network_throughput
+metrics_load_balancer_frontend_tls_connections_current
+metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits
+metrics_load_balancer_frontend_tls_connections_limits
+sinks
+sinks_destinations
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_cpu_percentages/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_cpu_percentages/index.md new file mode 100644 index 0000000000..fbc9f4e000 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_cpu_percentages/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_apps_cpu_percentages +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_apps_cpu_percentages + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_apps_cpu_percentages resource. + +## Overview + + + + +
Namemetrics_apps_cpu_percentages
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve cpu percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/cpu_percentage`. | + +## `SELECT` examples + +To retrieve cpu percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/cpu_percentage`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_apps_cpu_percentages +WHERE app_id = '{{ app_id }}' +AND end = '{{ end }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_memory_percentages/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_memory_percentages/index.md new file mode 100644 index 0000000000..a7a1a0c26c --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_memory_percentages/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_apps_memory_percentages +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_apps_memory_percentages + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_apps_memory_percentages resource. + +## Overview + + + + +
Namemetrics_apps_memory_percentages
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve memory percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/memory_percentage`. | + +## `SELECT` examples + +To retrieve memory percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/memory_percentage`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_apps_memory_percentages +WHERE app_id = '{{ app_id }}' +AND end = '{{ end }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_restart_counts/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_restart_counts/index.md new file mode 100644 index 0000000000..c09d03e56b --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_apps_restart_counts/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_apps_restart_counts +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_apps_restart_counts + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_apps_restart_counts resource. + +## Overview + + + + +
Namemetrics_apps_restart_counts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve restart count metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/restart_count`. | + +## `SELECT` examples + +To retrieve restart count metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/restart_count`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_apps_restart_counts +WHERE app_id = '{{ app_id }}' +AND end = '{{ end }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_bandwidths/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_bandwidths/index.md new file mode 100644 index 0000000000..0aaa1a0669 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_bandwidths/index.md @@ -0,0 +1,56 @@ +--- +title: metrics_droplet_bandwidths +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_bandwidths + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_bandwidths resource. + +## Overview + + + + +
Namemetrics_droplet_bandwidths
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve bandwidth metrics for a given Droplet, send a GET request to `/v2/monitoring/metrics/droplet/bandwidth`. Use the `interface` query parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. The metrics in the response body are in megabits per second (Mbps). | + +## `SELECT` examples + +To retrieve bandwidth metrics for a given Droplet, send a GET request to `/v2/monitoring/metrics/droplet/bandwidth`. Use the `interface` query parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. The metrics in the response body are in megabits per second (Mbps). + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_bandwidths +WHERE direction = '{{ direction }}' +AND end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND interface = '{{ interface }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_cpus/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_cpus/index.md new file mode 100644 index 0000000000..439df7ec08 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_cpus/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_cpus +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_cpus + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_cpus resource. + +## Overview + + + + +
Namemetrics_droplet_cpus
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve CPU metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/cpu`. | + +## `SELECT` examples + +To retrieve CPU metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/cpu`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_cpus +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_free/index.md new file mode 100644 index 0000000000..28572b8c3d --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_free/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_filesystem_free +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_filesystem_free + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_filesystem_free resource. + +## Overview + + + + +
Namemetrics_droplet_filesystem_free
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve filesystem free metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_free`. | + +## `SELECT` examples + +To retrieve filesystem free metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_free`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_filesystem_free +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_sizes/index.md new file mode 100644 index 0000000000..6fcd0d6b8d --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_filesystem_sizes/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_filesystem_sizes +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_filesystem_sizes + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_filesystem_sizes resource. + +## Overview + + + + +
Namemetrics_droplet_filesystem_sizes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve filesystem size metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_size`. | + +## `SELECT` examples + +To retrieve filesystem size metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_size`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_filesystem_sizes +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_15s/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_15s/index.md new file mode 100644 index 0000000000..e8d818ac90 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_15s/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_load_15s +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_load_15s + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_load_15s resource. + +## Overview + + + + +
Namemetrics_droplet_load_15s
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve 15 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_15`. | + +## `SELECT` examples + +To retrieve 15 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_15`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_load_15s +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_1s/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_1s/index.md new file mode 100644 index 0000000000..b42072e4e0 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_1s/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_load_1s +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_load_1s + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_load_1s resource. + +## Overview + + + + +
Namemetrics_droplet_load_1s
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve 1 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_1`. | + +## `SELECT` examples + +To retrieve 1 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_1`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_load_1s +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_5s/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_5s/index.md new file mode 100644 index 0000000000..6e3d05f4b8 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_load_5s/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_load_5s +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_load_5s + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_load_5s resource. + +## Overview + + + + +
Namemetrics_droplet_load_5s
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve 5 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_5`. | + +## `SELECT` examples + +To retrieve 5 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_5`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_load_5s +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_available/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_available/index.md new file mode 100644 index 0000000000..86634bde3b --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_available/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_memory_available +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_memory_available + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_memory_available resource. + +## Overview + + + + +
Namemetrics_droplet_memory_available
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve available memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_available`. | + +## `SELECT` examples + +To retrieve available memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_available`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_memory_available +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_cached/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_cached/index.md new file mode 100644 index 0000000000..fadcb382e9 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_cached/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_memory_cached +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_memory_cached + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_memory_cached resource. + +## Overview + + + + +
Namemetrics_droplet_memory_cached
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve cached memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_cached`. | + +## `SELECT` examples + +To retrieve cached memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_cached`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_memory_cached +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_free/index.md new file mode 100644 index 0000000000..6763f74af6 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_free/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_memory_free +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_memory_free + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_memory_free resource. + +## Overview + + + + +
Namemetrics_droplet_memory_free
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve free memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_free`. | + +## `SELECT` examples + +To retrieve free memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_free`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_memory_free +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_totals/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_totals/index.md new file mode 100644 index 0000000000..e448ec6f5b --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_droplet_memory_totals/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_droplet_memory_totals +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_droplet_memory_totals + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_droplet_memory_totals resource. + +## Overview + + + + +
Namemetrics_droplet_memory_totals
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve total memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_total`. | + +## `SELECT` examples + +To retrieve total memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_total`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_droplet_memory_totals +WHERE end = '{{ end }}' +AND host_id = '{{ host_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_connections/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_connections/index.md new file mode 100644 index 0000000000..1e3ce0e0e3 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_connections/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_connections +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_connections + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_connections resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_connections
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_connections`. | + +## `SELECT` examples + +To retrieve Droplets active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_connections`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_connections +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_downtimes/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_downtimes/index.md new file mode 100644 index 0000000000..eed9bf0cad --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_downtimes/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_downtimes +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_downtimes + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_downtimes resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_downtimes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets downtime status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_downtime`. | + +## `SELECT` examples + +To retrieve Droplets downtime status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_downtime`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_downtimes +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_health_checks/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_health_checks/index.md new file mode 100644 index 0000000000..84b1bbc4d1 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_health_checks/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_health_checks +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_health_checks + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_health_checks resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_health_checks
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets health check status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_health_checks`. | + +## `SELECT` examples + +To retrieve Droplets health check status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_health_checks`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_health_checks +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_50ps/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_50ps/index.md new file mode 100644 index 0000000000..5484724834 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_50ps/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_response_time_50ps +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_response_time_50ps + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_response_time_50ps resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_response_time_50ps
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets 50th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p`. | + +## `SELECT` examples + +To retrieve Droplets 50th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_response_time_50ps +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_95ps/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_95ps/index.md new file mode 100644 index 0000000000..53edd71686 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_95ps/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_response_time_95ps +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_response_time_95ps + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_response_time_95ps resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_response_time_95ps
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets 95th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p`. | + +## `SELECT` examples + +To retrieve Droplets 95th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_response_time_95ps +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_99ps/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_99ps/index.md new file mode 100644 index 0000000000..5a4e298aac --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_99ps/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_response_time_99ps +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_response_time_99ps + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_response_time_99ps resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_response_time_99ps
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets 99th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p`. | + +## `SELECT` examples + +To retrieve Droplets 99th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_response_time_99ps +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_avgs/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_avgs/index.md new file mode 100644 index 0000000000..becbd6140c --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_response_time_avgs/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_response_time_avgs +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_response_time_avgs + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_response_time_avgs resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_response_time_avgs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets average HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg`. | + +## `SELECT` examples + +To retrieve Droplets average HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_response_time_avgs +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_responses/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_responses/index.md new file mode 100644 index 0000000000..dc5e83165c --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_responses/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_responses +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_responses + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_responses resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_responses
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_responses`. | + +## `SELECT` examples + +To retrieve Droplets HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_responses`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_responses +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_50ps/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_50ps/index.md new file mode 100644 index 0000000000..e70c28ca7e --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_50ps/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_session_duration_50ps +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_session_duration_50ps + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_session_duration_50ps resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_session_duration_50ps
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets 50th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p`. | + +## `SELECT` examples + +To retrieve Droplets 50th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_session_duration_50ps +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_95ps/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_95ps/index.md new file mode 100644 index 0000000000..5eb3b065c7 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_95ps/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_session_duration_95ps +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_session_duration_95ps + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_session_duration_95ps resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_session_duration_95ps
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets 95th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p`. | + +## `SELECT` examples + +To retrieve Droplets 95th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_session_duration_95ps +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_avgs/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_avgs/index.md new file mode 100644 index 0000000000..83866e6bf9 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_http_session_duration_avgs/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_http_session_duration_avgs +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_http_session_duration_avgs + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_http_session_duration_avgs resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_http_session_duration_avgs
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets average HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg`. | + +## `SELECT` examples + +To retrieve Droplets average HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_http_session_duration_avgs +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_queue_sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_queue_sizes/index.md new file mode 100644 index 0000000000..ecfcbe4709 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_droplets_queue_sizes/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_droplets_queue_sizes +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_droplets_queue_sizes + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_droplets_queue_sizes resource. + +## Overview + + + + +
Namemetrics_load_balancer_droplets_queue_sizes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve Droplets queue size for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_queue_size`. | + +## `SELECT` examples + +To retrieve Droplets queue size for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_queue_size`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_droplets_queue_sizes +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_current/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_current/index.md new file mode 100644 index 0000000000..dbd7662bd0 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_current/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_connections_current +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_connections_current + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_connections_current resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_connections_current
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend total current active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_current`. | + +## `SELECT` examples + +To retrieve frontend total current active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_current`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_connections_current +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_limits/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_limits/index.md new file mode 100644 index 0000000000..472ea04080 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_connections_limits/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_connections_limits +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_connections_limits + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_connections_limits resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_connections_limits
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend max connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_limit`. | + +## `SELECT` examples + +To retrieve frontend max connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_limit`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_connections_limits +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_cpu_utilization/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_cpu_utilization/index.md new file mode 100644 index 0000000000..833ae7ff2e --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_cpu_utilization/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_cpu_utilization +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_cpu_utilization + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_cpu_utilization resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_cpu_utilization
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_cpu_utilization`. | + +## `SELECT` examples + +To retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_cpu_utilization`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_cpu_utilization +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_bytes/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_bytes/index.md new file mode 100644 index 0000000000..2862cf6efb --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_bytes/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_firewall_dropped_bytes +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_firewall_dropped_bytes + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_firewall_dropped_bytes resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_firewall_dropped_bytes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve firewall dropped bytes for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes`. This is currently only supported for network load balancers. | + +## `SELECT` examples + +To retrieve firewall dropped bytes for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes`. This is currently only supported for network load balancers. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_firewall_dropped_bytes +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_packets/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_packets/index.md new file mode 100644 index 0000000000..98de6cc856 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_firewall_dropped_packets/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_firewall_dropped_packets +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_firewall_dropped_packets + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_firewall_dropped_packets resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_firewall_dropped_packets
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve firewall dropped packets per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets`. This is currently only supported for network load balancers. | + +## `SELECT` examples + +To retrieve firewall dropped packets per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets`. This is currently only supported for network load balancers. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_firewall_dropped_packets +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_requests_per_seconds/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_requests_per_seconds/index.md new file mode 100644 index 0000000000..9b9a81447a --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_requests_per_seconds/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_http_requests_per_seconds +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_http_requests_per_seconds + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_http_requests_per_seconds resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_http_requests_per_seconds
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend HTTP requests per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second`. | + +## `SELECT` examples + +To retrieve frontend HTTP requests per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_http_requests_per_seconds +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_responses/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_responses/index.md new file mode 100644 index 0000000000..d7beb9423c --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_http_responses/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_http_responses +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_http_responses + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_http_responses resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_http_responses
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_responses`. | + +## `SELECT` examples + +To retrieve frontend HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_responses`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_http_responses +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_http/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_http/index.md new file mode 100644 index 0000000000..22c3b41aa1 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_http/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_network_throughput_http +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_network_throughput_http + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_network_throughput_http resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_network_throughput_http
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend HTTP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_http`. | + +## `SELECT` examples + +To retrieve frontend HTTP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_http`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_network_throughput_http +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_tcp/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_tcp/index.md new file mode 100644 index 0000000000..91faf4d548 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_tcp/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_network_throughput_tcp +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_network_throughput_tcp + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_network_throughput_tcp resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_network_throughput_tcp
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp`. | + +## `SELECT` examples + +To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_network_throughput_tcp +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_udp/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_udp/index.md new file mode 100644 index 0000000000..072b743977 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_network_throughput_udp/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_network_throughput_udp +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_network_throughput_udp + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_network_throughput_udp resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_network_throughput_udp
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp`. | + +## `SELECT` examples + +To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_network_throughput_udp +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_tcp_network_throughput/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_tcp_network_throughput/index.md new file mode 100644 index 0000000000..863cf05c11 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_tcp_network_throughput/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_nlb_tcp_network_throughput +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_nlb_tcp_network_throughput + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_nlb_tcp_network_throughput resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_nlb_tcp_network_throughput
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput`. | + +## `SELECT` examples + +To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_nlb_tcp_network_throughput +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_udp_network_throughput/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_udp_network_throughput/index.md new file mode 100644 index 0000000000..34d395bba2 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_nlb_udp_network_throughput/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_nlb_udp_network_throughput +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_nlb_udp_network_throughput + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_nlb_udp_network_throughput resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_nlb_udp_network_throughput
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput`. | + +## `SELECT` examples + +To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_nlb_udp_network_throughput +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_current/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_current/index.md new file mode 100644 index 0000000000..16d670022f --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_current/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_tls_connections_current +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_tls_connections_current + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_tls_connections_current resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_tls_connections_current
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend current TLS connections rate for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_current`. | + +## `SELECT` examples + +To retrieve frontend current TLS connections rate for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_current`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_tls_connections_current +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits/index.md new file mode 100644 index 0000000000..1c9ce82459 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_tls_connections_exceeding_rate_limits
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend closed TLS connections for exceeded rate limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit`. | + +## `SELECT` examples + +To retrieve frontend closed TLS connections for exceeded rate limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_tls_connections_exceeding_rate_limits +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_limits/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_limits/index.md new file mode 100644 index 0000000000..7ea0990add --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/metrics_load_balancer_frontend_tls_connections_limits/index.md @@ -0,0 +1,54 @@ +--- +title: metrics_load_balancer_frontend_tls_connections_limits +hide_title: false +hide_table_of_contents: false +keywords: + - metrics_load_balancer_frontend_tls_connections_limits + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a metrics_load_balancer_frontend_tls_connections_limits resource. + +## Overview + + + + +
Namemetrics_load_balancer_frontend_tls_connections_limits
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `string` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To retrieve frontend max TLS connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit`. | + +## `SELECT` examples + +To retrieve frontend max TLS connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit`. + + +```sql +SELECT +data, +status +FROM digitalocean.monitoring.metrics_load_balancer_frontend_tls_connections_limits +WHERE end = '{{ end }}' +AND lb_id = '{{ lb_id }}' +AND start = '{{ start }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks/index.md new file mode 100644 index 0000000000..08da921df6 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks/index.md @@ -0,0 +1,108 @@ +--- +title: sinks +hide_title: false +hide_table_of_contents: false +keywords: + - sinks + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a sinks resource. + +## Overview + + + + +
Namesinks
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get the details of a sink (resources and destination), send a GET request to `/v2/monitoring/sinks/${sink_uuid}`. | +| | `SELECT` | | To list all sinks, send a GET request to `/v2/monitoring/sinks`. | +| | `INSERT` | | To create a new sink, send a POST request to `/v2/monitoring/sinks`. Forwards logs from the resources identified in `resources` to the specified pre-existing destination. | +| | `DELETE` | | To delete a sink, send a DELETE request to `/v2/monitoring/sinks/${sink_uuid}`. | + +## `SELECT` examples + +To list all sinks, send a GET request to `/v2/monitoring/sinks`. + + +```sql +SELECT +column_anon +FROM digitalocean.monitoring.sinks +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sinks resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.monitoring.sinks ( +data__destination_uuid, +data__resources +) +SELECT +'{{ destination_uuid }}', +'{{ resources }}' +; +``` + + + + +```yaml +- name: sinks + props: + - name: destination_uuid + value: string + - name: resources + value: array + props: + - name: urn + value: string + - name: name + value: string + +``` + + + +## `DELETE` example + +Deletes the specified sinks resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.monitoring.sinks +WHERE sink_uuid = '{{ sink_uuid }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks_destinations/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks_destinations/index.md new file mode 100644 index 0000000000..40ed9ec7ce --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/sinks_destinations/index.md @@ -0,0 +1,160 @@ +--- +title: sinks_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - sinks_destinations + - monitoring + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a sinks_destinations resource. + +## Overview + + + + +
Namesinks_destinations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get the details of a destination, send a GET request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. | +| | `SELECT` | | To list all logging destinations, send a GET request to `/v2/monitoring/sinks/destinations`. | +| | `INSERT` | | To create a new destination, send a POST request to `/v2/monitoring/sinks/destinations`. | +| | `DELETE` | | To delete a destination and all associated sinks, send a DELETE request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. | +| | `UPDATE` | | To update the details of a destination, send a PATCH request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. | + +## `SELECT` examples + +To list all logging destinations, send a GET request to `/v2/monitoring/sinks/destinations`. + + +```sql +SELECT +column_anon +FROM digitalocean.monitoring.sinks_destinations +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sinks_destinations resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.monitoring.sinks_destinations ( +data__name, +data__type, +data__config +) +SELECT +'{{ name }}', +'{{ type }}', +'{{ config }}' +; +``` + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.monitoring.sinks_destinations ( +data__config, +data__type +) +SELECT +'{{ config }}', +'{{ type }}' +; +``` + + + + +```yaml +- name: sinks_destinations + props: + - name: data__config + value: string + - name: data__type + value: string + - name: name + value: string + - name: type + value: string + - name: config + props: + - name: credentials + props: + - name: username + value: string + - name: password + value: string + - name: endpoint + value: string + - name: cluster_uuid + value: string + - name: cluster_name + value: string + - name: index_name + value: string + - name: retention_days + value: integer + +``` + + + +## `UPDATE` example + +Updates a sinks_destinations resource. + +```sql +/*+ update */ +UPDATE digitalocean.monitoring.sinks_destinations +SET +name = '{{ name }}', +type = '{{ type }}', +config = '{{ config }}' +WHERE +destination_uuid = '{{ destination_uuid }}' +AND data__config = '{{ data__config }}' +AND data__type = '{{ data__type }}'; +``` + +## `DELETE` example + +Deletes the specified sinks_destinations resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.monitoring.sinks_destinations +WHERE destination_uuid = '{{ destination_uuid }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md index 8d8ffd2b19..92d79cd492 100644 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -1 Click Applications - +one_click_applications service documentation. + :::info Service Summary
-total resources: 2
-total selectable resources: 1
-total methods: 3
+total resources: 1
::: -## Overview - - - - - - -
Namedigitalocean.one_click_applications
TypeService
TitleDigitalOcean API - One Click Applications
Description1 Click Applications
Idone_click_applications:v23.04.00139
- ## Resources
-kubernetes
+one_click_applications
-one_click_applications
-
+
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md deleted file mode 100644 index 43003dd5c3..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: kubernetes -hide_title: false -hide_table_of_contents: false -keywords: - - kubernetes - - one_click_applications - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namekubernetes
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md index 0d2b15dc98..199c92e8d5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - one_click_applications - one_click_applications - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a one_click_applications resource. ## Overview @@ -30,10 +30,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The slug identifier for the 1-Click application. | -| | `string` | The type of the 1-Click application. | +| | `` | | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all available 1-Click applications, send a GET request to `/v2/1-clicks`. The `type` may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: `/v2/1-clicks?type=droplet`. Current supported types are `kubernetes` and `droplet`. The response will be a JSON object with a key called `1_clicks`. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click. | +| | `EXEC` | | To install a Kubernetes 1-Click application on a cluster, send a POST request to `/v2/1-clicks/kubernetes`. The `addon_slugs` and `cluster_uuid` must be provided as body parameter in order to specify which 1-Click application(s) to install. To list all available 1-Click Kubernetes applications, send a request to `/v2/1-clicks?type=kubernetes`. | + +## `SELECT` examples + +To list all available 1-Click applications, send a GET request to `/v2/1-clicks`. The `type` may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: `/v2/1-clicks?type=droplet`. Current supported types are `kubernetes` and `droplet`. The response will be a JSON object with a key called `1_clicks`. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click. + + +```sql +SELECT +column_anon +FROM digitalocean.one_click_applications.one_click_applications +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md deleted file mode 100644 index c7205f76af..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: default -hide_title: false -hide_table_of_contents: false -keywords: - - default - - projects - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview -
- - - -
Namedefault
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The unique universal identifier of this project. | -| | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | -| | `string` | The description of the project. The maximum length is 255 characters. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | -| | `string` | The environment of the project's resources. | -| | `boolean` | If true, all resources will be added to this project if no project is specified. | -| | `integer` | The integer id of the project owner. | -| | `string` | The unique universal identifier of the project owner. | -| | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| -| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get your default project, send a GET request to `/v2/projects/default`. | -| | `EXEC` | | To get your default project, send a GET request to `/v2/projects/default`. | -| | `EXEC` | | To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. | -| | `EXEC` | | To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. | diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md index dfc1b5a4fa..e266f2d9a6 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - default_resources - projects - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a default_resources resource. ## Overview @@ -34,9 +34,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `object` | The links object contains the `self` object, which contains the resource relationship. | | | `string` | The status of assigning and fetching the resources. | | | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | -| | `EXEC` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | -| | `EXEC` | | To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. | +| | `SELECT` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | +| | `EXEC` | | To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. | + +## `SELECT` examples + +To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. + + +```sql +SELECT +assigned_at, +links, +status, +urn +FROM digitalocean.projects.default_resources +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/defaults/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/defaults/index.md new file mode 100644 index 0000000000..305509609f --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/projects/defaults/index.md @@ -0,0 +1,68 @@ +--- +title: defaults +hide_title: false +hide_table_of_contents: false +keywords: + - defaults + - projects + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a defaults resource. + +## Overview +
+ + + +
Namedefaults
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `` | | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To get your default project, send a GET request to `/v2/projects/default`. | +| | `UPDATE` | | To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. | +| | `EXEC` | | To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. | + +## `SELECT` examples + +To get your default project, send a GET request to `/v2/projects/default`. + + +```sql +SELECT +column_anon +FROM digitalocean.projects.defaults +; +``` +## `UPDATE` example + +Updates a defaults resource. + +```sql +/*+ update */ +UPDATE digitalocean.projects.defaults +SET +name = '{{ name }}', +description = '{{ description }}', +purpose = '{{ purpose }}', +environment = '{{ environment }}', +is_default = true|false +WHERE +; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/index.md index 4d3d63c027..d39dfd8c00 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/index.md @@ -9,42 +9,31 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Projects - +projects service documentation. + :::info Service Summary
total resources: 4
-total selectable resources: 4
-total methods: 18
::: -## Overview - - - - - - -
Namedigitalocean.projects
TypeService
TitleDigitalOcean API - Projects
DescriptionProjects
Idprojects:v23.04.00139
- ## Resources
-default
default_resources
+defaults
projects
-resources
-
+resources
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md index 1df1b342bc..97a6e18ef3 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - projects - projects - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a projects resource. ## Overview @@ -30,24 +30,87 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The unique universal identifier of this project. | -| | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | -| | `string` | The description of the project. The maximum length is 255 characters. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | -| | `string` | The environment of the project's resources. | -| | `boolean` | If true, all resources will be added to this project if no project is specified. | -| | `integer` | The integer id of the project owner. | -| | `string` | The unique universal identifier of the project owner. | -| | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| -| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | -| | `SELECT` | | To list all your projects, send a GET request to `/v2/projects`. | -| | `INSERT` | | To create a project, send a POST request to `/v2/projects`. | -| | `DELETE` | | To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To
be deleted, a project must not have any resources assigned to it. Any existing
resources must first be reassigned or destroyed, or you will receive a 412 error.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | -| | `EXEC` | | To list all your projects, send a GET request to `/v2/projects`. | -| | `EXEC` | | To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. | -| | `EXEC` | | To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. | +| | `SELECT` | | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | +| | `SELECT` | | To list all your projects, send a GET request to `/v2/projects`. | +| | `INSERT` | | To create a project, send a POST request to `/v2/projects`. | +| | `DELETE` | | To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | +| | `UPDATE` | | To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. | +| | `EXEC` | | To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. | + +## `SELECT` examples + +To list all your projects, send a GET request to `/v2/projects`. + + +```sql +SELECT +column_anon +FROM digitalocean.projects.projects +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new projects resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.projects.projects ( + +) +SELECT + +; +``` + + + + +```yaml +- name: projects + props: [] + +``` + + + +## `UPDATE` example + +Updates a projects resource. + +```sql +/*+ update */ +UPDATE digitalocean.projects.projects +SET +name = '{{ name }}', +description = '{{ description }}', +purpose = '{{ purpose }}', +environment = '{{ environment }}', +is_default = true|false +WHERE +project_id = '{{ project_id }}'; +``` + +## `DELETE` example + +Deletes the specified projects resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.projects.projects +WHERE project_id = '{{ project_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md index 5177760eee..bfa7b923b1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - resources - projects - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a resources resource. ## Overview
@@ -34,9 +34,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `object` | The links object contains the `self` object, which contains the resource relationship. | | | `string` | The status of assigning and fetching the resources. | | | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | -| | `EXEC` | | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | -| | `EXEC` | | To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. | +| | `SELECT` | | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | +| | `EXEC` | | To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. | + +## `SELECT` examples + +To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. + + +```sql +SELECT +assigned_at, +links, +status, +urn +FROM digitalocean.projects.resources +WHERE project_id = '{{ project_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/regions/index.md index f48b23f00c..9743e9ce06 100644 --- a/docs/digitalocean-docs/providers/digitalocean/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/regions/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Regions - +regions service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 2
::: -## Overview -
- - - - - -
Namedigitalocean.regions
TypeService
TitleDigitalOcean API - Regions
DescriptionRegions
Idregions:v23.04.00139
- ## Resources
-regions
+regions
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md index 69106b4022..fc9468f2ca 100644 --- a/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - regions - regions - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a regions resource. ## Overview @@ -30,13 +30,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The display name of the region. This will be a full name that is used in the control panel and other interfaces. | +| | `string` | The display name of the region. This will be a full name that is used in the control panel and other interfaces. | | | `boolean` | This is a boolean value that represents whether new Droplets can be created in this region. | | | `` | This attribute is set to an array which contains features available in this region | | | `` | This attribute is set to an array which contains the identifying slugs for the sizes available in this region. | | | `string` | A human-readable string that is used as a unique identifier for each region. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of the regions that are available, send a GET request to `/v2/regions`. The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes. | + +## `SELECT` examples + +To list all of the regions that are available, send a GET request to `/v2/regions`. The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes. + + +```sql +SELECT +name, +available, +features, +sizes, +slug +FROM digitalocean.regions.regions +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md index acebe80eb0..caed97af3d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - actions - reserved_ips - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a actions resource. ## Overview
@@ -30,20 +30,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| | `object` | | -| | `string` | A human-readable string that is used as a unique identifier for each region. | -| | `integer` | A unique identifier for the resource that the action is associated with. | -| | `string` | The type of resource that the action is associated with. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| | `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. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | -| | `SELECT` | | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | -| | `INSERT` | | To initiate an action on a reserved IP send a POST request to
`/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a reserved IP to a Droplet
\| `unassign` \| Unassign a reserved IP from a Droplet
| -| | `EXEC` | | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | -| | `EXEC` | | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | +| | `SELECT` | | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | +| | `EXEC` | | To initiate an action on a reserved IP send a POST request to `/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request, set the `type` attribute to on of the supported action types: \| Action \| Details \|------------\|-------- \| `assign` \| Assigns a reserved IP to a Droplet \| `unassign` \| Unassign a reserved IP from a Droplet | + +## `SELECT` examples + +To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. + + +```sql +SELECT +column_anon +FROM digitalocean.reserved_ips.actions +WHERE reserved_ip = '{{ reserved_ip }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md index 0043e0a5c1..fd23ad0e4d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Reserved IPs - +reserved_ips service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 11
::: -## Overview -
- - - - - -
Namedigitalocean.reserved_ips
TypeService
TitleDigitalOcean API - Reserved Ips
DescriptionReserved IPs
Idreserved_ips:v23.04.00139
- ## Resources
-actions
+actions
-reserved_ips
-
+reserved_ips
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md index 9965ec8d0a..1829923abd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - reserved_ips - reserved_ips - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a reserved_ips resource. ## Overview @@ -35,12 +35,73 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `boolean` | A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted. | | | `string` | The UUID of the project to which the reserved IP currently belongs. | | | `object` | The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | -| | `SELECT` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | -| | `INSERT` | | On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to `/v2/reserved_ips` with the `droplet_id` attribute.

* To create a new reserved IP reserved to a region, send a POST request to
`/v2/reserved_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. | -| | `DELETE` | | To delete a reserved IP and remove it from your account, send a DELETE request
to `/v2/reserved_ips/$RESERVED_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| | `EXEC` | | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | -| | `EXEC` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | +| | `SELECT` | | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | +| | `SELECT` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | +| | `INSERT` | | On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to `/v2/reserved_ips` with the `droplet_id` attribute. * To create a new reserved IP reserved to a region, send a POST request to `/v2/reserved_ips` with the `region` attribute. **Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. | +| | `DELETE` | | To delete a reserved IP and remove it from your account, send a DELETE request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. | + +## `SELECT` examples + +To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. + + +```sql +SELECT +droplet, +ip, +locked, +project_id, +region +FROM digitalocean.reserved_ips.reserved_ips +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new reserved_ips resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.reserved_ips.reserved_ips ( +data__droplet_id +) +SELECT +'{{ droplet_id }}' +; +``` + + + + +```yaml +- name: reserved_ips + props: + - name: droplet_id + value: integer + +``` + + + +## `DELETE` example + +Deletes the specified reserved_ips resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.reserved_ips.reserved_ips +WHERE reserved_ip = '{{ reserved_ip }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/sizes/index.md index 1aa7505b72..a621c70956 100644 --- a/docs/digitalocean-docs/providers/digitalocean/sizes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/sizes/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Sizes - +sizes service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 2
::: -## Overview -
- - - - - -
Namedigitalocean.sizes
TypeService
TitleDigitalOcean API - Sizes
DescriptionSizes
Idsizes:v23.04.00139
- ## Resources
-sizes
+sizes
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md index 81cf8410c5..0f76786103 100644 --- a/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - sizes - sizes - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a sizes resource. ## Overview @@ -33,15 +33,40 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. | | | `boolean` | This is a boolean value that represents whether new Droplets can be created with this size. | | | `integer` | The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes. | +| | `array` | An array of objects containing information about the disks available to Droplets created with this size. | +| | `object` | An object containing information about the GPU capabilities of Droplets created with this size. | | | `integer` | The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes. | | | `number` | This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. | | | `number` | This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. | | | `array` | An array containing the region slugs where this size is available for Droplet creates. | | | `string` | A human-readable string that is used to uniquely identify each size. | | | `number` | The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. | -| | `integer` | The integer of number CPUs allocated to Droplets of this size. | +| | `integer` | The number of CPUs allocated to Droplets of this size. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of available Droplet sizes, send a GET request to `/v2/sizes`. The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. | + +## `SELECT` examples + +To list all of available Droplet sizes, send a GET request to `/v2/sizes`. The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. + + +```sql +SELECT +description, +available, +disk, +disk_info, +gpu_info, +memory, +price_hourly, +price_monthly, +regions, +slug, +transfer, +vcpus +FROM digitalocean.sizes.sizes +; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md index 68a3592d11..7711524a9f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Snapshots - +snapshots service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 4
::: -## Overview -
- - - - - -
Namedigitalocean.snapshots
TypeService
TitleDigitalOcean API - Snapshots
DescriptionSnapshots
Idsnapshots:v23.04.00139
- ## Resources
-snapshots
+snapshots
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md index 27d6800515..9bc5a74c4d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - snapshots - snapshots - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a snapshots resource. ## Overview @@ -30,19 +30,32 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The unique identifier for the snapshot. | -| | `string` | A human-readable name for the snapshot. | -| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | -| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | -| | `string` | The unique identifier for the resource that the snapshot originated from. | -| | `string` | The type of resource that the snapshot originated from. | -| | `number` | The billable size of the snapshot in gigabytes. | -| | `array` | An array of Tags the snapshot has been tagged with. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve information about a snapshot, send a GET request to
`/v2/snapshots/$SNAPSHOT_ID`.

The response will be a JSON object with a key called `snapshot`. The value of
this will be an snapshot object containing the standard snapshot attributes.
| -| | `SELECT` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| -| | `DELETE` | | Both Droplet and volume snapshots are managed through the `/v2/snapshots/`
endpoint. To delete a snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| | `EXEC` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| +| | `SELECT` | | To retrieve information about a snapshot, send a GET request to `/v2/snapshots/$SNAPSHOT_ID`. The response will be a JSON object with a key called `snapshot`. The value of this will be an snapshot object containing the standard snapshot attributes. | +| | `SELECT` | | To list all of the snapshots available on your account, send a GET request to `/v2/snapshots`. The response will be a JSON object with a key called `snapshots`. This will be set to an array of `snapshot` objects, each of which will contain the standard snapshot attributes. ### Filtering Results by Resource Type It's possible to request filtered results by including certain query parameters. #### List Droplet Snapshots To retrieve only snapshots based on Droplets, include the `resource_type` query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. #### List Volume Snapshots To retrieve only snapshots based on volumes, include the `resource_type` query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. | +| | `DELETE` | | Both Droplet and volume snapshots are managed through the `/v2/snapshots/` endpoint. To delete a snapshot, send a DELETE request to `/v2/snapshots/$SNAPSHOT_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | + +## `SELECT` examples + +To list all of the snapshots available on your account, send a GET request to `/v2/snapshots`. The response will be a JSON object with a key called `snapshots`. This will be set to an array of `snapshot` objects, each of which will contain the standard snapshot attributes. ### Filtering Results by Resource Type It's possible to request filtered results by including certain query parameters. #### List Droplet Snapshots To retrieve only snapshots based on Droplets, include the `resource_type` query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. #### List Volume Snapshots To retrieve only snapshots based on volumes, include the `resource_type` query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. + + +```sql +SELECT +column_anon +FROM digitalocean.snapshots.snapshots +; +``` +## `DELETE` example + +Deletes the specified snapshots resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.snapshots.snapshots +WHERE snapshot_id = '{{ snapshot_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md index c66bd1cbfd..58ca2b1962 100644 --- a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - account_keys - ssh_keys - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a account_keys resource. ## Overview
@@ -30,17 +30,79 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `integer` | A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. | -| | `string` | A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. | -| | `string` | A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. | -| | `string` | The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. | +| | `` | | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | -| | `SELECT` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | -| | `INSERT` | | To add a new SSH public key to your DigitalOcean account, send a POST request to `/v2/account/keys`. Set the `name` attribute to the name you wish to use and the `public_key` attribute to the full public key you are adding. | -| | `DELETE` | | To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | -| | `EXEC` | | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | -| | `EXEC` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | -| | `EXEC` | | To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or `/v2/account/keys/$SSH_KEY_FINGERPRINT`. Set the `name` attribute to the new name you want to use. | +| | `SELECT` | | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`. The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | +| | `SELECT` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | +| | `INSERT` | | To add a new SSH public key to your DigitalOcean account, send a POST request to `/v2/account/keys`. Set the `name` attribute to the name you wish to use and the `public_key` attribute to the full public key you are adding. | +| | `DELETE` | | To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`. A 204 status will be returned, indicating that the action was successful and that the response body is empty. | +| | `EXEC` | | To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or `/v2/account/keys/$SSH_KEY_FINGERPRINT`. Set the `name` attribute to the new name you want to use. | + +## `SELECT` examples + +To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. + + +```sql +SELECT +column_anon +FROM digitalocean.ssh_keys.account_keys +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account_keys resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.ssh_keys.account_keys ( +data__public_key, +data__name +) +SELECT +'{{ public_key }}', +'{{ name }}' +; +``` + + + + +```yaml +- name: account_keys + props: + - name: data__name + value: string + - name: data__public_key + value: string + - name: public_key + value: string + - name: name + value: string + +``` + + + +## `DELETE` example + +Deletes the specified account_keys resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.ssh_keys.account_keys +WHERE ssh_key_identifier = '{{ ssh_key_identifier }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md index fa8460ef60..11a67e8495 100644 --- a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md @@ -9,39 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -SSH Keys - +ssh_keys service documentation. + :::info Service Summary
total resources: 1
-total selectable resources: 1
-total methods: 7
::: -## Overview -
- - - - - -
Namedigitalocean.ssh_keys
TypeService
TitleDigitalOcean API - Ssh Keys
DescriptionSSH Keys
Idssh_keys:v23.04.00139
- ## Resources
-account_keys
+account_keys
+
-
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/index.md index 1774ae0f2e..ee7fdbb204 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/index.md @@ -9,40 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Tags - +tags service documentation. + :::info Service Summary
total resources: 2
-total selectable resources: 1
-total methods: 8
::: -## Overview - - - - - - -
Namedigitalocean.tags
TypeService
TitleDigitalOcean API - Tags
DescriptionTags
Idtags:v23.04.00139
- ## Resources
-resources
+resources
-tags
-
+tags
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md index 0f4973bbb7..d07ea500b8 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - resources - tags - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a resources resource. ## Overview @@ -28,9 +28,11 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `EXEC` | | Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | -| | `EXEC` | | Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | +| | `EXEC` | | Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | +| | `EXEC` | | Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md index a34afed450..e0f5fefe36 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - tags - tags - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a tags resource. ## Overview @@ -30,14 +30,110 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.
There is a limit of 255 characters per tag.

**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.

When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).

Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD".
| -| | `object` | An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. | +| | `string` | The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. **Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical. When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`). Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD". | +| | `object` | Tagged Resource Statistics include metadata regarding the resource type that has been tagged. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | -| | `SELECT` | | To list all of your tags, you can send a GET request to `/v2/tags`. | -| | `INSERT` | | To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. | -| | `DELETE` | | A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag | -| | `EXEC` | | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | -| | `EXEC` | | To list all of your tags, you can send a GET request to `/v2/tags`. | +| | `SELECT` | | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | +| | `SELECT` | | To list all of your tags, you can send a GET request to `/v2/tags`. | +| | `INSERT` | | To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. | +| | `DELETE` | | A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag | + +## `SELECT` examples + +To list all of your tags, you can send a GET request to `/v2/tags`. + + +```sql +SELECT +name, +resources +FROM digitalocean.tags.tags +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tags resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.tags.tags ( +data__name, +data__resources +) +SELECT +'{{ name }}', +'{{ resources }}' +; +``` + + + + +```yaml +- name: tags + props: + - name: name + value: string + - name: resources + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + - name: droplets + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + - name: imgages + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + - name: volumes + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + - name: volume_snapshots + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + - name: databases + props: + - name: count + value: integer + - name: last_tagged_uri + value: string + +``` + + + +## `DELETE` example + +Deletes the specified tags resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.tags.tags +WHERE tag_id = '{{ tag_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md deleted file mode 100644 index 4d6a0c5370..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: check_alerts -hide_title: false -hide_table_of_contents: false -keywords: - - check_alerts - - uptime - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview -
- - - -
Namecheck_alerts
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A unique ID that can be used to identify and reference the alert. | -| | `string` | A human-friendly display name. | -| | `string` | The comparison operator used against the alert's threshold. | -| | `object` | The notification settings for a trigger alert. | -| | `string` | Period of time the threshold must be exceeded to trigger the alert. | -| | `integer` | The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type. | -| | `string` | The type of alert. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | -| | `SELECT` | | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | -| | `INSERT` | | To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes
in the table below in the JSON body.
| -| | `DELETE` | | To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status
code with no body will be returned in response to a successful request.
| -| | `EXEC` | | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | -| | `EXEC` | | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | -| | `EXEC` | | To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md deleted file mode 100644 index eba709c03f..0000000000 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: check_state -hide_title: false -hide_table_of_contents: false -keywords: - - check_state - - uptime - - digitalocean - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL -custom_edit_url: null -image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecheck_state
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `object` | A map of region to regional state | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md index 197a387751..785d247204 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - checks - uptime - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a checks resource. ## Overview @@ -36,13 +36,73 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `array` | An array containing the selected regions to perform healthchecks from. | | | `string` | The endpoint to perform healthchecks on. | | | `string` | The type of health check to perform. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | -| | `SELECT` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | -| | `INSERT` | | To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes
in the table below in the JSON body.
| -| | `DELETE` | | To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status
code with no body will be returned in response to a successful request.


Deleting a check will also delete alerts associated with the check.
| -| | `EXEC` | | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | -| | `EXEC` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | -| | `EXEC` | | To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`.
| +| | `SELECT` | | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | +| | `SELECT` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | +| | `INSERT` | | To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes in the table below in the JSON body. | +| | `DELETE` | | To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status code with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check. | +| | `EXEC` | | To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`. | + +## `SELECT` examples + +To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. + + +```sql +SELECT +id, +name, +enabled, +regions, +target, +type +FROM digitalocean.uptime.checks +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new checks resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.uptime.checks ( + +) +SELECT + +; +``` + + + + +```yaml +- name: checks + props: [] + +``` + + + +## `DELETE` example + +Deletes the specified checks resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.uptime.checks +WHERE check_id = '{{ check_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/checks_alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/checks_alerts/index.md new file mode 100644 index 0000000000..bb80b59172 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/checks_alerts/index.md @@ -0,0 +1,113 @@ +--- +title: checks_alerts +hide_title: false +hide_table_of_contents: false +keywords: + - checks_alerts + - uptime + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a checks_alerts resource. + +## Overview +
+ + + +
Namechecks_alerts
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A unique ID that can be used to identify and reference the alert. | +| | `string` | A human-friendly display name. | +| | `string` | The comparison operator used against the alert's threshold. | +| | `object` | The notification settings for a trigger alert. | +| | `string` | Period of time the threshold must be exceeded to trigger the alert. | +| | `integer` | The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type. | +| | `string` | The type of alert. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | +| | `SELECT` | | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | +| | `INSERT` | | To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes in the table below in the JSON body. | +| | `DELETE` | | To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status code with no body will be returned in response to a successful request. | +| | `EXEC` | | To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | + +## `SELECT` examples + +To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. + + +```sql +SELECT +id, +name, +comparison, +notifications, +period, +threshold, +type +FROM digitalocean.uptime.checks_alerts +WHERE check_id = '{{ check_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new checks_alerts resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.uptime.checks_alerts ( +check_id +) +SELECT +'{{ check_id }}' +; +``` + + + + +```yaml +- name: checks_alerts + props: + - name: check_id + value: string + +``` + + + +## `DELETE` example + +Deletes the specified checks_alerts resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.uptime.checks_alerts +WHERE alert_id = '{{ alert_id }}' +AND check_id = '{{ check_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/checks_states/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/checks_states/index.md new file mode 100644 index 0000000000..6c6ec0600d --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/checks_states/index.md @@ -0,0 +1,52 @@ +--- +title: checks_states +hide_title: false +hide_table_of_contents: false +keywords: + - checks_states + - uptime + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a checks_states resource. + +## Overview + + + + +
Namechecks_states
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `object` | | +| | `object` | A map of region to regional state | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing check's state, send a GET request to `/v2/uptime/checks/$CHECK_ID/state`. | + +## `SELECT` examples + +To show information about an existing check's state, send a GET request to `/v2/uptime/checks/$CHECK_ID/state`. + + +```sql +SELECT +previous_outage, +regions +FROM digitalocean.uptime.checks_states +WHERE check_id = '{{ check_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/index.md index ac24ff38aa..537d429a55 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/index.md @@ -9,41 +9,30 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -Uptime - +uptime service documentation. + :::info Service Summary
total resources: 3
-total selectable resources: 3
-total methods: 16
::: -## Overview - - - - - - -
Namedigitalocean.uptime
TypeService
TitleDigitalOcean API - Uptime
DescriptionUptime
Iduptime:v23.04.00139
- ## Resources
-check_alerts
-check_state
-
-
checks
+checks_alerts
+
+checks_states
+
\ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/index.md b/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/index.md new file mode 100644 index 0000000000..2b62795934 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/index.md @@ -0,0 +1,37 @@ +--- +title: vpc_peerings +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peerings + - digitalocean + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +vpc_peerings service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+vpc_peerings +
+
+ +
+
\ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/vpc_peerings/index.md b/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/vpc_peerings/index.md new file mode 100644 index 0000000000..1d3f171e1a --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/vpc_peerings/vpc_peerings/index.md @@ -0,0 +1,119 @@ +--- +title: vpc_peerings +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peerings + - vpc_peerings + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a vpc_peerings resource. + +## Overview + + + + +
Namevpc_peerings
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A unique ID that can be used to identify and reference the VPC peering. | +| | `string` | The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. | +| | `string` | A time value given in ISO8601 combined date and time format. | +| | `string` | The current status of the VPC peering. | +| | `array` | An array of the two peered VPCs IDs. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To show information about an existing VPC Peering, send a GET request to `/v2/vpc_peerings/$VPC_PEERING_ID`. | +| | `SELECT` | | To list all of the VPC peerings on your account, send a GET request to `/v2/vpc_peerings`. | +| | `INSERT` | | To create a new VPC Peering, send a POST request to `/v2/vpc_peerings` specifying a name and a list of two VPC IDs to peer. The response code, 202 Accepted, does not indicate the success or failure of the operation, just that the request has been accepted for processing. | +| | `DELETE` | | To delete a VPC peering, send a DELETE request to `/v2/vpc_peerings/$VPC_PEERING_ID`. | +| | `UPDATE` | | To update the name of a VPC peering, send a PATCH request to `/v2/vpc_peerings/$VPC_PEERING_ID` with the new `name` in the request body. | + +## `SELECT` examples + +To list all of the VPC peerings on your account, send a GET request to `/v2/vpc_peerings`. + + +```sql +SELECT +id, +name, +created_at, +status, +vpc_ids +FROM digitalocean.vpc_peerings.vpc_peerings +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_peerings resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.vpc_peerings.vpc_peerings ( + +) +SELECT + +; +``` + + + + +```yaml +- name: vpc_peerings + props: [] + +``` + + + +## `UPDATE` example + +Updates a vpc_peerings resource. + +```sql +/*+ update */ +UPDATE digitalocean.vpc_peerings.vpc_peerings +SET + +WHERE +vpc_peering_id = '{{ vpc_peering_id }}'; +``` + +## `DELETE` example + +Deletes the specified vpc_peerings resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.vpc_peerings.vpc_peerings +WHERE vpc_peering_id = '{{ vpc_peering_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md index 29ace23046..a063f683cd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md @@ -9,40 +9,30 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- -VPCs - +vpcs service documentation. + :::info Service Summary
-total resources: 2
-total selectable resources: 2
-total methods: 10
+total resources: 3
::: -## Overview - - - - - - -
Namedigitalocean.vpcs
TypeService
TitleDigitalOcean API - Vpcs
DescriptionVPCs
Idvpcs:v23.04.00139
- ## Resources
members
+peerings
-vpcs
-
+vpcs
+ \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md index b0eb9b824a..61296fcfbb 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - members - vpcs - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a members resource. ## Overview @@ -33,8 +33,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | The name of the resource. | | | `string` | A time value given in ISO8601 combined date and time format that represents when the resource was created. | | | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of the resources that are members of a VPC, send a GET request to `/v2/vpcs/$VPC_ID/members`. To only list resources of a specific type that are members of the VPC, included a `resource_type` query parameter. For example, to only list Droplets in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. | + +## `SELECT` examples + +To list all of the resources that are members of a VPC, send a GET request to `/v2/vpcs/$VPC_ID/members`. To only list resources of a specific type that are members of the VPC, included a `resource_type` query parameter. For example, to only list Droplets in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. + + +```sql +SELECT +name, +created_at, +urn +FROM digitalocean.vpcs.members +WHERE vpc_id = '{{ vpc_id }}'; +``` \ No newline at end of file diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/peerings/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/peerings/index.md new file mode 100644 index 0000000000..c59d4a3305 --- /dev/null +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/peerings/index.md @@ -0,0 +1,121 @@ +--- +title: peerings +hide_title: false +hide_table_of_contents: false +keywords: + - peerings + - vpcs + - digitalocean + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage digitalocean resources using SQL +custom_edit_url: null +image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a peerings resource. + +## Overview +
+ + + +
Namepeerings
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | A unique ID that can be used to identify and reference the VPC peering. | +| | `string` | The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. | +| | `string` | A time value given in ISO8601 combined date and time format. | +| | `string` | The current status of the VPC peering. | +| | `array` | An array of the two peered VPCs IDs. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | To list all of a VPC's peerings, send a GET request to `/v2/vpcs/$VPC_ID/peerings`. | +| | `INSERT` | | To create a new VPC peering for a given VPC, send a POST request to `/v2/vpcs/$VPC_ID/peerings`. | +| | `UPDATE` | | To update the name of a VPC peering in a particular VPC, send a PATCH request to `/v2/vpcs/$VPC_ID/peerings/$VPC_PEERING_ID` with the new `name` in the request body. | + +## `SELECT` examples + +To list all of a VPC's peerings, send a GET request to `/v2/vpcs/$VPC_ID/peerings`. + + +```sql +SELECT +id, +name, +created_at, +status, +vpc_ids +FROM digitalocean.vpcs.peerings +WHERE vpc_id = '{{ vpc_id }}'; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new peerings resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.vpcs.peerings ( +data__name, +data__vpc_id, +vpc_id +) +SELECT +'{{ name }}', +'{{ vpc_id }}' +; +``` + + + + +```yaml +- name: peerings + props: + - name: vpc_id + value: string + - name: data__name + value: string + - name: data__vpc_id + value: string + - name: name + value: string + - name: vpc_id + value: string + +``` + + + +## `UPDATE` example + +Updates a peerings resource. + +```sql +/*+ update */ +UPDATE digitalocean.vpcs.peerings +SET + +WHERE +vpc_id = '{{ vpc_id }}' +AND vpc_peering_id = '{{ vpc_peering_id }}'; +``` diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md index 2c5349be18..a837ffc8a7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md @@ -5,20 +5,20 @@ hide_table_of_contents: false keywords: - vpcs - vpcs - - digitalocean - - stackql + - digitalocean - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage Sumologic resources using SQL +description: Query, deploy and manage digitalocean resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a vpcs resource. ## Overview @@ -38,14 +38,89 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | | `string` | The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than `/28` nor larger than `/16`. If no IP range is specified, a `/20` network range is generated that won't conflict with other VPC networks in your account. | | | `string` | The slug identifier for the region where the VPC will be created. | | | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | + ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | -| | `SELECT` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | -| | `INSERT` | | To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes
in the table below in the JSON body.

**Note:** If you do not currently have a VPC network in a specific datacenter
region, the first one that you create will be set as the default for that
region. The default VPC for a region cannot be changed or deleted.
| -| | `DELETE` | | To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status
code with no body will be returned in response to a successful request.

The default VPC for a region can not be deleted. Additionally, a VPC can only
be deleted if it does not contain any member resources. Attempting to delete
a region's default VPC or a VPC that still has members will result in a
403 Forbidden error response.
| -| | `EXEC` | | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | -| | `EXEC` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | -| | `EXEC` | | To update a subset of information about a VPC, send a PATCH request to
`/v2/vpcs/$VPC_ID`.
| -| | `EXEC` | | To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`.
| +| | `SELECT` | | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | +| | `SELECT` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | +| | `INSERT` | | To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes in the table below in the JSON body. **Note:** If you do not currently have a VPC network in a specific datacenter region, the first one that you create will be set as the default for that region. The default VPC for a region cannot be changed or deleted. | +| | `DELETE` | | To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status code with no body will be returned in response to a successful request. The default VPC for a region can not be deleted. Additionally, a VPC can only be deleted if it does not contain any member resources. Attempting to delete a region's default VPC or a VPC that still has members will result in a 403 Forbidden error response. | +| | `UPDATE` | | To update a subset of information about a VPC, send a PATCH request to `/v2/vpcs/$VPC_ID`. | +| | `EXEC` | | To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`. | + +## `SELECT` examples + +To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. + + +```sql +SELECT +id, +name, +description, +created_at, +default, +ip_range, +region, +urn +FROM digitalocean.vpcs.vpcs +; +``` +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpcs resource. + + + + +```sql +/*+ create */ +INSERT INTO digitalocean.vpcs.vpcs ( + +) +SELECT + +; +``` + + + + +```yaml +- name: vpcs + props: [] + +``` + + + +## `UPDATE` example + +Updates a vpcs resource. + +```sql +/*+ update */ +UPDATE digitalocean.vpcs.vpcs +SET + +WHERE +vpc_id = '{{ vpc_id }}'; +``` + +## `DELETE` example + +Deletes the specified vpcs resource. + +```sql +/*+ delete */ +DELETE FROM digitalocean.vpcs.vpcs +WHERE vpc_id = '{{ vpc_id }}'; +```