diff --git a/docs/datadog-docs/index.md b/docs/datadog-docs/index.md index 39e22f13ca..0153237c72 100644 --- a/docs/datadog-docs/index.md +++ b/docs/datadog-docs/index.md @@ -51,8 +51,8 @@ REGISTRY PULL datadog; The following system environment variables are used for authentication by default: -- - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) -- - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) +- - Datadog API key (see Datadog API Key Documentation) +- - Datadog Application Key (see Datadog Application Key Documentation) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/datadog-docs/providers/datadog/users/vw_users/index.md b/docs/datadog-docs/providers/datadog/users/vw_users/index.md index bd6d1e70e0..527b8915f2 100644 --- a/docs/datadog-docs/providers/datadog/users/vw_users/index.md +++ b/docs/datadog-docs/providers/datadog/users/vw_users/index.md @@ -47,4 +47,4 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | || | || ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/github-docs/index.md b/docs/github-docs/index.md index 629a9bfc9f..68a54d94a0 100644 --- a/docs/github-docs/index.md +++ b/docs/github-docs/index.md @@ -52,7 +52,7 @@ REGISTRY PULL github; The following system environment variables are used for authentication by default: - - GitHub username (login) -- - GitHub Personal Access Token (see [Creating a personal access token](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)) +- - GitHub Personal Access Token (see Creating a personal access token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/godaddy-docs/index.md b/docs/godaddy-docs/index.md index ec9e112f4c..de4b4e9e1d 100644 --- a/docs/godaddy-docs/index.md +++ b/docs/godaddy-docs/index.md @@ -51,7 +51,7 @@ REGISTRY PULL godaddy; The following system environment variables are used for authentication by default: -- - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) +- - Godaddy API key (see Creating a Godaddy API Key) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/netlify-docs/index.md b/docs/netlify-docs/index.md index 4701709282..f4c2a423c2 100644 --- a/docs/netlify-docs/index.md +++ b/docs/netlify-docs/index.md @@ -51,7 +51,7 @@ REGISTRY PULL netlify; The following system environment variables are used for authentication by default: -- - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) +- - Netlify API token (see How to Create a Netlify API Token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/okta-docs/index.md b/docs/okta-docs/index.md index f154a62159..1d7a817a46 100644 --- a/docs/okta-docs/index.md +++ b/docs/okta-docs/index.md @@ -51,7 +51,7 @@ REGISTRY PULL okta; The following system environment variables are used for authentication by default: -- - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) +- - Okta API Token (see Creating an Okta API Token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -83,7 +83,7 @@ stackql.exe shell --auth=$Auth The following parameter is required for the `okta` provider: -- `subdomain` - The Okta tenant domain, for example `my-company` would be supplied if your Okta domain is `my-company.okta.com` +- - The Okta tenant domain, for example `my-company` would be supplied if your Okta domain is `my-company.okta.com` This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. diff --git a/docs/pagerduty-docs/index.md b/docs/pagerduty-docs/index.md index cd132e8d57..c2a84511c4 100644 --- a/docs/pagerduty-docs/index.md +++ b/docs/pagerduty-docs/index.md @@ -51,7 +51,7 @@ REGISTRY PULL pagerduty; The following system environment variables are used for authentication by default: -- - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) +- - PagerDuty API token (see Creating a PagerDuty API Token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/sumologic-docs/index.md b/docs/sumologic-docs/index.md index 4c859bdf4a..7ae40bf94a 100644 --- a/docs/sumologic-docs/index.md +++ b/docs/sumologic-docs/index.md @@ -84,7 +84,7 @@ stackql.exe shell --auth=$Auth The following parameter is required for the `sumologic` provider if you are not using the `us2` region: -- `region` - The SumoLogic regional endpoint (e.g. `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`) +- - The SumoLogic regional endpoint (e.g. `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`) This parameter would be supplied to the `WHERE` clause of each `SELECT` statement if you are not usign the `us2` region. diff --git a/docs/vercel-docs/index.md b/docs/vercel-docs/index.md index 5b1643821d..390cc83c09 100644 --- a/docs/vercel-docs/index.md +++ b/docs/vercel-docs/index.md @@ -51,7 +51,7 @@ REGISTRY PULL vercel; The following system environment variables are used for authentication by default: -- - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) +- - Vercel API Token (see Creating a Vercel API Token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 8f7f9a8fc9..4346a179a6 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -293,7 +293,7 @@ 'custom': False, 'variables': """ - - GitHub username (login) -- - GitHub Personal Access Token (see [Creating a personal access token](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)) +- - GitHub Personal Access Token (see Creating a personal access token) """, 'linux': """ AUTH='{ "github": { "type": "basic", "username_var": "YOUR_GITHUB_USERNAME_VAR", "password_var": "YOUR_GITHUB_PASSWORD_VAR" }}' @@ -310,7 +310,7 @@ 'netlify': { 'custom': False, 'variables': """ -- - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) +- - Netlify API token (see How to Create a Netlify API Token) """, 'linux': """ AUTH='{ "netlify": { "type": "bearer", "credentialsenvvar": "YOUR_NETLIFY_AUTH_TOKEN_VAR" }}' @@ -324,29 +324,29 @@ # # AWS # - 'aws': { - 'custom': False, - 'variables': """ -- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) -- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) -- `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)) - """, - 'linux': """ -AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}' -stackql shell --auth="${AUTH}" -""", - 'windows': """ -$Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}" -stackql.exe shell --auth=$Auth -""", - }, +# 'aws': { +# 'custom': False, +# 'variables': """ +# - `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) +# - `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)) +# - `AWS_SESSION_TOKEN` - [__OPTIONAL:__ only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)) +# """, +# 'linux': """ +# AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}' +# stackql shell --auth="${AUTH}" +# """, +# 'windows': """ +# $Auth = "{ 'aws': { 'type': 'aws_signing_v4', 'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}" +# stackql.exe shell --auth=$Auth +# """, +# }, # # Okta # 'okta': { 'custom': False, 'variables': """ -- - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) +- - Okta API Token (see Creating an Okta API Token) """, 'linux': """ AUTH='{ "okta": { "type": "api_key", "valuePrefix": "SSWS ", "credentialsenvvar": "YOUR_OKTA_API_TOKEN_VAR" }}' @@ -363,7 +363,7 @@ 'vercel': { 'custom': False, 'variables': """ -- - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) +- - Vercel API Token (see Creating a Vercel API Token) """, 'linux': """ AUTH='{ "okta": { "type": "bearer", "credentialsenvvar": "YOUR_VERCEL_API_TOKEN_VAR" }}' @@ -380,7 +380,7 @@ 'godaddy': { 'custom': False, 'variables': """ -- - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) +- - Godaddy API key (see Creating a Godaddy API Key) """, 'linux': """ AUTH='{ "okta": { "type": "bearer", "credentialsenvvar": "YOUR_GODADDY_API_KEY_VAR" }}' @@ -397,7 +397,7 @@ 'pagerduty': { 'custom': False, 'variables': """ -- - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) +- - PagerDuty API token (see Creating a PagerDuty API Token) """, 'linux': """ AUTH='{ "pagerduty": { "type": "bearer", "credentialsenvvar": "YOUR_PAGERDUTY_API_TOKEN_VAR" }}' @@ -414,8 +414,8 @@ 'datadog': { 'custom': False, 'variables': """ -- - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) -- - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) +- - Datadog API key (see Datadog API Key Documentation) +- - Datadog Application Key (see Datadog Application Key Documentation) """, 'linux': """ AUTH='{ "datadog": { "type": "custom", "location": "header", "name": "DD-API-KEY", "credentialsenvvar": "YOUR_DD_API_KEY_VAR", "successor": { "type": "custom", "location": "header", "name": "DD-APPLICATION-KEY", "credentialsenvvar": "YOUR_DD_APP_KEY_VAR" }}}' @@ -462,7 +462,7 @@ 'azure': { 'custom': True, 'custom_markdown': """ -StackQL uses Azure application credentials obtained using the `az login` command from the Azure SDK. For more information, see [here](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). +StackQL uses Azure application credentials obtained using the command from the Azure SDK. For more information, see here. """, }, # @@ -471,7 +471,7 @@ 'azure_extras': { 'custom': True, 'custom_markdown': """ -StackQL uses Azure application credentials obtained using the `az login` command from the Azure SDK. For more information, see [here](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). +StackQL uses Azure application credentials obtained using the command from the Azure SDK. For more information, see here. """, }, # @@ -480,7 +480,7 @@ 'azure_isv': { 'custom': True, 'custom_markdown': """ -StackQL uses Azure application credentials obtained using the `az login` command from the Azure SDK. For more information, see [here](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). +StackQL uses Azure application credentials obtained using the command from the Azure SDK. For more information, see here. """, }, # @@ -489,7 +489,7 @@ 'azure_stack': { 'custom': True, 'custom_markdown': """ -StackQL uses Azure application credentials obtained using the `az login` command from the Azure SDK. For more information, see [here](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). +StackQL uses Azure application credentials obtained using the command from the Azure SDK. For more information, see here. """, }, # @@ -500,7 +500,7 @@ 'custom_markdown': """ :::note -__`cluster_addr`__ is a required paramter for all operations using the `k8s` provider, for example: + is a required parameter for all operations using the `k8s` provider, for example: ```sql SELECT name, namespace, uid, creationTimestamp @@ -515,7 +515,7 @@ :::note -The __`protocol`__ parameter is required when accessing a Kubernetes cluster via `kubectl proxy`, see the example below: +The parameter is required when accessing a Kubernetes cluster via `kubectl proxy`, see the example below: ```sql select name, namespace, uid, creationTimestamp @@ -542,7 +542,7 @@ kubectl get secret -o jsonpath="{.items[?(@.type==\"kubernetes.io/service-account-token\")].data['ca\.crt']}" | base64 -i --decode > k8s_cert_bundle.pem ``` -Alternatively, you could add the `--tls.allowInsecure=true` argument to the `stackql` command, it is not recommended however. +Alternatively, you could add the argument to the `stackql` command, it is not recommended however. ::: """ @@ -550,32 +550,32 @@ } server_variables_blocks = { - 'aws': """ -The following parameter is required for the `aws` provider: +# 'aws': """ +# The following parameter is required for the `aws` provider: -- `region` - AWS region (e.g. `us-east-1`) +# - `region` - AWS region (e.g. `us-east-1`) -This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. - """, +# This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. +# """, 'okta': """ The following parameter is required for the `okta` provider: -- `subdomain` - The Okta tenant domain, for example `my-company` would be supplied if your Okta domain is `my-company.okta.com` +- - The Okta tenant domain, for example `my-company` would be supplied if your Okta domain is `my-company.okta.com` This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. """, 'sumologic': """ The following parameter is required for the `sumologic` provider if you are not using the `us2` region: -- `region` - The SumoLogic regional endpoint (e.g. `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`) +- - The SumoLogic regional endpoint (e.g. `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`) This parameter would be supplied to the `WHERE` clause of each `SELECT` statement if you are not usign the `us2` region. """, 'k8s': """ The following parameters may be required for the `k8s` provider: -- `protocol` - `https` or `http` (default: `https`) -- `cluster_addr` - The hostname of the Kubernetes cluster (default: `localhost`) +- - `https` or `http` (default: `https`) +- - The hostname of the Kubernetes cluster (default: `localhost`) This parameter would be supplied to the `WHERE` clause of each `SELECT` statement. """,