cockpit/doc/guide/feature-kubernetes.xml

35 lines
1.5 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<chapter id="feature-kubernetes">
<title>Kubernetes</title>
<para>Cockpit has a dashboard that interacts with a
<ulink url="https://kubernetes.io/">Kubernetes cluster</ulink> or an
<ulink url="https://enterprise.openshift.com/">Openshift v3 cluster</ulink>. This
functionality is in the Cockpit <emphasis>kubernetes</emphasis> package.</para>
<para>The dashboard is part of a normal authenticated Cockpit session. Cockpit
communicates with Kubernetes via its REST API.</para>
<para>Usually some form of authentication is necessary to access the Kubernetes REST API.
Like the <filename>kubectl</filename> and <filename>oc</filename> commands, Cockpit uses
the authentication and server information in the <code>~/.kube/config</code> file for
the logged in user.</para>
<para>If a user is able to use <code>kubectl</code> successfully when at their shell terminal,
then that same user will able to use Kubernetes dashboard when logged into Cockpit:</para>
<programlisting>
$ <command>kubectl get pods</command>
NAME READY STATUS RESTARTS AGE
docker-registry-1-l4pyh 1/1 Running 10 23d
...
</programlisting>
<para>When running Openshift one can use the <code>oc login</code> command to configure the
<code>~/.kube/config</code> file correctly. This in turn allows Cockpit to use that
login information.</para>
</chapter>