Installing the Operator

Installing the Git Operator to install/upgrade Jenkins X

Jenkins X 3.x uses a git operator to manage installing + upgrading of Jenkins X and any other components in any environment. If you are interested you can read how it works.

Git user and token

To install the git operator you will need a pipeline user and token for the git repository.

This user and token needs read and write access to the git repository containing the installation configuration. Ideally the token will also have permissions to be able to create a webhook on the repository (to trigger CI/CD pipelines whenever someone creates a Pull Request on the git repository).

You can always setup webhooks by hand yourself whenever a git repository is created or imported or the domain name of your lighthouse hook endpoint changes via the jx verify webhooks command. Though its easier to get Jenkins X to automate this for you as part of the CI/CD pipelines; it just requires the git user and token to have sufficient permissions to list, create and modify webhooks.

Note also that the same pipeline user and token is reused by default for all pipelines on all repositories created or imported which will need read, write and webhook permissions on all of those repositories too. Though if you really want you can change this later on by editing the pipeline token.

Installing the operator

Run jx admin operator command inside the git clone of the git repository you created previously:

jx admin operator

If you are not inside the git clone of the git repository you will need to specify the --url parameter for the git URL:

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

If you know the git username and token you can pass those in on the command line too if you wish - otherwise the command will prompt you to enter the details:

jx admin operator --url=https://github.com/myorg/env-mycluster-dev.git --username mygituser --token mygittoken

This command will use helm to install the git operator which will trigger a Job to install Jenkins X (and re-trigger a Job whenever you commit to your git repository).

The terminal will display the logs as the boot Job runs.

At any time you can tail the boot job logs via the jx admin log command:

jx admin log

Jenkins X will now install itself.

If you want to you can populate the secrets once the ExternalSecret custom resources have been created.


Last modified September 21, 2020: release 0.0.1895 (3145738)