Skip to content

Commit b2b3e1b

Browse files
authored
Add Microsoft DevAzure Server notes (#2851)
Add a note to the Azure Devops oauth setup page that the Server version does not support oAuth 2. Modify the description of the Organization annotation in the Personal Access Token setup page.
1 parent c47a409 commit b2b3e1b

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ pass:[<!-- vale RedHat.Spelling = YES -->]
1616
. Set up the Microsoft Azure DevOps Services OAuth App (OAuth 2.0).
1717
. Apply the Microsoft Azure DevOps Services OAuth App Secret.
1818

19+
[IMPORTANT]
20+
OAuth 2.0 isn't supported on Azure DevOps Server, see link:https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops[the documentation page].
21+
1922
include::partial$proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc[leveloffset=+1]
2023

2124
include::partial$proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc[leveloffset=+1]

modules/end-user-guide/pages/using-a-git-provider-access-token.adoc

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ type: Opaque
8484
<1> Your {prod-short} user ID.
8585
<2> The Git provider name: `github` or `gitlab` or `bitbucket-server` or `azure-devops`.
8686
<3> The Git provider URL.
87-
<4> This line is only applicable to `azure-devops`: your Git provider user organization.
87+
<4> This line is only applicable to `azure-devops`: your Git provider user organization, or collection if Azure DevOps Server is used.
8888

8989
. Visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`.
9090

@@ -117,6 +117,23 @@ EOF
117117
----
118118
====
119119

120+
[IMPORTANT]
121+
====
122+
If you are using Azure DevOps Server, you must also modify the xref:mounting-git-configuration.adoc[workspace's
123+
gitconfig] with the following section:
124+
```
125+
[http]
126+
extraheader = "Authorization: Basic <base64-encoded(:personal-access-token)>"
127+
```
128+
To generate the key-value pair, use the following command:
129+
```
130+
echo -n "extraheader = \"Authorization: Basic "$(printf ":%s" <personal access token> | base64)\"
131+
```
132+
see link:https://learn.microsoft.com/en-us/azure/devops/repos/git/auth-overview?view=azure-devops&tabs=Linux#personal-access-tokens[the documentation page] for more information.
133+
134+
The `extraheader` configuration is needed for remote git operations to Azure Devops Server, e.g. `git clone`. This authorization method has a higher priority over the git credentials store, and as a result, the remote operations to other Git providers will fail.
135+
====
136+
120137
.Verification
121138

122139
. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.

0 commit comments

Comments
 (0)