Create Repository

Create a Git repository for your installation

Once you are connected to a Kubernetes cluster you need to create a git repository for your development environment.

Creating a fresh install

NOTE Jenkins X creates repositories per default as private. This can cause issues when evaluating Jenkins X with GitHub, using a free GitHub organisation to hold the various created (environment) repositories as free organization accounts do not have access to private repos. Using a personal Github account is not an issue though, as free private accounts have unlimited private repos.

For evaluation purposes you could use a private GitHub account as the owner of the repositories, and switch to a paid organizational account once you’re ready to go all in. Alternatively, you can use a free GitHub organisation and enable public environment repositories by setting environmentGitPublic to true in your jx boot configuration in the next section or use --git-public flags below.

To create a fresh install run the jxl boot create command. Note this by default creates three git repositories, one for each environments dev, staging and production.

jxl boot create

or for public git repositories as per the note above

jxl boot create --env-git-public  --git-public

Extra arguments

You can pass in a whole number of different arguments to default values in your installation. You can see all the available arguments via:

jxl boot create --help

e.g. if you want to specify the kubernetes provider to gke you can use:

jxl boot create --provider=gke

Shrinking the footprint

If you are using a free tier or small kubernetes cluster you can shrink the footprint a little via the following:

 jxl boot create --repository=bucketrepo

This will avoid nexus and chartmuseum and deploy the small bucketrepo instead. More on the configuration page

Using Multi Cluster

If you wish to use multi cluster where your staging and production environments are in separate repositories then please add the --env-remote flag then follow the multi cluster documentation after you have booted your development environment.

jxl boot create --env-remote

This will create the git repositories for your environments.

The command will output instructions on how to setup the secrets and then run the boot job.

Other options

You can switch to use istio instead of nginx for ingress support via adding:

jxl boot create --ingress-kind=istio

which then switches to adding istio instead and using Gateway and VirtualService resources from istio instead of the classic Ingress resources.

You can enable TLS + cert manager and externaldns via:

jxl boot create --tls --externaldns

Though please note we are still working on cert manager + externaldns integration in jxl boot so please be gentle.

Incidentally you can also specify the TLS secret

Upgrading an existing cluster

f you have already installed Jenkins X somehow; e.g. via the deprecated jx install command of via jx boot with or without using GitOps using helm 2.x to manage the development environment then we have a way to upgrade your cluster to helm 3 and helmfile.

To do this connect to your current Kubernetes cluster so that kubectl can see the development namespace.

You can test this by running:

kubectl get environments 

Which should list the Environment resources in your installation which usually has dev, staging and production.

You can use the jxl boot upgrade command to help upgrade your existing Jenkins X cluster to helm 3 and helmfile.

Connect to the cluster you wish to migrate and run:

jxl boot upgrade

and follow the instructions.

If your cluster is using GitOps the command will clone the development git repository to a temporary directory, modify it and submit a pull request.

If your cluster is not using GitOps then a new git repository will be created along with instructions on how to setup the secrets and then run the boot job.


Last modified April 8, 2020: release 0.0.1634 (a950dfc)