Skip to content

Commit 7f23503

Browse files
authored
Merge branch 'esa-pp' into esa-pp
2 parents 27c0f0d + 049988d commit 7f23503

20 files changed

+218
-192
lines changed

articles/azure-arc/edge-storage-accelerator/attach-app.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Attach your application using the Azure IoT Operations data processor or Kubernetes native application
3-
description: Learn how to attach your app using the Azure IoT Operations data processor or Kubernetes native application.
2+
title: Attach your application using the Azure IoT Operations data processor or Kubernetes native application (preview)
3+
description: Learn how to attach your app using the Azure IoT Operations data processor or Kubernetes native application in Edge Storage Accelerator.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 03/12/2024
7+
ms.date: 04/08/2024
88
zone_pivot_groups: attach-app
99
---
1010

11-
# Attach your application
11+
# Attach your application (preview)
1212

1313
This article assumes you created a Persistent Volume (PV) and a Persistent Volume Claim (PVC). For information about creating a PV, see [Create a persistent volume](create-pv.md). For information about creating a PVC, see [Create a Persistent Volume Claim](create-pvc.md).
1414

@@ -107,7 +107,7 @@ These pods are part of a **statefulSet**. You can't edit the statefulSet in plac
107107
name: example-static
108108
labels:
109109
app: example-static
110-
### Uncomment the next line and add your namespace only if you are not using the default namespace (if you are using azure-iot-operations) as specified from Line 6 of your pvc.yaml
110+
### Uncomment the next line and add your namespace only if you are not using the default namespace (if you are using azure-iot-operations) as specified from Line 6 of your pvc.yaml. If you are not using the default namespace, all future kubectl commands require "-n YOUR_NAMESPACE" to be added to the end of your command.
111111
# namespace: YOUR_NAMESPACE
112112
spec:
113113
replicas: 1
@@ -138,6 +138,9 @@ These pods are part of a **statefulSet**. You can't edit the statefulSet in plac
138138
claimName: YOUR_CLAIM_NAME_FROM_YOUR_PVC
139139
```
140140

141+
> [!NOTE]
142+
> If you are using your own namespace, all future `kubectl` commands require `-n YOUR_NAMESPACE` to be appended to the command. For example, you must use `kubectl get pods -n YOUR_NAMESPACE` instead of the standard `kubectl get pods`.
143+
141144
1. To apply this .yaml file, run the following command:
142145

143146
```bash

articles/azure-arc/edge-storage-accelerator/azure-monitor-kubernetes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Azure Monitor and Kubernetes monitoring
3-
description: Learn how to monitor your deployment using Azure Monitor and Kubernetes monitoring.
2+
title: Azure Monitor and Kubernetes monitoring (preview)
3+
description: Learn how to monitor your deployment using Azure Monitor and Kubernetes monitoring in Edge Storage Accelerator.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 03/12/2024
7+
ms.date: 04/08/2024
88

99
---
1010

11-
# Azure Monitor and Kubernetes monitoring
11+
# Azure Monitor and Kubernetes monitoring (preview)
1212

1313
This article describes how to monitor your deployment using Azure Monitor and Kubernetes monitoring.
1414

@@ -40,6 +40,6 @@ If you want to access log data via Azure Monitor, you must enable [Azure Monitor
4040

4141
Additionally, you can use [Azure Monitor Log Analytics](/azure/azure-monitor/logs/log-analytics-tutorial) to query collected log data.
4242

43-
## Next Steps
43+
## Next steps
4444

4545
[Edge Storage Accelerator overview](overview.md)

articles/azure-arc/edge-storage-accelerator/create-pv.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Create a persistent volume
3-
description: Learn about creating persistent volumes.
2+
title: Create a persistent volume (preview)
3+
description: Learn about creating persistent volumes in Edge Storage Accelerator.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 03/12/2024
7+
ms.date: 04/08/2024
88

99
---
1010

11-
# Create a persistent volume
11+
# Create a persistent volume (preview)
1212

1313
This article describes how to create a persistent volume using storage key authentication.
1414

@@ -24,7 +24,7 @@ This section describes the prerequisites for creating a persistent volume (PV).
2424

2525
## Storage key authentication configuration
2626

27-
1. Create a file named **add-key.sh**. This file creates a secret named `{YOUR_STORAGE_ACCOUNT}-secret`. This secret name is used for the `secretName` value when you configure your Persistent Volume (PV). No edits or changes to the following contents are necessary:
27+
1. Create a file named **add-key.sh** with the following contents. No edits or changes are necessary:
2828

2929
```bash
3030
#!/usr/bin/env bash
@@ -43,7 +43,7 @@ This section describes the prerequisites for creating a persistent volume (PV).
4343
kubectl create secret generic -n "${NAMESPACE}" "${STORAGE_ACCOUNT}"-secret --from-literal=azurestorageaccountkey="${SECRET}" --from-literal=azurestorageaccountname="${STORAGE_ACCOUNT}"
4444
```
4545

46-
1. After you create the file, change the write permissions on the file and execute the shell script using:
46+
1. After you create the file, change the write permissions on the file and execute the shell script using the following commands. Running these commands creates a secret named `{YOUR_STORAGE_ACCOUNT}-secret`. This secret name is used for the `secretName` value when configuring your PV:
4747

4848
```bash
4949
chmod +x add-key.sh
@@ -54,7 +54,7 @@ This section describes the prerequisites for creating a persistent volume (PV).
5454

5555
You must create a Persistent Volume (PV) for the Edge Storage Accelerator to create a local instance and bind to a remote BLOB storage account.
5656

57-
Note the name (`esa4` in this example), as you need to specify it in the `spec::volumeName` of the PVC that binds to it. Use your storage account and container that you created as part of the [prerequisites](#prerequisites).
57+
Note the `metadata: name:` (`esa4` in this example), as you must specify it in the `spec: volumeName` of the PVC that binds to it. Use your storage account and container that you created as part of the [prerequisites](#prerequisites).
5858

5959
1. Create a file named **pv.yaml**:
6060

@@ -77,7 +77,7 @@ Note the name (`esa4` in this example), as you need to specify it in the `spec::
7777
csi:
7878
driver: edgecache.csi.azure.com
7979
readOnly: false
80-
### Make sure this volumeid is unique in the cluster. You must specify it in the spec::volumeName of the PVC. ###
80+
### Make sure this volumeid is unique in the cluster. You must specify it in the spec:volumeName of the PVC. ###
8181
volumeHandle: YOUR_NAME_FROM_METADATA_NAME_IN_LINE_4_HERE
8282
volumeAttributes:
8383
protocol: edgecache

articles/azure-arc/edge-storage-accelerator/create-pvc.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Create a Persistent Volume Claim (PVC)
3-
description: Learn how to create a Persistent Volume Claim (PVC).
2+
title: Create a Persistent Volume Claim (PVC) (preview)
3+
description: Learn how to create a Persistent Volume Claim (PVC) in Edge Storage Accelerator.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 03/12/2024
7+
ms.date: 04/08/2024
88

99
---
1010

11-
# Create a Persistent Volume Claim (PVC)
11+
# Create a Persistent Volume Claim (PVC) (preview)
1212

13-
The PVC is a persistent volume claim against the persistent volume that you can use to mount a Kubernetes pod. In this case, the `storageClassName` is `blob-edgecache` and the storage amount requested for local storage.
13+
The PVC is a persistent volume claim against the persistent volume that you can use to mount a Kubernetes pod.
1414

1515
This size does not affect the ceiling of blob storage used in the cloud to support this local cache. Note the name of this PVC, as you need it when you create your application pod.
1616

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Install Edge Storage Accelerator (ESA) on a single-node K3s cluster using Ubuntu or AKS Edge Essentials (preview)
3+
description: Learn how to create a single-node K3s cluster for Edge Storage Accelerator and install Edge Storage Accelerator on your Ubuntu or Edge Essentials environment.
4+
author: sethmanheim
5+
ms.author: sethm
6+
ms.topic: how-to
7+
ms.date: 04/08/2024
8+
9+
---
10+
11+
# Install Edge Storage Accelerator on a single-node K3s cluster (preview)
12+
13+
This article shows how to set up a single-node [K3s cluster](https://docs.k3s.io/) for Edge Storage Accelerator (ESA) using Ubuntu or [AKS Edge Essentials](/azure/aks/hybrid/aks-edge-overview), based on the instructions provided in the Edge Storage Accelerator documentation.
14+
15+
## Prerequisites
16+
17+
Before you begin, ensure you have the following prerequisites in place:
18+
19+
- A machine capable of running K3s, meeting the minimum system requirements.
20+
- Basic understanding of Kubernetes concepts.
21+
22+
Follow these steps to create a single-node K3s cluster using Ubuntu or Edge Essentials.
23+
24+
## Step 1: Create and configure a K3s cluster on Ubuntu
25+
26+
Follow the [Azure IoT Operations K3s installation instructions](/azure/iot-operations/get-started/quickstart-deploy?tabs=linux#connect-a-kubernetes-cluster-to-azure-arc) to install K3s on your machine.
27+
28+
## Step 2: Prepare Linux using a single-node cluster
29+
30+
See [Prepare Linux using a single-node cluster](single-node-cluster.md) to set up a single-node K3s cluster.
31+
32+
## Step 3: Install Edge Storage Accelerator
33+
34+
Follow the instructions in [Install Edge Storage Accelerator](install-edge-storage-accelerator.md) to install Edge Storage Accelerator on your single-node Ubuntu K3s cluster.
35+
36+
## Step 4: Create Persistent Volume (PV)
37+
38+
Create a Persistent Volume (PV) by following the steps in [Create a PV](create-pv.md).
39+
40+
## Step 5: Create Persistent Volume Claim (PVC)
41+
42+
To bind with the PV created in the previous step, create a Persistent Volume Claim (PVC). See [Create a PVC](create-pvc.md) for guidance.
43+
44+
## Step 6: Attach application to Edge Storage Accelerator
45+
46+
Follow the instructions in [Edge Storage Accelerator: Attach your app](attach-app.md) to attach your application.
47+
48+
## Next steps
49+
50+
- [K3s Documentation](https://k3s.io/)
51+
- [Azure IoT Operations K3s installation instructions](/azure/iot-operations/get-started/quickstart-deploy?tabs=linux#connect-a-kubernetes-cluster-to-azure-arc)
52+
- [Azure Arc documentation](/azure/azure-arc/)
Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
### YamlMime:Landing
22

3-
title: Edge Storage Accelerator documentation
4-
summary: Edge Storage Accelerator (ESA) is a 1P storage system designed for Arc-connected Kubernetes clusters.
3+
title: Edge Storage Accelerator documentation (preview)
4+
summary: Edge Storage Accelerator (ESA) is a first-party storage system designed for Arc-connected Kubernetes clusters.
55

66
metadata:
7-
title: Edge Storage Accelerator documentation
8-
description: Edge Storage Accelerator (ESA) is a 1P storage system designed for Arc-connected Kubernetes clusters.
7+
title: Edge Storage Accelerator documentation (preview)
8+
description: Edge Storage Accelerator (ESA) is a first-party storage system designed for Arc-connected Kubernetes clusters.
99
ms.topic: landing-page
1010
author: sethmanheim
1111
ms.author: sethm
@@ -18,23 +18,21 @@ landingContent:
1818
links:
1919
- text: What is Edge Storage Accelerator?
2020
url: overview.md
21-
- linkListType: concept
21+
- linkListType: how-to-guide
2222
links:
23-
- text: Install Edge Storage Accelerator
24-
url: install-edge-storage-accelerator.md
23+
- text: Install Edge Storage Accelerator (ESA) on a single-node K3s cluster using Ubuntu or AKS Edge Essentials
24+
url: how-to-single-node-k3s.md
2525
- title: Get started
2626
linkLists:
2727
- linkListType: how-to-guide
2828
links:
2929
- text: Prepare Linux
3030
url: prepare-linux.md
31+
- text: Install Edge Storage Accelerator
32+
url: install-edge-storage-accelerator.md
33+
- text: Create a persistent volume
34+
url: create-pv.md
3135
- text: Create a persistent volume claim
3236
url: create-pvc.md
33-
- title: Troubleshoot
34-
linkLists:
35-
- linkListType: how-to-guide
36-
links:
37-
- text: Installation troubleshooting
38-
url: installation-troubleshooting.md
39-
- text: Operational troubleshooting
40-
url: operational-troubleshooting.md
37+
- text: Attach your application
38+
url: attach-app.md
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Install Edge Storage Accelerator
2+
title: Install Edge Storage Accelerator (preview)
33
description: Learn how to install Edge Storage Accelerator.
44
author: sethmanheim
55
ms.author: sethm
@@ -8,35 +8,35 @@ ms.date: 03/12/2024
88

99
---
1010

11-
# Install Edge Storage Accelerator
11+
# Install Edge Storage Accelerator (preview)
1212

1313
This article describes the steps to install Edge Storage Accelerator.
1414

1515
## Optional: increase cache disk size
1616

1717
Currently, the cache disk size defaults to 8 GiB. If you're satisfied with the cache disk size, move to the next section, [Install the Edge Storage Accelerator Arc Extension](#install-edge-storage-accelerator-arc-extension).
1818

19-
If you use Edge Essentials, require a larger cache disk size, and already created a **config.json** file, append the key and value pair (`"hydra.cachedStorageSize": "20Gi"`) to your existing **config.json**. Don't erase the previous contents of **config.json**.
19+
If you use Edge Essentials, require a larger cache disk size, and already created a **config.json** file, append the key and value pair (`"cachedStorageSize": "20Gi"`) to your existing **config.json**. Don't erase the previous contents of **config.json**.
2020

2121
If you require a larger cache disk size, create **config.json** with the following contents:
2222

2323
```json
2424
{
25-
"hydra.cachedStorageSize": "20Gi"
25+
"cachedStorageSize": "20Gi"
2626
}
2727
```
2828

2929
## Install Edge Storage Accelerator Arc extension
3030

3131
Install the Edge Storage Accelerator Arc extension using the following command:
3232

33+
> [!NOTE]
34+
> If you created a **config.json** file from the previous steps in [Prepare Linux](prepare-linux.md), append `--config-file "config.json"` to the following `az k8s-extension create` command. Any values set at installation time persist throughout the installation lifetime (inclusive of manual and auto-upgrades).
35+
3336
```bash
3437
az k8s-extension create --resource-group "${YOUR-RESOURCE-GROUP}" --cluster-name "${YOUR-CLUSTER-NAME}" --cluster-type connectedClusters --name hydraext --extension-type microsoft.edgestorageaccelerator
3538
```
3639

37-
> [!NOTE]
38-
> If you created a `config.json` from previous steps in [Prepare Linux](prepare-linux.md), append `--config-file "config.json"` to the previous `az k8s-extension create` command.
39-
4040
## Next steps
4141

42-
Once you complete these prerequisites, you can begin to [create a Persistent Volume (PV) with Storage Key Authentication or Workload Identity](create-pv.md).
42+
Once you complete these prerequisites, you can begin to [create a Persistent Volume (PV) with Storage Key Authentication](create-pv.md).

articles/azure-arc/edge-storage-accelerator/installation-troubleshooting.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

articles/azure-arc/edge-storage-accelerator/multi-node-cluster.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Prepare Linux using a multi-node cluster
3-
description: Learn how to prepare Linux with a multi-node cluster using AKS enabled by Azure Arc, Edge Essentials, or Ubuntu.
2+
title: Prepare Linux using a multi-node cluster (preview)
3+
description: Learn how to prepare Linux with a multi-node cluster in Edge Storage Accelerator using AKS enabled by Azure Arc, Edge Essentials, or Ubuntu.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 03/12/2024
7+
ms.date: 04/08/2024
88
zone_pivot_groups: platform-select
99

1010
---
1111

12-
# Prepare Linux using a multi-node cluster
12+
# Prepare Linux using a multi-node cluster (preview)
1313

1414
This article describes how to prepare Linux using a multi-node cluster, and assumes you [fulfilled the prerequisites](prepare-linux.md#prerequisites).
1515

@@ -56,7 +56,7 @@ This section describes how to prepare Linux with AKS Edge Essentials if you run
5656

5757
```bash
5858
az k8s-extension create --resource-group "YOUR_RESOURCE_GROUP_NAME" --cluster-name "YOUR_CLUSTER_NAME" --cluster-type connectedClusters --extension-type Microsoft.openservicemesh --scope cluster --name osm
59-
kubectl patch meshconfig osm-mesh-config -n "arc-osm-system" -p '{"spec":{"featureFlags":{"enableWASMStats": false }, "traffic":{"outboundPortEx
59+
kubectl patch meshconfig osm-mesh-config -n "arc-osm-system" -p '{"spec":{"featureFlags":{"enableWASMStats": false }, "traffic":{"outboundPortExclusionList":[443,2379,2380], "inboundPortExclusionList":[443,2379,2380]}}}' --type=merge
6060
```
6161

6262
1. Create a file named **config.json** with the following contents:

articles/azure-arc/edge-storage-accelerator/operational-troubleshooting.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)