FAQ on JayeX - Cloud Native CI/CD Built On Kubernetes

General

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

Where do I raise issues?

One of the challenges with JayeX 3.x is the source code is spread across a number of organisations and repositories since its highly decoupled into many plugins and microservices so it can be confusing

If you know the specific plugin causing an issue, say jx-preview then just raise the issue there in the issue tracker.

Otherwise use the issue tracker for JayeX 3.x and we can triage as required.

Using

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

How do I list the apps that have been deployed?

There is a handy HTML report in your cluster dev git repository at docs/README.md which lists all the charts deployed in every namespace with their version.

You can see the helm charts that are installed along with their version, namespaces and any configuration values by looking at the releases section of your helmfile.yaml and helmfile/*/helmfile.yaml files in your cluster git repository.

Pipelines

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

How do I diagnose a step in a pipeline?

If you are wondering what image, command, environment variables are being used in a step in the pipeline you can look at the pipelinerun or the related pod(s). If you use your favourite tool for looking in kubernetes (kubectl, k9s, …) and list the pipelineruns in the jx namespace you will proably be able to identify the one you are interested.

Previews

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

When do Preview Environments get removed?

We have a background garbage collection job which removes Preview Environments after the Pull Request is closed/merged. You can run it any time you like via the jx preview gc command

jx preview gc

You can also view the current previews via jx preview get:

jx preview get

and delete a preview by choosing one to delete via jx preview destroy:

jx preview destroy

How do I access the preview namespace or URL?

After the jx preview create step in a pull request pipeline you can access a number of preview environment variables.

ChatOps

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

What is ChatOps?

We use the phrase ChatOps to mean operating code changes, pipelines and GitOps promotion via chat. More specifically this usually is done via commenting on Pull Requests on your git providers website; though in the future this could be via Slack or web consoles too.

What are the benefits of ChatOps?

ChatOps helps developers collaborate on Pull Requests and speeds up merging of Pull Requests. We want to be able to merge changes as quickly as possible into master so that we continuously integrate code which minimises the downsides of long term feature branching and merge hell.

Troubleshooting

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

Why did my quickstart / import not work?

If you are not able to create quickstarts or import projects its most probably webhooks not being setup correctly.

When the jx project import or jx project quickstart runs it creates a Pull Request on your dev cluster repository. This should trigger a webhook on your git provider which should then trigger a Pipeline (via lighthouse webhooks). The pipeline should then create a second commit on the pull request to configure your repository which then should get labelled and auto-merge.

Ngrok

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

Follow these steps to set up ngrok for local JayeX installs.

Download and install ngrok.
Log into ngrok account and get the ngrok auth token (Authenticated sessions can run for unlimited time, unauthenticated sessions expire in 1.5 hours):
Create a ngrok config file at ~/.config/ngrok/ngrok.yml with the following content (replace <ngrok-auth-token> with the auth token from the ngrok account):

authtoken: <ngrok-auth-token>
tunnels:
  hook:
    proto: http
    addr: 8080
    schemes:
      - http
  ui:
    proto: http
    addr: 9090
    schemes:
      - http
version: "2"
region: us

Verify that the config is correct using:

ngrok config check

Run this in a new terminal window/tab:

ngrok start --all

Once the command succeeds, you should see something like this:

ngrok                                                                                                                                                                                       (Ctrl+C to quit)

Hello World! https://ngrok.com/next-generation

Session Status                online
Account                       user123 (Plan: Free)
Update                        update available (version 3.0.6, Ctrl-U to update)
Version                       3.0.5
Region                        United States (us)
Latency                       25ms
Web Interface                 http://127.0.0.1:4040
Forwarding                    http://XXXX.ngrok.io -> http://localhost:8080
Forwarding                    http://YYYY.ngrok.io -> http://localhost:9090

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00