Skip to content

Latest commit

 

History

History
97 lines (59 loc) · 4.45 KB

README.md

File metadata and controls

97 lines (59 loc) · 4.45 KB
Raw

sa-codefresh-pipelines

Example Pipelines built by SA Team.

Additional documentation on Codefresh Pipeline Specification

Golden Pipeline

Shared CI Pipeline

This specific example pipeline explains how one can reuse a Codefresh pipeline with multiple microservices.

The concept of the golden pipeline is to have a single YAML definition for CI that will be consumed by multiple microservice projects.

These projects could be separate GIT repositories or a mono repository.

The example though is based on a separate GIT repository for each microservice.

The file ./ci/golden-pipeline/microservice.yaml is full pipeline specification which is made up of both GIT Triggers and Codefresh Steps.

GIT triggers allow the user to associate the Codefresh pipeline with multiple GIT repositories or a single GIT repository with directory/path based microservices.

To utilize these in your account you will need to configure a GIT provider pipeline integration

You will find the steps located under .spec.steps these steps can be stored inline in the full specification but can also be stored in another file or another GIT repository using .spec.specTemplate

  specTemplate:
    location: git
    repo: <org name>/<repo name>
    path: ./<directory>/<file>
    revision: <branch>
    context: <GIT Pipeline Integration Name>

This pipeline will contain the steps for Continuous Integration.

Arguments should make use of variables supplied by webhooks or by GIT triggers via Build Variables in Advanced Options.

The latter is defined in the pipeline specification under .spec.triggers.[].variables.

In the example Codefresh pipeline you'll see the a combination of both.

After you've setup the pipeline to meet your CI requirements for microservices.

The next step is to add consumers to use this pipeline.

Each microservice should be a separate trigger entity under .spec.triggers.[] array.

In this pipeline 2 such triggers exist.

More can be added by adding into the array.

You can also control these externally as separate triggers and combine them through GIT contributions and a Codefresh Pipeline w/ Codefresh Marketplace Step pipeline-trigger-merge

Each trigger is setup to build on commit push, pull request open and pull request synchronize.

The CI pipeline is simplified into 4 steps.

  1. clone # Clones source code from GIT repository identified in trigger
  2. build # Builds and pushes image to artifact repository
  3. test # Runs image as container
  4. report # Reports image to Codefresh

To utilize the final step in CI you will need to install a Codefresh GitOps Runtime

More about GitOps Promotions will be covered by the next section of the README.md

Now that you have some information about purpose behind the pipelines you can copy over the files in ./ci/golden-pipelines and make edits to use them on your Codefresh Account.

You will find in both files < and > symbols indicating those symbols should be replaced by the value of the source/key between the symbols.

In many cases the values will be found by locating the friendly names of the Pipeline Integrations and by the GIT VCS derived data.

Shared CI Pipeline (Terraform Edition)

As an alternative method we support Terraform.

Codefresh Terraform Provider

This same Golden Pipeline example has Terraform files found in the terraform folder.

Run Terraform Init from ./ci/golden-pipeline/terraform to get Codefresh provider.

terraform init

See all variables in vars.tf

Example Plan:

terraform plan -v cf_api_token="<my_codefresh_api_token>" -v git_repo_owner=<my_git_organization>"

Example Apply:

terraform apply -v cf_api_token="<my_codefresh_api_token>" -v git_repo_owner=<my_git_organization>"