Skip to content

Commit 32d82ad

Browse files
authored
Merge pull request #192807 from spelluru/egridarc0324
added CLI command to enable HTTP
2 parents c68478d + b80e53f commit 32d82ad

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

articles/event-grid/kubernetes/install-k8s-extension.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This article provides steps to install Event Grid on Azure Arc enab
44
author: jfggdl
55
ms.author: jafernan
66
ms.subservice: kubernetes
7-
ms.date: 05/26/2021
7+
ms.date: 03/24/2022
88
ms.topic: how-to
99
---
1010

@@ -44,7 +44,7 @@ If you run into an issue, see the [Troubleshooting](#troubleshooting) section fo
4444
The Event Grid broker (server) serves two kinds of clients. Server authentication is done using Certificates. Client authentication is done using either certificates or SAS keys based on the client type.
4545

4646
- Event Grid operators that make control plane requests to the Event Grid broker are authenticated using certificates.
47-
- Event Grid publishers that publisher events to an event grid topic are authenticated with the topic's SAS keys.
47+
- Event Grid publishers that publisher events to an Event Grid topic are authenticated with the topic's SAS keys.
4848

4949
To establish a secure HTTPS communication with the Event Grid broker and Event Grid operator, we use PKI Certificates during the installation of Event Grid extension. Here are the general requirements for these PKI certificates:
5050

@@ -90,7 +90,7 @@ To establish a secure HTTPS communication with the Event Grid broker and Event G
9090
1. For **Release namespace**, you may want to provide the name of a Kubernetes namespace where Event Grid components will be deployed into. For example, you might want to have a single namespace for all Azure Arc-enabled services deployed to your cluster. The default is **eventgrid-system**. If the namespace provided doesn't exist, it's created for you.
9191
1. On the **Event Grid broker** details section, the service type is shown. The Event Grid broker, which is the component that exposes the topic endpoints to which events are sent, is exposed as a Kubernetes service type **ClusterIP**. Hence, the IPs assigned to all topics use the private IP space configured for the cluster.
9292
1. Provide the **storage class name** that you want to use for the broker and that's supported by your Kubernetes distribution. For example, if you're using AKS, you could use `azurefile`, which uses Azure Standard storage. For more information on predefined storage classes supported by AKS, see [Storage Classes in AKS](../../aks/concepts-storage.md#storage-classes). If you're using other Kubernetes distributions, see your Kubernetes distribution documentation for predefined storage classes supported or the way you can provide your own.
93-
1. **Storage size**. Default is 1 GiB. Consider the ingestion rate when determining the size of your storage. Ingestion rate in MiB/second measured as the size of your events times the publishing rate (events per second) across all topics on the Event Grid broker is a key factor when allocating storage. Events are transient in nature and once they're delivered, there is no storage consumption for those events. While ingestion rate is a main driver for storage use, it isn't the only one. Metadata holding topic and event subscription configuration also consumes storage space, but that normally requires a lower amount of storage space than the events ingested and being delivered by Event Grid.
93+
1. **Storage size**. Default is 1 GiB. Consider the ingestion rate when determining the size of your storage. Ingestion rate in MiB/second measured as the size of your events times the publishing rate (events per second) across all topics on the Event Grid broker is a key factor when allocating storage. Events are transient in nature and once they're delivered, there's no storage consumption for those events. While ingestion rate is a main driver for storage use, it isn't the only one. Metadata holding topic and event subscription configuration also consumes storage space, but that normally requires a lower amount of storage space than the events ingested and being delivered by Event Grid.
9494
1. **Memory limit**. Default is 1 GiB.
9595
1. **Memory request**. Default is 200 MiB. This field isn't editable.
9696

@@ -194,7 +194,36 @@ To establish a secure HTTPS communication with the Event Grid broker and Event G
194194
> During the preview version, ``cluster`` is the only scope supported when creating or updating an Event Grid extension. That means the service only supports a single instance of the Event Grid extension on a Kubernetes cluster.There is no support for namespace-scoped deployments yet. For more information on extension scopes, see [Create extension instance](../../azure-arc/kubernetes/extensions.md#create-extensions-instance) and search for ``scope``.
195195
196196
```azurecli-interactive
197-
az k8s-extension create --cluster-type connectedClusters --cluster-name <connected_cluster_name> --resource-group <resource_group_of_connected_cluster> --name <event_grid_extension_name> --extension-type Microsoft.EventGrid --scope cluster --auto-upgrade-minor-version true --release-train Stable --release-namespace <namespace_name> --configuration-protected-settings-file protected-settings-extension.json --configuration-settings-file settings-extension.json
197+
az k8s-extension create \
198+
--cluster-type connectedClusters \
199+
--cluster-name <connected_cluster_name> \
200+
--resource-group <resource_group_of_connected_cluster> \
201+
--name <event_grid_extension_name> \
202+
--extension-type Microsoft.EventGrid \
203+
--scope cluster \
204+
--auto-upgrade-minor-version true \
205+
--release-train Stable \
206+
--release-namespace <namespace_name> \
207+
--configuration-protected-settings-file protected-settings-extension.json \
208+
--configuration-settings-file settings-extension.json
209+
```
210+
211+
For more information on the CLI command, see [az k8s-extension create](/cli/azure/k8s-extension#az-k8s-extension-create). Notice that you can use the `--config-file` parameter to pass the name of a json file that contains configuration information related to Event Grid. In order to support HTTP, include the following setting.
212+
213+
```json
214+
"eventgridbroker.service.supportedProtocols[0]": "http"
215+
```
216+
217+
Here's a sample settings-extension.json with the above setting.
218+
219+
```json
220+
{
221+
"Microsoft.CustomLocation.ServiceAccount": "eventgrid-operator",
222+
"eventgridbroker.service.serviceType": "ClusterIP",
223+
"eventgridbroker.service.supportedProtocols[0]": "http",
224+
"eventgridbroker.dataStorage.storageClassName": "default",
225+
"eventgridbroker.diagnostics.metrics.reporterType": "prometheus"
226+
}
198227
```
199228
1. Validate that the event grid extension has successfully installed.
200229

0 commit comments

Comments
 (0)