jx-admin

README

jx admin

jx-admin is a small command line tool for System Administrators install / upgrade kubernetes applications such as Jenkins X via GitOps and immutable infrastructure.

jx-admin is based on helm 3.x

Commands

See the jx-admin command reference

Creating a new installation

First create your kubernetes cluster. If you are using Google Cloud you can try using gcloud directly.

If not try the usual Jenkins X way.

Now run the jx admin create command:

jx admin create

This will create a new git repository for your installation.

Once that is done you need to setup the secrets and then run the boot Job

Setting up Secrets

You need to specify a few secret values before you can boot up.

To populate the Secrets run:

jx secret edit

This will prompt you to enter all the missing Secrets required.

Importing and exporting

You can export the current secrets to the file system via

jx secret export -f /tmp/mysecrets.yaml

Or to view them on the terminal...

jx secret export -c

If you have an existing secrets.yaml file on the file system that looks kinda like this (with the actual values included)...

secrets:
  adminUser:
    username: 
    password: 
  hmacToken: 
  pipelineUser:
    username: 
    token: 
    email:  

Then you can import this YAML file via:

jx secret import -f /tmp/mysecrets.yaml

Running the boot Job

Once you have created your git repository via jx admin create or jx admin upgrade and populated the secrets as shown above you can run the boot Job via:

jx admin run --git-url=https://github.com/myorg/env-mycluster-dev.git

Once you have booted up once you can omit the git-url argument as it can be discovered from the dev Environment resource:

jx admin run

This will use helm to install the boot Job and tail the log of the pod so you can see the boot job run. It looks like the boot process is running locally on your laptop but really it is all running inside a Pod inside Kubernetes.

Upgrading a jx install or jx boot cluster on helm 2.x

You can use the jx admin 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:

jx admin 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.

Upgrading your cluster

Once you have the git repository for the upgrade you need to run the boot Job in a clean empty cluster.

To simplify things you may want to create a new cluster, connect to that and then boot from there. If you are happy with the results you can scale down/destroy the old one