Administering SUSE ALP Dolomite using Cockpit
- TOPIC
From basic system overview, over storage management to keeping your system up to date. Cockpit enables you to perform a number of administration tasks in a convenient way.
- INTENTION
This articles is intended to provide a complete overview of tasks that can be performed from the Cockpit web interface.
- REQUIREMENTS
To fully administer the system using Cockpit, you must have the
root
access or sudo privileges.
1 About Cockpit #
Cockpit is a Web-based graphical interface that enables you to manage most administration tasks from one place. You do not need to create credentials for Cockpit as, by default, Cockpit uses the same credentials that you use to log in to your server. Cockpit uses APIs that already exist on the system without adding a layer to the system.
Cockpit enables you to perform the following tasks:
download container images and run containers
update the server
inspect and change network settings
manage user accounts
view system logs
inspect and interact with
systemd
servicesuse a terminal on a remote server in your web browser
To extend Cockpit's functionality, you can enhance it with new applications available at https://cockpit-project.org/applications.html.
2 Installation #
This article describes how to run a containerized Cockpit Web server on SUSE ALP Dolomite using Podman. This workload adds the Cockpit Web server to ALP Dolomite so that you can administer the system and container via a user-friendly interface in your Web browser.
Find more comprehensive information about managing Cockpit in https://documentation.suse.com/alp/dolomite/html/cockpit-alp-dolomite/index.html.
You need to have the alp_cockpit software pattern installed before deploying the Cockpit container.
An alternative way of installing and enabling the Cockpit Web server is described in https://en.opensuse.org/openSUSE:ALP/Workgroups/SysMngmnt/Cockpit#Install_the_Web_Server_Via_Packages.
ALP Dolomite has the base part of the Cockpit component installed by default. It is included in the alp_cockpit pattern. To install and run Cockpit's Web interface, follow these steps:
Identify the Cockpit Web server workload image:
#
podman search cockpit-ws [...] registry.opensuse.org/suse/alp/workloads/tumbleweed_containerfiles/suse/alp/workloads/cockpit-wsPull the image from the registry:
#
podman container runlabel install \ registry.opensuse.org/suse/alp/workloads/tumbleweed_containerfiles/suse/alp/workloads/cockpit-ws:latestRun the Cockpit's containerized Web server:
#
podman container runlabel --name cockpit-ws run \ registry.opensuse.org/suse/alp/workloads/tumbleweed_containerfiles/suse/alp/workloads/cockpit-ws:latestTo run the Cockpit's Web server on each ALP Dolomite boot, enable its service:
#
systemctl enable cockpit.serviceTo view the Cockpit Web user interface, point your Web browser to the following address and accept the self-signed certificate:
https://HOSTNAME_OR_IP_OF_ALP_HOST:9090
Figure 1: Cockpit running on ALP Dolomite #
2.1 Software updates #
To be able to perform transactional software updates from Cockpit, install the cockpit-tukit package:
#
transactional-update pkg install cockpit-tukit#
reboot
3 Authentication #
Cockpit enables you to log in directly to each machine that can expose the
9090 port. This machine is sometimes referred to as the primary server. It
is the primary server that runs the cockpit-ws
through
which connections to additional servers are established.
If the port cannot be accessed on the particular machine, you can still use Cockpit to administer the machine by using it as a secondary server. For a procedure of adding a server as secondary, refer to Procedure 2, “Adding a server as secondary”.
The number of secondary servers that you can administer from one primary server is limited to 20. If you need to administer more servers, add other primary servers or use another tool for cluster administration.
3.1 Logging in to the primary server directly #
Whenever you have a direct network access to the 9090 port, you can directly log in to the server using your credentials. To do so, follow the Procedure 1, “Logging in to the primary server”.
By default, the access is controlled by a Cockpit-specific PAM stack
located at /etc/pam.d/cockpit
. The default
configuration allows logging in with the same user names and passwords
that are used for any local account on the system.
Go to the Cockpit login page by opening the following address in a browser:
https://IP_ADDRESS_OF_MACHINE:9090
Enter the credentials.
3.2 Logging in to secondary servers #
If your machine does not have a direct access to the 9090 port, you can use this machine as a secondary server. Bear in mind that the machine needs to have Cockpit installed.
There are two ways of logging in to a secondary server: you can log in to a secondary server directly or you can use the primary server.
3.2.1 Logging in to secondary servers directly #
You can log in to any secondary server without logging in to the primary server first. This solution can be useful when you do not have credentials for the primary server. The primary server will be used as a bridge, and you will be connected to the secondary server using SSH.
To connect to the secondary server, proceed as follows:
Go to the Cockpit login page by opening the following address in a browser:
https://IP_ADDRESS_OF_MACHINE:9090
Fill in the credentials for the secondary server.
Expand
on the login screen.Fill in the IP address of the secondary server.
Proceed by clicking
.If you are trying to log in for the first time, you are asked to verify the fingerprint. After this, click
.
3.2.2 Accessing secondary servers from the primary server #
If you have credentials for the primary server, you can access secondary servers from the primary one. Bear in mind that you have to add the secondary servers first as described in Procedure 2, “Adding a server as secondary”.
Log in to the primary server using the account with the system administrator role.
Click the USERNAME@HOSTNAME in the upper-left corner.
Click
.Fill in the host identification and optionally user name that will be used to log in to the server. You can assign a color to the machine. When the details are complete, click
.Verify a fingerprint on the server you want to add. If the fingerprint matches or if you have not set up the SSH connection, click
to proceed.Fill in the password and, if needed, check
. Cockpit will generate a new SSH key for the user, and next time you will be logged in automatically.
4 Configuring servers #
Using Cockpit, you can change the host name, set or synchronize the system time or change a time zone.
4.1 Changing the sever host name #
To change the host name, proceed as follows:
Navigate to the
part.In the
part, click .Fill in the following:
4.2 Changing the system time or time zone #
To change the system time or time zone, proceed as follows:
Click the
value.In the pop-up window you can change the following:
5 Filtering logs #
After navigating to the
page, Cockpit shows system logs according to the default or previously selected view criteria. To change the logs view, you need to adjust the log filters as described further.You can filter the logs according to the following criteria:
Time. For details, refer to Section 5.1, “Filtering according to time”.
Priority. For details, refer to Section 5.2, “Filtering according to priority”.
Identifier. You can filter logs for a particular service, daemon or process. Available identifiers are parsed from the logs currently displayed according to the set filters.
Free-form filters. For details, refer to Section 5.3, “Logs filters”.
Bear in mind that when changing any of the time, priority or identifier criteria, the other ones are still applied. For example, if you change the time criterion to
, the priority and identifier criteria remain the same.5.1 Filtering according to time #
To filter the logs according to a specific time, you can choose from the following values:
- Current boot
Displays logs for the current boot only. The
button enables continuous refreshing of currently displayed logs.- Previous boot
Displays logs relevant to the previous boot.
- Last 24 hours
Displays logs that were recorded within the last 24 hours.
- Last 7 days
Displays logs that were recorded within the last 7 days.
5.2 Filtering according to priority #
The standard syslog
severity levels are used (sorted
from most to least severe):
- Only emergency
The system is unusable. This is a panic condition.
- Alert and above
This log requires your immediate action.
- Critical and above
Failures in primary systems. You should correct the problem immediately.
- Error and above
Not an urgent error but should be handled within a specific time.
- Warning and above
Not an error but indicates that an error might occur if no action is taken.
- Notice and above
Unusual events that are not errors. No immediate actions are required.
- Info and above
Normal operational messages that serve as a confirmation that the system is working properly.
- Debug and above
These messages are used just to debug the system.
5.3 Logs filters #
You can refine the logs view here according to the following criteria:
- Since
Logs for the specified date or newer will be displayed. You can specify the time in the following way:
using the absolute date in the format YYYY-MM-DD
using any of the terms:
yesterday
,today
,tomorrow
andnow
using relative time by prefixing the value with - or + and specifying units. You can use the following units:
seconds
ors
,minutes
ormin
,hours
orh
,days
ord
,weeks
orw
,months
orm
, andyears
ory
.
- Until
Logs for the specified date or older will be displayed. You can specify the time in the following way:
using the absolute date in the format YYYY-MM-DD
using any of the terms:
yesterday
,today
,tomorrow
andnow
using relative time by prefixing the value with - or + and specifying units. You can use the following units:
seconds
ors
,minutes
ormin
,hours
orh
,days
ord
,weeks
orw
,months
orm
, andyears
ory
.
- Boot
Enter an integer: 0 means the current boot, -1 is for the previous boot, 1 for the first boot, 2 for the second, etc.
- Unit
Specify a
systemd
unit for which you want to display logs. Use one of the formats:_SYSTEMD_UNIT=NAME.service
COREDUMP_UNIT=NAME.service
UNIT=NAME.service
- Free-form search
Enter a string that you want to find in the log messages. You can also use PERL-compatible regular expressions. Alternatively, you can filter messages according to message log fields in the format FIELD=VALUE. For example,
CODE_LINE=349
displays logs with this value.
6 Managing networking #
After clicking
, you can view traffic on your system, manage firewall, manage network interfaces, or view network logs.6.1 Managing firewall rules and zones #
Cockpit enables you to create new zones or update the existing ones. In the firewall settings, you can add services to a zone or allow access to ports.
Do not remove the Cockpit service from the default firewall zone as the Cockpit service may get blocked, and you may get disconnected from the server.
6.1.1 Adding firewall zones #
The
is the default firewall zone. To add a new zone, proceed as follows:Navigate to the
view.Click
.Click
.Select
. Each trust level of network connections has a predefined set of included services (the Cockpit service is included in all trust levels).Define allowed addresses within the zone. Select one of the values:
Proceed with
.
6.1.2 Adding allowed services and ports to a zone #
You can add services to an existing firewall zone as described below:
Navigate to the
view.Click
.Click
.To add a service, check
and select the services from the list.To allow custom ports, check
and specify the port value for UDP and/or TCP. You can assign an identifier to this port.To confirm the changes, click
or , respectively.
6.2 About network bonds #
A bond interface is a combination of several network interfaces into one bond. Depending on the
(described further), network bonding can improve performance by increasing the network throughput and bandwidth. Network bonding can also increase fault tolerance by keeping overall connectivity even if some of the bonded interfaces stopped working.6.2.1 Managing bonds #
6.2.1.1 Adding bonds #
To add a bond, proceed as follows:
Navigate to the
page.Click
.Specify the following parameters of the bond interface:
- Name
Enter a unique name of the interface.
- Interfaces
Select which network interfaces should be grouped in the bond.
- MAC
You can either select a specific MAC address of the underlying interface, or you can use any of the following options:
- Permanent
Use the permanent hardware address if the device has a MAC address.
- Preserve
During the bond activation, the MAC address is not changed.
- Random
A random MAC address is created on each connection attempt.
- Stable
Creates a hashed MAC address.
- Mode
Keep the default mode or select any of the following modes:
- Round Robin
Transfers packets from the first available interface to the last. The mode offers fault tolerance and load balancing.
- Active Backup
Only one interface in the bonding is active. If the active interface fails, the backup will be activated.
- Balance XOR
Balancing using a transmit hash policy. The default is a modulo device count. To select a different policy, specify the
xmit_hash_policy
option in the field.- Broadcast
Everything is transmitted on all interfaces.
- 802.3ad Dynamic Link Aggregation
Creates aggregation groups that share the same speed and duplex settings.
- Adaptive Transmit Load Balancing
A channel bonding that does not require any special switch support. The outgoing traffic is distributed according to the current load on each interface.
- Adaptive Load Balancing
Includes adaptive transmit load balancing and receive load balancing, no special switch support is required.
- Primary
This selection is available only for the Active Backup mode. You can select a particular interface that will be used as primary, while other interfaces in the bond are used as secondary.
- Link monitoring
Select the type of link monitoring.
- Monitoring interval
Specifies the intervals at which the particular link monitor performs checks. The value is in ms.
- Link up delay
Define the time in ms for how long the bond is disabled after a link has been activated. The value should be a multiple of the
value, otherwise it will be rounded to the nearest value. Available only for the MII link monitor.- Link down delay
Define the time in ms for how long the bond is disabled if a link failure has been detected. The value should be a multiple of the
value, otherwise it will be rounded to the nearest value. Available only for the MII link monitor.- Monitoring targets
Specify the list of host IP addresses that you want to monitor. Available only for the ARP link monitor.
Proceed with
.
6.2.1.2 Modifying bonds #
To modify a bond, proceed as follows:
Navigate to the
view.Click on the particular bond name to open the details.
You can modify the following bond parameters:
- Bond
Select a MAC address from the list.
- Connect automatically
The bond connects automatically by default. Uncheck the box to disable the automatic connection.
- IPv4 and IPv6
After clicking
, you can set an IP address and configure a specific DNS, DNS search domain and Routes.- MTU
After clicking
, you can specify a particular value of the maximum transmission unit in bytes.- Bond
After clicking
, you can edit the same parameters as when you were creating the bond interface.
6.3 Managing network bridges #
A network bridge is a device that creates a single aggregated network from multiple networks.
6.3.1 Creating network bridges #
To create a network bridge, proceed as follows:
Navigate to the
page.In the
view, clickSpecify the following:
- Name
Specify a unique name of the bridge.
- Ports
Select interfaces to be included in the bridge.
- Spanning tree protocol (STP)
STP is a network protocol used for Ethernet networks that prevents bridge loops by setting a preferred link whenever network switches are connected with several links. This preferred link is used for all Ethernet traffic unless it fails. In that case, a redundant link is used instead. For details regarding STP, see STP.
If you enable the STP protocol, you can edit the following settings:
- STP priority
The lower the priority, the higher the probability of the switch to become the root switch.
- STP forward delay
Specify the time spent in the listening and learning state (in seconds). The default value is 15 s, but you can use any value between 4 and 30 s.
- STP hello time
Specify the time between each bridge protocol data unit (BDPU) that is sent on a port (in seconds). The default value is 2 s, but the recommended range is 1 to 10 s.
- STP maximum message age
Specify the maximum length of time that passes before a bridge port saves its configuration BPDU information.
6.3.2 Modifying or deleting existing bridges #
To modify or delete a bridge, proceed as follows:
Navigate to the
page.In the
view, click the bridge name to open the details.There you can delete the bridge by clicking
, or modify it by changing any of the following details:- General
The bridge connects automatically by default. To disable the automatic connection, uncheck the option.
- IPv4 and IPv6
After clicking
, you can set the IP address and configure a specific DNS, DNS search domain and Routes.- Bridge
By clicking
, you can edit all parameters of the bridge.
6.4 Managing VLANs using Cockpit #
A virtual local area network is a logical subnetwork that groups devices from different physical LANs.
6.4.1 Creating virtual local area network #
To add a VLAN, proceed as follows:
Navigate to the
page.In the
view, click .Fill in the VLAN details:
- Parent
Select the parent network interface.
- VLAN ID
Specify an ID in the range 1–4094.
- Name
Enter the name of the VLAN.
6.4.2 Modifying or deleting existing VLANs #
To modify or delete an existing VLAN, proceed as follows:
Navigate to the
page.In the
view, click the VLAN name.Either delete the VLAN by clicking
, or change any of the VLAN details:- Parent
Select the parent network interface.
- VLAN ID
Specify an ID in the range 1–4094.
- Name
Enter the name of the VLAN.
7 Working with containers #
After the first login to Cockpit, you need to start Podman. Keep the default check box selected to start Podman automatically on each boot.
The
page enables you to pull images from registries and manage your container. You can also filter the view by entering a filter criterion into the filter field.7.1 Getting container images #
To start a container, you need a container image. To get a container image, proceed as follows:
Navigate to the
page.Click
to open a search box for images.Choose a preferred image registry or proceed with
All registries
.Define the
. The default value islatest
.Fill in the image name or description in the
field to start the search.Cockpit suggests possible images according to the entered name, registry and tag.
Select the desired image and click
.
7.2 Managing containers using Cockpit #
7.2.1 Running new containers from images #
To run a container, you need a container image, either pulled by using Cockpit or by Podman. For details about Podman, refer to the Podman guide.
To run a new container from an image, proceed as follows:
Navigate to the
page.In the
view, click the play icon.In the
window, enter the container details as described below.- Name
You can define a custom name for the container. If not specified, the generated value is used.
- Command
Defines a command that is run inside the container, for example,
/usr/lib/systemd/systemd
or/bin/bash
.- Memory limit
You can limit maximum memory consumption of the container by checking the box and specifying the limit.
- With terminal
The container will not run in the detached mode.
- CPU shares
Specify the weight of the container to use CPU time. The default weight is 1024. The weight applies only if containers are under high load. If the tasks in one container are idle, other containers may use its CPU time.
If you have four containers, two of them have CPU shares of 512 and the other two have 1024. Thus, under high load, the containers with lower CPU shares get only 16,5% of CPU time, while those with 1024 CPU shares get 33% of CPU time.
- Ports
You can publish the ports of the container to the host. If you do not provide the host IP address, the port will be bound to all host IP addresses. If you omit the host port number, a random port is assigned.
To publish a port for both protocols (TCP and UDP), enter the same port number twice, just select different protocols.
- Volumes
Maps the volumes on the host system to the paths in the container. The
Container path
must be an absolute path inside the container. If it does not exist, the corresponding directory will be created.- Environment
Enables passing environment variables to the container.
Click
to proceed and start a container.
7.2.2 Further actions with running containers #
After expanding the container details, you can perform the following tasks:
access a terminal of the container in the
tabview the container logs in the
tabdelete the container by clicking the trash bin button
commit changes performed to the container, for example, installing packages to the container
start the container by clicking
restart the container, either by regular
, where processes running inside the container are stopped, or by , where the processes are killed, and you may lose datastop the container, either by regular
, or . When using , the state of all processes in the container is written to the disk, and after the next start, the container is restored to the same point before stopping.
8 Users administration #
The
Cockpit screen enables you to administer user accounts.Only users with the
role can edit other users.Using the
Cockpit screen, you can perform the following tasks:Creating new users of the system as described in Section 8.1, “Creating user accounts using Cockpit”
Assigning
sudo
privileges to user accounts as described in Section 8.2, “Modifying existing user accounts”Forcing a change of a user's password as described in Section 8.2, “Modifying existing user accounts”
Locking a particular user account as described in Section 8.2, “Modifying existing user accounts”.
8.1 Creating user accounts using Cockpit #
Cockpit enables you to add users to a running system and assign system administrator privileges to accounts.
To add a new user to the system, proceed as follows:
Navigate to the
page.Click
to open the window that enables you to add a new user.Fill in the user account details.
Click
to confirm the account.To assign the Section 8.2, “Modifying existing user accounts”.
privileges or add an SSH key to the account, you need to modify the account as described in
8.2 Modifying existing user accounts #
In the editing form, you can add an SSH key to an account, set a
password, assign the sudo
privileges, or lock an
account.
To modify a user account, proceed as follows:
Navigate to the
page.Click the account you want to modify.
In the user details view, you can perform the following actions:
- Delete the user
Click
to remove the user from the system.- Terminate user's session
By clicking
, you can log a particular user out of the system.- Change user's role
By checking/unchecking the
check box, you can assign or remove the administrator role from the user.- Manage access to the account
You can lock the account, or you can set a date when the account will expire.
- Manage the user's password
Click
to set a new password for the account.By clicking
, the user will have to change the password on the next login.Click
to set whether or when the password expires.- Add SSH key
You can add an SSH key for passwordless authentication via SSH. Click
, paste the contents of the public SSH key and confirm it by clicking .
9 Managing services #
The following sections describe how to start, stop and restart a service, target, socket, timer or path.
9.1 Managing systemd
units #
To manage a systemd
unit, proceed as follows:
Click the
page.Select the appropriate tab (
, , , or ).Click the unit you want to administer.
In the unit details, you can view relations to other
systemd
units, the status of the unit, or you can perform the following actions that can be found in the three-dot menu:
9.2 Creating new timers #
systemd
timers help you to automate recurring tasks. A systemd
timer can control triggering of systemd
services and handling of
events.
The default set of systemd
timers is stored in
/usr/lib/systemd
. If you create a timer with already
existing names, the default unit file is not overwritten, but a new one
is created in /etc/systemd/system/
that overrides
the default unit file. To restore the timer to the default
one, delete the timer unit file in
/etc/systemd/system/
.
If you try to create a timer that already exists in the
/etc/systemd/system/
directory, the unit file will
be overwritten, and the previous changes are lost.
To create a systemd
timer using Cockpit, proceed as follows:
Navigate to
.In the
tab, click .Fill in the details:
- Name
The name of the timer that will be used in the unit name and in the service unit name as well. For example, specifying the name example will create the following unit files:
/etc/systemd/system/example.timer
and/etc/systemd/system/example.service
.- Description
You can provide a short description of the timer.
- Command
The command to be invoked when the timer is triggered.
- Trigger
The timer can be triggered each time you reboot your machine or at a specific time. For the
option, you can define the delay of the service invocation. For the option, specify when the service should be invoked.
10 Updates and snapshots #
You can use Cockpit to search for new system updates and then apply them directly from the Web interface. On top of that, Cockpit enables you to perform a rollback to a previous snapshot.
If your system is not registered, the updates are not available and the check for updates fails. Therefore, register your system to view available updates.
Only users with the
role can update the system or perform a rollback to another snapshot.
Cockpit enables you to update your ALP Dolomite instance or perform a
rollback from the Software Updates
menu.
10.1 Updating ALP Dolomite using Cockpit #
To update your system, proceed as follows:
Navigate to the
page.Click
to get a list of new package updates and patches available for your system. We recommend installing the patches marked as important as soon as possible.Now you can update your system either with immediate reboot, or the reboot might be postponed:
Click
to apply patches and updates. After the update is complete, your system will be restarted and will boot into the new snapshot.To postpone reboot after the update, select
from the three-dot menu. Bear in mind that you need to reboot the system to activate the snapshot with updates. If you perform further changes without rebooting the system beforehand, a new snapshot will be created from the same point as the snapshots with updates. Therefore, the new snapshot will not include the updates.
10.2 Performing rollbacks #
To perform a rollback of your system, proceed as follows:
Navigate to the
page.Click
, or in the three-dot menu next to the snapshot you want to perform a rollback to.
After rebooting the system, the snapshot you rolled back to will be set as active. Do not make any changes (install updates, packages, etc.) before rebooting your system as the snapshot you rolled back to is not active. Any changes performed before you reboot your system will start from the currently active snapshot.