Installation orientation

Read this orientation to get a handle on the scope of the installation and post-install process

The goal of this topic is to give you an idea for the scope of work involved in installing and configuring TeamForge Orchestrate. It serves as a high-level orientation with links to specifics for the express purpose of encapsulating the whole process as concisely as possible. By its nature, TeamForge Orchestrate touches multiple systems and therefore installation and configuration may require cross-functional involvement.

This quick-start orientation does not substitute for complete documentation. Please read all aspects of the installation documentation, including Installation requirements.

Installation of server components

While a feature of TeamForge, Orchestrate requires the installation of new server-side components on a dedicated host.

  1. Prep host(s) for installation

    Read Installation requirements for hardware and software requirements and prepare new host(s).

  2. Firewall considerations

    The installation process and subsequent functioning requires firewall access. Read Installation requirements and make firewall adjustments as needed.

  3. Install server-side components

    Now you are ready to run the installation process itself, see Installation walk-through.

TeamForge configuration

Once the server components are installed, configure TeamForge for end-user access to Orchestrate.

  1. Install the TeamForge commit adapter

    Code commits in TeamForge are a pivotal part of the orchestration process. Install the Orchestrate-TeamForge commit adapter, which sends TeamForge commit data to Orchestrate, see Post-installation tasks.

  2. Add Orchestrate to desired projects

    TeamForge is now integrated with TeamForge Orchestrate, but each project must opt to use TeamForge Orchestrate. To do so, set up project-level IAF application for desired TeamForge projects, see Post-installation tasks.

  3. Create administrative Orchestrate role

    Installation of TeamForge Orchestrate creates four new permissions in TeamForge. Create a new Orchestrate administrator role, or update existing roles with the "Pipeline Create" permission, see TeamForge documentation. Add the role to desired users.

  4. Create read-only Orchestrate role

    End-users without admin rights need a read-only role to see TeamForge Orchestrate data and features. Create a new Orchestrate read-only role, or update existing roles with the "Pipeline read" permission, see TeamForge documentation. Add the role to desired users.

Create pipelines, sources and install adapters

Now that you have projects and users configured properly, create pipelines and add sources. Sources use "adapters" to supply data to TeamForge Orchestrate, so you will need to make sure firewalls are configured to permit the flow of data from adapters to Orchestrate.

  1. Create Pipelines and add steps

    Pipelines are associated to TeamForge projects, and serve as the primary container for sources under orchestration. See Pipelines

  2. Create sources for orchestration

    Sources represent an external system under orchestration. Set up a new source for every repository, build job, and code review project you wish to orchestrate. See Activity Sources

  3. Configure firewall rules

    In preparation for adding adapters, the next step requires that firewall rules be created to permit data from adapters to the TeamForge Orchestrate MQ server, see Installation requirements.

  4. Install and configure adapters

    Once a source is set up, you'll want to download, install, and configure the corresponding adapter. See Adapters: Integration using TeamForge Orchestrate.