Amplication (Sunset)
Amplication has been declared sunset. The integration is no longer available for new installations in Port, and this page is kept for existing installations only.
Port's Amplication integration syncs templates, resources, and outdated version alerts into your context lake. This gives your AI software factory context about generated resources and their template versions.
Common use cases
- Automate scaffolding of new services using Amplication's templates.
- Ensure standardization by enforcing predefined golden paths for resource creation.
- Leverage code generation to accelerate development and maintain consistency.
- Poll Amplication for templates, resources, and outdated version alerts to keep you in sync with your Amplication resources.
Prerequisites
Amplication API token
To generate a token, follow the API token generation instructions:
- Navigate to your Amplication workspace and go to the settings tab.
- Navigate to the
API Tokenssection and generate a new token. - Copy the token and save it in a secure location.
Amplication host URL
Your Amplication host URL is https://server.amplication.com/graphql.
Setup
Choose your preferred installation method below. Not sure which to pick? See the installation methods overview.
The prerequisites required for installation are listed below.
-
Go to the Amplication Connectors page in Port.
-
Under
Select your installation method, chooseHosted by Port. -
Configure the
Installation parametersandAdvanced configurationas you wish (see below for details).
Installation parameters
Each integration requires specific parameters (such as an API token, a URL, etc.), as seen in Port's UI when installing it. Hover over the ⓘ icon next to each parameter to see more details about it.
Advanced configuration
- During the installation process each integration may have additional settings under the
Advanced configurationsection in Port's UI. Additionally, each integration has one or more settings that can be configured after installation. To do so, click on the integration's name in the Connectors page and navigate to theSettingtab. Hover over the ⓘ icon next to each setting to see more details about it.
Port secrets
Some integration settings require sensitive pieces of data, such as tokens. For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.
When filling in such a setting, its value will be obscured (shown as ••••••••).
For each such setting, Port will automatically create a secret in your organization.
To see all secrets in your organization, follow these steps.
Port source IP addresses
When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses. You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:
- Europe (EU):
54.73.167.226,63.33.143.237,54.76.185.219 - United States (US):
3.234.37.33,54.225.172.136,3.225.234.99
-
Go to the Amplication Connectors page in your portal.
-
Select the
Self-hostedmethod. -
A
helmcommand will be displayed, with default values already filled out (e.g. your Port client ID, client secret, etc). Copy the command, replace the placeholders with your values, then run it in your terminal to install the integration.
Live event support
Currently, live events are not supported for this integration.
Resyncs will be performed periodically (with a configurable interval), or manually triggered by you via Port's UI.
Therefore, real-time events (including GitOps) will not be ingested into Port immediately.
Live events support for this integration is WIP and will be supported in the near future.
The resync interval can be configured using the scheduledResyncInterval parameter. See the optional parameters section below for more details.
Required parameters:
port.clientId- Your Port client ID (How to get the credentials).port.clientSecret- Your Port client secret (How to get the credentials).port.baseUrl- Your Port API URL (https://api.port.iofor EU,https://api.us.port.iofor US).integration.identifier- A unique identifier for your integration.integration.type- The integration type.integration.eventListener.type- The event listener type.integration.secrets.amplicationToken- The Amplication API token.integration.config.amplicationHost- The Amplication host. For examplehttps://server.amplication.com/graphql.
Optional parameters (click to expand)
scheduledResyncInterval- The number of minutes between each resync.initializePortResources- Whentrue, the integration will create default blueprints and the Port App config mapping.
- GitHub
- Jenkins
- Azure DevOps
- GitLab
- Go to the Amplication Connectors page in your portal.
- Under Select your installation method, choose your desired CI/CD platform.
- Copy the workflow and replace the placeholders with your values.
Below are the available parameters and their descriptions.
| Parameter | Description | Required? | Secret?Store this value as a GitHub Actions secret |
|---|---|---|---|
port_client_id | Your Port client ID (How to get the credentials). | ✓ | ✓ |
port_client_secret | Your Port client secret (How to get the credentials). | ✓ | ✓ |
port_base_url | Your Port API URL (https://api.port.io for EU, https://api.us.port.io for US). | ✓ | ✗ |
amplication_token | The Amplication API token. | ✓ | ✓ |
amplication_host | The Amplication host. For example https://server.amplication.com/graphql. | ✓ | ✓ |
initialize_port_resources | Default true. When set to true, the integration will create default blueprints and the Port app config mapping. | ✗ | ✗ |
integration_identifier | The identifier of the integration that will be installed. | ✗ | ✗ |
send_raw_data_examples | Enable sending raw data examples from the third-party API to Port for testing and managing the integration mapping. Default is true. | ✗ | ✗ |
Your Jenkins agent must be able to run Docker commands.
Below are the available parameters and their descriptions.
| Parameter | Description | Required? | Secret?Store this value as a Jenkins credential (Secret Text) |
|---|---|---|---|
OCEAN__ | Your Port client ID (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port client secret (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port API URL (https://api.port.io for EU, https://api.us.port.io for US). | ✓ | ✗ |
OCEAN__ | The Amplication API token. | ✓ | ✓ |
OCEAN__ | The Amplication host. For example https://server.amplication.com/graphql. | ✓ | ✓ |
OCEAN__ | Default true. When set to true, the integration will create default blueprints and the Port app config mapping. | ✗ | ✗ |
OCEAN__ | The identifier of the integration that will be installed. | ✗ | ✗ |
OCEAN__ | Enable sending raw data examples from the third-party API to Port for testing and managing the integration mapping. Default is true. | ✗ | ✗ |
Here is an example for a Jenkinsfile pipeline file:Jenkins pipeline (click to expand)
Prerequisites
- Your Azure Devops agent should be able to run docker commands. Learn more about agents here.
- You must have permissions to create and manage Azure DevOps variable groups for storing credentials.
Set up your credentials
- Create a Variable Group: Name it port-ocean-credentials.
- Store the required variables (see the table below).
- Authorize Your Pipeline:
-
Go to "Library" -> "Variable groups."
-
Find port-ocean-credentials and click on it.
-
Select "Pipeline Permissions" and add your pipeline to the authorized list.
-
Below are the available parameters and their descriptions.
| Parameter | Description | Required? | Secret?Store this value as an Azure DevOps pipeline variable |
|---|---|---|---|
OCEAN__ | Your Port client ID (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port client secret (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port API URL (https://api.port.io for EU, https://api.us.port.io for US). | ✓ | ✗ |
OCEAN__ | The Amplication API token. | ✓ | ✓ |
OCEAN__ | The Amplication host. For example https://server.amplication.com/graphql. | ✓ | ✓ |
OCEAN__ | Default true. When set to true, the integration will create default blueprints and the Port app config mapping. | ✗ | ✗ |
OCEAN__ | The identifier of the integration that will be installed. | ✗ | ✗ |
OCEAN__ | Enable sending raw data examples from the third-party API to Port for testing and managing the integration mapping. Default is true. | ✗ | ✗ |
Here is an example for a azure-pipeline.yml pipeline file:Azure pipeline (click to expand)
- Go to the Amplication Connectors page in your portal.
- Under Select your installation method, choose your desired CI/CD platform.
- Copy the workflow and replace the placeholders with your values.
Below are the available parameters and their descriptions.
| Parameter | Description | Required? | Secret?Store this value as a GitLab CI/CD variable |
|---|---|---|---|
OCEAN__ | Your Port client ID (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port client secret (How to get the credentials). | ✓ | ✓ |
OCEAN__ | Your Port API URL (https://api.port.io for EU, https://api.us.port.io for US). | ✓ | ✗ |
OCEAN__ | The Amplication API token. | ✓ | ✓ |
OCEAN__ | The Amplication host. For example https://server.amplication.com/graphql. | ✓ | ✓ |
OCEAN__ | Default true. When set to true, the integration will create default blueprints and the Port app config mapping. | ✗ | ✗ |
OCEAN__ | The identifier of the integration that will be installed. | ✗ | ✗ |
OCEAN__ | Enable sending raw data examples from the third-party API to Port for testing and managing the integration mapping. Default is true. | ✗ | ✗ |
Configuration
Port integrations use a YAML mapping block to ingest data from Amplication's API into Port.
The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.
Default mapping configuration
This is the default mapping configuration for this integration:
Default mapping configuration (click to expand)
deleteDependentEntities: true
createMissingRelatedEntities: true
resources:
- kind: amplication_template
selector:
query: 'true'
port:
entity:
mappings:
identifier: .id
title: .name
blueprint: '"AmplicationTemplate"'
properties:
description: .description
project: .project.name
project_id: .project.id
blueprint: .blueprint.name
blueprint_id: .blueprint.id
- kind: amplication_resource
selector:
query: 'true'
port:
entity:
mappings:
identifier: .id
title: .name
blueprint: '"AmplicationResource"'
properties:
description: .description
project: .project.name
project_id: .project.id
blueprint: .blueprint.name
blueprint_id: .blueprint.id
git_organization: .gitRepository.gitOrganization.provider
git_repository: .gitRepository.gitOrganization.name + "/" + .gitRepository.name
relations:
template: if .serviceTemplate != null then .serviceTemplate.id else null end
- kind: amplication_alert
selector:
query: 'true'
port:
entity:
mappings:
identifier: .id
title: 'if .block != null then .type + ": " + .block.displayName else .type end'
blueprint: '"AmplicationAlert"'
properties:
block_id: if .block != null then .block.id else null end
block_displayName: if .block != null then .block.displayName else null end
type: .type
outdatedVersion: .outdatedVersion
latestVersion: .latestVersion
status: .status
relations:
resource: .resourceId
Monitoring and sync status
To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.
Mapping & selectors per resource
Use the explorer below to view sample payloads and the resulting Port entities for each resource type.
- kind: amplication_template
selector:
query: 'true'
port:
entity:
mappings:
identifier: .id
title: .name
blueprint: '"AmplicationTemplate"'
properties:
description: .description
project: .project.name
project_id: .project.id
blueprint: .blueprint.name
blueprint_id: .blueprint.id
{
"id": "cm6zln01a0209utjtlorazri1",
"name": "Port Node.js Template",
"description": "Template created from an existing resource",
"resourceType": "ServiceTemplate",
"project": {
"id": "cm6zlfk2o01liutjtdw8xj7f0",
"name": "Port Integration"
},
"blueprint": {
"id": "cm6gb3j00000p14gz2n11otq4",
"name": "Node.js Service (Amplication's Standard)"
}
}
{
"identifier": "cm6zln01a0209utjtlorazri1",
"title": "Port Node.js Template",
"team": [],
"properties": {
"name": "Port Node.js Template",
"description": "Template created from an existing resource",
"project": "Port Integration",
"project_id": "cm6zlfk2o01liutjtdw8xj7f0",
"blueprint": "Node.js Service (Amplication's Standard)",
"blueprint_id": "cm6gb3j00000p14gz2n11otq4"
},
"relations": {},
"icon": "Amplication"
}