-
Notifications
You must be signed in to change notification settings - Fork 24
W-20727600 add scanner GA jh #333
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
Open
JennyHajee
wants to merge
36
commits into
latest
Choose a base branch
from
w-20727600-add-scanner-jh
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
3acda16
added scanner feature
JennyHajee 24817ce
edits
JennyHajee 24ca614
added rewrites for managing scanners
JennyHajee 22a7220
added new content in Creating an Asset for Create an MCP Server via U…
JennyHajee 1132e85
edits
JennyHajee 2231ab1
edits
JennyHajee 9c158a6
edits
JennyHajee 1becc93
edits
JennyHajee 2f9c334
edits
JennyHajee 51ffcd7
edits to index.adoc
JennyHajee 486ed64
copy edits
JennyHajee ad785b1
edit
JennyHajee 9aecbfa
added UTC time for scheduling a scanner
JennyHajee 32d4ede
edits per tech review
JennyHajee 0c9ff3d
varies edits and updated content per tech review
JennyHajee 3dfbe3a
edits per tech review
JennyHajee f378aae
more edits per tech review
JennyHajee b03930a
added image of agent scanner list and edits
JennyHajee f29315e
added screen shot for run now menu option
JennyHajee 482749e
updated scanner list image
JennyHajee 53b6e5b
more edits and some change to titles and short descriptions
JennyHajee 5d3b610
deleted agent-scanner-menu.png
JennyHajee e836357
deleted unused images
JennyHajee 5bd0e8a
more copy edits and added achor links in managing-scanners.adoc
JennyHajee daadaf0
added delimiters for json code block
JennyHajee 67ebf9f
updated before you begin adding amazon bedrock scanner lead in sentence
JennyHajee 9d26688
Update modules/ROOT/pages/adding-amazon-bedrock-scanner.adoc
JennyHajee b827150
Update modules/ROOT/pages/adding-google-vertex-scanner.adoc
JennyHajee 975fd70
Update modules/ROOT/pages/managing-scanners.adoc
JennyHajee 81c5485
Update modules/ROOT/pages/managing-scanners.adoc
JennyHajee 9dd5f5b
Update modules/ROOT/pages/managing-scanners.adoc
JennyHajee fca7570
Update modules/ROOT/pages/to-create-an-asset.adoc
JennyHajee 606f1e9
edits per peer review
JennyHajee b39944c
Merge branch 'latest' into w-20727600-add-scanner-jh
JennyHajee 527e095
edits per peer review
JennyHajee 6c6da5b
Merge branch 'w-20727600-add-scanner-jh' of github.com:mulesoft/docs-…
JennyHajee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 hidden or 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 hidden or 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,80 @@ | ||
| = Adding a Scanner for Amazon Bedrock | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| Add a scanner to discover, import, and sync agents from Amazon Bedrock into Exchange. Then you can govern the agents and consume them in other applications. | ||
|
|
||
| == Before You Begin | ||
| Before adding the scanner, verify that you have the permission, context, and these Amazon Bedrock credentials: | ||
|
|
||
| * Exchange Administrator permission | ||
| * Knowledge about the Amazon Web Services region where the agents are deployed. | ||
| * Amazon Bedrock access key ID | ||
| * Amazon Bedrock secret access key | ||
| + | ||
| You enter your Amazon Bedrock credentials when configuring the scanner in Exchange. For more information, see the Amazon Bedrock documentation. | ||
|
|
||
| To create the inline policy, use this policy: | ||
|
|
||
| [source,json] | ||
| ---- | ||
| { | ||
| "Version": "2012-10-17", | ||
| "Statement": [ | ||
| { | ||
| "Sid": "BedrockAgentDiscoveryPermissions", | ||
| "Effect": "Allow", | ||
| "Action": [ | ||
| "bedrock:ListAgents", | ||
| "bedrock:GetAgent", | ||
| "bedrock:ListAgentAliases", | ||
| "bedrock:GetAgentAlias", | ||
| "bedrock:ListAgentVersions", | ||
| "bedrock:GetAgentVersion", | ||
| "bedrock:InvokeModel", | ||
| "bedrock:InvokeAgent", | ||
| "bedrock:InvokeInlineAgent" | ||
| ], | ||
| "Resource": "*" | ||
| } | ||
| ] | ||
| } | ||
| ---- | ||
|
|
||
| * To ensure the scanner discovers the agent, assign an alias and link it to a version. The scanner ignores agents without an invocable URL. | ||
|
|
||
| == Add a Scanner for Amazon Bedrock | ||
|
|
||
| . Verify that you are in the business group where you want to add the scanner. | ||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Enter a name for the scanner. | ||
| . From *Scheduled Run Configuration*, complete these fields or options: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field/Option* |*Value* | ||
| |*Run Schedule* |Select a frequency and time in UTC. | ||
| |*Sync Review* |Select Auto-resolve. | ||
| |=== | ||
|
|
||
| . From *Connection Configuration*, complete these fields: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field* |*Value* | ||
| |*Agent Provider* |Select *Amazon Bedrock*. | ||
| |*Authentication Method* |Select *Access key*. | ||
| |*Access Key ID* |Enter the access key ID. | ||
| |*Secret Access Key* |Enter the secret access key. | ||
| |*AWS Region* |Select a region. | ||
| |=== | ||
|
|
||
| . Click *Test Connection*. | ||
| + | ||
| If the connection fails, review the *Connection Configuration* settings. Update the settings, and then test the connection again. | ||
| . To send email notifications: | ||
| + | ||
| .. Select *Advanced Settings* and turn on *Send Email Notifications*. | ||
| .. Enter an email address. | ||
| . Click *Add Scanner*. | ||
This file contains hidden or 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,51 @@ | ||
| = Adding a Scanner for Google Vertex AI | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| Add a scanner to discover, import, and sync agents from Google Vertex AI into Exchange. Then you can govern the agents and consume them in other applications. | ||
|
|
||
| == Before You Begin | ||
| Before adding the scanner, verify that you have the permission and these Google Vertex AI credentials: | ||
|
|
||
| * Exchange Administrator permission | ||
| * Google Vertex AI project ID | ||
| * Google Vertex AI secret access key | ||
| + | ||
| You enter these Google Vertex AI credentials when configuring the scanner in Exchange. For more information about creating a service account key, see Google Vertex AI documentation. | ||
|
|
||
| == Add a Scanner for Google Vertex AI | ||
|
|
||
| . Verify that you are in the business group where you want to add the scanner. | ||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Enter a name for the scanner. | ||
| . From *Scheduled Run Configuration*, complete these fields or options: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field/Option* |*Value* | ||
| |*Run Schedule* |Select a frequency and time in UTC. | ||
| |*Sync Review* |Select Auto-resolve. | ||
| |=== | ||
|
|
||
| . From *Connection Configuration*, complete these fields: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field* |*Value* | ||
| |*Agent Provider* |Select *Google Vertex AI*. | ||
| |*Authentication Method* |Select *Service Account*. | ||
| |*Account Email* |Enter the email address. | ||
| |*Project ID* |Enter the project ID. | ||
| |*Secret Access Key* |Enter the access key. | ||
| |*Location* |Select a location. | ||
| |=== | ||
|
|
||
| . Click *Test Connection*. | ||
| + | ||
| If the connection fails, review the *Connection Configuration* settings. Update the settings, and then test the connection again. | ||
| . To send email notifications: | ||
| + | ||
| .. Select *Advanced Settings* and turn on *Send Email Notifications*. | ||
| .. Enter an email address. | ||
| . Click *Add Scanner*. |
This file contains hidden or 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,51 @@ | ||
| = Adding a Scanner for Microsoft Azure Copilot | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| Add a scanner to discover, import, and sync agents from Microsoft Azure Copilot into Exchange. Then you can govern the agents and consume them in other applications. | ||
|
|
||
| == Before You Begin | ||
| Before adding this scanner, verify that you have the permission and these Microsoft Azure Copilot credentials: | ||
|
|
||
| * Exchange Administrator permission | ||
| * Microsoft Azure Copilot tenant ID | ||
| * Microsoft Azure Copilot client ID | ||
| * Microsoft Azure Copilot client secret | ||
| + | ||
| You enter the Microsoft Azure Copilot credentials when configuring the scanner in Exchange. For more information, see the Microsoft Azure Copilot documentation. | ||
|
|
||
| == Add a Scanner for Microsoft Azure Copilot | ||
|
|
||
| . Verify that you are in the business group where you want to add the scanner. | ||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Enter a name for the scanner. | ||
| . From *Scheduled Run Configuration*, complete these fields or options: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field/Option* |*Value* | ||
| |*Run Schedule* |Select a frequency and time in UTC. | ||
| |*Sync Review* |Select *Auto-resolve*. | ||
| |=== | ||
| . From *Connection Configuration*, complete these fields: | ||
| + | ||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Field* |*Value* | ||
| |*Agent Provider* |Select *Microsoft Azure Copilot*. | ||
| |*Authentication Method* |Select an option. | ||
| |*Tenant ID* |Enter the tenant ID. | ||
| |*Client ID* |Enter the client ID. | ||
| |*Client Secret* |Enter the client secret. | ||
| |*Scope* |Enter the URL. | ||
| |=== | ||
|
|
||
| . Click *Test Connection*. | ||
| + | ||
| If the connection fails, review the *Connection Configuration* settings. Update the settings, and then test the connection again. | ||
| . To send email notifications: | ||
| + | ||
| .. Select *Advanced Settings* and turn on *Send Email Notifications*. | ||
| .. Enter an email address. | ||
| . Click *Add Scanner*. |
43 changes: 43 additions & 0 deletions
43
modules/ROOT/pages/discovering-and-importing-external-agents.adoc
This file contains hidden or 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,43 @@ | ||
| = Discovering and Importing External Agents With Scanners | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| Use agent scanners to automatically discover and import agents from outside Anypoint Platform. Scanners inspect agent ecosystems on diverse platforms to provide enterprise-grade governance and visibility through MuleSoft Agent Fabric. They extract metadata from agents and tools and synchronize the information with the Agent Fabric registry in Anypoint Exchange. | ||
|
|
||
| Create a scanner to connect to external provider platforms and transform native metadata into the canonical Agent-to-Agent (A2A) format. The system detects updates and resolves conflicts to maintain a single source of truth. This secure, metadata-first integration operates as a read-only mechanism to avoid complexity and permission challenges in external systems. | ||
|
|
||
| Add and configure a scanner to discover and import agents. Schedule scans to run at specific intervals and configure the connection and email notifications. After a scan is complete, view a summary of added agents and the scan history. | ||
|
|
||
| Scanners add supported agents to *Agents & Tools* as agent asset types. They detect new and missing agents and identify metadata updates. Subsequent scans overwrite metadata changes and restore agents deleted from Exchange. To retain changes, update the asset in the agent provider‘s source. | ||
|
|
||
| After you add a scanner to a business group, you can't move the scanner or its assets to another group. View a list of scanners on the *Agent Scanners* page. The list displays information about the scanner status, name, agent provider, the last run status, the next run, and the added agents. | ||
|
|
||
| image:agent-scanner-list.png["Agent Scanners page showing a list of scanners"] | ||
|
|
||
| Agent scanners support these providers: | ||
|
|
||
| * Amazon Bedrock | ||
| * Google Vertex AI | ||
| * Microsoft Copilot Studio | ||
|
|
||
| == Security and Data Retention | ||
|
|
||
| Agent scanners register agent assets as read-only because the data originated from the agent provider’s platform. Sensitive information, such as API keys and tokens, are securely stored in Anypoint Security secrets manager. To maintain compliance, create credentials with limited permissions. Scanners don't write data to your source system, but read-only access ensures the highest security. | ||
|
|
||
| The system retains scan logs and statuses for at least 90 days and never deletes the most recent successful run. | ||
|
|
||
| Scanners enforce these limits: | ||
|
|
||
| * Frequency: Once daily | ||
| * Retrieval: 1,200 agents per runtime limit | ||
| * Runtime: 6 hours | ||
| + | ||
| If a scan exceeds the runtime limit, the scanner saves the progress and continues the scan the next time it runs. | ||
|
|
||
| == Before You Begin Adding a Scanner | ||
|
|
||
| Make sure you have the permissions and access: | ||
|
|
||
| * Exchange Administrator permission | ||
| * Verify that you are in the business group where you want to add the scanner. |
This file contains hidden or 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 hidden or 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,109 @@ | ||
| = Managing Scanners In Exchange | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| To view and manage your agent scanners, click *Agent Scanners* in the sidebar of Exchange. | ||
|
|
||
| You can perform these actions to manage scanners: | ||
|
|
||
| * xref:managing-scanners.adoc#run-a-scanner[Run a scanner] | ||
| * xref:managing-scanners.adoc#view-scanner-details[View scanner details] | ||
| * xref:managing-scanners.adoc#abort-scans[Abort a scan] | ||
| * xref:managing-scanners.adoc#delete-a-scanner[Delete a scanner] | ||
| * xref:managing-scanners.adoc#edit-scanner-configuration[Edit a scanner configuration] | ||
| * xref:managing-scanners.adoc#view-audit-logs[View audit logs] | ||
|
|
||
| [[run-a-scanner]] | ||
| == Run a Scanner | ||
| Run the scanner manually to capture new agents and add them to Exchange. | ||
| Scanners run once daily and retrieve up to 1,200 agents per scan, with a maximum runtime of 6 hours. Exchange retains scan logs and statuses for at least 90 days and never deletes the most recent run. Run one scan at a time for each agent provider. | ||
|
|
||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Find the scanner in the list, click the more options icon (image:more-options-icon.png[2%,2%]) and then select *Run Now*. | ||
| + | ||
| The scan waits in the queue until the current scan finishes. | ||
|
|
||
| [[view-scanner-details]] | ||
| == View Scanner Details | ||
| View a list of scanners and the details about their scans. The *Agent Scanners* page lists the scanners added for the business group. The scanner details show information about the scanner, connection, last completed run, and scan history. | ||
|
|
||
| Scanner statuses are: | ||
|
|
||
| * Scheduled | ||
| * Paused | ||
| * Queued | ||
| * Running | ||
| * Importing | ||
| * Stopped | ||
|
|
||
| To see more information about a scanner and its scan details, from the sidebar in Exchange, click *Agent Scanners* and click the name of a scanner from the list. | ||
|
|
||
| Here's an example details page: | ||
|
|
||
| image:scanner-details.png["Agent Scanner details page showing a list of scanners"] | ||
|
|
||
| The *Actions* menu on the scanner details page includes these options, depending on the scanner status: | ||
|
|
||
| [%header,cols="1,4"] | ||
| |=== | ||
| |*Scanner Status* |*Actions Menu Options* | ||
| |Scheduled or Paused |Run Now | ||
| |Edit Scanner | ||
| |Delete Scanner | ||
| |Queued, Running, or Importing |Abort Scan | ||
| |Stopped |Edit Scanner | ||
| |Delete Scanner | ||
| |=== | ||
|
|
||
| [[abort-scans]] | ||
| == Abort Scans | ||
| Abort scans for a scanner when its status is queued, running, or importing. When the scan is aborted, the status is updated to stopped. | ||
|
|
||
| * To abort a scan from the *Agent Scanners* page: | ||
| + | ||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Find the scanner in the list, click the more options icon (image:more-options-icon.png[2%,2%]) and then select *Abort Scan*. | ||
|
|
||
| * To abort a scan from the scanner details page, click *Actions* and then select *Abort Scan*. | ||
|
|
||
| [[delete-a-scanner]] | ||
| == Delete a Scanner | ||
| Delete an unused scanner when its status is scheduled, paused or stopped. Choose whether to keep or delete the agents associated with the scanner. Imported assets remain in Exchange if instances exist in API Manager. | ||
|
|
||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Find the scanner in the list, click the more options icon (image:more-options-icon.png[2%,2%]) and then select *Delete Scanner*. | ||
| . Choose whether to keep or delete imported agents and click *Delete*. | ||
|
|
||
| [[edit-scanner-configuration]] | ||
| == Edit Scanner Configuration | ||
| Edit settings for a scanner with a status of scheduled, paused, or stopped, and turn scheduled scans on or off. | ||
|
|
||
| * To edit a scanner from the *Agent Scanners* page: | ||
| + | ||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Find the scanner in the list, click the more options icon (image:more-options-icon.png[2%,2%]) and then select *Edit Scanner*. | ||
| . Make your changes, and click *Update*. | ||
|
|
||
| * To edit a scanner from the scanner details page: | ||
| + | ||
| . Click *Actions* and then select *Edit Scanner*. | ||
| . Make your changes, and click *Update*. | ||
|
|
||
| [[view-audit-logs]] | ||
| == View Audit Logs | ||
| View audit logs for scanners. In the audit log, view scan details, such as agents that were imported, updated, removed, and already in Exchange, and unsuccessful scans. The available tabs depend on the scan results. | ||
|
|
||
| Here's an example audit log: | ||
|
|
||
| image:scanner-audit-log.png["Audit log showing details of a scan event"] | ||
|
|
||
| . From the sidebar in Exchange, click *Agent Scanners*. | ||
| . Select the scanner from the list. | ||
| . Select an event from *Scan History*. | ||
| . To view imported agents, click the *Imported* tab. | ||
| . To view updated agents with newer versions available, click the *Updated* tab. | ||
| . To view agents removed from Exchange because they’re missing from the provider, click the *Removed* tab. | ||
| . To view agents that are found in the agent provider’s system and already in Exchange, click the *Already in Exchange* tab. | ||
| . To view unsuccessful scans, click the *Unsuccessful* tab. | ||
|
|
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.