BuildMaster Documentation

Server Roles

  • Last Modified: 2019-09-17

A role describes a purpose or a function that a server may have, and is used as a deployment target so that you don't have to explicitly specify server names.

For example, if you deploy to hdars-api-host role in the testing environment, then you will deploy to all servers with that role, and in that environment. This can be especially helpful when your application is deployed across multiple servers, such as in a load-balanced environment.

Creating and Assigning Server Roles

You can create, edit, and delete server roles using the web-based interface (Admin > Infrastructure > Roles), or programmatically with the Infrastructure API.

You can assign a role to a server either by editing the list of servers assigned to that role (Role > Edit Details), or by editing the list of roles assigned to a server (Server > Edit Roles).

Deploying to Server Roles

There are two ways to deploy to a server role:

Pipeline Stage Target

You can specify a role name instead of a list of servers as a stage target in a pipeline stage. When the build is deployed to that stage, the stage target's deployment plan will be run against all servers with that role and in that environment.

Server Roles and OtterScript

You can deploy to servers in a role using the @ServersInRole function within a loop block.

        foreach server in @ServersInRole(hdars-api-host)
            Deploy-Artifact hdars-api-service
                To: C:\HDars\App\api-service

Role Dependencies

Role dependencies are used by Otter to model complex server and application configuration through hierarchical sets of simple roles with dependencies. This makes it much easier to share common configuration and define smaller (but related) roles.

While you can define a role's dependencies (i.e. the other roles which are required) on the role overview page, BuildMaster won't behave any differently if a role has dependencies. They are included only so that you can synchronize your infrastructure across products.

Example: Multiple Server Roles

Let's say you have a complex, multi-tier system called HDars that's designed to scale and run across multiple servers. You may have the following roles defined:

  • HDars-cloud hosts the middle-tier, cloud-data processing components
  • HDars-web hosts the web front-end for HDars that end-users will access
  • HDars-database is where the database components are hosted

These server roles may be applied to different servers in different environments.

Server Environment Roles
INT1 Integration HDars-cloud, HDars-web, HDars-database
TESAPP! Testing HDars-cloud, HDars-web
TESTDB1 Testing HDars-database
PRODHDARSWEB1 Production HDars-web
PRODHDARSWEB2 Production HDars-web
PRODHDARSAPI1 Production HDars-cloud
PRODDBSV1 Production HDars-database

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit bd2ce6f3 on master