Skip to content

[Azure docs] Replace Azure AD with Microsoft Entra ID #9774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
May 8, 2024

Conversation

alaudazzi
Copy link
Contributor

Microsoft renamed Azure Active Directory (Azure AD) to Microsoft Entra ID.
Refer to https://learn.microsoft.com/en-gb/entra/fundamentals/new-name.

This PR updates the following Elastic integrations doc pages:

Related issues

Closes https://github.com/elastic/integration-docs/issues/325

@alaudazzi alaudazzi added bug Something isn't working, use only for issues documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. labels May 2, 2024
@alaudazzi alaudazzi requested review from zmoog and muthu-mps May 2, 2024 14:28
@alaudazzi alaudazzi self-assigned this May 2, 2024
@alaudazzi alaudazzi requested review from a team as code owners May 2, 2024 14:28
@elasticmachine
Copy link

elasticmachine commented May 2, 2024

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are replacing the name "Azure Active Directory" in the docs while the integration title, including buttons and icons, stays unchanged.

CleanShot 2024-05-03 at 10 24 44

Do we have plans to change these in a different PR, or should we also update them in this one?

@zmoog
Copy link
Contributor

zmoog commented May 3, 2024

Turning this docs-focused PR into a rebrand would also help in the integration search:

CleanShot 2024-05-03 at 10 43 49

CleanShot 2024-05-03 at 10 44 09

@zmoog
Copy link
Contributor

zmoog commented May 3, 2024

I hope you don't mind if I fixed a couple of diagrams with rendering issues:

(1) Before:

CleanShot 2024-05-03 at 10 48 09

(1) After:

CleanShot 2024-05-03 at 10 53 39

I hope you don't mind if I fixed a couple of diagrams with rendering issues:

(2) Before:

CleanShot 2024-05-03 at 10 54 59

(2) After:

CleanShot 2024-05-03 at 10 55 44

@alaudazzi
Copy link
Contributor Author

@zmoog
Thank you for reviewing and fixing the diagrams!

To your question:

Do we have plans to change these in a different PR, or should we also update them in this one?

This is the Kibana UI, so I guess we need to find a contact on the Kibana team.

@zmoog
Copy link
Contributor

zmoog commented May 3, 2024

This is the Kibana UI, so I guess we need to find a contact on the Kibana team.

IIRC, Kibana builds the UI elements using the information in the YAML files from the integration source. Let me check!

@zmoog
Copy link
Contributor

zmoog commented May 3, 2024

Yep, most of the text in the UI elements come from the metadata in the integration YAML files:

CleanShot.2024-05-03.at.12.57.23.mp4

@alaudazzi
Copy link
Contributor Author

alaudazzi commented May 3, 2024

I will ask the Kibana team.

@zmoog
Copy link
Contributor

zmoog commented May 3, 2024

It seems we can do this by updating the metadata in the manifest.yml file:

diff --git a/packages/azure/manifest.yml b/packages/azure/manifest.yml
index 38c28d051..3e76aa8ed 100644
--- a/packages/azure/manifest.yml
+++ b/packages/azure/manifest.yml
@@ -94,8 +94,8 @@ policy_templates:
         size: 5002x2666
         type: image/png
   - name: adlogs
-    title: Azure Active Directory
-    description: Azure Directory logs integration
+    title: Microsoft Entra ID
+    description: Collect logs from Microsoft Entra ID (formerly Azure Active Directory) with Elastic Agent.
     data_streams:
       - auditlogs
       - signinlogs
@@ -105,7 +105,7 @@ policy_templates:
       - security
     inputs:
       - type: "azure-eventhub"
-        title: "Collect Azure Active Directory logs from Event Hub"
+        title: "Collect Microsoft Entra ID logs from Event Hub"
         description: "Collecting Active Directory logs as audit logs and signin logs from Azure instances (input: azure-eventhub)"
         input_group: logs
     icons:

@alaudazzi
Copy link
Contributor Author

@zmoog
As agreed, to keep docs and UI in sync, we'll handle the Kibana UI updates in this PR.
Thank you for updating the manifest.yml file 🙏

Comment on lines 45 to 47
* Microsoft Entra ID
* Azure Monitor
* Spring Apps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alphabetical order?

@zmoog
Copy link
Contributor

zmoog commented May 6, 2024

@efd6, thanks for taking the time to align the text in the diagram! I was about to do the same, but I'll take and commit yours! 😇

zmoog added 3 commits May 6, 2024 09:59
A couple of diagrams were too broad and were having rendering issues.
Update titles and descriptions, so metadata and UI elements in Kibana
are up to date with the rebranding.
Thanks to @efd6 for taking the time to fix the alignment! ❤️
@zmoog
Copy link
Contributor

zmoog commented May 6, 2024

Final result for (1) integration metadata and (2) diagrams.

CleanShot.2024-05-06.at.09.54.07.mp4

Copy link
Member

@shmsr shmsr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits

alaudazzi and others added 2 commits May 6, 2024 10:30
Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
@muthu-mps
Copy link
Contributor

muthu-mps commented May 7, 2024

@alaudazzi - Can we rebuild the package and push the README file changes?

@zmoog
Copy link
Contributor

zmoog commented May 7, 2024

I made two last changes:

  • sort services alphabetically
  • replace the Azure Active Directory logo with the Microsoft Entra ID logo
CleanShot.2024-05-07.at.16.05.07.mp4

- version: "1.11.4"
changes:
- description: Replace Azure AD with Microsoft Entra ID.
type: bugfix
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are rebranding the Azure AD to Microsoft Entra ID. Can this be an enhancement?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are fixing a product name that is now obsolete. If it makes more sense to call it "enhancement", that's fine with me.

@muthu-mps
Copy link
Contributor

@zmoog - This diagram is still referring to Active Directory service. We need to update it to Entra ID.

(2) After:

CleanShot 2024-05-03 at 10 55 44

alaudazzi and others added 3 commits May 7, 2024 18:01
@zmoog
Copy link
Contributor

zmoog commented May 7, 2024

I found a few other leftovers searching for the following terms:

  • Active Directory
  • Azure AD

Can you think of any other case?

@muthu-mps
Copy link
Contributor

I found a few other leftovers searching for the following terms:

  • Active Directory
  • Azure AD

Can you think of any other case?

I am able to find the above mentioned terms. We are good!

@muthu-mps
Copy link
Contributor

@zmoog - The pipeline test data and the generated sample events might have references to the Active Directory. Do you think we need to update the references here as well? IMO, No need to update the test file references.

Copy link
Contributor

@muthu-mps muthu-mps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@zmoog
Copy link
Contributor

zmoog commented May 8, 2024

The pipeline test data and the generated sample events might have references to the Active Directory. Do you think we need to update the references here as well? IMO, No need to update the test file references.

Yeah, I agree there is no need to update the existing test cases. They were generated when Azure AD was the service name.

@elasticmachine
Copy link

💚 Build Succeeded

History

cc @alaudazzi

Copy link

@alaudazzi alaudazzi merged commit 2294f97 into elastic:main May 8, 2024
@elasticmachine
Copy link

Package azure - 1.11.4 containing this change is available at https://epr.elastic.co/search?package=azure

@andrewkroh andrewkroh added the Integration:azure Azure Logs label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working, use only for issues documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:azure Azure Logs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants