Skip to content

Commit 7b80e9d

Browse files
failupdmerlob
andauthored
Apply suggestions from code review
Co-authored-by: Daniela Merlo <97902112+dmerlob@users.noreply.github.com>
1 parent 9e77ffd commit 7b80e9d

4 files changed

Lines changed: 50 additions & 49 deletions

File tree

modules/ROOT/pages/godaddy-ans-registration.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,33 @@ With GoDaddy ANS integration in API Manager, you can:
1515
* Track verification progress directly from API Manager
1616
* View verification status in Anypoint Exchange
1717

18-
== Registration workflow
18+
== Registration Workflow
1919

2020
The registration workflow spans API Manager, GoDaddy, and your DNS provider.
2121

22-
You initiate registration from an API instance in API Manager. GoDaddy validates domain ownership using standard verification methods such as DNS or ACME challenges. API Manager tracks the verification process and updates the agent status when verification is complete.
22+
Initiate registration from an API instance in API Manager. GoDaddy validates domain ownership using standard verification methods such as DNS or ACME challenges. API Manager tracks the verification process and updates the agent status when verification is complete.
2323

2424
Depending on your domain configuration, some steps might require manual action.
2525

26-
== Consumer endpoint and FQDN
26+
== Consumer Endpoint and FQDN
2727

2828
The consumer endpoint configured for the agent is used to derive a fully qualified domain name (FQDN) that uniquely identifies the agent.
2929

30-
Only the hostname portion of the endpoint is used. For example, in `https://example.com/path`, the registered domain is `example.com`.
30+
Only the hostname of the endpoint is used. For example, in `https://example.com/path`, the registered domain is `example.com`.
3131

32-
This domain is registered as part of the verification process and cannot be modified after registration.
32+
This domain is registered as part of the verification process and can't be modified after registration.
3333

3434
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)?].
3535

36-
== Domain requirements
36+
== Domain Requirements
3737

38-
The domain used for registration must meet the following requirements:
38+
The domain used for registration must meet these requirements:
3939

40-
* Must be a custom domain (vanity domain)
41-
* MuleSoft-managed domains such as `cloudhub.io` are not supported
42-
* Must be associated with a valid DNS configuration
40+
* Be a custom domain (vanity domain)
41+
* Not be a MuleSoft-managed domain such as `cloudhub.io`, as these domains aren’t supported
42+
* Be associated with a valid DNS configuration
4343

44-
If these requirements are not met, registration cannot proceed.
44+
If these requirements aren't met, registration can't proceed.
4545

4646
== Integration with Anypoint Exchange
4747

@@ -50,11 +50,11 @@ Verification status is reflected in Anypoint Exchange:
5050
* Verified agents display a visual indicator in search results and asset pages
5151
* Verification is tied to the agent instance and its associated domain
5252

53-
== Next steps
53+
== Next Steps
5454

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

57-
For more information, see xref:godaddy-set-up.adoc[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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Create an agent instance
1+
= Create an Agent Instance
22

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

@@ -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 agent instance
15+
== Create an Agent Instance
1616

1717
. In Anypoint Platform, go to *API Manager*.
1818
. Click *Add new instance*.
@@ -36,7 +36,7 @@ This endpoint is used to derive the domain that identifies the agent during veri
3636

3737
After deployment, the agent instance is created and available in API Manager.
3838

39-
== Next steps
39+
== Next Steps
4040

4141
After creating the agent instance:
4242

@@ -46,4 +46,4 @@ After creating the agent instance:
4646

4747
Before verification, ensure that your environment is properly configured.
4848

49-
For more information, see xref:godaddy-set-up.adoc[Prepare your environment for agent verification]
49+
For more information, see xref:godaddy-set-up.adoc[Prepare Your Environment for Agent Verification]

modules/ROOT/pages/godaddy-set-up.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
= Prepare your environment for agent verification
1+
= Prepare Your Environment for Agent Verification
22

3-
Before verifying an agent using GoDaddy Agent Name Service (ANS), you must configure your environment to support domain-based identity validation.
3+
Before verifying an agent using GoDaddy Agent Name Service (ANS), configure your environment to support domain-based identity validation.
44

55
Verification requires a custom domain, a configured runtime environment, and secure communication settings.
66

7-
== Custom domain
7+
== Custom Domain
88

99
Agent verification requires a custom domain (vanity domain) that you own and control.
1010

1111
* The domain associated with your agent must match the consumer endpoint used during registration.
12-
* The domain is used to establish the agent’s identity
13-
* You must be able to create and manage DNS records for the domain
14-
* MuleSoft-managed domains such as `cloudhub.io` are not supported
12+
* The domain is used to establish the agent’s identity.
13+
* You must be able to create and manage DNS records for the domain.
14+
* MuleSoft-managed domains such as `cloudhub.io` are not supported.
1515

16-
== Private space
16+
== Private Space
1717

18-
Agents must be deployed in a private space that supports custom domains and TLS configuration.
18+
Deploy agents in a private space that supports custom domains and TLS configuration.
1919

20-
If you do not already have a private space, create one in Runtime Manager before proceeding.
20+
If you don't already have a private space, create one in Runtime Manager before proceeding.
2121

2222
For more information, see xref:cloudhub-2::ps-manage.adoc[Private Spaces].
2323

24-
== TLS context
24+
== TLS Context
2525

26-
A TLS context must be configured in your private space for the domain used by the agent.
26+
Configure a TLS context in your private space for the domain used by the agent.
2727

2828
TLS configuration enables secure communication and is required to complete verification. A TLS context must be configured for the domain used by the agent.
2929

@@ -43,11 +43,11 @@ Make sure that:
4343
* The certificate is valid and active
4444
* The domain matches the consumer endpoint used by the agent
4545

46-
If no TLS context is configured, verification cannot proceed and an error is displayed.
46+
If no TLS context is configured, verification can't proceed and an error is displayed.
4747

4848
For more information, see xref:cloudhub-2::ps-config-domains.adoc[Configure domains and TLS certificates]
4949

50-
== Gateway configuration
50+
== Gateway Configuration
5151

5252
Agents must be exposed through a configured gateway to support domain-based verification.
5353

@@ -67,7 +67,7 @@ Each agent must be configured with a separate endpoint in the gateway.
6767
If multiple agents are deployed on the same domain, each one requires its own explicit endpoint configuration.
6868
====
6969

70-
== Secret group access
70+
== Secret Group Access
7171

7272
Agent verification requires access to a secret group in Secrets Manager.
7373

@@ -78,11 +78,11 @@ Make sure that:
7878
* At least one secret group exists
7979
* You have permission to write to the selected secret group
8080

81-
If you do not have the required permissions, you cannot complete verification.
81+
If you don't have the required permissions, you can't complete verification.
8282

83-
IMPORTANT: If the domain, TLS context, and gateway configuration are not aligned, agent verification cannot be completed.
83+
IMPORTANT: If the domain, TLS context, and gateway configuration aren't aligned, agent verification can't be completed.
8484

85-
== Next steps
85+
== Next Steps
8686

8787
After completing the environment setup:
8888

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

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
= Verify an agent using GoDaddy ANS
1+
= Verify an Agent Using Godaddy Ans
22

33
Verify an agent to establish a trusted identity based on domain ownership and enable its verified status in Anypoint Exchange.
44

55
Verification uses GoDaddy Agent Name Service (ANS) to validate the domain associated with the agent and confirm that you control it.
66

7-
== Before you begin
7+
== Before You Begin
88

99
Before verifying an agent, make sure that:
1010

@@ -16,31 +16,31 @@ Before verifying an agent, make sure that:
1616

1717
For infrastructure requirements such as domain configuration and TLS setup, see xref:godaddy-set-up.adoc[Prepare your environment for agent verification].
1818

19-
== Start agent verification
19+
== Start Agent Verification
2020

2121
. In Anypoint Platform, go to *API Manager*.
2222
. Select the API instance that represents your agent.
2323
. Click *Actions* > *Verify agent identity*.
2424

2525
The verification wizard opens and guides you through the required steps.
2626

27-
== Step 1: Provide prerequisites
27+
== Step 1: Provide Prerequisites
2828

2929
In this step:
3030

3131
* Confirm or update the *Consumer endpoint*
3232
+
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.
33+
The consumer endpoint is used to derive the domain that is verified. Only the hostname is used. This domain becomes part of the agent’s identity and can't be changed after registration.
3434

3535
* Select a *Secret group*
3636
+
3737
The secret group is used to store credentials and generated security artifacts required for verification.
3838

3939
You must have access to at least one secret group with sufficient permissions to continue.
4040

41-
If the domain or environment is not correctly configured, validation errors are displayed and you cannot proceed.
41+
If the domain or environment isn't correctly configured, validation errors are displayed and you can't proceed.
4242

43-
== Step 2: Enter GoDaddy ANS credentials
43+
== Step 2: Enter GoDaddy ANS Credentials
4444

4545
Provide your GoDaddy credentials:
4646

@@ -51,7 +51,7 @@ These credentials are used to authenticate with GoDaddy ANS and initiate the ver
5151

5252
If you don’t already have these credentials, generate them in your GoDaddy account.
5353

54-
== Step 3: Verify domain ownership (ACME)
54+
== Step 3: Verify Domain Ownership (Acme)
5555

5656
To prove domain ownership, create a DNS TXT record using the provided values.
5757

@@ -61,9 +61,10 @@ To prove domain ownership, create a DNS TXT record using the provided values.
6161

6262
API Manager checks whether the record has been propagated and validated.
6363

64-
NOTE: ACME records expire after a limited time. If they expire, new records are generated automatically when you retry verification.
64+
[NOTE]
65+
ACME records expire after a limited time. If they expire, new records are generated automatically when you retry verification.
6566

66-
== Step 4: Verify DNS records
67+
== Step 4: Verify DNS Records
6768

6869
After ACME verification, additional DNS records are generated.
6970

@@ -73,7 +74,7 @@ After ACME verification, additional DNS records are generated.
7374

7475
These records enable secure communication and complete the verification process.
7576

76-
== Verification process
77+
== Verification Process
7778

7879
Verification is asynchronous and depends on DNS propagation and external validation.
7980

@@ -83,15 +84,15 @@ Verification is asynchronous and depends on DNS propagation and external validat
8384

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

86-
== Retry or restart verification
87+
== Retry or Restart Verification
8788

88-
If verification is not completed:
89+
If verification isn't completed:
8990

90-
* DNS records may expire after a limited time
91+
* DNS records can expire after a limited time
9192
* You can restart the verification process from the agent instance
9293
* New DNS records are generated when restarting
9394

94-
== After verification
95+
== After Verification
9596

9697
When verification is successful:
9798

0 commit comments

Comments
 (0)