Ocean 
Ocean is an innovative solution developed by Port to seamlessly integrate various third-party systems with our developer portal product, empowering engineers to effortlessly prioritize key features and streamline the integration process.
Prerequisites
- Python 3.11
Installation
In order to install the Ocean Framework, run the following command:
pip install "port-ocean[cli]"
Or
poetry add "port-ocean[cli]"
Run Integration
-
source the integration venv
. .venv/bin/activate -
Run
ocean sail ./path/to/integration
Export Architecture
Real-Time updates Architecture
Integration Lifecycle
Folder Structure
The Ocean Integration Framework follows a specific folder structure within this mono repository. This structure ensures proper organization and easy identification of integration modules. The suggested folder structure is as follows:
port-ocean/
├── port_ocean (framework)/
│ ├── ocean.py
│ ├── core/
| └── ...
└── integrations/
│ └─── integration_name/
│ ├──── main.py
│ ├──── pyproject.toml
│ └──── Dockerfile
├── ...
└── ...
- The
frameworkfolder contains the core logic for managing the integration lifecycle. - Each integration is represented by a separate folder inside the
integrationsdirectory. - Inside each integration folder, you'll find a
main.pyfile that implements the core functionality of the integration for the specific third-party system. - The
pyproject.tomlfile inside each integration folder lists the required dependencies for that integration.
Configuration
The Integration Framework utilizes a config.yaml file for its configuration. This file defines both the framework configuration and the integration configuration within it. Each integration is identified by its type and unique identifier, which are utilized during initialization to appropriately update Port.
Example config.yaml:
# This is an example configuration file for the integration service.
# Please copy this file to config.yaml file in the integration folder and edit it to your needs.
port:
clientId: PORT_CLIENT_ID # Can be loaded via environment variable: PORT_CLIENT_ID
clientSecret: PORT_CLIENT_SECRET # Can be loaded via environment variable: PORT_CLIENT_SECRET
baseUrl: https://api.getport.io/v1
# The event listener to use for the integration service.
eventListener:
type: KAFKA / WEBHOOK
integration:
# The name of the integration.
identifier: "my_integration"
# The type of the integration.
type: "PagerDuty"
config:
my_git_token: "random"
some_other_integration_config: "Very important information"
Contributing
The reason Ocean is open source is that we aim for the Port integration library to offer numerous useful out-of-the-box integrations. We have confidence that developers and DevOps professionals who rely on Port in their everyday work will be inclined to contribute and assist in making it a comprehensive tool.
In order to learn how you can contribute to Ocean, read our contributing guide
Local Development (Framework)
-
Clone the repository
-
Install dependencies:
make installOr (For installing integrations dependencies as well)
make install/all -
source the integration venv
. .venv/bin/activate
Local Development (Integration)
-
Clone the repository
-
For new integration run
make newand follow the instructions
-
Install dependencies
-
cd DESIRED_INTEGRATION_FOLDER && make install
-
source the integration venv
. .venv/bin/activate -
Run the integration
make runOr
ocean sail
License
The Ocean Framework is open-source software licensed under the Apache 2.0 License. See the LICENSE file for more information.
Contact
For any questions or inquiries, please reach out to our team at support@getport.io
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file port_ocean-0.47.3.tar.gz.
File metadata
- Download URL: port_ocean-0.47.3.tar.gz
- Upload date:
- Size: 322.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d694d9a67885ecee5c41adf663cbf7e0b4e589c5dc7779c3ef7c8c726430b2be
|
|
| MD5 |
9de7f53334d7f67a14b6935a700f0704
|
|
| BLAKE2b-256 |
c94da2c51616053cd6c9da5e8ff3464dce4d848bcf4550636ab61b42d3434f2b
|
File details
Details for the file port_ocean-0.47.3-py3-none-any.whl.
File metadata
- Download URL: port_ocean-0.47.3-py3-none-any.whl
- Upload date:
- Size: 438.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d3065825baa2c1e8d307c2fb14df4f12b779b84a212a22fa209587547ac4de32
|
|
| MD5 |
c7c3e11c2c6ed05ff63e8f21509f6494
|
|
| BLAKE2b-256 |
c63b8e2238cfff0e76b976c59de05e31f8e25b4b34246ac756e1aee8edab70c6
|
