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.

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

docs: add glossary for Adsys #169

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
50 changes: 46 additions & 4 deletions adsys/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,49 @@ concepts, tools or packages that a Windows users might
not be familiar with.
-->

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe some other ones to consider adding:

  • gnome (note that this is more relevant to the desktop use-case)
  • domain controller
  • active directory
  • administrative templates
  • group policies
  • adwatchd
  • dconf
  • Ubuntu Pro (some features require Pro)

Could perhaps add an entry for server and client, just explaining that with respect to ADSys the serve is Windows Server and the clients are Ubuntu desktops and servers.

this glossary will be implemented in myst, and the syntax is:

definition:

:::{glossary}
MyST
: An amazing markup language that supports glossaries
:::
reference:

You can use {term}`MyST` to create glossaries.

see: https://mystmd.org/guide/glossaries-and-terms

* AppArmor: ...
* Polkit: ...
* sudo: ...
* ...
- [**adcli**](https://manpages.ubuntu.com/manpages/xenial/man8/adcli.8.html): A command-line tool for managing Active Directory (AD) domain membership on Linux.
- **Adsys**: A tool that allows system administrators to manage Ubuntu machines using Microsoft Active Directory (AD).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Adsys**: A tool that allows system administrators to manage Ubuntu machines using Microsoft Active Directory (AD).
- **ADSys**: A tool that allows system administrators to manage Ubuntu machines using Microsoft Active Directory (AD).

- [**adsysctl**](https://documentation.ubuntu.com/adsys/en/latest/reference/adsysctl-cli/): A command-line utility for interacting with the Adsys service in Ubuntu.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [**adsysctl**](https://documentation.ubuntu.com/adsys/en/latest/reference/adsysctl-cli/): A command-line utility for interacting with the Adsys service in Ubuntu.
- [**adsysctl**](https://documentation.ubuntu.com/adsys/en/latest/reference/adsysctl-cli/): A command-line utility for interacting with the ADSys service in Ubuntu.

- **apt (Advanced Package Tool)**: A package management system used in Debian-based distributions like Ubuntu to install, update, and remove software.
- [**AppArmor**](https://documentation.ubuntu.com/server/how-to/security/apparmor/): A Linux security module that enforces mandatory access control policies on programs to limit their capabilities.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good and nice use of a link too.

make sure for other example, such as gsettings and dconf, that you consider whether there is any appropriate link that could be provided within the docs.


- **buffer**: A temporary data storage area used to manage data flow between processes, hardware, or networks.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe this is not needed?

seems like a very general term.


- [**certmonger**](https://manpages.ubuntu.com/manpages/focal/man8/certmonger.8.html): A service that monitors and renews certificates, commonly used in enterprise environments.

- **D-Bus call**: A command or API request used to communicate with system services via D-Bus, a message bus system for interprocess communication.
- **Daemon**: A background process that runs continuously to provide system services.

- **FISH (Friendly Interactive Shell)**: A user-friendly command-line shell with syntax highlighting, autosuggestions, and other advanced features.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if this is needed.

multiple shells are mentioned (zsh, bash, fish)

- **FQDN (Fully Qualified Domain Name)**: A complete domain name that specifies the exact location of a device within the DNS hierarchy.

- **getcert**: A command-line tool used to request, monitor, and renew security certificates, often used with certmonger.
- **GSettings**: A system for storing application and desktop settings in GNOME-based environments.
- **GVfs (GNOME Virtual File System)**: A user-space virtual filesystem that provides access to remote locations, such as FTP, SMB, and Google Drive.

- **kernel**: The core of an operating system that manages hardware and system resources.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably not needed -- general concept.

only mentioned twice.

- **Kerberos**: A network authentication protocol that uses tickets to securely authenticate users and services.

- **LDAP (Lightweight Directory Access Protocol)**: A protocol for accessing and managing directory information, commonly used for authentication.

- **Mount Managers**: Tools or processes that handle the mounting and unmounting of filesystems on Linux.
- **mounts**: The process of attaching a filesystem to a specific directory in the Linux file hierarchy.

- **PAM (Pluggable Authentication Modules)**: A framework for integrating various authentication methods into Linux systems.
- [**Polkit**](https://manpages.ubuntu.com/manpages/focal/man8/polkit.8.html): A toolkit for defining and handling system-wide privileges in Linux.
- **proxy**: A server or service that acts as an intermediary for network requests, often used for filtering or caching.

- **realmd**: A service that allows automatic discovery and enrollment of Linux machines into Active Directory or other identity domains.

- **Samba**: A software suite that enables file and print sharing between Linux and Windows systems using the SMB/CIFS protocol.
- **Security Identifier (SID)**: A unique identifier assigned to users, groups, and other objects in Windows-based systems.
- **SSSD (System Security Services Daemon)**: A service that manages authentication and authorization with identity providers like Active Directory or LDAP.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for something like this you could mention that ADSys works with SSSD and provide a link to an explanation: https://documentation.ubuntu.com/adsys/en/stable/explanation/adsys-ref-arch/

- **sudo**: A command that allows users to run programs with elevated (superuser) privileges.
- **systemd**: A modern system and service manager for Linux, responsible for initializing and managing system processes.
- **systemd journal**: A logging system that collects and organizes system logs for troubleshooting and auditing.

- **Ubiquity installer**: The default graphical installer for Ubuntu, designed to simplify OS installation.

- **visudo**: A command used to safely edit the sudoers file, which controls user permissions for executing commands with elevated privileges.

- **Winbind**: A component of Samba that allows Linux systems to authenticate users against a Windows domain.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could say that this can be used instead of SSSD for authentication.