canonical-livepatch-server docs - index

Canonical Livepatch Server (Machine Charm)

CharmHub Badge Release Tests

Description

The Livepatch machine charm is the easiest and the recommended way to deploy the Livepatch server. This charm installs and configures the Livepatch server, which serves Livepatch-es and metadata attached to them to the clients. Canonical Livepatch patches high and critical linux kernel vulnerabilities, removing the immediate need to reboot to upgrade the kernel, instead allowing the downtime to be scheduled. It is a part of the Ubuntu Pro offering.

:warning: For users who want to deploy an entire Livepatch on-prem server (including its dependencies), it is recommended to use the machine/stable channel of the bundle made for this purpose. For more detailed steps on using the bundle, please see the tutorials on the Livepatch website.

Usage

The Livepatch server may be deployed using the Juju command line as follows:

juju deploy canonical-livepatch-server

Integrations

Database

Livepatch server requires integration with a PostgreSQL charm via the database endpoint. As an example, users can deploy a PostgreSQL database and integrate it with Livepatch as follows:

juju deploy postgresql
juju integrate canonical-livepatch-server:database postgresql:database

There is also an endpoint, named database-legacy, which can be used with PostgreSQL charm’s legacy endpoint, db . But it is strongly recommended that users integrate with the database endpoint mentioned earlier.

Reverse-proxy

Livepatch provides an endpoint, named website, which can integrated with reverse-proxy/load-balancer services that are meant to gate external access, like HAProxy.

As an example, users can integrate this endpoint by using Juju as follows:

juju deploy haproxy
juju integrate canonical-livepatch-server:website haproxy:website

Documentation

For more detailed instructions on deploying Livepatch server, please see the documentation for this service, available on the Livepatch website.

Contributing

Please see the Juju SDK documentation for more information about developing and improving charms and Contributing for developer guidance.

License

The Livepatch machine charm is free software, distributed under the Apache Software License, version 2.0. See License for more details.