Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Manage Single Cluster Contrail

SUMMARY Learn how to perform life cycle management tasks in a single cluster installation or within a specific cluster in a multi-cluster installation.


The way that you manage a Kubernetes cluster does not change when Contrail is the CNI plug-in. Once Contrail is installed, Contrail components work seamlessly with Kubernetes components to provide the networking infrastructure.

The Contrail controller is constantly watching and reacting to cluster events as they occur. When you add a new node, the Contrail data plane components are automatically deployed. When you delete a node, the Contrail controller automatically deletes networking resources associated with that node. Contrail works seamlessly with kubectl and other tools such as Prometheus and Grafana.

See the Appendix for examples of how to perform some common tasks on a Kubernetes cluster. These examples are not specific to Contrail and are provided with no warranty.

The remainder of this chapter contains tasks that are specific to Contrail.

Upgrade Contrail

Use this procedure to upgrade Contrail.

The Contrail controller consists of Deployments and StatefulSets, which are configured for rolling updates. During the upgrade, the pods in each Deployment and StatefulSet are upgraded one at a time. The remaining pods in that Deployment or StatefulSet remain operational. This enables Contrail controller upgrades to be hitless.

The Contrail data plane consists of a DaemonSet with a single vRouter pod. During the upgrade procedure, this single pod is taken down and upgraded. Because of this, Contrail data plane upgrades are not hitless. If desired, migrate traffic off of the node being upgraded prior to performing the upgrade.

You upgrade Contrail software simply by changing the deployed manifests to reference the new software version and then reapplying the manifests.

All Contrail manifests must reference the same software version. You cannot mix and match Contrail software versions (other than during transient upgrade situations).

  1. Locate the manifest(s) that you used to install Contrail. In the example in Install Single Cluster Contrail, we used the all-inclusive deployer.yaml manifest.
  2. Edit the manifest to reference the Contrail image versions that you want to upgrade to.
    Double check your work by verifying that all image references are correct.

    If you have a large number of nodes, use node selectors to group your upgrades to a more manageable number.

  3. Upgrade Contrail.

    The pods in each Deployment and Stateful set will upgrade one at a time. The vRouter DaemonSet will go down and come back up.

  4. Use standard kubectl commands to check on the upgrade.

    Check the status of the nodes.

    Check the status of the pods.

    If some pods remain down, debug the installation as you normally do. Use the kubectl describe command to see why a pod is not coming up. A common error is a network or firewall issue preventing the node from reaching the Juniper Networks repository.

Uninstall Contrail

Use this procedure to uninstall Contrail.

We supply a script that uninstalls Contrail resources associated with Contrail namespaces. The script deletes the following:

  • contrail namespace and resources that belong to that namespace
  • contrail-system namespace and resources that belong to that namespace
  • contrail-deploy namespace and resources that belong to that namespace
  • default-global-vrouter-config and default-global-system-config

Since there are interdependencies between Contrail components, don't try to delete Contrail components individually. The provided script uninstalls Contrail components gracefully and in the proper sequence.

  1. If you've installed Contrail Analytics, uninstall it now. The uninstall script does not uninstall resources in namespaces other than those listed above.

    To uninstall Contrail Analytics, see step 7 in Install Contrail Analytics.

  2. Delete any other resources and namespaces (for example, overlay networks) that you created after you installed Contrail.
  3. Locate and extract the uninstall script from the downloaded Contrail Manifests and Tools package.
  4. Run the script to uninstall Contrail. You must run the script from the extracted uninstall directory.

    The uninstall should complete after a few minutes.

    If the script doesn't complete, type <CTRL> c to stop the uninstall.

    It's likely that one or more namespaces are stuck in the Terminating state. To check the namespaces:

    If you see a namespace with a status of Terminating, get more information on that namespace:

    Look in the conditions section of the output to see what's blocking the uninstall. For example:

    In this example output, the problem is the API services. Find out which API services are not available.

    Delete those API services with False availability.

    Rerun the uninstall script. You'll likely see errors because the script will try to delete resources that may already have been deleted when you ran the script earlier. For example: