Skip to content

Commit d02a75d

Browse files
committed
Add feedback
1 parent e8ac4e7 commit d02a75d

File tree

2 files changed

+9
-21
lines changed

2 files changed

+9
-21
lines changed

articles/iot-operations/manage-mqtt-broker/howto-configure-authentication.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.subservice: azure-mqtt-broker
77
ms.topic: how-to
88
ms.custom:
99
- ignite-2023
10-
ms.date: 07/27/2024
10+
ms.date: 08/02/2024
1111

1212
#CustomerIntent: As an operator, I want to configure authentication so that I have secure MQTT broker communications.
1313
---
@@ -35,8 +35,6 @@ metadata:
3535
name: authn
3636
namespace: azure-iot-operations
3737
spec:
38-
listenerRef:
39-
- listener
4038
authenticationMethods:
4139
- method: ServiceAccountToken
4240
serviceAccountToken:
@@ -48,10 +46,9 @@ To change the configuration, modify the `authenticationMethods` setting in this
4846

4947
## Relationship between BrokerListener and BrokerAuthentication
5048

51-
BrokerListener and BrokerAuthentication are separate resources, but they're linked together using `listenerRef`. The following rules apply:
49+
The following rules apply to the relationship between BrokerListener and BrokerAuthentication:
5250

53-
* A BrokerListener can be linked to only one BrokerAuthentication
54-
* A BrokerAuthentication can be linked to multiple BrokerListeners
51+
* Each BrokerListener can have multiple ports. Each port can be linked to a BrokerAuthentication resource.
5552
* Each BrokerAuthentication can support multiple authentication methods at once
5653

5754
## Authentication flow
@@ -79,14 +76,15 @@ metadata:
7976
name: authn
8077
namespace: azure-iot-operations
8178
spec:
82-
listenerRef:
83-
- listener
8479
authenticationMethods:
85-
- method: custom
80+
- method: Custom
81+
custom:
8682
# ...
87-
- method: serviceAccountToken
83+
- method: ServiceAccountToken
84+
serviceAccountToken:
8885
# ...
8986
- method: x509Credentials
87+
x509Credentials:
9088
# ...
9189
```
9290

@@ -102,12 +100,7 @@ If the custom authentication server is unavailable and all subsequent methods de
102100

103101
## Disable authentication
104102

105-
For testing, disable authentication by changing it in the [BrokerListener resource](howto-configure-brokerlistener.md).
106-
107-
```yaml
108-
spec:
109-
authenticationEnabled: false
110-
```
103+
For testing, you can disable authentication by omitting `authenticationRef` in the `ports` setting of a BrokerListener resource.
111104

112105
## Configure authentication method
113106

articles/iot-operations/manage-mqtt-broker/howto-configure-authorization.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ The specification of a *BrokerAuthorization* resource has the following fields:
2929

3030
| Field Name | Required | Description |
3131
| --- | --- | --- |
32-
| listenerRef | Yes | The names of the BrokerListener resources that this authorization policy applies. This field is required and must match an existing *BrokerListener* resource in the same namespace. |
3332
| authorizationPolicies | Yes | This field defines the settings for the authorization policies, such as *enableCache* and *rules*.|
3433
| enableCache | No | Whether to enable caching for the authorization policies. If set to `true`, the broker caches the authorization results for each client and topic combination to improve performance and reduce latency. If set to `false`, the broker evaluates the authorization policies for each client and topic request, to ensure consistency and accuracy. This field is optional and defaults to `false`. |
3534
| rules | No | A list of rules that specify the principals and resources for the authorization policies. Each rule has these subfields: *principals* and *brokerResources*. |
@@ -50,8 +49,6 @@ metadata:
5049
name: "my-authz-policies"
5150
namespace: azure-iot-operations
5251
spec:
53-
listenerRef:
54-
- "my-listener" # change to match your listener name as needed
5552
authorizationPolicies:
5653
enableCache: true
5754
rules:
@@ -119,8 +116,6 @@ metadata:
119116
name: "my-authz-policies"
120117
namespace: azure-iot-operations
121118
spec:
122-
listenerRef:
123-
- "az-mqtt-non-tls-listener"
124119
authorizationPolicies:
125120
enableCache: false
126121
rules:

0 commit comments

Comments
 (0)