Skip to content

Commit

Permalink
Merge pull request #209 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
updated confluent
  • Loading branch information
jeffreyaven authored Nov 9, 2024
2 parents ca5f615 + d112b2a commit a2bbefc
Showing 1 changed file with 39 additions and 13 deletions.
52 changes: 39 additions & 13 deletions docs/confluent-docs/index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
---
title: azure
title: confluent
hide_title: false
hide_table_of_contents: false
keywords:
- azure
- microsoft azure
- confluent
- kafka
- stackql
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage Microsoft Azure resources using SQL
description: Query, deploy and manage Confluent Cloud resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
id: azure-doc
slug: /providers/azure
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
id: confluent-doc
slug: /providers/confluent

---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Core cloud services from Microsoft Azure.
Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment.


:::info Provider Summary

Expand All @@ -38,20 +39,45 @@ See also:

## Installation

To pull the latest version of the `azure` provider, run the following command:
To pull the latest version of the `confluent` provider, run the following command:

```bash
REGISTRY PULL azure;
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

StackQL uses Azure application credentials obtained using the <CopyableCode code="az login" /> command from the Azure SDK. For more information, see <a href="https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli">here</a>.
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://docs.confluent.io/cloud/current/security/authenticate/overview.html#api-keys">Confluent Cloud API Keys</a>)
- <CopyableCode code="CONFLUENT_CLOUD_API_SECRET" /> - Confluent Cloud API secret (see <a href="https://docs.confluent.io/cloud/current/security/authenticate/overview.html#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='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}'
stackql shell --auth="${AUTH}"

```

### Authenticating using an Azure Service Principal
or using PowerShell:

To authenticate using an Azure Service Principal, set the following environment variables: <CopyableCode code="AZURE_TENANT_ID" />, <CopyableCode code="AZURE_CLIENT_ID" /> and <CopyableCode code="AZURE_CLIENT_SECRET" />, see [__creating-an-azure-service-principal__](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication-service-principal?tabs=azure-cli#2-create-an-azure-service-principal).
```powershell
$Auth = "{ 'confluent': { '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">
Expand Down

0 comments on commit a2bbefc

Please sign in to comment.