Jan Ulrich Hasecke
2020-01-16 eaea868cdd1332671051906d64bc3c0c79aa8c23
source/referenz/hsadmin/skript.rst
@@ -1,20 +1,21 @@
.. _kap-hsscript-skript:
===========================
HSAdmin über Skript steuern
===========================
============================
HSAdmin über Skripte steuern
============================
In :numref:`kap-hsadmin-syntax` haben wir die Option :option:`-f` erwähnt, die wir setzen können, um HSAdmin eine Datei zu übergeben, in der sich die Befehle befinden.
Dies ermöglicht es uns, ohne großen Aufwand Skriptdateien zu pflegen, mit denen wir wiederkehrende Aufgaben bequem erledigen können.
In diesem Kapitel zeigen wir, wie Sie die Anlage einer neuen Wordpress-Website mit Hilfe eines solchen Skripts vereinfachen können.
Bevor man die Wordpress-Software installiert, müssen mehrere Schritte erledigt sein.
In :numref:`kap-hsadmin-syntax` wurde die Option :option:`-f` erwähnt, die gesetzt werden kann, um HSAdmin eine Datei zu übergeben, in der sich die Befehle befinden.
Die Option ermöglicht es, ohne großen Aufwand Skriptdateien zu pflegen, mit denen wiederkehrende Aufgaben bequem erledigt werden können.
Dieses Kapitel zeigt, wie Sie die Anlage einer neuen Wordpress-Website mit Hilfe eines solchen Skripts vereinfachen können.
Bevor Sie die eigentliche Wordpress-Software installiert, müssen mehrere Schritte auf der Hostsharing-Plattform erledigt sein.
1. Es existiert ein :role:`Domain-Admin` bzw. es wird ein neuer Domain-Admin angelegt.
2. Es wird eine Domain erstellt und dem Domain-Admin zugewiesen.
3. Es wird ein :role:`Datenbank-Nutzer` angelegt.
4. Es wird eine Datenbank angelegt und dem Datenbank-Nutzer zugewiesen.
Mit der folgenden Skript-Datei kann diese vier Schritte mit einem Befehl ausführen.
Mit der folgenden Skript-Datei kann man diese vier Schritte mit einem Befehl ausführen.
.. code-block:: text
   :linenos:
@@ -26,7 +27,7 @@
In Zeile 1 wird der Domain-Admin erzeugt, in Zeile 2 die Domain ``beispiel.de`` angelegt, in Zeile 3 der Datenbank-Nutzer und in Zeile 4 die Datenbank.
Es ist möglich, die Datei lesbarer zu formatieren, indem jedem Key-Value-Paar eine eigene Zeile zuweist.
Es ist möglich, die Datei lesbarer zu formatieren, indem man jedem Key-Value-Paar eine eigene Zeile zuweist.
.. code-block:: text
   :linenos:
@@ -66,13 +67,17 @@
   Beim Löschen müssen Sie die Reihenfolge umkehren: Datenbank löschen, Datenbank-Nutzer löschen, Domain löschen, Domain-Admin löschen. 
   
Noch bequemer ist es, die notwendigen Benutzer, Domains und Datenbanken mit einem JS-Skript anzulegen.
Im Folgenden zeigen wir zwei Skripts.
Noch bequemer ist es, die notwendigen Benutzer, Domains und Datenbanken mit Hilfe eines ausführlicheren JS-Skripts oder über die Python-API anzulegen.
HSAdmin mit Javascript ansprechen
=================================
Im Folgenden zeigen wir zwei JS-Skripts, die in der Regel im Verzeichnis des :role:`Paket-Admin` mit dessen Benutzerrechten aufgerufen werden.
Mit dem ersten Skript erstellen wir eine Domain und weisen ihr einen eigenen Domain-Admin zu, dessen Name aus dem Namen der Domain abgeleitet wird.
Mit dem zweiten Skript erzeugen wir eine Datenbank und einen Datenbank-Nutzer, sodass wir unter der gewünschten Domain zum Beispiel eine PHP-Anwendung wie Wordpress einrichten können.
Skript zur Erzeugung von Domain und Domain-Admin
================================================
JS-Skript zur Anlage einer Domain
---------------------------------
Ein Skript, um eine Domain mit einem gesonderten Domain-Admin anzulegen, könnte so aussehen:
@@ -85,8 +90,14 @@
Der Namen des Domain-Admin ergibt sich aus dem Namen der Domain.
Bei einer Domain, die einen Bindestrich enthält, muss dieser durch einen Unterstrich ersetzt werden, da Benutzernamen nur einen Bindestrich enthalten dürfen.
Das Skript wird folgendermaßen aufgerufen:
Das Skript wird im Benutzerverzeichnis des Paket-Admin gespeichert und ausführbar gemacht:
.. code-block:: console
   xyz00@h50:~$ chmod u+x createdomainandadmin.js
Anschließend können Sie es folgendermaßen aufrufen:
.. code-block:: console
   xyz00@h50:~$ ./createdomainandadmin.js my-domain.de
@@ -98,9 +109,8 @@
.. literalinclude:: createdomain.js
   :lines: 18
Skript zur Anlage einer Datenbank und eines Datenbank-Nutzers
=============================================================
JS-Skript zur Anlage einer Datenbank
------------------------------------
Das Skript zur Anlage einer Datenbank und eines Datenbank-Nutzers sieht ähnlich aus.
@@ -120,4 +130,104 @@
.. attention::
   Merken Sie sich die Passworte, da Sie diese später benötigen.
   Bei einer Datenbank-Anwendungen müssen Sie bei der Konfiguration den Datenbank-Benutzer und sein Passwort angeben.
   Bei einer Datenbank-Anwendungen müssen Sie bei der Konfiguration den Datenbank-Benutzer und sein Passwort angeben.
.. _kap-python-api:
Nutzung der Python-API
======================
Sie können HSAdmin auch remote über die Python-API des Programms ansprechen.
Das ermöglicht es Ihnen von einem entfernten Rechner aus HSAdmin zu bedienen.
Um mit der Python-API zu arbeiten müssen Sie zunächst die Python-Bindings für HSAdmin installieren.
Installation von hs.admin.api
-----------------------------
Wir installieren die Python-Bindings in einer virtuellen Python-Umgebung, sodass wir diese zunächst einrichten und aktivieren.
.. code-block:: console
   $ python3 -m venv /hsadmin
   $ . /hsadmin/bin/activate
Anschließend klonen wir die Python-Bindings und installieren sie.
.. code-block:: console
   $ git clone https://dev.hostsharing.net//r/ansible/hs.admin.api.git
   $ cd hs.admin.api
   $ python setup.py install
Nun steht uns das Modul mit dem Python-Bindings in der virtuellen Umgebung zur Verfügung, sodass wir es in einem Skript importieren können.
Python-Skript
-------------
Um die API in einem Skript nutzen zu können, müssen wir mit folgendem Code ein API-Objekt erzeugen.
.. literalinclude:: createdomain.py
   :linenos:
   :lines: 1-9
Nun ist es möglich, mit der üblichen Syntax HSAdmin im Skript anzusprechen.
Mit diesen beiden Befehlen legen wir beispielsweise einen Domain-Admin und eine neue Domain an.
.. literalinclude:: createdomain.py
   :lines: 11-12
Eine Datenbank lässt sich folgendermaßen anlegen.
.. literalinclude:: createuseranddb.py
   :lines: 11-12
Nun wollen wir diese Befehle in ein Skript einbauen, das noch einige andere nützliche Dinge für uns erledigt.
Reseller und Webmaster, die viele Anwendungen betreuen, buchen häufig mehrere Pakete bei Hostsharing, sodass sie gerne ein Skript hätten, dem sie auch das Kürzel für das Paket übergeben können, in dem sie eine Domain mit Datenbank einrichten möchten.
Außerdem wäre es hilfreich, wenn das Skript dafür sorgt, dass Benutzernamen und Datenbankenname immer nach einem einheitlichen Schema erzeugt werden, sodass die Orientierung leichter fällt.
In unserem Beispielskript übergeben wir daher dem Skript drei Argumente:
1. das Kürzel für das Paket
2. den Domainnamen
3. eine Projekt-ID
Die Projekt-ID darf nicht mehr als 10 Zeichen umfassen, da sie zusammen mit dem fünfstelligen Paketkürzel in den Namen für Datenbank und Datenbank-Nutzer verwendet wird. Diese dürfen aber nicht länger als 16 Zeichen sein.
Als Schema für eine Projekt-ID kommt also beispielsweise eine Kombination aus einer Kundennummer und einer Abkürzung in Frage.
Wir verwenden in unserem Beispiel dafür eine dreistellige Kundennummer und die Abkürzung ``wp`` für Wordpress.
Die Elemente trennen wir mit dem Unterstrich, da nur dieser als Namensbestandteil erlaubt ist.
Wenn wir für den Kunden mit der Kundennummer 23 im Paket ``xyz00`` eine Domain für einen Wordpress-Blog einrichten möchten, lautet der Aufruf des Skripts folgendermaßen:
.. code-block:: console
   $ python createall.py xyz00 hs-example.de 023_wp
Der Code des Skripts sieht so aus:
.. literalinclude:: createall.py
   :linenos:
In den ersten fünf Zeilen importieren wir einige Module bzw. Funktionen, die wir benötigen.
In den Zeilen 7 bis 9 lesen wir die übergebenen Argumente aus und speichern die Werte in entsprechenden Variablen.
Um das API-Objekt zu erzeugen, benötigen wir das Passwort für den übergebenen Paket-Admin.
Wir lesen in Zeile 11 das Passwort aus dem verschlüsselten Passwort-Tresor des Kommandozeilenprogramms :command:`pass` aus und speichern es in der Variablen ``pw``.
Weitere Informationen zu dem Programm finden Sie auf der Website https://www.passwordstore.org/.
Sie können natürlich andere Programme wählen, um ein Passwort aus einem Passwort-Tresor auszulesen.
Falls Sie nur ein Paket bei Hostsharing verwalten, können Sie das Passwort auch direkt ins Skript eintragen.
Aus Sicherheitsgründen sollten Sie dies möglichst vermeiden.
Anschließend erzeugt das Skript das API-Objekt, wobei es als Credentials den Namen des Paket-Admin und sein Passwort übergibt.
Der Namen des Paket-Admin ist identisch mit dem Paket, in dem die Domain angelegt werden soll.
Danach wird ein Zufallsgenerator definiert, mit die Passworte erzeugt werden, die später benötigt werden.
In Zeile 27 und 28 werden die Passworte für den Domain-Admin und  den Datenbank-Nutzer erzeugt und in Variablen gespeichert.
Direkt anschließend erzeugt das Skript aus den beim Aufruf übergebenen Werten die Namen für den Domain-Admin, den Datenbank-Nutzer und die Datenbank.
In den Zeilen 33 bis 36 werden der Domain-Admin, die Domain, den Datenbank-Nutzer und die Datenbank angelegt.
Und zum Schluss gibt das Skript alle Daten aus.
Idealerweise würde ein solches Skript die neuen Benutzernamen mit den jeweiligen Passworten in den Passwort-Tresor eintragen, sodass dies nicht mit der Hand erledigt werden muss.