Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to the Cockpit guide for SLES. #418

Merged
merged 5 commits into from
Feb 3, 2025
Merged

Changes to the Cockpit guide for SLES. #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1652eef
Changes to the Cockpit guide for SLES.
lvicoun Jan 24, 2025
23b819f
Fixed a typo.
lvicoun Jan 24, 2025
04b5cb4
Apply suggestions from code review
lvicoun Jan 24, 2025
ac540bb
Removed the Micro Cockpit DC file.
lvicoun Jan 24, 2025
94d06c5
Finalized SLES cockpit draft.
lvicoun Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DC-Micro-cockpit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
## ----------------------------
##
## Basics
MAIN="cockpit-slemicro.asm.xml"
MAIN="cockpit.asm.xml"
SRC_DIR="articles"
IMG_SRC_DIR="images"

## Profiling
PROFOS="slmicro"
PROFCONDITION="6.0"
STRUCTID="slemicro-cockpit-55-further"
PROFCONDITION="6.2"
STRUCTID="slmicro-cockpit"
#PROFARCH="x86_64;zseries;power;aarch64"

## stylesheet location
Expand Down
18 changes: 18 additions & 0 deletions DC-SLES-cockpit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## ----------------------------
## Doc Config File for the DB Assembly
## ----------------------------
##
## Basics
MAIN="cockpit.asm.xml"
SRC_DIR="articles"
IMG_SRC_DIR="images"

## Profiling
PROFOS="sles"
PROFCONDITION="16.0"
STRUCTID="sles-cockpit"
#PROFARCH="x86_64;zseries;power;aarch64"

## stylesheet location
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2021-ns"
151 changes: 98 additions & 53 deletions articles/cockpit-slemicro.asm.xml → articles/cockpit.asm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,12 @@ type="application/relax-ng-compact-syntax"?>
<description>GNU Free Documentation License</description>
</resource>
</resources>
<structure renderas="article" xml:id="slemicro-cockpit-55-further">
<structure renderas="article" xml:id="sles-cockpit">
<merge>
<title>Administering &productname; Using &cockpit;</title>
<!-- History -->
<revhistory xml:id="rh-slemicro-cockpit">
<revision><date>2024-11-01</date>
<revhistory xml:id="rh-sles-cockpit">
<revision><date>2025-02-01</date>
<revdescription>
<para>
Initial version
Expand All @@ -191,9 +191,7 @@ type="application/relax-ng-compact-syntax"?>
</meta>
<!-- Productname & Version -->
<meta name="productname">
<productname version="5.5">&slem;</productname>
<productname version="6.0">&slem;</productname>
<productname version="6.1">&slm;</productname>
<productname version="16.0">&sles;</productname>
</meta>
<!-- Social Media -->
<meta name="title">Administering &productnameshort; using &cockpit;</meta>
Expand All @@ -216,7 +214,7 @@ type="application/relax-ng-compact-syntax"?>
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Documentation</dm:component>
<dm:product os="slmicro">SUSE Linux Micro 6.1</dm:product>
<dm:product os="sles">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
Expand Down Expand Up @@ -254,7 +252,7 @@ type="application/relax-ng-compact-syntax"?>
<term>GOAL</term>
<listitem>
<para>
You will be able to administer your system using &cockpit;;.
You will be able to administer your system using &cockpit;.
</para>
</listitem>
</varlistentry>
Expand All @@ -263,7 +261,7 @@ type="application/relax-ng-compact-syntax"?>
<listitem>
<para>
To fully administer the system using &cockpit;, you must have
&rootuser; access or &sudo; privileges.
&sudo; privileges.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -496,12 +494,13 @@ type="application/relax-ng-compact-syntax"?>
</abstract>
</merge>
</module>
<module renderas="section" resourceref="_cockpit-creating-users"/>
<module renderas="section" resourceref="_cockpit-creating-users">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module renderas="section" resourceref="_cockpit-creating-groups"/>
</module>
<module renderas="section" resourceref="_cockpit-managing-services">
Expand All @@ -519,93 +518,79 @@ type="application/relax-ng-compact-syntax"?>
</module>
<module renderas="section" resourceref="_cockpit-creating-timers"/>
</module>
<module os="slemicro" renderas="section" resourceref="_cockpit-selinux">
<module renderas="section" resourceref="_cockpit-selinux">
<module renderas="section" resourceref="_cockpit-troubleshooting-selinux">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module renderas="section" resourceref="_cockpit-system-update">
<module renderas="section" resourceref="_cockpit-managing-updates">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module renderas="section" resourceref="_cockpit-performing-rollback">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
</module>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</structure>

<structure renderas="article" xml:id="slemicro-cockpit-54">
<structure renderas="article" xml:id="slmicro-cockpit">
<merge>
<title>Administering &productname; using &cockpit;</title>
<revhistory xml:id="rh-slemicro-cockpit-54">
<revision><date>2023-05-15</date>
<title>Administering &productname; Using &cockpit;</title>
<!-- History -->
<revhistory xml:id="rh-slmicro-cockpit">
<revision><date>2024-11-01</date>
<revdescription>
<para>
Initial version
</para>
</revdescription>
</revision>
</revhistory>

<!-- Maintainer -->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<!-- ISO date of last update as YYYY-MM-DD -->
<meta name="updated" content="2024-04-13"/>
<!-- enter the platform identifier or list of comma-separated list of identifiers -->
<!-- Architecture -->
<meta name="architecture" its:translate="no">
<phrase>&x86-64;</phrase>
<phrase>&power;</phrase>
<phrase>&zseries;</phrase>
<phrase>&aarch64;</phrase>
</meta>
<!-- enter product name and version -->
<meta name="productname" its:translate="no">
<productname version="5.4">&slem;</productname>
<!-- Productname & Version -->
<meta name="productname">
<productname version="5.5">&slem;</productname>
<productname version="6.0">&slem;</productname>
<productname version="6.1">&slm;</productname>
</meta>
<!-- SEO and social media -->
<!-- Social Media -->
<meta name="title">Administering &productnameshort; using &cockpit;</meta>
<meta name="description">
An administration guide that describes how to manage &productnameshort; using the &cockpit; web interface.
</meta>
<meta name="social-descr">
Administering using &cockpit;
</meta>
<!-- suitable category, comma-separated list of categories -->

<!-- Search -->
<meta name="social-descr">Administering using &cockpit;</meta>
<!-- Task -->
<meta name="task" its:translate="no">
<phrase>Configuration</phrase>
<phrase>Storage</phrase>
<phrase>Maintenance</phrase>
<phrase>Administration</phrase>
</meta>
<meta name="series" its:translate="no">Product &amp; Solutions</meta>
<!-- Series -->
<meta name="series" its:translate="no">Products &amp; Solutions</meta>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Documentation</dm:component>
<dm:product os="slemicro" condition="5.4">SUSE Linux Enterprise Micro 5.4</dm:product>
<dm:product os="slmicro">SUSE Linux Micro 6.2</dm:product>
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>TOPIC</term>
<term>WHAT?</term>
<listitem>
<para>
From basic system overview, over storage management to keeping
Expand All @@ -615,14 +600,30 @@ type="application/relax-ng-compact-syntax"?>
</listitem>
</varlistentry>
<varlistentry>
<term>INTENTION</term>
<term>WHY?</term>
<listitem>
<para>
This article is intended to provide a complete overview of
tasks that can be performed from the &cockpit; Web interface.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
You will be able to administer your system using &cockpit;;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
Expand Down Expand Up @@ -655,6 +656,21 @@ type="application/relax-ng-compact-syntax"?>
<para/>
</abstract>
</merge>
<module renderas="section" resourceref="_cockpit-authentication-basics">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module renderas="section" resourceref="_cockpit-adding-2fa"/>
<module renderas="section" resourceref="_cockpit-allow-rootlogin">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module renderas="section" resourceref="_cockpit-primary-servers">
<merge>
<abstract>
Expand Down Expand Up @@ -815,7 +831,28 @@ type="application/relax-ng-compact-syntax"?>
</abstract>
</merge>
</module>

<module renderas="section">
<merge>
<title>Pods management</title>
<abstract>
<para/>
</abstract>
</merge>
<module renderas="section" resourceref="_cockpit-creating-pods">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module renderas="section" resourceref="_cockpit-adding-containers-pods">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
</module>
<module renderas="section" resourceref="_cockpit-user-management">
<module renderas="section" resourceref="_cockpit-modifying-accounts">
Expand All @@ -831,7 +868,7 @@ type="application/relax-ng-compact-syntax"?>
<para/>
</abstract>
</merge>

<module renderas="section" resourceref="_cockpit-creating-groups"/>
</module>
<module renderas="section" resourceref="_cockpit-managing-services">
<merge>
Expand All @@ -848,7 +885,15 @@ type="application/relax-ng-compact-syntax"?>
</module>
<module renderas="section" resourceref="_cockpit-creating-timers"/>
</module>
<module renderas="section" resourceref="_cockpit-selinux"/>
<module os="slemicro" renderas="section" resourceref="_cockpit-selinux">
<module renderas="section" resourceref="_cockpit-troubleshooting-selinux">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module renderas="section" resourceref="_cockpit-system-update">
<module renderas="section" resourceref="_cockpit-managing-updates">
<merge>
Expand Down
17 changes: 5 additions & 12 deletions concepts/cockpit-about-cockpit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
download container images and run containers
</para>
</listitem>
<listitem>
<listitem os="slemicro">
<para>
update the server
</para>
</listitem>
<listitem os="slemicro">
<listitem>
<para>
manage the server storage
</para>
Expand Down Expand Up @@ -77,22 +77,15 @@
inspect and interact with &systemd; services
</para>
</listitem>
<listitem os="slemicro">
<listitem>
<para>
switch between &selnx; modes
</para>
</listitem>
<listitem>
<para>
use a terminal on a remote server in your web browser
use a terminal on a remote server in your Web browser
</para>
</listitem>
</itemizedlist>
<tip os="alp-dolomite">
<para>
To extend &cockpit;'s functionality, you can enhance it with new
applications available at
<link xlink:href="https://cockpit-project.org/applications.html"/>.
</para>
</tip>
</itemizedlist>
</topic>
Loading