IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2024-12-23 07:33:27 -06:00
Code Issues Packages Projects Releases Wiki Activity
8084b94c17
freeipa/doc/designs/template.md
Florence Blanc-Renaud 5edf144a7e Doc: add a design template 
Add a template for new features in doc/designs/template.md
The template is excluded from automatic doc generation.

Signed-off-by: Florence Blanc-Renaud <flo@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
2021-09-14 14:58:33 -04:00

3.0 KiB
Raw Blame History

Feature name

Overview

Short overview of the problem set and any background material or references one would need to understand the details.

Use Cases

Walk through one or more full examples of how the feature will be used. These should not all be the simplest cases.

How to Use

This a starting point for design discussions.

Easy to follow instructions how to use the new feature according to the use cases described above. FreeIPA user needs to be able to follow the steps and demonstrate the new features.

The chapter may be divided in sub-sections per Use Case.

Design

The proposed solution. This may include but is not limited to:

For other hints what to consider see general considerations page.

Implementation

Any implementation details you would like to spell out. Describe any technical details here. Make sure you cover

  • Dependencies: any new dependencies that FreeIPA project packages would gain and that needs to be packaged in distros? The proposal needs to be carefully reviewed, so that FreeIPA dependency size does not increase without strong justification.
  • Backup and Restore: any new file to back up or change required in Backup and Restore?

If this section is not trivial, move it to /Implementation sub page and only include link.

Feature Management

UI

How the feature will be managed via the Web UI.

CLI

Overview of the CLI commands. Example:

Command Options
config-mod --user-auth-type=password/otp/radius
user-mod --user-auth-type=password/otp/radius --radius=STR --radius-username=STR

Configuration

Any configuration options? Any commands to enable/disable the feature or turn on/off its parts?

Upgrade

Any impact on upgrades? Remove this section if not applicable.

Test plan

Test scenarios that will be transformed to test cases for FreeIPA Continuous Integration during implementation or review phase. This can be also link to source in pagure with the test, if appropriate.

Troubleshooting and debugging

Include as much information as possible that would help troubleshooting:

  • Does the feature rely on existing files (keytabs, config file...)
  • Does the feature produce logs? in a file or in the journal?
  • Does the feature create/rely on LDAP entries?
  • How to enable debug logs?
  • When the feature doesn't work, is it possible to diagnose which step failed? Are there intermediate steps that produce logs?