Skip to content

Commit 359d50d

Browse files
authored
Merge pull request #1811 from fluxcd/rfc-0010-docs
[RFC-0010] Link workload identity docs to complete guide
2 parents fdc84c7 + d555222 commit 359d50d

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

docs/spec/v1/buckets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ Supported options are:
134134

135135
If you do not specify `.spec.provider`, it defaults to `generic`.
136136

137+
For a complete guide on how to set up authentication for cloud providers,
138+
see the integration [docs](/flux/integrations/).
139+
137140
#### Generic
138141

139142
When a Bucket's `spec.provider` is set to `generic`, the controller will

docs/spec/v1/gitrepositories.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,9 @@ Supported options are:
251251
When provider is not specified, it defaults to `generic` indicating that
252252
mechanisms using `spec.secretRef` are used for authentication.
253253

254+
For a complete guide on how to set up authentication for cloud providers,
255+
see the integration [docs](/flux/integrations/).
256+
254257
#### Azure
255258

256259
The `azure` provider can be used to authenticate to Azure DevOps repositories

docs/spec/v1/ocirepositories.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ static credentials are used for authentication, either with
121121
`spec.secretRef` or `spec.serviceAccountName`.
122122
If you do not specify `.spec.provider`, it defaults to `generic`.
123123

124+
For a complete guide on how to set up authentication for cloud providers,
125+
see the integration [docs](/flux/integrations/).
126+
124127
#### AWS
125128

126129
The `aws` provider can be used to authenticate automatically using the EKS
@@ -267,12 +270,22 @@ kubectl create secret docker-registry ...
267270

268271
### Service Account reference
269272

270-
`.spec.serviceAccountName` is an optional field to specify a name reference to a
271-
Service Account in the same namespace as the OCIRepository. The controller will
272-
fetch the image pull secrets attached to the service account and use them for authentication.
273+
`.spec.serviceAccountName` is an optional field to specify a Service Account
274+
in the same namespace as OCIRepository with purpose depending on the value of
275+
the `.spec.provider` field:
276+
277+
- When `.spec.provider` is set to `generic`, the controller will fetch the image
278+
pull secrets attached to the Service Account and use them for authentication.
279+
- When `.spec.provider` is set to `aws`, `azure`, or `gcp`, the Service Account
280+
will be used for Workload Identity authentication. In this case, the controller
281+
feature gate `ObjectLevelWorkloadIdentity` must be enabled, otherwise the
282+
controller will error out.
283+
284+
**Note:** that for a publicly accessible image repository, you don't need to
285+
provide a `secretRef` nor `serviceAccountName`.
273286

274-
**Note:** that for a publicly accessible image repository, you don't need to provide a `secretRef`
275-
nor `serviceAccountName`.
287+
For a complete guide on how to set up authentication for cloud providers,
288+
see the integration [docs](/flux/integrations/).
276289

277290
### Cert secret reference
278291

0 commit comments

Comments
 (0)