Skip to content

Commit 75e1bc3

Browse files
committed
W-21743430-goddady-fa
1 parent 2030191 commit 75e1bc3

5 files changed

Lines changed: 97 additions & 19 deletions

File tree

modules/ROOT/nav.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
** xref:manage-versions-instances-concept.adoc[Manage API Instance Versions]
1919
** xref:configure-multiple-credential-providers.adoc[Configure Multiple Client Provider]
2020
** xref:govern-api-instances.adoc[Govern API Instances]
21+
** xref:godaddy-overview.adoc[Agent verification (GoDaddy ANS)]
22+
*** xref:godaddy-set-up.adoc[]
23+
*** xref:godaddy-register-agent.adoc[]
24+
*** xref:godaddy-verify-agent.adoc[]
2125
* xref:api-groups-landing-page.adoc[Manage API Groups]
2226
** xref:api-groups-creating-groups.adoc[Create API Groups]
2327
** xref:api-groups-modifying-groups.adoc[Modify API Groups]

modules/ROOT/pages/godaddy-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Verification status is reflected in Anypoint Exchange:
5454

5555
Before registering an agent, ensure that your environment is properly configured.
5656

57-
For more information, see xref:<NEW_PAGE_ID>[Prepare your environment for agent verification].
57+
For more information, see xref:godaddy-set-up.adoc[Prepare your environment for agent verification].
5858

5959
== See also
6060

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Create an agent instance in API Manager to expose your agent and configure its runtime, endpoint, and routing settings.
44

5-
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.
5+
After creating the agent instance, you can verify its identity using GoDaddy ANS to associate it with a domain and enable its verified status in Anypoint Exchange.
66

77
== Requirements
88

@@ -12,7 +12,7 @@ Before you begin, make sure that:
1212
* You have access to a target runtime (for example, Flex Gateway)
1313
* You have the required permissions to manage API instances
1414

15-
== Create an new agent instance
15+
== Create an agent instance
1616

1717
. In Anypoint Platform, go to *API Manager*.
1818
. Click *Add new instance*.
@@ -24,9 +24,9 @@ Before you begin, make sure that:
2424
+
2525
. Configure the endpoint settings:
2626
+
27-
* *Consumer endpoint*: The public endpoint where the agent will be exposed
27+
* *Consumer endpoint*: The public endpoint where the agent is exposed
2828
+
29-
This endpoint is used later for identity verification.
29+
This endpoint is used to derive the domain that identifies the agent during verification.
3030
+
3131
. Configure the upstream service:
3232
+
@@ -44,4 +44,8 @@ After creating the agent instance:
4444
* Complete domain validation to enable verified status
4545
* Confirm that the agent displays as verified in Anypoint Exchange
4646

47-
For more information, see xref:placeholderside[Verify an agent using GoDaddy ANS].
47+
Before verification, ensure that your environment is properly configured.
48+
49+
For more information, see xref:<NEW_PAGE_ID>[Prepare your environment for agent verification].
50+
51+
For more information about verification, see xref:goddady-verify-agent.adoc[Verify an agent using GoDaddy ANS].
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
= Prepare your environment for agent verification
2+
3+
Before verifying an agent using GoDaddy Agent Name Service (ANS), you must configure your environment to support domain-based identity validation.
4+
5+
Verification requires a custom domain, a configured runtime environment, and secure communication settings.
6+
7+
== Custom domain
8+
9+
Agent verification requires a custom domain (vanity domain) that you own and control.
10+
11+
* The domain is used to establish the agent’s identity
12+
* You must be able to create and manage DNS records for the domain
13+
* MuleSoft-managed domains such as `cloudhub.io` are not supported
14+
15+
The domain associated with your agent must match the consumer endpoint used during registration.
16+
17+
== Private space
18+
19+
Agents must be deployed in a private space to support custom domains and TLS configuration.
20+
21+
If you do not already have a private space, create one in Runtime Manager before proceeding.
22+
23+
For more information, see xref:cloudhub-2::ps-manage.adoc[Private Spaces].
24+
25+
== TLS context
26+
27+
A TLS context must be configured in your private space for the domain used by the agent.
28+
29+
TLS configuration enables secure communication and is required to complete verification. API Manager validates that a TLS context exists for the domain before allowing verification to proceed.
30+
31+
To configure a TLS context:
32+
33+
. In Anypoint Platform, go to *Runtime Manager*.
34+
. Select your private space.
35+
. Open the *TLS* or *Domains and TLS* section.
36+
. Create a new TLS context for your domain.
37+
. Upload a valid certificate for the domain.
38+
39+
Make sure that:
40+
41+
* The TLS context is associated with your domain
42+
* The certificate is valid and active
43+
* The domain matches the consumer endpoint used by the agent
44+
45+
If no TLS context is configured, verification cannot proceed and an error is displayed.
46+
47+
TIP: Use a wildcard certificate (for example, `*.example.com`) to support multiple agents on the same domain.
48+
49+
== Secret group access
50+
51+
Agent verification requires access to a secret group in Secrets Manager.
52+
53+
The secret group is used to store generated security artifacts such as keystores and identity credentials.
54+
55+
Make sure that:
56+
57+
* At least one secret group exists
58+
* You have permission to write to the selected secret group
59+
60+
If you do not have the required permissions, you cannot complete verification.
61+
62+
== Next steps
63+
64+
After completing the environment setup:
65+
66+
* xref:godaddy-register-agent.adoc[Create an agent instance]
67+
* xref:goddady-verify-agent.adoc[Verify an agent using GoDaddy ANS]

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ Before verifying an agent, make sure that:
1010

1111
* The agent instance is created and deployed in API Manager
1212
* A valid consumer endpoint is configured for the agent
13-
* You have a GoDaddy account with API key and secret
13+
* You have GoDaddy API credentials (API key and secret)
1414
* You have access to manage DNS records for the domain
1515
* You have access to a secret group in Secrets Manager
1616

17+
For infrastructure requirements such as domain configuration and TLS setup, see xref:godaddy-set-up.adoc[Prepare your environment for agent verification].
18+
1719
== Start agent verification
1820

1921
. In Anypoint Platform, go to *API Manager*.
@@ -28,38 +30,39 @@ In this step:
2830

2931
* Confirm or update the *Consumer endpoint*
3032
+
31-
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.
33+
The consumer endpoint is used to derive the domain that will be verified. Only the hostname is used. This domain becomes part of the agent’s identity and cannot be changed after registration.
3234

3335
* Select a *Secret group*
3436
+
3537
The secret group is used to store credentials and generated security artifacts required for verification.
3638

37-
NOTE: You must have access to at least one secret group to continue.
39+
You must have access to at least one secret group with sufficient permissions to continue.
40+
41+
If the domain or environment is not correctly configured, validation errors are displayed and you cannot proceed.
3842

3943
== Step 2: Enter GoDaddy ANS credentials
4044

41-
In this step, provide your GoDaddy credentials:
45+
Provide your GoDaddy credentials:
4246

4347
* *API key*
4448
* *API secret*
4549

46-
These credentials are required to authenticate with GoDaddy ANS and initiate the verification process.
50+
These credentials are used to authenticate with GoDaddy ANS and initiate the verification process.
4751

48-
If you don’t already have these credentials, generate them in your GoDaddy account.
49-
In GoDaddy, go to your developer or API settings and create a new API key and secret.
50-
51-
Make sure the credentials have the required permissions to manage domain verification.
52+
If you don’t already have these credentials, generate them in your GoDaddy account.
5253

5354
== Step 3: Verify domain ownership (ACME)
5455

55-
To prove domain ownership, you must create a DNS TXT record.
56+
To prove domain ownership, create a DNS TXT record using the provided values.
5657

57-
. Copy the provided record details.
58+
. Copy the record details.
5859
. In your DNS provider, create the TXT record.
5960
. Return to API Manager and click *Verify*.
6061

6162
API Manager checks whether the record has been propagated and validated.
6263

64+
NOTE: ACME records expire after a limited time. If they expire, new records are generated automatically when you retry verification.
65+
6366
== Step 4: Verify DNS records
6467

6568
After ACME verification, additional DNS records are generated.
@@ -68,15 +71,15 @@ After ACME verification, additional DNS records are generated.
6871
. Add them to your DNS provider.
6972
. Click *Verify*.
7073

71-
These records enable secure communication and complete the identity verification process.
74+
These records enable secure communication and complete the verification process.
7275

7376
== Verification process
7477

7578
Verification is asynchronous and depends on DNS propagation and external validation.
7679

7780
* Status updates are displayed in API Manager
7881
* Verification can take several minutes or longer depending on DNS updates
79-
* API Manager continuously checks the status after verification is initiated
82+
* API Manager continues checking the status after verification is initiated
8083

8184
You can close the verification dialog and return later. The status continues to update in the background.
8285

0 commit comments

Comments
 (0)