stackql-deploy 2.2.0

Infrastructure-as-code framework for declarative cloud resource management using StackQL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

import File from '@site/src/components/File';
import LeftAlignedTable from '@site/src/components/LeftAlignedTable';

## Custom Authentication at Resource Level

This feature allows for custom authentication settings to be specified at the resource level within the `stackql_manifest.yml` file. This enables context-specific authentication configurations, such as control plane or data plane context switching within the same stack. Authentication parameters can be overridden by setting specific variable references in the `auth` section.

:::note

Use the latest version of `stackql-deploy` for this feature. To upgrade:

```bash
stackql-deploy upgrade
```

:::

<LeftAlignedTable type="object" required={false} />

The `auth` object will depend upon the provider the resource belongs to, consult the provider documentation in the [StackQL Provider Registry Docs](https://stackql.io/providers).

### Example Usage

<File name='stackql_manifest.yml'>

```yaml {4,12-18}
resources:
  - name: app_manager_api_key
    props:
      - name: display_name
        value: "{{ stack_name }}-{{ stack_env }}-app-manager-api-key"
      - name: description
        value: "Kafka API Key owned by 'app-manager' service account"
      - name: owner
        value:
          id: app_manager_id
          api_version: app_manager_api_version
          kind: app_manager_kind
    exports:
      - app_manager_api_key_id
      - app_manager_api_key_secret

  - name: users_topic
    auth:
      confluent:
        type: basic
        username_var: app_manager_api_key_id
        password_var: app_manager_api_key_secret
    props:
      - name: topic_name
        value: "users"
      - name: kafka_cluster
        value: {{ cluster_id }}
      - name: rest_endpoint
        value: {{ cluster_rest_endpoint }}
```

</File>

This configuration sets up a custom `basic` authentication for the `users_topic` resource, where:

- `username_var` is set to `app_manager_api_key_id`
- `password_var` is set to `app_manager_api_key_secret`

These variables are defined in the exported section of the `app_manager_api_key` resource and dynamically referenced within the authentication configuration.