Regarding mailing list email Simon:

Chapter layout

Doesn't seem to make it clear that it's trying to describe salt-based configuration management, and the traditional configuration management. It's post-fixing some stuff with "[Management]" but that's not very clear what it means.

Required Changes

• Doesn't have an icon for the salt-type configuration files. again, references to [management]
• Clarify management types (Management and Salt) Agreed this is confusing!

It would be advisable to document the task minion-action-cleanup on our documentation.

Document all fucntions containing the activationkey_ prefix.

Best Practices does not document the $ifEmpty and $optional attributes which has been shipped in these formulas:

• bind-formula ($ifEmpty is only used here)
• dhcpd-formula
• saltboot-formula

In particular I am confused what the precise relationship between $default, $optional, and $ifEmpty is.
$ifEmpty was implemented in https://github.com/SUSE/spacewalk/pull/4261 .

For context, I need this because YaST is adding support for Salt Formulas: FATE#32722

Right now it reads:

Multi-core 64-bit CPU

Problem

We are having situations where a 2 core CPU, with each core at 1800Mhz is not enough, and we get ISE at some situations because of ProxyTimeouts waiting HTTP responses while playing with the products page at the same time reposync is running.

So the question is: would we support a customer running an Intel Celeron x86_64 with 2 cores, as long as memory and storage are OK?

For example the Celeron 2970M from 2014 (https://ark.intel.com/products/81014)

This is even more critical for Uyuni, as I am pretty sure that some users will be using consumer grade hardware for testing.

Solution

Not clear, but as a minimum, maybe we should specify the number of cores (as we do for PowerPC):

Minimum 4 dedicated cores

I am not so sure about the frequency :-(

But anyway, I think this is something to be discussed with engineering as well.

I have noticed an error in the port table in the SUSE Manager documentation:

link: https://www.suse.com/documentation/suse-manager-3/book_suma_getting-started_31/data/sect1_2_chapter_book_suma_getting-started_31.html

Correction:

In the port table:

Incorrect: 4505 and 4506 are listed as inbound and outbound

Correct: 4505 and 4506 are inbound only
Notes: The salt master never initiates a connection to the minions.

Richard

Docs need to be copied from 2.1 xml sources and places in 3.0/3.1 xml sources.

• Added to head listed in AT book command-line-tools.adoc https://github.com/SUSE/doc-susemanager/blob/develop/adoc/command-line-tools.adoc#command-line-tools
• Add to 3.0 sources (XML)
• Add to 3.1 sources (XML)

The SUSE Manager 3 Reference Manual still references up2date which was the old package manager used by Red Hat on RHEL 4 in 2005 and never used in a SUSE product. Any reference to it should probably be changed to Zypper or Yum. See https://www.suse.com/documentation/suse-manager/singlehtml/book_suma_reference_manual/book_suma_reference_manual.html for examples.

rhnpush -> mgr-push
rhn-virtualization -> mgr-virtualization
rhn-custom-info -> mgr-custom-info
osad -> mgr-osad
rhncfg -> mgr-cfg
spacewalksd -> mgr-daemon

Details at https://github.com/SUSE/spacewalk/pull/5375 (stil WIP)

Keep in mind those are build service packages, which means they will generate subpackages (the real RPM).

According to @Loquacity some changes will be required.

Ping me if you need more details.

https://github.com/SUSE/spacewalk/issues/6059

We need a note in the activation key section that you can also bootstrap salt minions.

Previously, an empty profile was assigned to a HW type group matching to its manufacturer and product grains on registration.

After https://github.com/SUSE/spacewalk/pull/6148 is merged, this group assignment is skipped if the empty profile is already assigned to some HW type group (a server group with name with HWTYPE: prefix).

We need to clarify when to use db5 replacement macros and which ones are available.

Create a table in the guide adding the available geekodoc macros, for example:

[filename]/etc/hosts
[literal]This is a literal string

There is a patch currently being reviewed that will introduce a mechanism to cleanup expired notification messages after a configurable lifetime (default still under review, probably 30 or 60 days). This might need to be mentioned in the docs, I guess:

https://github.com/SUSE/spacewalk/pull/6239

Best Practices - FIle Overview description contains some confusing documentation examples about custom formula directories, i have added just two comments for trying to make it more clear.

Metadata Directory

Custom metadata (information) need to be placed in:

# Replacing `custom` by `custom-formula-name` as it is already documented in other examples probably would be less confusing
/srv/formula_metadata/custom/

All custom folders located in the following directories needs to contain a form.yml file. These files are detected as form recipes and may be applied to groups and systems from the Web UI:

# Is this path correct? it seems that `salt` was added by error or confusion with the states directories
/srv/salt/formula_metadata/custom-formula-name/form.yml

Public cloud document is a little wordy, and should be cleaned up with adoc block structures.

Just creating this card, so we don't forget to document this:

• https://github.com/SUSE/spacewalk/pull/5415
• https://github.com/SUSE/spacewalk/pull/5673
• https://github.com/SUSE/spacewalk/pull/5845.

At the moment I don't know how much we need to document (and even where 😄 the feature overlaps with Retail). I need to discuss this with @aaannz and @jcayouette .

Lana found a bug in how the pdf procedure is rendering, we are not sure if it is due to xslt, or to a formatting issue.

Explore the correct way to make a procedure then check to see how it is rendered in html and pdf.

Add missing help entities to reference > help

Best Practices does not document the $key attribute which has been shipped in these formulas:

• bind-formula
• dhcpd-formula
• saltboot-formula

For context, I need this because YaST is adding support for Salt Formulas: FATE#32722

There is a note in the gs on using the bootstrap script for registering Salt client, however we need to add that activation keys can now be used in the script as well.

• Add entry to BP activation keys
• Update registering salt clients in GS

We missed the License inclusion during the xml -> adoc migration. It has been converted, but we need to simply link the license to the LICENSE document in our publishing repos.

https://docreview.nue.suse.com/assets/docs/ref.webui.admin.html#ref.webui.admin.schedules
<- token cleanup is not listed here, maybe we should add it?

The current Salt GS is the first draft, it needs revision for clarity.

• We should provide more examples
• Images of some terminal commands in action
• Manager specific Salt use cases