Troubleshooting

Procedure

• Run the following command to check the version information:

  $ microshift version

  Example output

  Red Hat build of MicroShift Version: 4.15-0.microshift-e6980e25
  Base OCP Version: 4.15

Procedure

• To get the version number using the OpenShift CLI (oc), view the kube-public/microshift-version config map by running the following command:

  $ oc get configmap -n kube-public microshift-version -o yaml

  Example output

  apiVersion: v1
  data:
    major: "4"
    minor: "13"
    version: 4.13.8-0.microshift-fa441af87431
  kind: ConfigMap
  metadata:
    creationTimestamp: "2023-08-03T21:06:11Z"
    name: microshift-version
    namespace: kube-public

Procedure

• To display the base database version information, run the following command:

  $ microshift-etcd version

  Example output

  microshift-etcd Version: 4.15.1
  Base etcd Version: 3.5.10

• To display the full database version information, run the following command:

  $ microshift-etcd version -o json

  Example output

  {
    "major": "4",
    "minor": "15",
    "gitVersion": "4.15.1",
    "gitCommit": "2e182312718cc9d267ec71f37dc2fbe2eed01ee2",
    "gitTreeState": "clean",
    "buildDate": "2024-01-09T06:51:40Z",
    "goVersion": "go1.20.10",
    "compiler": "gc",
    "platform": "linux/amd64",
    "patch": "",
    "etcdVersion": "3.5.10"
  }

• Not waiting several minutes after a system start to successfully stop MicroShift. The system must complete health checks and any other background processes before a back up can succeed.

• If MicroShift stopped running because of an error, you cannot perform a backup of the data.

  • Make sure the system is healthy.
  • Stop it in a healthy state before attempting a backup.
• If you do not have sufficient storage for the data, the backup fails. Ensure that you have enough storage for the MicroShift data.
• If you do not have sufficient permissions, a backup can fail. Ensure you have the correct user permissions to create a backup and perform the required configurations.

• Logs print to the console during manual backups.

• Logs are automatically generated for rpm-ostree system automated backups as part of the MicroShift journal logs. You can check the logs by running the following command:

  $ sudo journalctl -u microshift

Procedure

• You can check the system status, which returns the cluster status, by running the following command:

  $ sudo systemctl status microshift

  If MicroShift is failing to start, this command returns the logs from the previous run.

• Optional: You can view the logs by running the following command:

  $ sudo journalctl -u microshift

• Optional: If MicroShift is running, you can see active pods by entering the following command:

  $ oc get pods -A

Procedure

• Check the MicroShift journal logs by running the following command:

  $ sudo journalctl -u microshift

• Check the greenboot journal logs by running the following command:

  $ sudo journalctl -u greenboot-healthcheck

• Check the journal logs for a boot of a specific service by running the following command:

  $ sudo journalctl --boot <boot> -u <service-name>

• Examining the comprehensive logs of a specific boot uses two steps. First list the boots, then select the one you want from the list you obtained:

  • List the boots present in the journal logs by running the following command:

    $ sudo journalctl --list-boots

  • Check the journal logs for the boot you want by running the following command:

    $ sudo journalctl --boot <-my-boot-number>

Procedure

• To see a report of health check status, use the following command:

  $ systemctl show --property=SubState --value greenboot-healthcheck.service

  • An output of start means that greenboot checks are still running.
  • An output of exited means that checks have passed and greenboot has exited. Greenboot runs the scripts in the green.d directory when the system is a healthy state.
  • An output of failed means that checks have not passed. Greenboot runs the scripts in red.d directory when the system is in this state and might restart the system.

• To see a report showing the numerical exit code of the service where 0 means success and non-zero values mean a failure occurred, use the following command:

  $ systemctl show --property=ExecMainStatus --value greenboot-healthcheck.service

• To see a report showing a message about boot status, such as Boot Status is GREEN - Health Check SUCCESS, use the following command:

  $ cat /run/motd.d/boot-status

Prerequisites

• You have installed jq.
• You have access to the cluster as a user with the cluster-admin role.