--- title: Charmhub | Deploy Canonical Livepatch Server K8S using Charmhub - The Open Operator Collection description: Deploy the latest version of Canonical Livepatch Server K8S as a Kubernetes Operator on any cloud. Canonical Livepatch Server url: https://charmhub.io/canonical-livepatch-server-k8s --- # Canonical Livepatch Server K8S [Commercial Systems](https://charmhub.io/publisher/commercial-systems "View all packages from Commercial Systems") * [Commercial Systems](https://charmhub.io/publisher/commercial-systems "View all packages from Commercial Systems") Platform: stable v2.3.0 ``` juju deploy canonical-livepatch-server-k8s ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- #### Relevant links * [Homepage](https://ubuntu.com/security/livepatch) * [Contact](mailto:Canonical Commercial Systems Team ) --- #### Contacts ##### Maintainers + [Canonical Commercial Systems Team](mailto:jaas-crew@lists.canonical.com) * [Submit a bug](https://bugs.launchpad.net/livepatch-onprem) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) # Canonical Livepatch Server (K8s Charm) ## [Description](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-description) The Livepatch K8s charm is the easiest and the recommended way to deploy the Livepatch server on K8s. This charm configures and runs 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. For users who want to deploy an entire Livepatch on-prem server (including its dependencies), it is recommended to use the `k8s/stable` channel of the [bundle](https://charmhub.io/canonical-livepatch-onprem?channel=k8s/stable) made for this purpose. For more detailed steps on using the bundle, please see the [tutorials](https://ubuntu.com/security/livepatch/docs/livepatch_on_prem/tutorial) on the Livepatch website. ## [Usage](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-usage) The Livepatch server may be deployed using the Juju command line as follows: ``` juju deploy canonical-livepatch-server-k8s ``` ## [Integrations](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-integrations) ### [Database](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-database) Livepatch server requires integration with a PostgreSQL charm via the `database` endpoint. As an example, users can deploy a [PostgreSQL](https://charmhub.io/postgresql-k8s) database and integrate it with Livepatch as follows: ``` juju deploy postgresql-k8s --trust juju integrate canonical-livepatch-server-k8s:database postgresql-k8s: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. ### [Nginx ingress (`nginx-route`)](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-nginx-ingress-nginx-route) Livepatch provides an endpoint, named `nginx-route`, which can be integrated with the [`nginx-ingress-integrator`](https://charmhub.io/nginx-ingress-integrator) charm to expose the Livepatch server via an Nginx-controlled cluster ingress. As an example, users can integrate with this endpoint by using Juju as follows: ``` juju integrate canonical-livepatch-server-k8s:nginx-route nginx-ingress-integrator:nginx-route ``` ### [Loki (optional)](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-loki-optional) Livepatch can be optionally integrated with [Loki](https://charmhub.io/loki-k8s) via the `log-proxy` endpoint. Users can integrate other applications with this endpoint by using Juju as follows: ``` juju integrate canonical-livepatch-server-k8s:log-proxy loki-k8s:logging ``` ### [Grafana dashboard (optional, provides)](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-grafana-dashboard-optional-provides) Livepatch provides observability dashboards on Grafana. Users can monitor the status of the running Livepatch server via many metrics, including (but not limited to): * Rate of HTTP response status codes (e.g., 200, 404, or 403) for a range of percentile values. * Rate of incoming HTTP requests per second. * Database metrics (i.e., errors and response times). For this purpose, there is an endpoint, named `grafana-dashboard`, which implements the `grafana_dashboard` interface and can be integrated with [Grafana](https://charmhub.io/grafana-k8s). Users can integrate other applications with this endpoint by using Juju as follows: ``` juju integrate canonical-livepatch-server-k8s:grafana-dashboard grafana-k8s:grafana-dashboard ``` ### [Prometheus (optional, provides)](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-prometheus-optional-provides) Users can integrate Livepatch server with Prometheus to have it scrape the metrics. For this purpose, there is an endpoint, named `metrics-endpoint`, which implements the `prometheus_scrape` interface and can be integrated with [Prometheus](https://charmhub.io/prometheus-k8s). Users can integrate other applications with this endpoint by using Juju as follows: ``` juju integrate canonical-livepatch-server-k8s:metrics-endpoint prometheus-k8s:metrics-endpoint ``` ## [OCI Image](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-oci-image) This charm uses an OCI image, built as a ROCK and published on GitHub Container Registry (GHCR) as `ghcr.io/canonical/livepatch-server`. ## [Documentation](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-documentation) For more detailed instructions on deploying Livepatch server, please see the documentation for this service, available on the [Livepatch website](https://ubuntu.com/security/livepatch/docs). ## [Contributing](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-contributing) Please see the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms and [Contributing](https://github.com/canonical/livepatch-k8s-operator/blob/main/CONTRIBUTING.md) for developer guidance. ## [License](https://charmhub.io/canonical-livepatch-server-k8s#p-32022-license) The Livepatch K8s charm is free software, distributed under the Apache Software License, version 2.0. See [License](https://github.com/canonical/livepatch-k8s-operator/blob/main/LICENSE) for more details. --- [Help improve this document in the forum](https://discourse.charmhub.io/t/canonical-livepatch-server-k8s-docs-index/14366) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 1 year, 11 months ago.