Steps for Successful Onboarding

SeaLights supports three onboarding methods—CI/CD-Integrated, CD-Only, and Standalone—to fit a range of environments, team structures, and onboarding phases. Regardless of the method, the goal is to report accurate code coverage and test insights to the SeaLights dashboard with minimal disruption.

This guide is intended for DevOps engineers, QA leads, and decision makers seeking to understand the onboarding scope and required resources.

Typical setup for CI/CD

Onboarding Approaches

CI/CD-Integrated Setup (Recommended)

The most scalable and sustainable method. SeaLights is integrated directly into your CI/CD pipeline to automatically analyze your application and collect coverage and test data during every build and test cycle.

Use shell commands to instrument builds and report test coverage. Any CI/CD tool that supports command execution is compatible: GitHub Actions, GitLab CI, Azure DevOps (ADO), Jenkins...

  • Seamless integration with daily workflows

  • High automation and low ongoing effort

  • Supports multiple build/test environments

CD-Only Setup (Intermediate, Java/.NET Only)

An efficient intermediate option that allows onboarding without modifying the CI system — ideal when CI ownership is separate or integration is limited to QA/test environments.

The SeaLights CD agent is deployed directly on the application under test, where it scans and instruments the artifact for coverage collection. It supports executing one or more test types in series, including manual tests or tests running from different machines.

Currently available for Java and .NET applications only

  • Fast time-to-value without CI changes

  • Useful when Dev/QA/DevOps teams operate in silos

  • Recommended when SeaLights is used only in testing stages

Standalone Setup (Initial, Developer-Local)

Ideal for early onboarding or a proof-of-concept (POC) phase, this setup is typically performed on a developer’s local machine or a dedicated test environment.

It enables teams to manually run SeaLights commands or automate them using simple scripts, providing a flexible way to validate integration and gather initial results without involving the CI/CD pipeline.

This setup is often used as a preliminary step before moving to full CI/CD or CD-only integration. The same commands are reused later—only the parameter values are adapted, usually by injecting environment variables dynamically in CI/CD systems.

  • Minimal setup and no CI/CD involvement

  • Ideal for validating the configuration early

  • Recommended as a temporary, local test setup

Required Personnel, Knowledge & Permissions

It is critical to identify the right project team and ensure their availability for the success of the onboarding project. The following personnel must be available with approved time allocation to ensure an effective and seamless progress:

DevOps/Admin (CI/CD)

Configure pipelines; access CI jobs and working directories

QA or CD Environment Owner

Access to the application under test, including deploy/test environments (CD-only)

Developer (Standalone)

Local admin rights to run onboarding commands

Network/Security contact

Ensure outbound HTTPS traffic is allowed to SeaLights endpoints

Application Expert (POC)

Familiar with app architecture, packages, and testing workflows

Network Connectivity Validation

To ensure a smooth onboarding experience, we kindly request that your team completes a network connectivity check before any onboarding activity. This check confirms that SeaLights agents will be able to communicate securely with their respective servers. Please coordinate with your IT or network security team in advance, as firewall adjustments may require internal approvals or lead time. Verifying connectivity ahead of time helps prevent delays later in the onboarding process.

What needs to be done:

  • Run a simple connectivity test from each relevant machine, including:

    • Local developer machines (if applicable)

    • CI/CD infrastructure (GitHub Actions, GitLab CI, ADO, Jenkins…)

    • Application servers or containers (Testing environments)

    • Test Automation machines

  • Confirm that these systems can reach our servers and return a successful response for the following Key Endpoints:

    • Required: https://<your-custom-domain>.sealights.co

    • Optional but recommended: https://agents.sealights.co

  • If a proxy is in use, ensure it allows outbound connections to the above domains over port 443 (TLS v1.2/1.3).

  • For teams who have not yet received their dedicated account domain, use: https://connect.sealights.co

For exact command-line instructions and troubleshooting steps, please refer to our connectivity documentation: Troubleshooting Agent Connectivity

Last updated

Was this helpful?