Skip to content

Commit 9709e52

Browse files
committed
Update bucket and oci docs too
Signed-off-by: Somtochi Onyekwere <somtochionyekwere@gmail.com>
1 parent 8341f8a commit 9709e52

File tree

3 files changed

+33
-20
lines changed

3 files changed

+33
-20
lines changed

docs/spec/v1beta2/buckets.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -439,8 +439,8 @@ data:
439439

440440
##### Workload Identity
441441

442-
If you have [Workload Identity mutating webhook](https://azure.github.io/azure-workload-identity/docs/installation/managed-clusters.html)
443-
installed on your cluster. You need to create an Azure Identity and give it
442+
If you have [Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation/managed-clusters.html)
443+
set up on your cluster. You need to create an Azure Identity and give it
444444
access to Azure Blob Storage.
445445

446446
```shell
@@ -465,7 +465,7 @@ az identity federated-credential create \
465465
--subject "system:serviceaccount:flux-system:source-controller"
466466
```
467467

468-
Add a patch to label and annotate the source-controller Pods and ServiceAccount
468+
Add a patch to label and annotate the source-controller Deployment and ServiceAccount
469469
correctly so that it can match an identity binding:
470470

471471
```yaml
@@ -517,7 +517,7 @@ spec:
517517
endpoint: https://testfluxsas.blob.core.windows.net
518518
```
519519

520-
##### Managed Identity with AAD Pod Identity
520+
##### Deprecated: Managed Identity with AAD Pod Identity
521521

522522
If you are using [aad pod identity](https://azure.github.io/aad-pod-identity/docs),
523523
You need to create an Azure Identity and give it access to Azure Blob Storage.

docs/spec/v1beta2/helmrepositories.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,11 @@ by extension gain access to ACR.
233233
When the kubelet managed identity has access to ACR, source-controller running on
234234
it will also have access to ACR.
235235

236-
*Note*: If you have more than one identity configured on the cluster, you have to specify which one to use
237-
by setting the `AZURE_CLIENT_ID` variable in the source-controller pod.
236+
**Note:** If you have more than one identity configured on the cluster, you have to specify which one to use
237+
by setting the `AZURE_CLIENT_ID` environment variable in the source-controller deployment.
238238

239239
If you are running into further issues, please look at the
240-
[troubleshooting guide](https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/azidentity/TROUBLESHOOTING.md#azure-virtual-machine-managed-identity)
240+
[troubleshooting guide](https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/azidentity/TROUBLESHOOTING.md#azure-virtual-machine-managed-identity).
241241

242242
##### Azure Workload Identity
243243

@@ -276,15 +276,16 @@ patches:
276276
azure.workload.identity/use: "true"
277277
```
278278

279-
To use Workload Identity, the Workload Identity mutating webhook has to be installed on your cluster and
280-
you have to create an identity that has access to ACR. Next, establish
279+
Ensure Workload Identity is properly setup on your cluster and the mutating webhook is installed.
280+
Create an identity that has access to ACR. Next, establish
281281
a federated identity between the source-controller ServiceAccount and the
282-
identity. Patch the source-controller Pod and ServiceAccount as shown in the patch
282+
identity. Patch the source-controller Deployment and ServiceAccount as shown in the patch
283283
above. Please take a look at this [guide](https://azure.github.io/azure-workload-identity/docs/quick-start.html#6-establish-federated-identity-credential-between-the-identity-and-the-service-account-issuer--subject).
284284

285-
##### Deprecated: AAD Pod Identity
285+
##### Deprecated: AAD Pod Identity
286286

287-
**Note:** AAD Pod Identity will be archived in September 2023, and you are advised to use Workload Identity instead.
287+
**Note:** The AAD Pod Identity project will be archived in [September 2023](https://github.com/Azure/aad-pod-identity#-announcement),
288+
and you are advised to use Workload Identity instead.
288289

289290
When using aad-pod-identity to enable access to ACR, add the following patch to
290291
your bootstrap repository, in the `flux-system/kustomization.yaml` file:
@@ -310,7 +311,7 @@ to give the `source-controller` pod access to the ACR. To do this, you have to i
310311
`aad-pod-identity` on your cluster, create a managed identity that has access to the
311312
container registry (this can also be the Kubelet identity if it has `AcrPull` role
312313
assignment on the ACR), create an `AzureIdentity` and `AzureIdentityBinding` that describe
313-
the managed identity and then label the `source-controller` pods with the name of the
314+
the managed identity and then label the `source-controller` deployment with the name of the
314315
AzureIdentity as shown in the patch above. Please take a look at [this guide](https://azure.github.io/aad-pod-identity/docs/)
315316
or [this one](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity)
316317
if you want to use AKS pod-managed identities add-on that is in preview.

docs/spec/v1beta2/ocirepositories.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -157,15 +157,22 @@ to the IAM role when using IRSA.
157157

158158
#### Azure
159159

160-
The `azure` provider can be used to authenticate automatically using kubelet
161-
managed identity or Azure Active Directory pod-managed identity (aad-pod-identity),
160+
The `azure` provider can be used to authenticate automatically using Workload Identity, Kubelet Managed
161+
Identity or Azure Active Directory pod-managed identity (aad-pod-identity),
162162
and by extension gain access to ACR.
163163

164164
##### Kubelet Managed Identity
165165

166166
When the kubelet managed identity has access to ACR, source-controller running
167167
on it will also have access to ACR.
168168

169+
**Note:** If you have more than one identity configured on the cluster, you have to specify which one to use
170+
by setting the `AZURE_CLIENT_ID` environment variable in the source-controller deployment.
171+
172+
If you are running into further issues, please look at the
173+
[troubleshooting guide](https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/azidentity/TROUBLESHOOTING.md#azure-virtual-machine-managed-identity).
174+
175+
169176
##### Workload Identity
170177

171178
When using Workload Identity to enable access to ACR, add the following patch to
@@ -203,13 +210,18 @@ patches:
203210
azure.workload.identity/use: "true"
204211
```
205212

206-
To use Workload Identity, you have to install the Workload Identity
207-
mutating webhook and create an identity that has access to ACR. Next, establish
208-
a federated identity between the source-controller ServiceAccount and the
209-
identity. Patch the source-controller Pod and ServiceAccount as shown in the patch
213+
Ensure Workload Identity is properly setup on your cluster and the mutating webhook is installed.
214+
Create an identity that has access to ACR. Next, establish
215+
a federated identity between the source-controller ServiceAccount and the
216+
identity. Patch the source-controller Deployment and ServiceAccount as shown in the patch
210217
above. Please take a look at this [guide](https://azure.github.io/azure-workload-identity/docs/quick-start.html#6-establish-federated-identity-credential-between-the-identity-and-the-service-account-issuer--subject).
211218

212-
##### AAD Pod Identity
219+
##### Deprecated: AAD Pod Identity
220+
221+
**Note:** The AAD Pod Identity project will be archived in [September 2023](https://github.com/Azure/aad-pod-identity#-announcement),
222+
and you are advised to use Workload Identity instead.
223+
224+
213225
When using aad-pod-identity to enable access to ACR, add the following patch to
214226
your bootstrap repository, in the `flux-system/kustomization.yaml` file:
215227

0 commit comments

Comments
 (0)