Cloud-Native Router Readiness Checks
Learn how Cloud-Native Router Readiness checks verify that your Cloud-Native Router installation is working properly.
Cloud-Native Router Readiness checks are a set of tests that validate your installation. They consist of preflight and postflight checks.
| Preflight checks |
Preflight checks verify that your cluster nodes can support JCNR. The checks test for resource capacity, OS version, and other infrastructure requirements. Preflight checks run prior to Cloud-Native Router coming up. |
| Postflight checks |
Postflight checks verify that your Cloud-Native Router installation is working properly. The checks test for status and other basic functions. Postflight checks run after Cloud-Native Router comes up. |
Cloud-Native Router Readiness is the name of the custom resource where these preflight and postflight checks
are defined. When you enable Cloud-Native Router Readiness checks in values.yaml
(readinessCheck: true), a set of pods that run these tests are created. For
example:
kubectl get pods -A | grep preflight
cpuavailability-preflight-k8s-cp0-wtt92 0/1 Completed 0 cpuavailability-preflight-k8s-worker0-p7bxk 0/1 Completed 0 cpuinstructionset-preflight-k8s-cp0-4zmzq 0/1 Completed 0 cpuinstructionset-preflight-k8s-worker0-gh9zl 0/1 Completed 0 crpd-prerequisite-preflight-k8s-cp0-sqnjj 0/1 Completed 0 crpd-prerequisite-preflight-k8s-worker0-29psj 0/1 Completed 0 <trimmed>
To see the list of checks that are currently performed, see List of Cloud-Native Router Readiness Checks.
When Cloud-Native Router Readiness checks are enabled, they run automatically when you install the Cloud-Native Router Helm chart. A failed check does not necessarily fail the installation. In some cases, the installation is allowed to continue.
To see the results of the checks, look at the results ConfigMap. For best viewing of the results, use the JSON processor jq.
If jq is not installed on your OS by default, install it using the appropriate package manager for your OS. For example:
dnf install jq
apt install jq
Here's an example of the preflight results ConfigMap:
kubectl get cm preflight-results -n contrail-deploy -ojsonpath={".data.readinessStatus"} | jq
{
"preflight": {
"taskResults": [
{
"name": "cpuavailability",
"taskExecutionTime": "2s",
"message": "task completed (2/2)",
"taskPassed": false,
"failure_reason": "core 2 is not available on the node\ncore 2 is not available on the node\n"
},
<trimmed>
If there are any errors, fix them and then uninstall and reinstall JCNR.
Here's an example of the postflight results ConfigMap:
kubectl get cm postflight-results -n contrail-deploy -ojsonpath={".data.readinessStatus"} | jq{
"postflight": {
"taskResults": [
{
"name": "jcnrresources",
"taskExecutionTime": "0s",
"message": "task completed (1/1)",
"taskPassed": true
}
],
"result": "success"
}
}
Although preflight and postflight checks can detect many common errors, some errors can slip through undetected. If the installation still fails after you fix all listed errors, look at the deployer and applier logs for more information:
-
For deployer logs, see Check Deployer Logs.
-
For applier logs, see View Log Files.
Also see the various general troubleshooting suggestions in Troubleshoot Deployment.