Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
2 changes: 1 addition & 1 deletion docker/manage-secrets.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases\n"
f"SECRET_KEY='{netbox_secret_key}'\n"
"SKIP_SUPERUSER=false\n"
"SUPERUSER_EMAIL='noreply@example.org'\n"
"SUPERUSER_EMAIL='noreply@orthos2.test'\n"
"SUPERUSER_NAME='admin'\n"
f"SUPERUSER_PASSWORD={netbox_superuser_password}\n"
"WEBHOOKS_ENABLED=true\n"
Expand Down
2 changes: 1 addition & 1 deletion docker/orthos/devel-server.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ exit(0 if Machine.objects.filter(fqdn='testmachine.orthos2.test').exists() else
python3.11 manage.py shell -c "
from django.contrib.auth.models import User
exit(0 if User.objects.filter(username='admin').exists() else 1)
" || DJANGO_SUPERUSER_PASSWORD="$ORTHOS2_SUPERUSER_PASSWORD" python3.11 manage.py createsuperuser --noinput --username admin --email admin@example.com
" || DJANGO_SUPERUSER_PASSWORD="$ORTHOS2_SUPERUSER_PASSWORD" python3.11 manage.py createsuperuser --noinput --username admin --email admin@orthos2.test
python3.11 manage.py shell </code/docker/orthos/django-generate-admin-token
python3.11 manage.py runserver 0.0.0.0:8000
}
Expand Down
3 changes: 1 addition & 2 deletions docs/adminguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Administrator`s Guide

These pages are partly very technical. You should read the User Guide before to understand the basic concept and the goals of Orthos.
This document describes how to create and administrate groups and users, architectures, domains,
machines, machine groups, serial console types, systems and enclosures, manufacturers and device types. Furthermore, the
machines, serial console types, systems and enclosures, manufacturers and device types. Furthermore, the
administration of the Orthos server will be discussed.

.. toctree::
Expand All @@ -24,6 +24,5 @@ administration of the Orthos server will be discussed.
Systems and Enclosures <adminguide/systems_and_enclosures>
Manufacturers and Device Types <adminguide/manufacturers_and_devicetypes>
Serial Console Type <adminguide/serial_console_type>
Machine Groups <adminguide/machine_groups>
Remote Power Types <adminguide/remote_power_type>
Remote Power Devices <adminguide/remote_power_device>
12 changes: 4 additions & 8 deletions docs/adminguide/architectures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,8 @@ Contact email

Email address to the person who is the contact person for an architecture.

Write DHCPv4
============

Enable/disable writing a DHCPv4 file for this architecture.

Write DHCPv6
============
Default profile
===============

Enable/disable writing a DHCPv6 file for this architecture.
The name of the Cobbler profile used as the default installation choice for machines of this architecture when
using the "Setup Machine" action.
4 changes: 2 additions & 2 deletions docs/adminguide/domains.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,5 @@ The end of the range for auto-generated IPv6 addresses that are handed out by Or
Setup architectures
===================

Here the list of domains with their corresponding contact e-mails are being listed. If an architecture is not listed,
its machines cannot use the "Setup machine" functionality.
Here the list of architectures supported by this domain, each with a corresponding contact e-mail, is listed. If an
architecture is not listed, its machines cannot use the "Setup machine" functionality.
36 changes: 17 additions & 19 deletions docs/adminguide/groups_and_users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Concepts
########

A standard user does not belong to a group. Orthos can manage its own user base. Additionally it can also connect to an
OIDC server and add OIDC users to its local database if successfully authenticated. By default the user cannot log
in to the admin dashboard, the necessary rights must be granted by an administrator over the admin dashboard.
OIDC server and add OIDC users to its local database if successfully authenticated. By default a user has no
administrative permissions; the necessary Django model permissions (e.g. to change enclosures or machines) must be
granted by an administrator via Groups or directly on the user. Superuser-only pages (Users, Groups, Systems, Server
Configuration, etc.) additionally require superuser status, which only an existing superuser can grant.
It is possible to create a user without group membership. However, users should
be added to the appropriate groups for easier administration and permissions. Administrative permissions are set in
Orthos in such a way that everything is forbidden first, necessary rights must be set.
Expand All @@ -20,9 +22,9 @@ Orthos in such a way that everything is forbidden first, necessary rights must b
| granular administrative | ---------------------------
| permissions |-----| Users |
--------------------------- ---------------------------
| granular administrative | -------------------
| permissions |-----| Admin Dashboard |
--------------------------- -------------------
| granular administrative | -----------------------
| permissions |-----| Administrative Pages |
--------------------------- -----------------------


Groups fields description
Expand All @@ -36,10 +38,10 @@ Name of group. Please, use unique name.
Permissions
===========

Detailed Orthos administration rights. Every user in the profile must have the blalbla enabled to login to the admin
dashboard. by the name of rights, rights are self-explanatory.
Detailed Orthos administration rights, granted to every member of the group. Rights that can be assigned are
self-explanatory.

Example: ``admin | log entry | Can add log entry, data | enclosure | Can add enclosure etc.``
Example: ``data | enclosure | Can change enclosure, data | machine | Can change machine etc.``

Users fields description
########################
Expand All @@ -52,7 +54,9 @@ Name of user.
Password
========

User password, it must comply with password rules.
There is no password field when creating a user from this page. New accounts start with no usable password;
access is granted afterward by using the "Send password reset email" action on the user's detail page, or the user
can simply log in via OIDC if configured.

Active
======
Expand All @@ -62,7 +66,8 @@ Designates whether this user should be treated as active. Unselect this instead
Staff status
============

Designates whether the user can log into this admin site.
A Django built-in flag, shown as a badge and filterable on the Users list. It is not currently used to gate access
to any Orthos 2 page — administrative pages are gated by superuser status and/or Django model permissions instead.

Superuser status
================
Expand All @@ -72,13 +77,6 @@ Designates that this user has all permissions without explicitly assigning them.
Groups
======

Here users can be grouped and administrative rights can be assigned to individual groups.

User permissions
================

Detailed Orthos administration rights. Every user in the profile must have the Staff status enabled to login to the
admin dashboard. Rights that can be assigned are self-explanatory.

Example: ``admin | log entry | Can add log entry, data | enclosure | Can add enclosure etc.``
Here users can be grouped and administrative rights can be assigned to individual groups. This is the only way to
grant a user model permissions from this page; individual (per-user) permissions are not editable here.

34 changes: 22 additions & 12 deletions docs/adminguide/machine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ System (required)

The type of system of the machine.

Example: VM, BMC, BareMetal, LPAR, Desctop, RemotePower etc.
Example: VM, BMC, BareMetal, LPAR, Desktop, RemotePower etc.

Serial number/Product code/Device Type
=======================================
Expand Down Expand Up @@ -214,13 +214,6 @@ is via telnet. Access to the console runs via the CScreen srever.

Example: sconsole3.arch.suse.de

Device
======

Kernel device through which the output for the serial console runs.

Example: ttyS0, ttyS1 etc.

Port
====

Expand All @@ -233,9 +226,20 @@ A free command can be entered here.

Example: telnet sconsole3.arch.suse.de 2008

Comment
=======

Free-text comment for this serial console configuration.

REMOTE POWER description
########################

Fence Agent
===========

The Remote Power Type (fence agent) used to control power for this machine. Available choices depend on whether the
machine is a BMC, a Hypervisor, or has a Remote Power Device assigned, see :doc:`remote_power_type`.

Remote power device
===================

Expand All @@ -248,6 +252,11 @@ Port

Network port for accessing the RemotePower.

Comment
=======

Free-text comment for this remote power configuration.

Options
=======

Expand All @@ -256,10 +265,11 @@ The option to append to the fence agents call. See individual fence agent for av
Delete a machine
################

To delete a machine, choose from the machine list and press 'Delete' at the bottom of the machine view. All related
information that is also deleted together with the machine object is displayed. Press ``Yes`` to confirm. For
administrative reasons, a copy of each deleted machine object is stored in the form of a file. The format (JSON, Yaml)
as well as the target directory can be set via the server configuration.
There is no "Delete" button for a machine in the web frontend; a machine can currently only be deleted via the API
(``DELETE`` command). All related sub-objects (network interfaces, BMC, serial console, remote power, annotations,
etc.) are deleted together with the machine. If the ``serialization.execute`` key is enabled (the default), a copy of
each deleted machine object is stored in the form of a file beforehand. The format (JSON, Yaml) as well as the target
directory can be set via the server configuration.

Further configuration information can be found in the :ref:`admin-guide` (``serialization.*``).

Expand Down
64 changes: 0 additions & 64 deletions docs/adminguide/machine_groups.rst

This file was deleted.

24 changes: 22 additions & 2 deletions docs/adminguide/remote_power_device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ MAC (required)

The MAC address of the device.

Architecture (required)
========================

The CPU architecture of the power device.

Domain (required)
==================

The network domain the power device's FQDN belongs to.

Username (required)
===================

Expand All @@ -33,8 +43,18 @@ The password to login to the remote power device.
Fence Agent (required)
======================

The fence agent used. This is a choice field that shows all Orthos 2 Remote Power Types that are available for the type
"rpower".
The fence agent used. This is a choice field that shows all Orthos 2 Remote Power Types that are available for the
device kind "Remote Power Device" (internal value ``rpowerdevice``).

IPv4 Address
============

The IPv4 address of the power device, if any.

IPv6 Address
============

The IPv6 address of the power device, if any.

URL
===
Expand Down
Loading