Large Deployments Guide
The Information Plan … is the primary document you will use to plan how to manage the publications project, providing the basis for your preliminary estimates of the schedule and budget needed to complete the project.
We have two problems that require solving:
-
The new Hub feature has some draft documentation being created that is quite lengthy (https://github.com/uyuni-project/uyuni-docs/pull/166)
-
The Salt Guide currently houses some large scale deployment and tuning content that doesn’t really belong there (https://opensource.suse.com/doc-susemanager/suse-manager/salt/large-scale.html)
This draft Information Plan is to determine if a new "Large Deployment Guide" could be used for this content.
The Project Plan takes the creative ideas of the Information Plan and sets a course for their development … A Project Plan that carefully specifies what can be built in the allotted time and at the designated level of quality removes some of the risk.
This project would be mostly focused on writing/editing the new Hub content. Additionally, a new book would be created in the suite, called the "Large Deployments Guide" and the relevant chapters from the Salt Guide moved into, possibly including some light editing/rearranging. There is also some planned content around monitoring large scale installations which could be a potential future candidate for this document.
-
Introduction to large scale deployment (From Salt Guide)
-
Define 'large scale'
-
Hardware/Infra reqs
-
Define single server vs hub vs SMR
-
-
Using a single Server to manage large scale deployments (Salt Guide)
-
Operation reqs
-
(Ask Moio for more?)
-
-
Using multiple Servers to manage large scale deployments (Hub)
-
Installation
-
Using the API
-
Namespaces
-
Authentication modes
-
-
Managing large scale deployments in a Retail environment
-
Basic overview, link to SMR Guide
-
-
Tuning large scale installations (Salt Guide)
-
Monitoring large scale installations (TBD https://github.com/SUSE/spacewalk/issues/10780)
Ideally, this work will be completed for the release of SUSE Manager 4.1, however that may not be possible due to other project constraints. More realistically, an initial documentation release in a 4.1 MU could be targeted.
Budget is not being tracked for this project.
No additional technical resources are required at this stage, as existing test suites and equipment can be used.
The project will require only the existing documentation team members.
| Milestone | Start | End |
|---|---|---|
Phase 1 |
||
Phase 2 |
||
Phase 3 |
||
Phase 4 |
||
Phase 5* |
Note that Phase 5 is an evaluation phase, and can be completed after publication. This plan assumes a TBD release date.
-
Joseph Cayouette: Tool-chain and production
-
Lana Brindley: Writing and project management
-
Karl Eichwalder: (80%) Writing assistance
Note that other documentation tasks are of greater importance than this project, and will always be prioritised.
-
Document to be distributed internally to both the SUSE Manager and general documentation teams for review prior to release
-
Limited beta review period for Uyuni community members and VIP SUSE Manager customers using the opensource.suse.com site.
