Skip to content

Commit

Permalink
Format the doc for gitrepositories to wrap at 80 chars
Browse files Browse the repository at this point in the history
Signed-off-by: Dipti Pai <[email protected]>
  • Loading branch information
dipti-pai committed Sep 6, 2024
1 parent 5ad8213 commit bea703f
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions docs/spec/v1/gitrepositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,26 +214,34 @@ this via the `--password` flag.

### Provider

`.spec.provider` is an optional field that allows specifying an OIDC provider used for
authentication purposes.
`.spec.provider` is an optional field that allows specifying an OIDC provider
used for authentication purposes.

Supported options are:

- `generic`
- `azure`

When provider is not specified, it defaults to `generic` indicating that mechanisms using `spec.secretRef` are used for authentication.
When provider is not specified, it defaults to `generic` indicating that
mechanisms using `spec.secretRef` are used for authentication.

#### Azure

The `azure` provider can be used to authenticate to Azure DevOps repositories automatically using Workload Identity.
The `azure` provider can be used to authenticate to Azure DevOps repositories
automatically using Workload Identity.

##### Pre-requisites

- Ensure that your Azure DevOps Organization is [connected to Microsoft Entra](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/connect-organization-to-azure-ad?view=azure-devops)
- Ensure Workload Identity is properly set up on your cluster and the mutating webhook is installed.
- Create a managed identity and federated identity between the source-controller service account and managed identity. 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)
- Ensure that the managed identity has required permissions to access the Azure DevOps repository as described [here](https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/service-principal-managed-identity?view=azure-devops#2-add-and-manage-service-principals-in-an-azure-devops-organization)
- Ensure that your Azure DevOps Organization is [connected to Microsoft
Entra](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/connect-organization-to-azure-ad?view=azure-devops)
- Ensure Workload Identity is properly set up on your cluster and the mutating
webhook is installed.
- Create a managed identity and federated identity between the source-controller
service account and managed identity. 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)
- Ensure that the managed identity has required permissions to access the Azure
DevOps repository as described
[here](https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/service-principal-managed-identity?view=azure-devops#2-add-and-manage-service-principals-in-an-azure-devops-organization)

Add the following patch in `flux-system/kustomization.yaml` file:

Expand Down

0 comments on commit bea703f

Please sign in to comment.