Skip to main content

DataOps Pipeline Graph Styling

As described in the DataOps Pipeline Overview, graph styling aims to effectively describe the role and function of each pipeline job at a glance. As a result, DataOps includes several features such as pipeline graph icons, graph borders, and graph font colors.

Pipeline Graph Icons

If you want to add icons to your pipeline graph, you can use the icon tag. The following code snippet demonstrates how the icon tag supports image URLs, project paths, and variables.

build:
stage: build
script:
- echo "Building..."
icon: "https://cdn.iconscout.com/icon/free/png-512/discord-3-569463.png" # using an image URL

test:
stage: test
script:
- echo "Testing..."
icon: "/assets/icons/favicon.ico" # using an asset path

sample:
stage: .post
script:
- echo "Post Script..."
icon: ${MY_ICON} # using a variable

pipeline-graph __shadow__

DataOps provides as set of icons in the reference project as variables. Examples include ${SNOWFLAKE_ICON}, ${VAULT_ICON}, or ${MATILLION_ICON}. Refer to the full list of icons for common data vendor choices.

Pipeline Graph Icon Styles

Job icons are customizable. You can add any colored background to an icon by setting the icon_background_color property. If the disable_icon_background property is set to true, DataOps will ignore the background color.

The icon_background_color property supports CSS colors in any CSS format, including hard-coded, hex, or rgba and is defined in YAML as follows:

variables:
MY_ICON: "https://cdn2.iconfinder.com/data/icons/font-awesome/1792/phone-512.png"
BackgroundRadius: '5px'

stages:
- Development

develop:
stage: Development
...
icon: ${MY_ICON}
icon_background_color: "grey"
icon_background_radius: ${BackgroundRadius}

pipeline-graph-icon-styles __shadow__

Once the disable_icon_background property is set to true, the icon will not have any background color, and the icon_background_color property will be ignored as follows:

variables:
MY_ICON: "https://cdn2.iconfinder.com/data/icons/font-awesome/1792/phone-512.png"
BackgroundRadius: '5px'

stages:
- Development

develop:
stage: Development
...
icon: ${MY_ICON}
icon_background_color: "grey"
icon_background_radius: ${BackgroundRadius}
disable_icon_background: true

background-disable __shadow__

The job icon radius is also be customizable by using the icon_background_radius property. This property supports CSS radius property style formats like "15px 50px 30px 5px" or "5px 50px" and is defined in YAML as follows:

variables:
MY_ICON: "https://cdn2.iconfinder.com/data/icons/font-awesome/1792/phone-512.png"
BackgroundRadius: '5px'

stages:
- Development

develop:
stage: Development
...
icon: ${MY_ICON}
icon_background_color: "grey"
icon_background_radius: ${BackgroundRadius}

job-icon-radius __shadow__

Pipeline Graph Style Customizations

Pipeline Graph Borders

If you want to customize a job's borders, you can use border_color and border_width. These properties support CSS colors in any CSS format like hard-coded, hex, or rgba and are defined in YAML as follows:

develop:
stage: Development
...
border_color: 'red'
border_width: 'thick'

pipeline-graph-border __shadow__

Pipeline Graph Font Colors

You can also add a font color to a job by using the font_color property. This property supports CSS colors in any CSS format like hard-coded, hex, or rgba and is defined in YAML as follows:

stages:
- Development

develop:
stage: Development
...
font_color: "purple"

pipeline-font-color __shadow__

Pipeline Graph Background Colors

You can add a background color to a job using the background_color property. This property supports CSS colors in any CSS format like hard-coded, hex, or rgba and is defined in YAML as follows:

variables:
MY_ICON: "https://cdn2.iconfinder.com/data/icons/font-awesome/1792/phone-512.png"
BACKGROUND_COLOR: 'grey'

stages:
- Development

develop:
stage: Development
...
icon: ${MY_ICON}
background_color: ${BACKGROUND_COLOR}

pipeline-graph-bg-color __shadow__