Skip to content

Commit 531bb5d

Browse files
committed
docs: various nits in specs
Signed-off-by: Hidde Beydals <[email protected]>
1 parent 4995cff commit 531bb5d

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

docs/spec/v1beta2/buckets.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -440,8 +440,8 @@ data:
440440
##### Workload Identity
441441

442442
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 would need to create an Azure Identity and
444-
give it access to Azure Blob Storage.
443+
installed on your cluster. You need to create an Azure Identity and give it
444+
access to Azure Blob Storage.
445445

446446
```shell
447447
export IDENTITY_NAME="blob-access"
@@ -451,7 +451,7 @@ az role assignment create --role "Storage Blob Data Reader" \
451451
--scope "/subscriptions/<SUBSCRIPTION-ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.Storage/storageAccounts/<account-name>/blobServices/default/containers/<container-name>"
452452
```
453453

454-
Establish federated identity between the identity and the source-controller
454+
Establish a federated identity between the Identity and the source-controller
455455
ServiceAccount.
456456

457457
```shell
@@ -500,7 +500,7 @@ patches:
500500
azure.workload.identity/use: "true"
501501
```
502502

503-
If you have set Workload Identity up correctly and labeled the source-controller
503+
If you have set up Workload Identity correctly and labeled the source-controller
504504
Pod and ServiceAccount, then you don't need to reference a Secret. For more information,
505505
please see [documentation](https://azure.github.io/azure-workload-identity/docs/quick-start.html).
506506

@@ -520,7 +520,7 @@ spec:
520520
##### Managed Identity with AAD Pod Identity
521521

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

525525
```sh
526526
export IDENTITY_NAME="blob-access"
@@ -533,7 +533,7 @@ export IDENTITY_CLIENT_ID="$(az identity show -n ${IDENTITY_NAME} -g ${RESOURCE_
533533
export IDENTITY_RESOURCE_ID="$(az identity show -n ${IDENTITY_NAME} -otsv --query id)"
534534
```
535535

536-
Create an `AzureIdentity` object that references the identity created above:
536+
Create an AzureIdentity object that references the identity created above:
537537

538538
```yaml
539539
---
@@ -548,7 +548,8 @@ spec:
548548
type: 0 # user-managed identity
549549
```
550550

551-
Create an `AzureIdentityBinding` object that binds pods with a specific selector with the `AzureIdentity` created:
551+
Create an AzureIdentityBinding object that binds Pods with a specific selector
552+
with the AzureIdentity created:
552553

553554
```yaml
554555
apiVersion: "aadpodidentity.k8s.io/v1"
@@ -575,8 +576,8 @@ spec:
575576
aadpodidbinding: ${IDENTITY_NAME} # match the AzureIdentity name
576577
```
577578

578-
If you have set aad-pod-identity up correctly and labeled the source-controller
579-
pod, then you don't need to reference a secret.
579+
If you have set up aad-pod-identity correctly and labeled the source-controller
580+
Pod, then you don't need to reference a Secret.
580581

581582
```yaml
582583
apiVersion: source.toolkit.fluxcd.io/v1beta2
@@ -618,13 +619,16 @@ data:
618619
sasKey: <base64>
619620
```
620621

621-
The sasKey only contains the SAS token e.g `?sv=2020-08-0&ss=bfqt&srt=co&sp=rwdlacupitfx&se=2022-05-26T21:55:35Z&st=2022-05...`.
622-
The leading question mark is optional.
623-
The query values from the `sasKey` data field in the Secrets gets merged with the ones in the `spec.endpoint` of the `Bucket`.
624-
If the same key is present in the both of them, the value in the `sasKey` takes precedence.
622+
The `sasKey` only contains the SAS token e.g
623+
`?sv=2020-08-0&ss=bfqt&srt=co&sp=rwdlacupitfx&se=2022-05-26T21:55:35Z&st=2022-05...`.
624+
The leading question mark (`?`) is optional. The query values from the `sasKey`
625+
data field in the Secrets gets merged with the ones in the `.spec.endpoint` of
626+
the Bucket. If the same key is present in the both of them, the value in the
627+
`sasKey` takes precedence.
625628

626-
**Note:** The SAS token has an expiry date and it must be updated before it expires to allow Flux to
627-
continue to access Azure Storage. It is allowed to use an account-level or container-level SAS token.
629+
**Note:** The SAS token has an expiry date, and it must be updated before it
630+
expires to allow Flux to continue to access Azure Storage. It is allowed to use
631+
an account-level or container-level SAS token.
628632

629633
The minimum permissions for an account-level SAS token are:
630634

@@ -839,7 +843,7 @@ spec:
839843

840844
### Triggering a reconcile
841845

842-
To manually tell the source-controller to reconcile a Bucket outside of the
846+
To manually tell the source-controller to reconcile a Bucket outside the
843847
[specified interval window](#interval), a Bucket can be annotated with
844848
`reconcile.fluxcd.io/requestedAt: <arbitrary value>`. Annotating the resource
845849
queues the Bucket for reconciliation if the `<arbitrary-value>` differs from

docs/spec/v1beta2/helmrepositories.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ 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-
##### Workload Identity
236+
##### Azure Workload Identity
237237

238238
When using Workload Identity to enable access to ACR, add the following patch to
239239
your bootstrap repository, in the `flux-system/kustomization.yaml` file:
@@ -317,7 +317,7 @@ Workload Identity, and by extension gain access to GCR or Artifact Registry.
317317
When the GKE nodes have the appropriate OAuth scope for accessing GCR and Artifact Registry,
318318
source-controller running on it will also have access to them.
319319

320-
#### Workload Identity
320+
#### GKE Workload Identity
321321

322322
When using Workload Identity to enable access to GCR or Artifact Registry, add the
323323
following patch to your bootstrap repository, in the `flux-system/kustomization.yaml`

0 commit comments

Comments
 (0)