Octopus Deploy Integration

Loading version...

Port's Octopus Deploy integration allows you to model Octopus Deploy resources in your software catalog and ingest data into them.

Supported resources SpaceProjectReleaseDeploymentMachine

Ingesting Additional Resources

The integration supports additional resources, see the ingest additional resources page for more information.

Setup

Choose your preferred installation method below. Not sure which to pick? See the installation methods overview.

Configuration

Port integrations use a YAML mapping block to ingest data from the third-party 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)

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
- kind: space
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .Id
        title: .Name
        blueprint: '"octopusSpace"'
        properties:
          url: env.OCEAN__INTEGRATION__CONFIG__SERVER_URL + "/app#/" + .Id
          description: .Description
- kind: project
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .Id
        title: .Name
        blueprint: '"octopusProject"'
        properties:
          url: env.OCEAN__INTEGRATION__CONFIG__SERVER_URL + "/app#/" + .SpaceId + "/projects/" + .Id
          description: .Description
          isDisabled: .IsDisabled
          tenantedDeploymentMode: .TenantedDeploymentMode
        relations:
          space: .SpaceId
- kind: release
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .Id
        title: .ProjectId + "(" + .Version + ")"
        blueprint: '"octopusRelease"'
        properties:
          version: .Version
          assembledDate: .Assembled
          channelId: .ChannelId
          releaseNotes: .ReleaseNotes
          url: env.OCEAN__INTEGRATION__CONFIG__SERVER_URL + "/app#/" + .SpaceId + "/releases/" + .Id
        relations:
          project: .ProjectId
- kind: deployment
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .Id
        title: .Name
        blueprint: '"octopusDeployment"'
        properties:
          createdAt: .Created
          deployedBy: .DeployedBy
          taskId: .TaskId
          failureEncountered: .FailureEncountered
          comments: .Comments
          url: env.OCEAN__INTEGRATION__CONFIG__SERVER_URL + "/app#/" + .SpaceId + "/deployments/" + .Id
        relations:
          release: .ReleaseId
          project: .ProjectId
- kind: machine
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .Id
        title: .Name
        blueprint: '"octopusMachine"'
        properties:
          roles: .Roles
          status: .HealthStatus
          url: env.OCEAN__INTEGRATION__CONFIG__SERVER_URL + "/app#/" + .SpaceId + "/infrastructure/machines/" + .Id + "/settings"
          isDisabled: .IsDisabled
          operatingSystem: .OperatingSystem
          architecture: .Architecture
          statusSummary: .StatusSummary
          endpointType: .Endpoint.DeploymentTargetTypeId
          communicationStyle: .Endpoint.CommunicationStyle
        relations:
          space: .SpaceId

Mapping & examples per resource

Use the explorer below to view sample payloads and the resulting Port entities for each resource type. For additional resources and advanced configurations, see the ingest additional resources page.

Monitoring and sync status

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.