Skip to content

Commit

Permalink
Amplify Enterprise Marketplace > Amplify Engage Part 1 (#608)
Browse files Browse the repository at this point in the history
* Committed on new branch

* review edits
  • Loading branch information
lbadenhop authored Feb 13, 2025
1 parent e39ebf2 commit f05b44c
Show file tree
Hide file tree
Showing 46 changed files with 176 additions and 177 deletions.
4 changes: 2 additions & 2 deletions content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Mapping this analogy back to Amplify:

The management plane allows Platform Administrators and API providers to administer users, teams, agents, and other related entities in support of managing your distributed environments and organizations.

#### Marketplace
#### Amplify Engage

API providers have visibility over the environments that have been connected to the Amplify platform, including services within those environments. Discovery Agents automate the retrieval of information from these systems, but services can also be added manually or via API or CLI. APIs and other assets are curated and published to the Amplify Marketplace. The Enterprise Marketplace caters to both providers and consumers. It enables enterprises to deliver digital experiences with great speed and control by offering a centralized location for discovery and collaboration around assets, maximizing reuse across the enterprise.
API providers have visibility over the environments that have been connected to the Amplify platform, including services within those environments. Discovery Agents automate the retrieval of information from these systems, but services can also be added manually or via API or CLI. APIs and other assets are curated and published to the Amplify Marketplace. Amplify Engage caters to both providers and consumers. It enables enterprises to deliver digital experiences with great speed and control by offering a centralized location for discovery and collaboration around assets, maximizing reuse across the enterprise.

#### Administration

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Overview/provider_journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following steps summarize the provider journey within the Amplify API Manage
1. Create an environment - see [Define an environment](/docs/connect_manage_environ) that represent the data plane
2. Discover APIs from an existing data plane

* Manual discovery using the Enterprise Marketplace WebUI - see [Add an API service](/docs/connect_manage_environ/manage_services/add_api_service)
* Manual discovery using the Amplify Engage WebUI - see [Add an API service](/docs/connect_manage_environ/manage_services/add_api_service)
* Automatic using a CI/CD procedure - see [Integrate with Amplify](/docs/integrate_with_central)
* Automatic and synchronized using a discovery agent - see [Connect your environment with a Gateway](/docs/connect_manage_environ#synchronize-your-environment-with-a-gateway)

Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: "Welcome to Amplify Enterprise Marketplace"
linkTitle: "Welcome to Amplify Enterprise Marketplace"
title: "Welcome to Amplify Engage"
linkTitle: "Welcome to Amplify Engage"
weight: 03
no_list: true
menu:
main:
weight: 20
---
This website contains the entire documentation set for Amplify Enterprise Marketplace.
This website contains the entire documentation set for Amplify Engage.

## Amplify Enterprise Marketplace documentation
## Amplify Engage documentation

Browse all documentation for Amplify Enterprise Marketplace under the left navigation menu.
Browse all documentation for Amplify Engage under the left navigation menu.

Here are some suggestions to get started:

Expand All @@ -27,4 +27,4 @@ Email `[email protected]` or visit [Axway Support](https://support.axway.com/).

## Training

Axway offers training across the globe, including on-site instructor-led classes and self-paced online learning. To learn more about Amplify Enterprise Marketplace and other Axway product solutions, browse Axway University's [courses and learning plans](https://university.axway.com/learn).
Axway offers training across the globe, including on-site instructor-led classes and self-paced online learning. To learn more about Amplify Engage and other Axway product solutions, browse Axway University's [courses and learning plans](https://university.axway.com/learn).
2 changes: 1 addition & 1 deletion content/en/docs/amplify_relnotes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ date: 2025-1-7
hide_readingtime: true
---

This page displays the supported agents for each release of Amplify Enterprise Marketplace. To learn more about what's in a release, click on the release note title / date to go to the corresponding release note.
This page displays the supported agents for each release of Amplify Engage. To learn more about what's in a release, click on the release note title / date to go to the corresponding release note.

Please take note of the agents' versions on this page before navigating to the corresponding release note.

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/connect_manage_environ/add_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Learn how to create an environment to represent your API services and other disc
* **Frequency** - set how often the Embedded agent should run traffic collection. 30 minutes is the minimum value that can be set. For example, 30m = 30 minutes, 5h5m = 5 hours and 5 mins, 2d = 2 days.
* **Sampling** - enter the percentage of full transaction details sent to the platform for display in Business and Consumer insights. The default value is 10 and the acceptable values are between 0 and 50.
* **Redaction and Sanitization** - redaction and sanitization settings to use when reporting transactions from the data plane.
* **URL Path** - all URL paths, or path regular expressions, which may be reported to Enterprise Marketplace. ".*" will send all the path values. For example, if the agent finds a path of `https://somehost.com/pathof/my/api/uses/thispath` then `https://somehost.com/pathof/my/api/uses/thispath` will be sent to the platform.
* **URL Path** - all URL paths, or path regular expressions, which may be reported to Amplify Engage. ".*" will send all the path values. For example, if the agent finds a path of `https://somehost.com/pathof/my/api/uses/thispath` then `https://somehost.com/pathof/my/api/uses/thispath` will be sent to the platform.
* **Query Arguments** - regular expressions applied to the query argument name and query argument value in the transactional data.
* **Allowed Patterns** - query argument names that match any of these expressions will be reported. For example, "^id$" value will find all the query arguments with their key set to "id" and send to platform.
* **Sanitization Patterns**
Expand Down Expand Up @@ -136,7 +136,7 @@ Learn how to create an environment to represent your API services and other disc
* **Frequency** - set how often the Embedded agent should run traffic collection. 30 minutes is the minimum value that can be set. For example, 30m = 30 minutes, 5h5m = 5 hours and 5 mins, 2d = 2 days.
* **Sampling** - enter the percentage of full transaction details sent to the platform for display in Business and Consumer insights. The default value is 10 and the acceptable values are between 0 and 50.
* **Redaction and Sanitization** - the redaction and sanitization settings to use when reporting transactions from the data plane.
* **URL Path** - all URL paths, or path regular expressions, which may be reported to Enterprise Marketplace. ".*" will send all the path values. For example, if the agent finds a path of `https://somehost.com/pathof/my/api/uses/thispath` then `https://somehost.com/pathof/my/api/uses/thispath` will be sent to the platform.
* **URL Path** - all URL paths, or path regular expressions, which may be reported to Amplify Engage. ".*" will send all the path values. For example, if the agent finds a path of `https://somehost.com/pathof/my/api/uses/thispath` then `https://somehost.com/pathof/my/api/uses/thispath` will be sent to the platform.
* **Query Arguments** - regular expressions applied to the query argument name and query argument value in the transactional data.
* **Allowed Patterns** - query argument names that match any of these expressions will be reported. For example, "^id$" value will find all the query arguments with their key set to "id" and send to platform.
* **Sanitization Patterns**
Expand Down
20 changes: 10 additions & 10 deletions content/en/docs/connect_manage_environ/agents_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A list of agents is displayed with the following information:

## Add your agent status to the environment details page using the CLI

If your environment status in **Enterprise Marketplace / Topology** displays `Manual Sync.`, even though you have configured agents that have discovered APIs from your gateway and sent relative traffic to Business Insights, then you either installed the agents manually or with an older version of Axway Central CLI. Axway Central CLI (0.12.0 and later) creates necessary resources for the known agents (AWS, v7, Azure) to report its environment status to Amplify for you to view.
If your environment status in **Amplify Engage / Topology** displays `Manual Sync.`, even though you have configured agents that have discovered APIs from your gateway and sent relative traffic to Business Insights, then you either installed the agents manually or with an older version of Axway Central CLI. Axway Central CLI (0.12.0 and later) creates necessary resources for the known agents (AWS, v7, Azure) to report its environment status to Amplify for you to view.

If you installed the agents manually or with an older version of Axway Central CLI, you must:

Expand All @@ -71,7 +71,7 @@ Refer to `axway central get` to list the resources.

The following samples describe the resources for:

* An environment: my-enterprise-marketplace-environment
* An environment: my-engage-environment
* A Discovery Agent: my-discovery-agent-name
* A Traceability Agent: my-traceability-agent-name

Expand All @@ -81,7 +81,7 @@ Environment sample:
group: management
apiVersion: v1alpha1
kind: Environment
name: my-enterprise-marketplace-environment
name: my-engage-environment
title: My beautiful environment title
metadata:
attributes:
Expand Down Expand Up @@ -109,7 +109,7 @@ title: My beautiful DiscoveryAgent title
metadata:
scope:
kind: Environment
name: my-enterprise-marketplace-environment
name: my-engage-environment
attributes: {}
finalizers: []
tags:
Expand All @@ -134,7 +134,7 @@ title: My beautiful TraceabilityAgent title
metadata:
scope:
kind: Environment
name: my-enterprise-marketplace-environment
name: my-engage-environment
attributes: {}
finalizers: []
tags:
Expand Down Expand Up @@ -172,7 +172,7 @@ Run `axway central get env`. You should see something similar to this:

```shell
NAME AGE TITLE RESOURCE KIND RESOURCE GROUP
my-enterprise-marketplace-environment a few seconds ago My beautiful environment title Environment management
my-engage-environment a few seconds ago My beautiful environment title Environment management
```

#### Step 3: Create the agent resources
Expand All @@ -184,7 +184,7 @@ Create agent resources using one of these methods:

Reference the CLI output name `CENTRAL_AGENTNAME` variable in your agent configuration file.

Check that the resources were created correctly by using either the Axway Central CLI or by going to **Enterprise Marketplace WebUI > Topology > Environment**.
Check that the resources were created correctly by using either the Axway Central CLI or by going to **Amplify Engage WebUI > Topology > Environment**.

Once you are done, verify your work by running the commands `axway central get da` or `axway central get ta` or `axway central get da,ta`

Expand All @@ -193,11 +193,11 @@ You should see something similar to this:
```shell
// discovery agent
NAME STATUS AGE RESOURCE KIND SCOPE KIND SCOPE NAME RESOURCE GROUP
my-discovery-agent-name a minute ago DiscoveryAgent Environment my-enterprise-marketplace-environment management
my-discovery-agent-name a minute ago DiscoveryAgent Environment my-engage-environment management
// traceability agent
NAME STATUS AGE RESOURCE KIND SCOPE KIND SCOPE NAME RESOURCE GROUP
my-traceability-agent-name a few seconds ago TraceabilityAgent Environment my-enterprise-marketplace-environment management
my-traceability-agent-name a few seconds ago TraceabilityAgent Environment my-engage-environment management
```

Notice that each agent has an empty column named `STATUS`. This status column will be updated with either `running` when agent is running, `stopped` when agent is stopped or `failed` when the agent cannot establish the connection with the gateway.
Expand All @@ -208,7 +208,7 @@ In order to link agent binary with the appropriate agent resource, you have to u

Sample: CENTRAL_AGENTNAME=my-discovery-agent-name

Once the Discovery Agent successfully starts, the agent status (Enterprise Marketplace / Topology) will change to `Running`. If there are no other agents linked to that environment, then the environment status will change from `Manual Sync` to `Connected`.
Once the Discovery Agent successfully starts, the agent status (Amplify Engage / Topology) will change to `Running`. If there are no other agents linked to that environment, then the environment status will change from `Manual Sync` to `Connected`.
{{< alert title="Note" color="primary" >}}
The environment status is calculated from the aggregate status of all agents linked to that environment:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ APIMANAGER_AUTH_PASSWORD=AnApiManagerUserPassword
CENTRAL_AUTH_CLIENTID=AnApiCentralServiceAccountClientId
CENTRAL_AUTH_PRIVATEKEY=<path>/to/private_key.pem
CENTRAL_AUTH_PUBLICKEY=<path>/to/public_key.pem
CENTRAL_ORGANIZATIONID=TheOrganizationIDfromEnterpriseMarketplace
CENTRAL_ENVIRONMENT=EnterpriseMarketplaceEnvironmentName
CENTRAL_ORGANIZATIONID=TheOrganizationIDfromAmplifyEngage
CENTRAL_ENVIRONMENT=AmplifyEngageEnvironmentName
```

### Traceability Agent
Expand All @@ -64,8 +64,8 @@ APIGATEWAY_AUTH_PASSWORD=AnApiGatewayOperatorUserPassword
CENTRAL_AUTH_CLIENTID=AnApiCentralServiceAccountClientId
CENTRAL_AUTH_PRIVATEKEY=<path>/to/private_key.pem
CENTRAL_AUTH_PUBLICKEY=<path>/to/public_key.pem
CENTRAL_ORGANIZATIONID=TheOrganizationIDfromEnterpriseMarketplace
CENTRAL_ENVIRONMENT=EnterpriseMarketplaceEnvironmentName
CENTRAL_ORGANIZATIONID=TheOrganizationIDfromAmplifyEngage
CENTRAL_ENVIRONMENT=AmplifyEngageEnvironmentName
#
#Reporting Traffic to Consumer Insights
#
Expand Down Expand Up @@ -112,7 +112,7 @@ All common agent variables can be found [here](/docs/connect_manage_environ/conn

| Variable name | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| APIMANAGER_DISCOVERYIGNORETAGS | Comma-separated blacklist of tags that should not be on a proxy before sending to Enterprise Marketplace. Takes precedence over APIMANAGER_FILTER. |
| APIMANAGER_DISCOVERYIGNORETAGS | Comma-separated blacklist of tags that should not be on a proxy before sending to Amplify Engage. Takes precedence over APIMANAGER_FILTER. |
| APIMANAGER_FILTER | Expression to filter the API you want the agent to discover. See [Discover APIs](/docs/connect_manage_environ/connect_api_manager/filtering-apis-to-be-discovered/). |

#### Invoke policy handling
Expand Down Expand Up @@ -214,7 +214,7 @@ APIMANAGER_CUSTOM_OAUTHEXT_CLIENTID_LABEL="Azure AD Client Id"
| INPUTS_CLOSE_REMOVED | The agent will close the harvester of the file when it has been removed from disk (default value: `2h`). See [close_removed](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-log.html#filebeat-input-log-close-removed). |
| INPUTS_CLEAN_REMOVED | The agent will remove the state of the file when it has been removed from from the disk (default value: `2h`). See [clean_removed](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-log.html#filebeat-input-log-clean-removed). |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SANITIZE | Determines what portions of a JMS Property value to sanitize. Example: `[{keyMatch:"jmsProviderURL",valueMatch:".{0,10}$"}]` to sanitize the `jmsProviderURL` property to mask the last ten characters or less. |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SHOW | Determines what JMS Properties to send to Enterprise Marketplace. By default, all JMS properties are redacted. Example: `[{keyMatch:".*"}]` to send all JMS properties. |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SHOW | Determines what JMS Properties to send to Amplify Engage. By default, all JMS properties are redacted. Example: `[{keyMatch:".*"}]` to send all JMS properties. |
| APIGATEWAY_AUTH_USERNAME | Your Axway API Gateway username: should have an API Operator role. |
| APIGATEWAY_AUTH_PASSWORD | Your Axway API Gateway user password. |
| APIGATEWAY_CLIENTTIMEOUT | The time interval at which the HTTP client times out making HTTP requests to API Gateway (ns - default, us, ms, s, m, h). Set to 60s. |
Expand Down
Loading

0 comments on commit f05b44c

Please sign in to comment.