[Integration][Amplication] add initial version of Amplication integration #1354

itainathaniel · 2025-01-26T15:44:27Z

Description

What: This PR introduces an integration that imports Amplication templates, resources (services), and outdated version alerts into Port. The integration provides a seamless way to sync backend services and their metadata generated by Amplication into Port's service catalog. In addition, there's a self service action which creates an Amplication resource using a webhook.

Why: This integration was built to bridge the gap between backend service creation (Amplication) and infrastructure management (Port). By enabling automatic imports and alerts, it centralizes service metadata for better organization and visibility and saves time by automating manual data entry and tracking. By automating scaffolding using Amplication via Port, the developer can create consistent and standard boilerplate and foundation.

How: By using the catalog API endpoint, we imported the templates and resources. By using the outdatedVersionAlerts endpoint, we imported the alerts. By making relations between templates, resources and alerts, we can show everything in bright colours.

Type of change

Please leave one option from the following and delete the rest:

New Integration (non-breaking change which adds a new integration)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

Integration able to create all default resources from scratch
Resync finishes successfully
Resync able to create entities
Resync able to update entities
Resync able to detect and delete entities
Scheduled resync able to abort existing resync and start a new one
Tested with at least 2 integrations from scratch
Tested with Kafka and Polling event listeners
Tested deletion of entities that don't pass the selector

Integration testing checklist

Integration able to create all default resources from scratch
Resync able to create entities
Resync able to update entities
Resync able to detect and delete entities
Resync finishes successfully
If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
If resource kind is updated, run the integration with the example data and check if the expected result is achieved
If new resource kind is added or updated, validate that live-events for that resource are working as expected
Docs PR link here

Preflight checklist

Handled rate limiting
Handled pagination
Implemented the code in async
Support Multi account

Screenshots

templates index with their resource_count

template entity with its resources

resource entity with its alerts

Creating an Amplication service from template action

API Documentation

Since we're using GraphQL, the API documentation can be found in our GraphQL Playground, in our sandbox server. We use two queries, catalog and outdatedVersionAlerts and you can find their docs in the DOCS button to the right side of the page.

omby8888

Nice work! please address those changes

omby8888 · 2025-02-02T11:34:25Z

integrations/amplication/Dockerfile

no need for this file, we manage the image build from a singular Dockerfile under integrations/_infra

omby8888 · 2025-02-02T11:38:20Z

integrations/amplication/.dockerignore

no need for this file

omby8888 · 2025-02-02T11:47:01Z

integrations/amplication/.port/resources/actions.json

+            "method": "POST",
+            "headers": {
+                "RUN_ID": "{{ .run.id }}",
+                "authorization": "Bearer {{ .secrets.amplication_token }}"


this will not work, as .secrets.* is a context of Port organization's managed secrets rather than the integration's env params. as for now, this token ingestion needs to be done manually

Suggested change

"authorization": "Bearer {{ .secrets.amplication_token }}"

"authorization": "Bearer <YourAmplicationToken>"

@omby8888 I'm sorry, but I don't follow. I see an example to this comment in GitLab's integration:

ocean/integrations/gitlab/.port/resources/actions.json

Line 28 in 25b6758

"url": "https://gitlab.com/api/v4/projects/<YourGitlabProject>/ref/main/trigger/pipeline?token=<YourGitlabToken>"

but it means users which install Amplication's integration will have to go to the two self-service actions and add the token there, instead of going to the Manage secrets panel, like the suggestion in the Edit Action's Backend tab:

Configure the invocation payload

The following values ... You can reference secrets using {{ .secrets["secret-name"] }}

It actually work for us now with our sandbox, so this is why I'm confused.

BTW, looks like when installing an integration, the token requested in spec.yaml (the field[s] with the sensitive: true value) are saved as secrets automatically, so I could access them with _<INTEGRATION_NAME>_<CONFIGURATION_SPEC_NAME>, right?

omby8888 · 2025-02-02T11:48:09Z

integrations/amplication/.port/resources/actions.json

+          "method": "POST",
+          "headers": {
+            "RUN_ID": "{{ .run.id }}",
+            "authorization": "Bearer {{ .secrets.amplication_token }}"


Same as above

omby8888 · 2025-02-02T11:49:39Z

integrations/amplication/.port/resources/port-app-config.yml

@@ -0,0 +1,57 @@
+createMissingRelatedEntities: True
+


remove break line

omby8888 · 2025-02-02T13:33:32Z

integrations/amplication/config.yaml

no need for this file

omby8888 · 2025-02-02T13:34:24Z

integrations/amplication/pyproject.toml

@@ -0,0 +1,113 @@
+[tool.poetry]
+name = "amplication"
+version = "0.1.0"


make it beta for now please

Suggested change

version = "0.1.0"

version = "0.1.0-beta"

omby8888 · 2025-02-02T13:35:38Z

integrations/amplication/amplication/client.py

+            headers=await self.auth_headers,
+        )
+        response.raise_for_status()
+        return response.json()["data"]["catalog"]["data"]


add safeguards here please

omby8888 · 2025-02-02T13:35:46Z

integrations/amplication/amplication/client.py

+            headers=await self.auth_headers,
+        )
+        response.raise_for_status()
+        return response.json()["data"]["outdatedVersionAlerts"]


omby8888 · 2025-02-02T13:36:06Z

integrations/amplication/amplication/client.py

+            headers=await self.auth_headers,
+        )
+        response.raise_for_status()
+        return response.json()["data"]["catalog"]["data"]


… integration

…eries

…ent module

itainathaniel · 2025-02-05T11:56:31Z

Thanks @omby8888 , I fixed most of the stuff you asked, the only open issue is the use of {{ .secrets }} in the actions.json file

…gration

…tion

init(integration) add initial version of Amplication integration

7b90611

github-actions bot added the size/XXL label Jan 26, 2025

feat(integration):make some wording changes, add action

d14a9fe

omby8888 requested changes Feb 2, 2025

View reviewed changes

itainathaniel added 6 commits February 5, 2025 10:08

remove unused files

6a1dd43

update integration version name

ca93c1f

docs(amplication): Improve configuration descriptions for Amplication…

b5fe2de

… integration

Merge branch 'port-labs:main' into main

0aca535

refactor(amplication): Improve GraphQL query handling and separate qu…

1276b08

…eries

refactor(amplication): Improve code formatting and readability in cli…

f46c8ae

…ent module

itainathaniel added 8 commits February 5, 2025 18:23

refactor(amplication): Update configuration keys for Amplication inte…

242b599

…gration

refactor(amplication): Update authorization token secret key

3042492

feat(amplication): Enable automatic service build after template crea…

aa1bf35

…tion

Update pages.json

dd302a9

Update spec.yaml

3584a62

Update actions.json

d7aadcc

Update blueprints.json

f207ebb

Merge pull request #3 from amplication/change-icons

79b5d7b

itainathaniel requested a review from omby8888 February 11, 2025 08:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Integration][Amplication] add initial version of Amplication integration #1354

[Integration][Amplication] add initial version of Amplication integration #1354

itainathaniel commented Jan 26, 2025

omby8888 left a comment

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

itainathaniel Feb 5, 2025

itainathaniel Feb 5, 2025

omby8888 Feb 2, 2025

itainathaniel Feb 5, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

omby8888 Feb 2, 2025

itainathaniel commented Feb 5, 2025

	"authorization": "Bearer {{ .secrets.amplication_token }}"
	"authorization": "Bearer <YourAmplicationToken>"

[Integration][Amplication] add initial version of Amplication integration #1354

Are you sure you want to change the base?

[Integration][Amplication] add initial version of Amplication integration #1354

Conversation

itainathaniel commented Jan 26, 2025

Description

Type of change

All tests should be run against the port production environment(using a testing org).

Core testing checklist

Integration testing checklist

Preflight checklist

Screenshots

API Documentation

omby8888 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Configure the invocation payload

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itainathaniel commented Feb 5, 2025