Skip to content

Commit 55dcb1f

Browse files
authored
Merge pull request #270577 from schaffererin/userstory233310
Updated resource propagation concepts article and removed the how-to article
2 parents 8f765f4 + 28e767a commit 55dcb1f

10 files changed

+575
-403
lines changed

.openpublishing.redirection.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3924,6 +3924,16 @@
39243924
"redirect_url": "/azure/operational-excellence/relocation-storage-account",
39253925
"redirect_document_id": false
39263926
},
3927+
{
3928+
"source_path_from_root": "/articles/kubernetes-fleet/resource-propagation.md",
3929+
"redirect_url": "/azure/kubernetes-fleet/concepts-resource-propagation",
3930+
"redirect_document_id": false
3931+
},
3932+
{
3933+
"source_path_from_root": "/articles/kubernetes-fleet/access-fleet-kubernetes-api.md",
3934+
"redirect_url": "/azure/kubernetes-fleet/quickstart-access-fleet-kubernetes-api",
3935+
"redirect_document_id": false
3936+
},
39273937
{
39283938
"source_path_from_root": "/articles/defender-for-iot/organizations/update-legacy-ot-software.md",
39293939
"redirect_url": "/azure/defender-for-iot/organizations/update-ot-software?tabs=portal",

articles/kubernetes-fleet/concepts-resource-propagation.md

Lines changed: 313 additions & 33 deletions
Large diffs are not rendered by default.

articles/kubernetes-fleet/index.yml

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ metadata:
88
ms.service: kubernetes-fleet
99
ms.custom: ignite-2023
1010
ms.topic: landing-page
11-
ms.date: 11/06/2023
11+
ms.date: 04/01/2024
1212
landingContent:
1313
- title: About Azure Kubernetes Fleet Manager
1414
linkLists:
@@ -58,15 +58,12 @@ landingContent:
5858
links:
5959
- text: Create a Fleet resource and join member clusters
6060
url: quickstart-create-fleet-and-members.md
61-
- linkListType: how-to-guide
61+
- linkListType: quickstart
6262
links:
63-
- text: Orchestrate updates across multiple member clusters
64-
url: update-orchestration.md
65-
- linkListType: how-to-guide
63+
- text: Access the Kubernetes API of the Fleet resource
64+
url: quickstart-access-fleet-kubernetes-api.md
65+
- linkListType: quickstart
6666
links:
6767
- text: Propagate Kubernetes resource objects from a Fleet resource to member clusters (preview)
68-
url: resource-propagation.md
69-
- linkListType: how-to-guide
70-
links:
71-
- text: Set up multi-cluster Layer 4 load balancing (preview)
72-
url: l4-load-balancing.md
68+
url: quickstart-resource-propagation.md
69+

articles/kubernetes-fleet/l4-load-balancing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can follow this document to set up layer 4 load balancing for such multi-clu
3131
* These target clusters have to be [added as member clusters to the Fleet resource](./quickstart-create-fleet-and-members.md#join-member-clusters).
3232
* These target clusters should be using [Azure CNI (Container Networking Interface) networking](../aks/configure-azure-cni.md).
3333

34-
* You must gain access to the Kubernetes API of the hub cluster by following the steps in [Access the Kubernetes API of the Fleet resource](./access-fleet-kubernetes-api.md).
34+
* You must gain access to the Kubernetes API of the hub cluster by following the steps in [Access the Kubernetes API of the Fleet resource](./quickstart-access-fleet-kubernetes-api.md).
3535

3636
* Set the following environment variables and obtain the kubeconfigs for the fleet and all member clusters:
3737

articles/kubernetes-fleet/access-fleet-kubernetes-api.md renamed to articles/kubernetes-fleet/quickstart-access-fleet-kubernetes-api.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,41 @@
11
---
2-
title: "Access the Kubernetes API of the Fleet resource"
3-
description: Learn how to access the Kubernetes API of the Fleet resource.
4-
ms.topic: how-to
5-
ms.date: 03/20/2024
6-
author: shashankbarsin
7-
ms.author: shasb
2+
title: "Quickstart: Access the Kubernetes API of the Fleet resource"
3+
description: Learn how to access the Kubernetes API of the Fleet resource with Azure Kubernetes Fleet Manager.
4+
ms.topic: quickstart
5+
ms.date: 04/01/2024
6+
author: schaffererin
7+
ms.author: schaffererin
88
ms.service: kubernetes-fleet
99
---
1010

11-
# Access the Kubernetes API of the Fleet resource with Azure Kubernetes Fleet Manager
11+
# Quickstart: Access the Kubernetes API of the Fleet resource
1212

1313
If your Azure Kubernetes Fleet Manager resource was created with the hub cluster enabled, then it can be used to centrally control scenarios like Kubernetes resource propagation. In this article, you learn how to access the Kubernetes API of the hub cluster managed by the Fleet resource.
1414

1515
## Prerequisites
1616

1717
[!INCLUDE [free trial note](../../includes/quickstarts-free-trial-note.md)]
1818

19-
* You must have a Fleet resource with a hub cluster and member clusters. If you don't have this resource, follow [Quickstart: Create a Fleet resource and join member clusters](quickstart-create-fleet-and-members.md).
19+
* You need a Fleet resource with a hub cluster and member clusters. If you don't have one, see [Create an Azure Kubernetes Fleet Manager resource and join member clusters using Azure CLI](quickstart-create-fleet-and-members.md).
2020
* The identity (user or service principal) you're using needs to have the Microsoft.ContainerService/fleets/listCredentials/action on the Fleet resource.
2121

22-
## Access the Kubernetes API of the Fleet resource cluster
22+
## Access the Kubernetes API of the Fleet resource
2323

24-
1. Set the following environment variables for your subscription ID, resource group, and Fleet resource, and set the default Azure subscription to use using the [`az account set`][az-account-set] command.
24+
1. Set the following environment variables for your subscription ID, resource group, and Fleet resource:
2525

2626
```azurecli-interactive
2727
export SUBSCRIPTION_ID=<subscription-id>
28-
az account set --subscription ${SUBSCRIPTION_ID}
29-
3028
export GROUP=<resource-group-name>
3129
export FLEET=<fleet-name>
3230
```
3331
34-
2. Get the kubeconfig file of the hub cluster Fleet resource using the [`az fleet get-credentials`][az-fleet-get-credentials] command.
32+
2. Set the default Azure subscription to use using the [`az account set`][az-account-set] command.
33+
34+
```azurecli-interactive
35+
az account set --subscription ${SUBSCRIPTION_ID}
36+
```
37+
38+
3. Get the kubeconfig file of the hub cluster Fleet resource using the [`az fleet get-credentials`][az-fleet-get-credentials] command.
3539
3640
```azurecli-interactive
3741
az fleet get-credentials --resource-group ${GROUP} --name ${FLEET}
@@ -43,13 +47,13 @@ If your Azure Kubernetes Fleet Manager resource was created with the hub cluster
4347
Merged "hub" as current context in /home/fleet/.kube/config
4448
```
4549
46-
3. Set the following environment variable for the `id` of the hub cluster Fleet resource:
50+
4. Set the following environment variable for the `id` of the hub cluster Fleet resource:
4751
4852
```azurecli-interactive
4953
export FLEET_ID=/subscriptions/${SUBSCRIPTION_ID}/resourceGroups/${GROUP}/providers/Microsoft.ContainerService/fleets/${FLEET}
5054
```
5155
52-
4. Authorize your identity to the hub cluster Fleet resource's Kubernetes API server using the following commands:
56+
5. Authorize your identity to the hub cluster Fleet resource's Kubernetes API server using the following commands:
5357
5458
For the `ROLE` environment variable, you can use one of the following four built-in role definitions as the value:
5559
@@ -64,7 +68,7 @@ If your Azure Kubernetes Fleet Manager resource was created with the hub cluster
6468
az role assignment create --role "${ROLE}" --assignee ${IDENTITY} --scope ${FLEET_ID}
6569
```
6670
67-
Your output should be similar to the following example output:
71+
Your output should look similar to the following example output:
6872
6973
```output
7074
{
@@ -83,7 +87,7 @@ If your Azure Kubernetes Fleet Manager resource was created with the hub cluster
8387
}
8488
```
8589
86-
5. Verify you can access the API server using the `kubectl get memberclusters` command.
90+
6. Verify you can access the API server using the `kubectl get memberclusters` command.
8791
8892
```bash
8993
kubectl get memberclusters
@@ -100,8 +104,7 @@ If your Azure Kubernetes Fleet Manager resource was created with the hub cluster
100104
101105
## Next steps
102106
103-
* Review the [API specifications][fleet-apispec] for all Fleet custom resources.
104-
* Review our [troubleshooting guide][troubleshooting-guide] to help resolve common issues related to the Fleet APIs.
107+
* [Propagate resources from a Fleet hub cluster to member clusters](./quickstart-resource-propagation.md).
105108
106109
<!-- LINKS --->
107110
[fleet-apispec]: https://github.com/Azure/fleet/blob/main/docs/api-references.md

articles/kubernetes-fleet/quickstart-create-fleet-and-members-portal.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Get started with Azure Kubernetes Fleet Manager (Fleet) by using the Azure porta
1616

1717
## Prerequisites
1818

19+
[!INCLUDE [free trial note](../../includes/quickstarts-free-trial-note.md)]
20+
1921
* Read the [conceptual overview of this feature](./concepts-fleet.md), which provides an explanation of fleets and member clusters referenced in this document.
2022
* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
2123
* An identity (user or service principal) with the following permissions on the Fleet and AKS resource types for completing the steps listed in this quickstart:
@@ -60,6 +62,4 @@ Get started with Azure Kubernetes Fleet Manager (Fleet) by using the Azure porta
6062

6163
## Next steps
6264

63-
* [Orchestrate updates across multiple member clusters](./update-orchestration.md).
64-
* [Set up Kubernetes resource propagation from hub cluster to member clusters](./resource-propagation.md).
65-
* [Set up multi-cluster layer-4 load balancing](./l4-load-balancing.md).
65+
* [Access the Kubernetes API of the Fleet resource](./quickstart-access-fleet-kubernetes-api.md).

articles/kubernetes-fleet/quickstart-create-fleet-and-members.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Get started with Azure Kubernetes Fleet Manager (Fleet) by using the Azure CLI t
1616

1717
## Prerequisites
1818

19+
[!INCLUDE [free trial note](../../includes/quickstarts-free-trial-note.md)]
20+
1921
* Read the [conceptual overview of this feature](./concepts-fleet.md), which provides an explanation of fleets and member clusters referenced in this document.
2022
* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
2123
* An identity (user or service principal) which can be used to [log in to Azure CLI](/cli/azure/authenticate-azure-cli). This identity needs to have the following permissions on the Fleet and AKS resource types for completing the steps listed in this quickstart:
@@ -150,11 +152,7 @@ Fleet currently supports joining existing AKS clusters as member clusters.
150152
151153
```azurecli-interactive
152154
# Join the first member cluster
153-
az fleet member create \
154-
--resource-group ${GROUP} \
155-
--fleet-name ${FLEET} \
156-
--name ${MEMBER_NAME_1} \
157-
--member-cluster-id ${MEMBER_CLUSTER_ID_1}
155+
az fleet member create --resource-group ${GROUP} --fleet-name ${FLEET} --name ${MEMBER_NAME_1} --member-cluster-id ${MEMBER_CLUSTER_ID_1}
158156
```
159157
160158
Your output should look similar to the following example output:
@@ -197,9 +195,7 @@ Fleet currently supports joining existing AKS clusters as member clusters.
197195
198196
## Next steps
199197
200-
* [Orchestrate updates across multiple member clusters](./update-orchestration.md).
201-
* [Set up Kubernetes resource propagation from hub cluster to member clusters](./resource-propagation.md).
202-
* [Set up multi-cluster layer-4 load balancing](./l4-load-balancing.md).
198+
* [Access the Kubernetes API of the Fleet resource](./quickstart-access-fleet-kubernetes-api.md).
203199
204200
<!-- INTERNAL LINKS -->
205201
[az-extension-add]: /cli/azure/extension#az-extension-add

0 commit comments

Comments
 (0)