JayeX concept models on JayeX - Cloud Native CI/CD Built On Kubernetes

Version Stream

Mon, 01 Jan 0001 00:00:00 +0000

JayeX is made up of a large number of command line packages, images and helm charts, some of which are released by the JayeX community and others come from the wider open source ecosystem.

To improve the stability of JayeX when lots of packages and charts are changing all the time we have introduced the JayeX Version Stream

How it works

The version stream is stored in the jenkins-x/jx3-versions git repository and stores the stable version of all packages and charts used by JayeX.

Source Repositories

Mon, 01 Jan 0001 00:00:00 +0000

Source Control Management (SCM) Repositories which have been configured to run CI/CD pipelines using JayeX are represented as Source Repositories. Source Repositories are a kubernetes custom resource (CR) scoped to a namespace and created in the development namespace/environment.

A source repository includes information about the SCM provider, Organization, Repository name and clone URLs.

A simple example of a source repository is shown below

apiVersion: jenkins.io/v1
kind: SourceRepository
metadata:
  labels:
    gitops.jenkins-x.io/pipeline: namespaces
    owner: jenkins-x
    provider: github
    repository: jx
  name: jenkins-x-jx
  namespace: jx
spec:
  httpCloneURL: https://github.com/jenkins-x/jx.git
  org: jenkins-x
  provider: https://github.com
  providerKind: github
  providerName: github
  repo: jx
  url: https://github.com/jenkins-x/jx

This shows a source repository named jenkins-x-jx in the namespace jx. It represents a repository named jx in the jenkins-x organization which is hosted in github.

Environments

Mon, 01 Jan 0001 00:00:00 +0000

Environment is a kubernetes custom resource (CR) in JayeX where the application code lives. Examples of environment include development, testing, staging and production. Environments are scoped to kubernetes namespaces and essentially extend a namespace with additional JayeX related metadata.

After installing JayeX, a development environment is created. This is the environment where all JayeX related resources like lighthouse, build controller, nexus, chart museum are installed. Dev environment by default is in the jx namespace, but it is configurable. This is also the environment where all your pipelines will run.

Pipeline activites

Mon, 01 Jan 0001 00:00:00 +0000

JayeX creates pipeline activites for jobs. It’s a kubernetes custom resource (CR) which is scoped to a namespace.

Pipeline activities are made up of steps. A step can have three kinds

Stage
Preview
Promote

Each type of step has a name, status, start and end timestamp. A pipeline activity can have steps of different kinds (for example a pipeline activity can have a stage, preview and promote step) Let’s look at each of these kinds in detail.

Deployment lifecycle

Mon, 01 Jan 0001 00:00:00 +0000

Ever wondered how the code you commit to your source control repository ends up deployed in production by JayeX? Well, this document is an attempt to answer that question.

Please go over documentation regarding source repositories, environments and pipeline activities before reading this section.

After you have installed JayeX in a kubernetes cluster and created a quickstart or imported an existing repository, you should see a folder structure which resembles this:

├── charts
│   └── app
│       ├── Chart.yaml
│       ├── .helmignore
│       ├── Kptfile
│       ├── Makefile
│       ├── README.md
│       ├── templates
│       │   ├── canary.yaml
│       │   ├── deployment.yaml
│       │   ├── _helpers.tpl
│       │   ├── hpa.yaml
│       │   ├── ingress.yaml
│       │   ├── ksvc.yaml
│       │   ├── NOTES.txt
│       │   ├── sa.yaml
│       │   └── service.yaml
│       └── values.yaml
├── Dockerfile
├── .gitignore
├── go.mod
├── go.sum
├── .lighthouse
│   └── jenkins-x
│       ├── pullrequest.yaml
│       ├── release.yaml
│       └── triggers.yaml
├── main.go
├── Makefile
├── OWNERS
├── OWNERS_ALIASES
└── preview
    ├── helmfile.yaml
    ├── Kptfile
    └── values.yaml.gotmpl

The JayeX pipeline files are all located in the .lighthouse/jenkins-x folder. Inside this folder, you should see these files: