Skip to content

Expand non-quick installation content #410

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.

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

Open
wants to merge 50 commits into
base: main
Choose a base branch
from

Conversation

tahliar
Copy link
Collaborator

@tahliar tahliar commented Aug 28, 2024

PR creator: Description

Adding a full deployment guide Expanding the Admin Guide installation content so that all the options are clear. This does not replace the Installation and Setup Quick Start, which has a different use case.

This is an expansion of the installation content for 15 SP7. It can be fine-tuned even further (and crossover with SAP more) in SLE 16, which has a whole new structure that makes sharing content easier.

Here's a PDF of the Admin Guide as a whole:
book-administration_en.pdf
For the most part I made changes to Part I: Installation and setup, but I did make a few changes in other parts too. I'll add a section below that goes into greater detail about the changes, since the diff is too big to be coherent.
See Summary of changes below.

This was a long-term project and therefore needed to be rebased regularly, so the commit dates in this PR do not reflect reality.

I originally kept track of the relevant product changes for each SP, but I've decided that it doesn't make sense to backport this, both because of complexity and to avoid issues with the localised content in earlier versions.

PR creator: Are there any relevant issues/feature requests?

  • jsc#PED-2842

PR creator: Which product versions do the changes apply to?

When opening a PR, check all versions of the documentation that your PR applies to.

  • SLE-HA 15
    • 15 next (current main, no backport necessary)
    • 15 SP6
    • 15 SP5
    • 15 SP4
    • 15 SP3
    • 15 SP2
  • SLE-HA 12
    • 12 SP5

PR reviewer only: Have all backports been applied?

The doc team member merging your PR will take care of backporting to older documents.
When opening a PR, do not set the following check box.

  • all necessary backports are done

Summary of changes

Main change: major expansion of the content in "Part I: Installation and setup"

For this I'll attach a PDF, as it's a whole Part. This PDF contains only Part I:
part-install_en.pdf

New content

  • Added a new chapter "2 Installation overview". This gives an introduction to the rest of the chapters in this part, i.e. the high-level procedure for setting up a cluster.
  • Added a new chapter "4 Logging in to the cluster nodes". Before installing anything, this explains the root vs sudo user options, and SSH agent forwarding.
  • Added a new chapter "6 Using the bootstrap scripts". This goes into detail about crm cluster init and crm cluster join, with options beyond just the quickstart defaults. It also includes a quick section on crm cluster remove.
  • Added a new section "7.4 Configuring an arbitrator for quorum decisions" because the QDevice window in YaST wasn't documented before.

Edited content

  • Slightly restructured chapter "1 Product overview", including making STONITH stand out more in section "1.4 Architecture".
  • Slightly restructured chapter "7 Using the YaST cluster module" to follow the initial wizard better, but moved the non-YaST parts to the end (i.e. transferring the config to all nodes and starting the cluster).
  • Tested and updated all sections in chapter "7 Using the YaST cluster module".
  • Moved AutoYaST to a separate chapter "8 Deploying nodes with AutoYaST".

Minor change: Updated/edited sections of "Part II: Configuration and administration"

This is new content to explain more of the post-installation functions of crm cluster init that weren't already documented.

Note that the syntax highlighting in the HTML render is a bit odd right now, but that's a style sheet issue.

  • In section "9.5.1 User privileges and authentication":

image

  • In section "9.5.11 Managing Corosync configuration":

image

@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from f0c2eb9 to 18d2861 Compare September 19, 2024 03:36
@tahliar tahliar changed the title WIP: Full install guide WIP: Expand non-quick installation content Sep 20, 2024
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from 99fc267 to 8a95d11 Compare October 2, 2024 07:14
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from f91880c to 79f6ac1 Compare October 10, 2024 06:30
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch 2 times, most recently from 1a27bea to eef8b5d Compare October 30, 2024 02:46
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch 2 times, most recently from 93151d1 to add6e76 Compare November 29, 2024 06:02
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch 3 times, most recently from 3bbdb21 to 2ae0bd9 Compare December 6, 2024 07:15
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from 2ae0bd9 to 707faca Compare January 29, 2025 03:56
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from 468a431 to b9248d2 Compare March 13, 2025 05:07
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from 74fcac9 to b023560 Compare March 26, 2025 04:02
@tahliar tahliar marked this pull request as ready for review March 26, 2025 06:39
@tahliar tahliar changed the title WIP: Expand non-quick installation content Expand non-quick installation content Mar 26, 2025
@tahliar tahliar force-pushed the PED-2842-full-install-guide branch from a3431c9 to 8baa4fe Compare April 14, 2025 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant