-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Azure Devops improvements and add Tabs (#48)
- Split up Azure Docs - Add links for each section in project setup to Devops docs - Add Tabs functionality * Add docsify-tabs docs to read me --------- Co-authored-by: Mayra Pena <mayraapena2016@gmail.com>
- Loading branch information
1 parent
f5711ee
commit 33c172d
Showing
11 changed files
with
253 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Add Application as a user in DevOps Portal | ||
|
|
||
| <u>**Step 1**</u> | ||
|
|
||
| - In another tab (you will need to return to your application later), sign in to your [Azure DevOps Portal](https://dev.azure.com) and click `Organization settings` at the bottom of the left navigation. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_organization_settings.png" alt="Organization Settings" width="200" height="500"> | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Select `Users` in the left navigation menu. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_user_nav.png" alt="Organization Navbar" width="200" height="500"> | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - Select `Add Users` to add the application to the user list. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_add_user_button.png" alt="Add User button"> | ||
|
|
||
| <u>**Step 4**</u> | ||
|
|
||
| - Set the user as the application you created above, give it Basic Access. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_add_user_menu.png" alt="Add User menu"> | ||
|
|
||
| <u>**Step 5**</u> | ||
|
|
||
| - Select the project you wish to add the application to to using the `Add to projects` dropdown, and select the `Send email invites` checkbox. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_assign_to_project.png" alt="Add to project" width="500" height="500"> | ||
|
|
||
|
|
||
| ✅ Now that you have created your EntraID application and added it as a user in the DevOps Portal you will need to set up an [authentication method ](/how-tos/datacoves/authenticate_azure_devops.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Authentication for Azure DevOps | ||
|
|
||
| Now you are ready to begin configuring your authentication method. This is the method Datacoves will use to clone your repo from Azure DevOps. You have two options: `secrets` and `certificates`. | ||
|
|
||
| <u>**Step 1**</u> | ||
|
|
||
| - Navigate back to the tab where you created your application in the Azure Portal. You should be inside your newly created application. | ||
|
|
||
| - Select the `Certificates & Secrets` option in the left navigation menu. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_secret_nav.jpg" alt="Navigation" width="800" height="600"> | ||
|
|
||
| ### `secret` or `certificate` Authentification Method | ||
|
|
||
| As mentioned above, you have two authentication methods available: `secrets` or `certificates`. Please select one to continue to the next steps. | ||
|
|
||
| <!-- tabs:start --> | ||
|
|
||
| #### **Secret-Based Authentication** | ||
|
|
||
| ### Secret-Based Authentication | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Select `Client Secrets` in the top navigation menu and `+ New Secret`. | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - Give it a meaningful description and set your desired expiration date. | ||
|
|
||
| <u>**Step 4**</u> Copy the Value onto a notepad. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_secret.jpg" alt="Azure Secret"> | ||
|
|
||
| ✅ Congrats, you are now ready to [configure your project](how-tos/datacoves/how_to_projects.md). | ||
|
|
||
| #### **Certificate-Based Authentication** | ||
|
|
||
| ### Certificate-Based Authentication | ||
|
|
||
| 🚨 This configuration requires some back and forth between Azure DevOps and Datacoves. | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Select `Certificates` from the top navigation menu. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_upload_certificate.png" alt="Upload Certificate"> | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - To generate a certificate PEM file, you will need to begin [configuring your Datacoves project](how-tos/datacoves/how_to_projects.md). | ||
|
|
||
| <u>**Step 4**</u> | ||
|
|
||
| - Select `Azure DevOps Certificate` as your Cloning Strategy. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_certificate.jpg" alt="Certificates"> | ||
|
|
||
| <u>**Step 5**</u> | ||
|
|
||
| - Copy the certificate and save it as a plain text file on your desktop with a `.pem` extension `datacoves_cert.pem`. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_certificate_copy.jpg" alt="Certificate PEM file"> | ||
|
|
||
| <u>**Step 6**</u> | ||
|
|
||
| - Navigate back to your Azure Portal tab and select `Upload certificate`. Upload the PEM file you saved in the previous step. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_upload_certificate.png" alt="Upload Certificate"> | ||
|
|
||
| <u>**Step 7**</u> | ||
|
|
||
| - Give it a description and select `Add`. | ||
|
|
||
| <!-- tabs:end --> | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Create your application | ||
|
|
||
| If you do not have an Entra ID application created, you can do so by following these steps: | ||
|
|
||
| <u>**Step 1**</u> | ||
|
|
||
| - From your [Azure Portal](https://portal.azure.com), search for EntraID. | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Select `App Registrations` from the left navigation menu. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_overview.png" alt="App Registration" width="200" height="450"> | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - Select `+ New registration` and fill out the fields as seen below: | ||
| - **Name:** Give your application a meaningful name | ||
| - **Supported account types**: Select `Accounts in this organizational directory only` | ||
|
|
||
| <u>**Step 4**</u> | ||
|
|
||
| - Click `Register` | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_register_application.png" alt="Register Application" width="700" height="600"> | ||
|
|
||
| ✅ Next you will want to [Add Application as a user in DevOps Portal](/how-tos/datacoves/add_entraid_app_as_user.md) |
49 changes: 49 additions & 0 deletions
49
docs/how-tos/datacoves/gather_azure_devops_auth_details.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Gather DevOps Authentication details | ||
|
|
||
| You will need to gather the following application information to configure your project to use Azure DevOps for cloning. | ||
|
|
||
| ## Application (Client) ID and Directory (Tenant) ID | ||
|
|
||
| <u>**Step 1**</u> | ||
|
|
||
| - From your [Azure Portal](https://portal.azure.com), search for EntraID. | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Select `App Registrations` from the left navigation menu. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_overview.png" alt="App Registration" width="200" height="450"> | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - Select `All Applications` and select your newly created app. | ||
|
|
||
| <u>**Step 4**</u> | ||
|
|
||
| - Copy your Application (Client) ID and Directory (Tenant) ID. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_app_details.jpg" alt="Azure DevOps Details"> | ||
|
|
||
| ### Repo SSH and HTTP urls | ||
|
|
||
| You will need to copy the SSH or HTTP clone url. | ||
|
|
||
| <u>**Step 1**</u> | ||
|
|
||
| - Log in to your [Azure DevOps Portal](https://dev.azure.com). | ||
|
|
||
| <u>**Step 2**</u> | ||
|
|
||
| - Navigate to your project. | ||
|
|
||
| <u>**Step 3**</u> | ||
|
|
||
| - Navigate to your repo and select the `Clone` button. | ||
|
|
||
| <u>**Step 4**</u> | ||
|
|
||
| - Copy **both** the SSH **and** HTTP urls and enter in the appropriate fields in the project setup screen in Datacoves. | ||
|
|
||
| <img src="/how-tos/datacoves/assets/azure_devops_https.png" alt="SSH and HTTP"> | ||
|
|
||
| ✅ Be sure to save all of these details on a safe notepad. Now you can begin setting up your [Azure DevOps authentication](/how-tos/datacoves/authenticate_azure_devops.md) |
130 changes: 6 additions & 124 deletions
130
docs/how-tos/datacoves/how_to_configure_azure_DevOps.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,129 +1,11 @@ | ||
| # How to clone with Azure DevOps | ||
| # How to Clone with Azure DevOps | ||
|
|
||
| To enable Datacoves cloning from Azure DevOps you must complete a series of steps outlined in this how to. | ||
| To enable Datacoves cloning from Azure DevOps, you must complete a series of steps outlined in this guide. | ||
|
|
||
| - [Create your Application](how-tos/datacoves/how_to_configure_azure_DevOps.md#create-your-application) | ||
| - [Add your Application as a User in the DevOps Portal](how-tos/datacoves/how_to_configure_azure_DevOps.md#add-application-as-a-user-in-devops-portal) | ||
| - [Configure Secret or Certificate Based Authentication](how-tos/datacoves/how_to_configure_azure_DevOps.md#configure-your-secret-or-certificate-to-authenticate) | ||
| - [Gather Application Information](how-tos/datacoves/how_to_configure_azure_DevOps.md#gather-application-information) | ||
|
|
||
| ## Create your application | ||
|
|
||
| If you do not have an Entra ID application created you can do so by following the following steps: | ||
|
|
||
| **Step 1:** From your [Azure Portal](https://portal.azure.com) search for EntraID. | ||
|
|
||
| **Step 2:** Select `App Registrations` from the left navigation menu. | ||
|
|
||
|  | ||
|
|
||
| **Step 3:** Select `+ New registration` and fill out the fields as seen below: | ||
| - **Name:** Give your application a meaningful name | ||
| - **Supported account types**: Select `Accounts in this organizational directory only` | ||
|
|
||
| **Step 4:** Click `Register` | ||
|  | ||
|
|
||
| ## Add Application as a user in DevOps Portal | ||
|
|
||
| **Step 1:** In a another tab (You will need to return to your application later), sign in to your [Azure DevOps Portal](https://dev.azure.com) and click `Organization settings` at the bottom of the left navigation. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** Select `Users` in the left navigation menu. | ||
|
|
||
|  | ||
|
|
||
| **Step 3:** Select `Add Users` to add the Application to the user list. | ||
|
|
||
|  | ||
|
|
||
| **Step 4:** Set the User as the application you created above, give it Basic Access and select `Send email invites`. | ||
|
|
||
|  | ||
|
|
||
| ## Configure your secret or certificate to authenticate | ||
|
|
||
| You have two authentication methods available to you, secrets or certificates. Please select one and follow the steps to configure. | ||
|
|
||
| **Step 1:** Navigate back to the tab where you created your application in the Azure Portal. You should be inside your newly created application. | ||
|
|
||
| Select the `Certificates & Secrets` option in the left navigation menu. | ||
|
|
||
|  | ||
|
|
||
| ### Secret Based Authentication | ||
|
|
||
| To configure a secret: | ||
|
|
||
| **Step 2:** Select `Client Secrets` in the top navigation menu and `+ New Secret`. | ||
|
|
||
| **Step 3:** Give it a meaningful description and set your desired expiration date. | ||
|
|
||
| **Step 3:** Copy the Value onto a notepad | ||
|
|
||
|  | ||
|
|
||
| ### Certificate Based Authentication | ||
|
|
||
| To configure a certificate: | ||
|
|
||
| **Step 2:** Select `Certificates` from the top navigation menu. | ||
|
|
||
|  | ||
|
|
||
| **Step 3:** To generate a certificate PEM file you will need to begin [configuring your Datacoves project](how-tos/datacoves/how_to_projects.md). | ||
|
|
||
| **Step 4:** Select `Azure DevOps Certificate` as your Cloning Strategy. | ||
|
|
||
|  | ||
|
|
||
| **Step 5:** Copy the certificate and save it as a plain text file on your desktop with a pem extension `datacoves_cert.pem`. | ||
|
|
||
|  | ||
|
|
||
| **Step 6:** Navigate back to your Azure Portal tab and select `upload certificate`. Upload the PEM file you saved in the previous step. | ||
|
|
||
|  | ||
|
|
||
| **Step 7:** Give it a description and select `Add`. | ||
|
|
||
| ## Gather application information | ||
|
|
||
| To configure your Datacoves project which we will do in the following section, you will need to collect some information. | ||
|
|
||
| ### Application (Client) ID and Directory (Tenant) ID | ||
|
|
||
| You will need to gather the following Application information to configure your project to use Azure DevOps for cloning. | ||
|
|
||
| **Step 1:** From your [Azure Portal](https://portal.azure.com) search for EntraID. | ||
|
|
||
| **Step 2:** Select `App Registrations` from the left navigation menu. | ||
|
|
||
|  | ||
|
|
||
| **Step 3:** Select `All Applications` and select your newly created app. | ||
|
|
||
| **Step 4:** Copy your Application (Client) ID and Directory (Tenant) ID. | ||
|
|
||
|  | ||
|
|
||
| ### Secret Based Authentication | ||
|
|
||
| You should have the secret value you save in an [earlier section](how-tos/datacoves/how_to_clone_with_azure.md#secret) | ||
|
|
||
| ### Repo SSH and HTTP urls | ||
|
|
||
| **Step 1:** Log in to your [Azure DevOps Portal](dev.azure.com). | ||
|
|
||
| **Step 2:** Navigate to your project. | ||
|
|
||
| **Step 3:** Navigate to your repo and select the `Clone` button. | ||
|
|
||
| **Step 2:** Copy **both** the SSH **and** HTTP urls and enter in the appropriate fields in the project setup screen in Datacoves. | ||
|  | ||
|
|
||
| Congrats, you are now ready to [configure your project](how-tos/datacoves/how_to_projects.md) | ||
| - [Create your Application](how-tos/datacoves/create_your_entraid_application.md) | ||
| - [Add your Application as a User in the DevOps Portal](how-tos/datacoves/add_entraid_app_as_user.md) | ||
| - [Gather DevOps Authentication details](how-tos/datacoves/gather_azure_devops_auth_details.md) | ||
| - [Authenticate Azure DevOps](how-tos/datacoves/authenticate_azure_devops.md) | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.