Paketmanagement der CDB-Tools¶

Die CDB-Tools sind eine Umgebung in der zusätzliche Software in CDB Prozessen bereit gestellt werden kann. Einiges wird bereits in der Standard-Installation der CDB-Tools bereit gestellt, anderes kann individuell nachinstalliert werden. Die CDB-Tools Umgebung bietet im Kern zwei unterschiedliche Methoden zur Installation zusätzlicher Software:

Zusätzliche Python Pakte: bereitgestellt über PyPi (pip)
Zusätzliche Software: bereitgestellt über die CDB-Tools Entwicklung

Python Pakte der CDB-Tools¶

Python Pakete werden mit dem Kommando pip installiert. Es existiert ein pip in der CDB-Installation und ein weiteres pip in der CDB-Tools Umgebung. In der CDB-Tools Umgebung (z.B. winShortcuts/tools-sh.bat):

C:\share\cdb_cust_dev
[CDBTools]$ pip --version
pip 19.0.3 from C:\share\cdb-tools\py27\Python27\site-packages\pip (python 2.7)

Die CDB-Tools beziehen bereits diverse Pakete über PyPi, die in der cdb-tools/bootstrap/requirements.txt Datei aufgelistet sind. Um die CDB-Instanz resp. die CDB-Software nicht zu manipulieren muss die Installation der Pakete immer in das User-Scheme (PYTHONUSERBASE) der Laufzeitumgebung erfolgen.

[CDBTools]$ pip install --user <package-name>

Hinweis

Bei der Verwendung von pip install in den CDB-Tools sollte immer die Option --user verwendet werden. Bei unsachgemäßer Installation von Paketen mit pip kann es passieren, dass in die CDB-Software installiert wird, deshalb immer erst mal in einem unkritischen System testen!

In der CDB-Tools Umgebung ist die PIP_CONFIG_FILE% Variable gesetzt. Die pip.ini Konfiguration liegt unter cdb-tools/bootstrap/pip.ini:

[CDBTools]$ echo %PIP_CONFIG_FILE%
C:\share\cdb-tools\bootstrap\pip.ini

Python Pakete in CDB¶

Ab CDB-15 ist auch ein pip in CDB enthalten. Dieses wird nicht von den CDB-Tools genutzt, die haben ihr eigenes pip resp. Paketmanagement. In einer Standard CDB-Installation (z.B. winShortcuts/cdb-sh.bat):

[cdbsrv-11.3.10:cust_dev] C:\share\cdb_cust_dev> pip --version
pip 9.0.1 from C:\share\contact\cdbsrv-11.3.10\lib\site-packages (python 2.7)

Warnung

In dem Plattform Handbuch von CDB wird dieses pip vorgestellt, dort werden auch die Einschränkungen erwähnt. Mit diesem pip wird in die CDB-Software resp. in den CDB-Instanz installiert. Bei dem pip aus CDB muss der Schalter --target mit angegeben werden, sonst werden die Pakete in den CDB-Software Ordner installiert. Werden (neue) Python Pakete damit installiert, so kann es sein, dass deren Abhängigkeiten aktuelle Versionen von Python Paketen benötigen, die bereits mit der CDB-Software ausgeliefert werden. Diese werden dann ebenfalls im target Ordner installiert. Damit wird dann auch die CDB-Software resp. die Standard CDB-Umgebung verändert, da nun auch die CDB Module (ungetestet) diese neuen Bibliotheken nutzen.

Die CDB-Tools Umgebung wurde entwickelt um genau das zu vermeiden (non-Invasiv) und um eine klare Trennung zwischen CDB-Standard Umgebung und einer erweiterten Umgebung zu haben. Deshalb ist es im allgemeinen zu empfehlen, das pip aus den CDB-Tools zu verwenden, siehe „Python Pakte der CDB-Tools“.

Tipp

Egal ob CDB oder CDB-Tools, wenn Sie auch bei unsachgemäßer Nutzung sicher vermeiden wollen, dass Manipulationen an der CDB-Software sattfinden, dann müssen Sie den CDB -Admins bzw. -Entwicklern die Schreibberechtigungen auf den CADDOK_RUNTIME Ordner entziehen.

Softwarepakete der CDB-Tools¶

Die CDB-Tools stellen über die Releases ergänzende Software Pakete zur Verfügung. Um diese Pakete zu installieren muss die CDB-Tools Umgebung aktiv sein (entweder über tools-sh oder in einer normalen Shell aktivieren):

C:\share\cdb-tools> win_bin\cdbtools-activate.bat
...

Der Download und die Installation der Pakete wird mit dem Skript cdb-tools/bootstrap/build.py durchgeführt, hier ein Beispiel bei dem das ConEmu.zip Paket aus den Releases heruntergeladen und installiert wird:

C:\share\cdb-tools
[CDBTools]$ python bootstrap/build.py install-software ConEmu.zip
install:  win_bin\ConEmu
          C:\share\cdb-tools\dist\sw-download\ConEmu.zip
missing: ConEmu.zip
download: https://github.com/return42/cdb-tools/releases/download/v1.1/ConEmu.zip ...
download: ConEmu.zip[7.8 MB][======================================================] 100%
  ConEmu.zip already installed
  --> to update first remove: C:\share\cdb-tools\win_bin\ConEmu
  --> ..........
  --> ConEmu.zip: pe.t64.map          [============================================] 100%
install: win_bin\ConEmu OK

Hinweis

Das ConEmu.zip Paket ist bereits in dem cdb-tools.zip der Releases enthalten und braucht i.d.R. nicht nochmal installiert werden. Es soll hier lediglich als ein Beispiel dienen.

In dem Beispiel ist zu sehen, dass zuerst der Download erfolgt, danach wird versucht das Paket zu installieren. Sofern bereits ein solches Paket installiert ist muss dieses erst entfernt werden (einfach löschen oder umbenennen). Der Download erfolgt in den Ordner dist/sw-download und kann auch separat ausgeführt werden (siehe command: get-software).

[CDBTools]$ python bootstrap/build.py --help

usage: build.py [-h] [--debug] [--verbose] [--quiet]  <command> ...

CDB-Tools build maintenance script

optional arguments:
  -h, --help            show this help message and exit
  --debug               run in debug mode (default: False)
  --verbose             run in verbose mode (default: False)
  --quiet               run in quiet mode (default: False)

<command>:

    get-pypkgs          download python requirements (pip download)
    install-pypkgs      install python requirements (pip download)
    get-software        get software archieves (ZIP)
    install-software    install software archieves (ZIP)
    dist                build distribution

Paketmanagement der CDB-Tools¶

Python Pakte der CDB-Tools¶

Python Pakete in CDB¶

Softwarepakete der CDB-Tools¶

Project Links

Navigation