Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,10 +324,6 @@ d. Fix broken links in the generated pages.
The Confluent OpenAPI spec embeds anchors (e.g. `#section/Versioning/API-Lifecycle-Policy`, `#operation/readConnectv1Connector`) and a few regex fragments inside `<code>` blocks (e.g. `[-a-z0-9]*[a-z0-9]`) that Docusaurus flags as broken links / mis-parses as link references. The post-doc-gen script `provider-dev/scripts/fix_doc_links.mjs` rewrites the affected pages from a curated map.

```bash
# preview without writing
node provider-dev/scripts/fix_doc_links.mjs --dry-run

# apply
node provider-dev/scripts/fix_doc_links.mjs
```

Expand Down
7 changes: 6 additions & 1 deletion website/docs/services/connect/connectors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ Connector.
</tr>
</thead>
<tbody>
<tr>
<td><CopyableCode code="connectv1_connector" /></td>
<td><code>string</code></td>
<td></td>
</tr>
</tbody>
</table>
</TabItem>
Expand Down Expand Up @@ -235,7 +240,7 @@ Retrieve a list of "names" of the active connectors. You can then make a read re

```sql
SELECT
*
connectv1_connector
FROM confluent.connect.connectors
WHERE environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ List of dek subjects
</tr>
</thead>
<tbody>
<tr>
<td><CopyableCode code="dek_subject" /></td>
<td><code>string</code></td>
<td></td>
</tr>
</tbody>
</table>
</TabItem>
Expand Down Expand Up @@ -254,7 +259,7 @@ List of dek subjects

```sql
SELECT
*
dek_subject
FROM confluent.encryption_keys.data_encryption_keys
WHERE name = '{{ name }}' -- required
AND deleted = '{{ deleted }}'
Expand Down
7 changes: 6 additions & 1 deletion website/docs/services/encryption_keys/dek_versions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ List of version numbers for dek
</tr>
</thead>
<tbody>
<tr>
<td><CopyableCode code="dek_version" /></td>
<td><code>integer</code></td>
<td></td>
</tr>
</tbody>
</table>
</TabItem>
Expand Down Expand Up @@ -253,7 +258,7 @@ List of version numbers for dek

```sql
SELECT
*
dek_version
FROM confluent.encryption_keys.dek_versions
WHERE name = '{{ name }}' -- required
AND subject = '{{ subject }}' -- required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ List of kek names
</tr>
</thead>
<tbody>
<tr>
<td><CopyableCode code="kek_name" /></td>
<td><code>string</code></td>
<td></td>
</tr>
</tbody>
</table>
</TabItem>
Expand Down Expand Up @@ -251,7 +256,7 @@ List of kek names

```sql
SELECT
*
kek_name
FROM confluent.encryption_keys.key_encryption_keys
WHERE deleted = '{{ deleted }}'
;
Expand Down
53 changes: 46 additions & 7 deletions website/docs/services/kafka/acls/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,28 +89,28 @@ The following methods are available for this resource:
<tr>
<td><a href="#get_kafka_acls"><CopyableCode code="get_kafka_acls" /></a></td>
<td><CopyableCode code="select" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td><a href="#parameter-resource_type"><code>resource_type</code></a>, <a href="#parameter-resource_name"><code>resource_name</code></a>, <a href="#parameter-pattern_type"><code>pattern_type</code></a>, <a href="#parameter-principal"><code>principal</code></a>, <a href="#parameter-host"><code>host</code></a>, <a href="#parameter-operation"><code>operation</code></a>, <a href="#parameter-permission"><code>permission</code></a></td>
<td>- When calling `/acls` without the `principal` parameter, service<br /> accounts are returned in numeric ID format (e.g., `User:12345`).<br />- To retrieve service accounts in the `sa-xxx` format, use<br /> `/acls?principal=UserV2:*`.<br />- The `principal` parameter supports both legacy `User:` format and<br /> new `UserV2:` format for service accounts.<br />Return a list of ACLs that match the search criteria.</td>
</tr>
<tr>
<td><a href="#create_kafka_acls"><CopyableCode code="create_kafka_acls" /></a></td>
<td><CopyableCode code="insert" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-resource_type"><code>resource_type</code></a>, <a href="#parameter-resource_name"><code>resource_name</code></a>, <a href="#parameter-pattern_type"><code>pattern_type</code></a>, <a href="#parameter-principal"><code>principal</code></a>, <a href="#parameter-host"><code>host</code></a>, <a href="#parameter-operation"><code>operation</code></a>, <a href="#parameter-permission"><code>permission</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a>, <a href="#parameter-resource_type"><code>resource_type</code></a>, <a href="#parameter-resource_name"><code>resource_name</code></a>, <a href="#parameter-pattern_type"><code>pattern_type</code></a>, <a href="#parameter-principal"><code>principal</code></a>, <a href="#parameter-host"><code>host</code></a>, <a href="#parameter-operation"><code>operation</code></a>, <a href="#parameter-permission"><code>permission</code></a></td>
<td></td>
<td>Create an ACL.</td>
</tr>
<tr>
<td><a href="#delete_kafka_acls"><CopyableCode code="delete_kafka_acls" /></a></td>
<td><CopyableCode code="delete" /></td>
<td><a href="#parameter-resource_type"><code>resource_type</code></a>, <a href="#parameter-pattern_type"><code>pattern_type</code></a>, <a href="#parameter-operation"><code>operation</code></a>, <a href="#parameter-permission"><code>permission</code></a>, <a href="#parameter-cluster_id"><code>cluster_id</code></a></td>
<td><a href="#parameter-resource_type"><code>resource_type</code></a>, <a href="#parameter-pattern_type"><code>pattern_type</code></a>, <a href="#parameter-operation"><code>operation</code></a>, <a href="#parameter-permission"><code>permission</code></a>, <a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td><a href="#parameter-resource_name"><code>resource_name</code></a>, <a href="#parameter-principal"><code>principal</code></a>, <a href="#parameter-host"><code>host</code></a></td>
<td>Delete the ACLs that match the search criteria.</td>
</tr>
<tr>
<td><a href="#batch_create_kafka_acls"><CopyableCode code="batch_create_kafka_acls" /></a></td>
<td><CopyableCode code="exec" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-data"><code>data</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a>, <a href="#parameter-data"><code>data</code></a></td>
<td></td>
<td>Create ACLs.</td>
</tr>
Expand All @@ -130,11 +130,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
</tr>
</thead>
<tbody>
<tr id="parameter-cloud_provider">
<td><CopyableCode code="cloud_provider" /></td>
<td><code>string</code></td>
<td>Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)</td>
</tr>
<tr id="parameter-cluster_id">
<td><CopyableCode code="cluster_id" /></td>
<td><code>string</code></td>
<td>The Kafka cluster ID. (example: cluster-1)</td>
</tr>
<tr id="parameter-kafka_endpoint_id">
<td><CopyableCode code="kafka_endpoint_id" /></td>
<td><code>string</code></td>
<td>Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -&gt; Overview -&gt; REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)</td>
</tr>
<tr id="parameter-operation">
<td><CopyableCode code="operation" /></td>
<td><code>string</code></td>
Expand All @@ -150,6 +160,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
<td><code>string</code></td>
<td>The ACL permission.</td>
</tr>
<tr id="parameter-region">
<td><CopyableCode code="region" /></td>
<td><code>string</code></td>
<td>Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)</td>
</tr>
<tr id="parameter-resource_type">
<td><CopyableCode code="resource_type" /></td>
<td><code>string</code></td>
Expand Down Expand Up @@ -212,6 +227,9 @@ kind,
metadata
FROM confluent.kafka.acls
WHERE cluster_id = '{{ cluster_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
AND resource_type = '{{ resource_type }}'
AND resource_name = '{{ resource_name }}'
AND pattern_type = '{{ pattern_type }}'
Expand Down Expand Up @@ -247,7 +265,10 @@ principal,
host,
operation,
permission,
cluster_id
cluster_id,
kafka_endpoint_id,
region,
cloud_provider
)
SELECT
'{{ resource_type }}' /* required */,
Expand All @@ -257,7 +278,10 @@ SELECT
'{{ host }}' /* required */,
'{{ operation }}' /* required */,
'{{ permission }}' /* required */,
'{{ cluster_id }}'
'{{ cluster_id }}',
'{{ kafka_endpoint_id }}',
'{{ region }}',
'{{ cloud_provider }}'
;
```
</TabItem>
Expand All @@ -269,6 +293,15 @@ SELECT
- name: cluster_id
value: "{{ cluster_id }}"
description: Required parameter for the acls resource.
- name: kafka_endpoint_id
value: "{{ kafka_endpoint_id }}"
description: Required parameter for the acls resource.
- name: region
value: "{{ region }}"
description: Required parameter for the acls resource.
- name: cloud_provider
value: "{{ cloud_provider }}"
description: Required parameter for the acls resource.
- name: resource_type
value: "{{ resource_type }}"
valid_values: ['UNKNOWN', 'ANY', 'TOPIC', 'GROUP', 'CLUSTER', 'TRANSACTIONAL_ID', 'DELEGATION_TOKEN']
Expand Down Expand Up @@ -309,6 +342,9 @@ AND pattern_type = '{{ pattern_type }}' --required
AND operation = '{{ operation }}' --required
AND permission = '{{ permission }}' --required
AND cluster_id = '{{ cluster_id }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
AND resource_name = '{{ resource_name }}'
AND principal = '{{ principal }}'
AND host = '{{ host }}'
Expand All @@ -332,7 +368,10 @@ Create ACLs.

```sql
EXEC confluent.kafka.acls.batch_create_kafka_acls
@cluster_id='{{ cluster_id }}' --required
@cluster_id='{{ cluster_id }}' --required,
@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required,
@region='{{ region }}' --required,
@cloud_provider='{{ cloud_provider }}' --required
@@json=
'{
"data": "{{ data }}"
Expand Down
42 changes: 36 additions & 6 deletions website/docs/services/kafka/cluster_configs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,35 +201,35 @@ The following methods are available for this resource:
<tr>
<td><a href="#get_kafka_cluster_config"><CopyableCode code="get_kafka_cluster_config" /></a></td>
<td><CopyableCode code="select" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td></td>
<td>Return the dynamic cluster-wide broker configuration parameter specified by ``name``.</td>
</tr>
<tr>
<td><a href="#list_kafka_cluster_configs"><CopyableCode code="list_kafka_cluster_configs" /></a></td>
<td><CopyableCode code="select" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td></td>
<td>Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka<br />cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.</td>
</tr>
<tr>
<td><a href="#update_kafka_cluster_config"><CopyableCode code="update_kafka_cluster_config" /></a></td>
<td><CopyableCode code="replace" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td></td>
<td>Update the dynamic cluster-wide broker configuration parameter specified by ``name``.</td>
</tr>
<tr>
<td><a href="#update_kafka_cluster_configs"><CopyableCode code="update_kafka_cluster_configs" /></a></td>
<td><CopyableCode code="replace" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-data"><code>data</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a>, <a href="#parameter-data"><code>data</code></a></td>
<td></td>
<td>Update or delete a set of dynamic cluster-wide broker configuration parameters.</td>
</tr>
<tr>
<td><a href="#delete_kafka_cluster_config"><CopyableCode code="delete_kafka_cluster_config" /></a></td>
<td><CopyableCode code="delete" /></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a></td>
<td><a href="#parameter-cluster_id"><code>cluster_id</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-kafka_endpoint_id"><code>kafka_endpoint_id</code></a>, <a href="#parameter-region"><code>region</code></a>, <a href="#parameter-cloud_provider"><code>cloud_provider</code></a></td>
<td></td>
<td>Reset the configuration parameter specified by ``name`` to its<br />default value by deleting a dynamic cluster-wide configuration.</td>
</tr>
Expand All @@ -249,16 +249,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
</tr>
</thead>
<tbody>
<tr id="parameter-cloud_provider">
<td><CopyableCode code="cloud_provider" /></td>
<td><code>string</code></td>
<td>Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)</td>
</tr>
<tr id="parameter-cluster_id">
<td><CopyableCode code="cluster_id" /></td>
<td><code>string</code></td>
<td>The Kafka cluster ID. (example: cluster-1)</td>
</tr>
<tr id="parameter-kafka_endpoint_id">
<td><CopyableCode code="kafka_endpoint_id" /></td>
<td><code>string</code></td>
<td>Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -&gt; Overview -&gt; REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)</td>
</tr>
<tr id="parameter-name">
<td><CopyableCode code="name" /></td>
<td><code>string</code></td>
<td>The configuration parameter name. (example: compression.type)</td>
</tr>
<tr id="parameter-region">
<td><CopyableCode code="region" /></td>
<td><code>string</code></td>
<td>Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -291,6 +306,9 @@ value
FROM confluent.kafka.cluster_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND name = '{{ name }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;
```
</TabItem>
Expand All @@ -313,6 +331,9 @@ synonyms,
value
FROM confluent.kafka.cluster_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;
```
</TabItem>
Expand All @@ -338,7 +359,10 @@ SET
value = '{{ value }}'
WHERE
cluster_id = '{{ cluster_id }}' --required
AND name = '{{ name }}' --required;
AND name = '{{ name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required;
```
</TabItem>
<TabItem value="update_kafka_cluster_configs">
Expand All @@ -352,6 +376,9 @@ data = '{{ data }}',
validate_only = {{ validate_only }}
WHERE
cluster_id = '{{ cluster_id }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
AND data = '{{ data }}' --required;
```
</TabItem>
Expand All @@ -374,6 +401,9 @@ Reset the configuration parameter specified by ``name`` to its<br />default valu
DELETE FROM confluent.kafka.cluster_configs
WHERE cluster_id = '{{ cluster_id }}' --required
AND name = '{{ name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
;
```
</TabItem>
Expand Down
Loading
Loading