mendersoftware/mender-ci-tools image with pre-installed mender-cli and mender-artifact tools is used for the templates.
Pipelines examples can be found in the related folder.
The templates, which interact with a Mender server, requires the following environment variables are set in the GitLab CI/CD Settings:
MENDER_SERVER_URL(optional): Mender server's URL including protocol (default: https://hosted.mender.io)MENDER_SERVER_ACCESS_TOKEN: Mender Personal Access Token (read the documentation for more information)
The templates are designed in a way that defined jobs extends. Jobs templates gives flexibility in using them in custom stages and allows to build pipelines to work across different environments.
MENDER_ARTIFACTS_FOLDER environment variable is pre-defined and shared across all templates. It's used for storing built Mender artifacts and transferring
them across all jobs in the CI/CD pipeline.
.mender:build:artifact template can be used to build a Mender artifact in the script section. before_script is used for creating the MENDER_ARTIFACTS_FOLDER folder. If it's overwritten, then make sure your script contains this step.
Mender artifacts in the MENDER_ARTIFACTS_FOLDER folder will be uploaded as GitLab CI artifacts and shared across jobs in a pipeline.
.mender:upload:artifact template uploads a Mender artifacts from MENDER_ARTIFACTS_FOLDER folder to a Mender server and requires MENDER_SERVER_URL and MENDER_SERVER_ACCESS_TOKEN variables to work.
.mender:create:deployment template creates a deployment on a Mender server and requires MENDER_SERVER_URL and MENDER_SERVER_ACCESS_TOKEN variables to work.
The following environment variables are required:
MENDER_DEPLOYMENT_GROUP: The name of Mender devices group a deployment will be triggered to. One ofMENDER_DEPLOYMENT_GROUPorMENDER_DEVICES_LISTis required.MENDER_DEVICES_LIST: The list of Mender devices a deployment will be triggered to.MENDER_DEPLOYMENT_NAME: The name of Mender deployment.MENDER_RELEASE_NAME: The name of Mender release.