-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #201 from stackql/feature/doc-updates
anthropic and confluent
- Loading branch information
Showing
146 changed files
with
6,187 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| title: confluent | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - confluent | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Confluent Cloud resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/confluent/stackql-confluent-provider-featured-image.png | ||
| id: confluent-doc | ||
| slug: /providers/confluent | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
| Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment. | ||
|
|
||
| :::info Provider Summary (v24.11.00270) | ||
|
|
||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <span>total services: <b>22</b></span><br /> | ||
| <span>total methods: <b>391</b></span><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| <span>total resources: <b>111</b></span><br /> | ||
| <span>total selectable resources: <b>81</b></span><br /> | ||
| </div> | ||
| </div> | ||
|
|
||
| ::: | ||
|
|
||
| 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 `confluent` provider, run the following command: | ||
|
|
||
| ```bash | ||
| REGISTRY PULL confluent; | ||
| ``` | ||
| > 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: | ||
|
|
||
| - <CopyableCode code="CONFLUENT_CLOUD_API_KEY" /> - Confluent Cloud API key (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>) | ||
| - <CopyableCode code="CONFLUENT_CLOUD_API_SECRET" /> - Confluent Cloud API secret (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>) | ||
|
|
||
| These variables are sourced at runtime (from the local machine or as CI variables/secrets). | ||
|
|
||
| <details> | ||
|
|
||
| <summary>Using different environment variables</summary> | ||
|
|
||
| To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: | ||
|
|
||
| ```bash | ||
|
|
||
| AUTH='{ "anthropic": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}' | ||
| stackql shell --auth="${AUTH}" | ||
|
|
||
| ``` | ||
| or using PowerShell: | ||
|
|
||
| ```powershell | ||
| $Auth = "{ 'anthropic': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}" | ||
| stackql.exe shell --auth=$Auth | ||
| ``` | ||
| </details> | ||
|
|
||
| ## Services | ||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/confluent/billing/">billing</a><br /> | ||
| <a href="/providers/confluent/catalog/">catalog</a><br /> | ||
| <a href="/providers/confluent/connect/">connect</a><br /> | ||
| <a href="/providers/confluent/encryption_keys/">encryption_keys</a><br /> | ||
| <a href="/providers/confluent/flink_artifacts/">flink_artifacts</a><br /> | ||
| <a href="/providers/confluent/flink_compute_pools/">flink_compute_pools</a><br /> | ||
| <a href="/providers/confluent/iam/">iam</a><br /> | ||
| <a href="/providers/confluent/kafka/">kafka</a><br /> | ||
| <a href="/providers/confluent/ksqldb_clusters/">ksqldb_clusters</a><br /> | ||
| <a href="/providers/confluent/managed_kafka_clusters/">managed_kafka_clusters</a><br /> | ||
| <a href="/providers/confluent/networking/">networking</a><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/confluent/notifications/">notifications</a><br /> | ||
| <a href="/providers/confluent/org/">org</a><br /> | ||
| <a href="/providers/confluent/partner/">partner</a><br /> | ||
| <a href="/providers/confluent/pipelines/">pipelines</a><br /> | ||
| <a href="/providers/confluent/provider_integrations/">provider_integrations</a><br /> | ||
| <a href="/providers/confluent/quotas/">quotas</a><br /> | ||
| <a href="/providers/confluent/schema_registry/">schema_registry</a><br /> | ||
| <a href="/providers/confluent/schema_registry_clusters/">schema_registry_clusters</a><br /> | ||
| <a href="/providers/confluent/sql/">sql</a><br /> | ||
| <a href="/providers/confluent/stream_sharing/">stream_sharing</a><br /> | ||
| <a href="/providers/confluent/sts/">sts</a><br /> | ||
| </div> | ||
| </div> |
52 changes: 52 additions & 0 deletions
52
docs/confluent-docs/providers/confluent/billing/costs/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: costs | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - costs | ||
| - billing | ||
| - confluent | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Confluent Cloud resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/confluent/stackql-confluent-provider-featured-image.png | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>costs</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="confluent.billing.costs" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| | Name | Datatype | Description | | ||
| |:-----|:---------|:------------| | ||
| | <CopyableCode code="id" /> | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). | | ||
| | <CopyableCode code="amount" /> | `number` | Final amount after deducting discounts. | | ||
| | <CopyableCode code="api_version" /> | `string` | APIVersion defines the schema version of this representation of a resource. | | ||
| | <CopyableCode code="discount_amount" /> | `number` | Amount discounted from the original amount in dollars. | | ||
| | <CopyableCode code="end_date" /> | `string` | End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. | | ||
| | <CopyableCode code="granularity" /> | `string` | Granularity at which each line item is aggregated. | | ||
| | <CopyableCode code="kind" /> | `string` | Kind defines the object this REST resource represents. | | ||
| | <CopyableCode code="line_type" /> | `string` | Type of the line item. | | ||
| | <CopyableCode code="network_access_type" /> | `string` | Network access type for the cluster. | | ||
| | <CopyableCode code="original_amount" /> | `number` | Original amount accrued for this line item. | | ||
| | <CopyableCode code="price" /> | `number` | Price for the line item in dollars. | | ||
| | <CopyableCode code="product" /> | `string` | Product name. | | ||
| | <CopyableCode code="quantity" /> | `number` | Quantity of the line item. | | ||
| | <CopyableCode code="resource" /> | `object` | The resource for a given object | | ||
| | <CopyableCode code="start_date" /> | `string` | Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. | | ||
| | <CopyableCode code="unit" /> | `string` | Unit of the line item. | | ||
| ## Methods | ||
| | Name | Accessible by | Required Params | | ||
| |:-----|:--------------|:----------------| | ||
| | <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: billing | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - billing | ||
| - confluent | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Confluent Cloud resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/confluent/stackql-confluent-provider-featured-image.png | ||
| --- | ||
|
|
||
| Billing | ||
|
|
||
| :::info Service Summary | ||
|
|
||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <span>total resources: <b>1</b></span><br /> | ||
| <span>total selectable resources: <b>1</b></span><br /> | ||
| <span>total methods: <b>1</b></span><br /> | ||
| </div> | ||
| </div> | ||
|
|
||
| ::: | ||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>confluent.billing</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Service</td></tr> | ||
| <tr><td><b>Title</b></td><td>Confluent Cloud APIs - Billing</td></tr> | ||
| <tr><td><b>Description</b></td><td>Billing</td></tr> | ||
| <tr><td><b>Id</b></td><td><code>billing:v24.10.00268</code></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Resources | ||
| <div class="row"> | ||
| <div class="providerDocColumn"> | ||
| <a href="/providers/confluent/billing/costs/">costs</a><br /> | ||
| </div> | ||
| <div class="providerDocColumn"> | ||
| </div> | ||
| </div> |
44 changes: 44 additions & 0 deletions
44
docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: business_metadata | ||
| hide_title: false | ||
| hide_table_of_contents: false | ||
| keywords: | ||
| - business_metadata | ||
| - catalog | ||
| - confluent | ||
| - stackql | ||
| - infrastructure-as-code | ||
| - configuration-as-data | ||
| - cloud inventory | ||
| description: Query, deploy, and manage Confluent Cloud resources using SQL. | ||
| custom_edit_url: null | ||
| image: /img/providers/confluent/stackql-confluent-provider-featured-image.png | ||
| --- | ||
|
|
||
| import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Overview | ||
| <table><tbody> | ||
| <tr><td><b>Name</b></td><td><code>business_metadata</code></td></tr> | ||
| <tr><td><b>Type</b></td><td>Resource</td></tr> | ||
| <tr><td><b>Id</b></td><td><CopyableCode code="confluent.catalog.business_metadata" /></td></tr> | ||
| </tbody></table> | ||
|
|
||
| ## Fields | ||
| | Name | Datatype | Description | | ||
| |:-----|:---------|:------------| | ||
| | <CopyableCode code="attributes" /> | `object` | The business metadata attributes | | ||
| | <CopyableCode code="entityName" /> | `string` | The qualified name of the entity | | ||
| | <CopyableCode code="entityType" /> | `string` | The entity type | | ||
| | <CopyableCode code="error" /> | `object` | Error message of this operation | | ||
| | <CopyableCode code="typeName" /> | `string` | The business metadata name | | ||
| ## Methods | ||
| | Name | Accessible by | Required Params | Description | | ||
| |:-----|:--------------|:----------------|:------------| | ||
| | <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [](#section/Versioning/API-Lifecycle-Policy)<br /><br />Gets the list of business metadata for a given entity represented<br />by a qualified name. | | ||
| | <CopyableCode code="create_business_metadata" /> | `INSERT` | | [](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to create multiple business metadata. | | ||
| | <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [](#section/Versioning/API-Lifecycle-Policy)<br /><br />Delete a business metadata on an entity. | | ||
| | <CopyableCode code="update_business_metadata" /> | `EXEC` | | [](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to update multiple business metadata. | |
Oops, something went wrong.