W-21743430-goddady-fa

Author: failup

modules/ROOT/pages/godaddy-overview.adoc

@@ -1,64 +1,55 @@
 = Register Agents with GoDaddy ANS
 
 GoDaddy Agent Name Service (ANS) integration enables you to register and verify agents deployed through API Manager. 
-Registration associates your agent with a verified domain and allows Anypoint Exchange to display a verified status for the asset.
+Registration associates your agent with a fully qualified domain name (FQDN) and establishes a verifiable identity based on domain ownership.
 
-This integration introduces a registration workflow in API Manager that communicates with GoDaddy to validate domain ownership and agent identity.
+This integration connects API Manager with GoDaddy to validate agent identity and surface verification status across the platform.
 
 == Capabilities
 
 With GoDaddy ANS integration in API Manager, you can:
 
 * Register an agent instance with GoDaddy ANS
-* Track the registration status directly from API Manager
-* Retry or restart registration if it fails or expires
-* Verify agents associated with your domain
+* Verify agent identity using domain ownership validation
+* Track verification progress directly from API Manager
 * Surface verification status in Anypoint Exchange
 
-== Registration Workflow
+== Registration workflow
 
-The registration workflow spans API Manager, GoDaddy, and Anypoint Exchange:
+The registration workflow spans API Manager, GoDaddy, and your DNS provider.
 
-1. You initiate registration from an API instance in API Manager.
-2. API Manager sends a registration request to GoDaddy ANS.
-3. GoDaddy validates domain ownership using DNS or ACME challenges.
-4. API Manager tracks and updates the registration status.
-5. Once verification is complete, the agent is marked as verified.
-6. Anypoint Exchange displays the verified status for the asset.
+You initiate registration from an API instance in API Manager. 
+GoDaddy then validates domain ownership using standard verification methods such as DNS or ACME challenges. 
+API Manager tracks the progress of this process and updates the agent status once verification is complete.
 
-The exact validation process depends on the domain type used by the agent.
+Depending on your domain configuration, some steps might require manual action.
 
-== Supported Domain types
+== Consumer endpoint and FQDN
 
-The registration experience varies depending on the domain associated with the agent:
+The consumer endpoint configured for the agent is used to derive a fully qualified domain name (FQDN) that uniquely identifies the agent.
 
-* *MuleSoft-managed domains*:  
-API Manager automatically handles DNS configuration and verification.
+This domain is registered as part of the verification process and represents the agent’s identity in GoDaddy ANS. 
+After registration, the domain cannot be modified.
 
-* *Custom domains*:  
-You must manually configure DNS records to complete verification. 
-If verification is not completed within the allowed time window, the registration expires and must be restarted.
+For more information, see https://www.godaddy.com/resources/skills/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for[What is a Fully Qualified Domain Name (FQDN)?].
 
-== Registration status
+== Supported domain types
 
-During registration, API Manager tracks the status of the verification process. 
-Common states include:
+The registration experience varies depending on the domain associated with the agent:
 
-* Pending validation
-* Waiting for DNS configuration
-* Active (verified)
-* Failed
-* Expired
+* *MuleSoft-managed domains*:  
+API Manager handles domain configuration and verification automatically.
 
-You can monitor the current status and take action, such as retrying the process, directly from API Manager.
+* *Custom domains*:  
+You must configure DNS records in your DNS provider to complete verification. 
+If verification is not completed within the allowed time window, the process must be restarted.
 
 == Integration with Anypoint Exchange
 
 Verification status is reflected in Anypoint Exchange:
 
 * Verified agents display a visual indicator in search results and asset pages
 * Verification is tied to the agent instance and its associated domain
-* Only successfully verified agents are marked as verified
 
 == Before you begin
 
@@ -67,7 +58,7 @@ Before registering an agent, make sure that:
 * The API instance is deployed and accessible
 * A valid consumer endpoint is configured
 * Required credentials for GoDaddy ANS are available
-* You have permissions to manage the API instance and related secrets
+* You have access to manage DNS records for the domain, if using a custom domain
 
 == See also
 

modules/ROOT/pages/godaddy-register-agent.adoc

@@ -1,58 +1,47 @@
-= Register an agent
+= Create an agent instance
 
-Register an agent to verify its domain and enable its verified status in Anypoint Exchange. 
-Registration is initiated from an API instance in API Manager and requires validating domain ownership through GoDaddy ANS.
+Create an agent instance in API Manager to expose your agent and configure its runtime, endpoint, and routing settings.
+
+After creating the agent instance, you can verify its identity using GoDaddy ANS to associate it with a trusted domain and enable its verified status in Anypoint Exchange.
 
 == Requirements
 
 Before you begin, make sure that:
 
 * The API instance is deployed and accessible
-* A valid consumer endpoint is configured for the agent
-* You have access to the required GoDaddy ANS credentials
-* You have permissions to manage the API instance and related secrets
+* You have access to a target runtime (for example, Flex Gateway)
+* You have the required permissions to manage API instances
 
-== Register an agent
+== Create an new agent instance
 
 . In Anypoint Platform, go to *API Manager*.
-. Select the API instance that represents your agent.
-. In the instance details, locate the *Agent registration* section.
-. Click *Register agent*.
-. Provide the required configuration:
+. Click *Add new instance*.
+. Select the agent or API asset you want to deploy.
+. Configure the runtime settings:
 +
-* *Consumer endpoint*: The public endpoint used for verification
-* *Credentials*: The GoDaddy API key and secret required for registration. +
-Generate these credentials in your GoDaddy account and provide them during registration. 
-. Click *Submit* to start the registration process.
-
-API Manager initiates the registration request and displays the current registration status.
-
-== Complete domain verification
-
-Depending on the domain type, verification is completed differently:
-
-* *MuleSoft-managed domains*:  
-Verification is handled automatically. No additional action is required.
-
-* *Custom domains*:  
-You must create the required DNS records to complete verification.  
-Use the values provided in API Manager to configure your DNS provider.
-
-Verification must be completed within the allowed time window. If verification expires, you must restart the registration process.
-
-== Monitor registration status
-
-After submitting the registration:
+* Select the target gateway
+* Choose the deployment configuration
++
+. Configure the endpoint settings:
++
+* *Consumer endpoint*: The public endpoint where the agent will be exposed  
++
+This endpoint is used later for identity verification.
++
+. Configure the upstream service:
++
+* Provide the target service or backend configuration
++
+. Review the configuration and click *Deploy*.
 
-* View the current status in the *Agent registration* section
-* Wait for the status to transition to *Active* after successful verification
-* If the process fails or expires, use the available option to retry or restart registration
+After deployment, the agent instance is created and available in API Manager.
 
 == Next steps
 
-After the agent is successfully registered:
+After creating the agent instance:
 
+* Verify the agent identity using GoDaddy ANS
+* Complete domain validation to enable verified status
 * Confirm that the agent displays as verified in Anypoint Exchange
-* Review the asset details and ensure the verified status is visible
 
-For more information, see xref:placeholderside[Integration with Anypoint Exchange].
+For more information, see xref:placeholderside[Verify an agent using GoDaddy ANS].

modules/ROOT/pages/godaddy-verify-agent.adoc

@@ -0,0 +1,92 @@
+= Verify an agent using GoDaddy ANS
+
+Verify an agent to establish a trusted identity based on domain ownership and enable its verified status in Anypoint Exchange.
+
+Verification uses GoDaddy Agent Name Service (ANS) to validate the domain associated with the agent and confirm that you control it.
+
+== Before you begin
+
+Before verifying an agent, make sure that:
+
+* The agent instance is created and deployed in API Manager
+* A valid consumer endpoint is configured for the agent
+* You have a GoDaddy account with API key and secret
+* You have access to manage DNS records for the domain
+* You have access to a secret group in Secrets Manager
+
+== Start agent verification
+
+. In Anypoint Platform, go to *API Manager*.
+. Select the API instance that represents your agent.
+. Click *Actions* > *Verify agent identity*.
+
+The verification wizard opens and guides you through the required steps.
+
+== Step 1: Provide prerequisites
+
+In this step:
+
+* Confirm or update the *Consumer endpoint*
++
+The consumer endpoint is used to derive the domain that will be verified. This value becomes part of the agent’s identity and cannot be changed after registration.
+
+* Select a *Secret group*
++
+The secret group is used to store credentials and generated security artifacts required for verification.
+
+NOTE: You must have access to at least one secret group to continue. 
+
+== Step 2: Enter GoDaddy ANS credentials
+
+In this step, provide your GoDaddy credentials:
+
+* *API key*
+* *API secret*
+
+These credentials are used to communicate with GoDaddy ANS and initiate the verification process.
+
+== Step 3: Verify domain ownership (ACME)
+
+To prove domain ownership, you must create a DNS TXT record.
+
+. Copy the provided record details.
+. In your DNS provider, create the TXT record.
+. Return to API Manager and click *Verify*.
+
+API Manager checks whether the record has been propagated and validated.
+
+== Step 4: Verify DNS records
+
+After ACME verification, additional DNS records are generated.
+
+. Copy the provided DNS records.
+. Add them to your DNS provider.
+. Click *Verify*.
+
+These records enable secure communication and complete the identity verification process.
+
+== Verification process
+
+Verification is asynchronous and depends on DNS propagation and external validation.
+
+* Status updates are displayed in API Manager
+* Verification can take several minutes or longer depending on DNS updates
+* API Manager continuously checks the status after verification is initiated
+
+You can close the verification dialog and return later. The status continues to update in the background.
+
+== Retry or restart verification
+
+If verification is not completed:
+
+* DNS records may expire after a limited time
+* You can restart the verification process from the agent instance
+* New DNS records are generated when restarting
+
+== After verification
+
+When verification is successful:
+
+* The agent is marked as verified in API Manager
+* A verified indicator appears in Anypoint Exchange
+* The agent is associated with a trusted domain identity