Einrichten der Installationsumgebungsvariablen

Die Befehle zum Installieren und Aktualisieren IBM® Software Hub verwenden Variablen im Format ${VARIABLE_NAME}. Sie können ein Script erstellen, um die entsprechenden Werte automatisch als Umgebungsvariablen zu exportieren, bevor Sie die Installationsbefehle ausführen. Nachdem Sie das Skript bezogen haben, können Sie die meisten Installations- und Aktualisierungsbefehle aus der Dokumentation kopieren und ohne Änderungen ausführen.

Installationsphase
  • Sie sind nicht hier. Einrichten einer Client-Workstation
  • Sie sind nicht hier. Cluster einrichten
  • Sie befinden sich hier Symbol. Erfassen der erforderlichen Informationen
  • Sie sind nicht hier. Vorbereitung der Installation in einem eingeschränkten Netzwerk
  • Sie sind nicht hier. Vorbereitung der Ausführung von Installationen aus einer privaten Container-Registry
  • Sie sind nicht hier. Vorbereitung des Clusters für IBM Software Hub
  • Sie sind nicht hier. Vorbereitung zur Installation einer Instanz von IBM Software Hub
  • Sie sind nicht hier. Installation einer Instanz von IBM Software Hub
  • Sie sind nicht hier. Einrichten der control plane
  • Sie sind nicht hier. Installation von Lösungen und Dienstleistungen
Wer muss diese Aufgabe erledigen?

Betriebsteam Das IBM Software Hub Betriebsteam sollte mit dem Cluster-Administrator zusammenarbeiten, um Informationen über den Cluster zu sammeln, auf dem das IBM Software Hub System installiert werden soll.

Diese Informationen sollten an alle Benutzer weitergegeben werden, die Installations- oder Aktualisierungsbefehle ausführen, für die Informationen über Ihre Umgebung erforderlich sind, z. B. Informationen über Ihren Red Hat® OpenShift® Container Platform Cluster oder Ihre private Container-Registrierung.

Wann müssen Sie diese Aufgabe erledigen?

Wiederholen Sie dies nach Bedarf. Erstellen Sie mindestens ein Skript für Umgebungsvariablen. Je nach Anwendungsfall müssen Sie möglicherweise mehrere Skripte erstellen.

Vorbereitende Schritte

Bevor Sie ein Skript für Umgebungsvariablen erstellen, sollten Sie überlegen, welchen Anwendungsfall Sie unterstützen müssen:

Wiederholt anwendbare Implementierungen in Clustern
Wenn Sie wiederholbare Bereitstellungen über Cluster hinweg erstellen möchten, haben Sie folgende Möglichkeiten:
Option Empfohlen, wenn Sie... Weitere Hinweise
Verwenden Sie dasselbe Skript erneut Verbessern Sie die Konsistenz der Bereitstellungen in Ihren Umgebungen. Sie müssen sicherstellen, dass Sie die Cluster -Variablen ändern, bevor Sie eine Installation ausführen.
Erstellen Sie mehrere Skripte Vermeiden Sie es, das Skript für die Umgebungsvariablen zu ändern, bevor Sie eine Installation ausführen. Sie müssen sicherstellen, dass eine Änderung in einem Skript gegebenenfalls auch in die zugehörigen Skripte übernommen wird. Wenn Sie beispielsweise den Wert der PRIVATE_REGISTRY_PULL_PASSWORD Variablen in einem Skript aktualisieren, müssen Sie die Variable in allen zugehörigen Skripten aktualisieren.

Benennen Sie außerdem jedes Skript eindeutig, um sicherzustellen, dass Sie die richtigen Variablen auslesen, bevor Sie Installations- oder Aktualisierungsbefehle ausführen.

Mehrere Bereitstellungen in demselben Cluster
Wenn Sie mehrere Bereitstellungen auf demselben Cluster erstellen möchten, haben Sie folgende Möglichkeiten:
Option Empfohlen, wenn Sie... Weitere Hinweise
Verwenden Sie dasselbe Skript erneut Erstellen Sie standardisierte Bereitstellungen. Sie müssen sicherstellen, dass Sie die Projekt variablen aktualisieren, bevor Sie die Installation ausführen.
Erstellen Sie mehrere Skripte
  • Stellen Sie in jeder Instanz von unterschiedliche IBM Software Hub Dienste bereit.
  • Vermeiden Sie es, das Skript für die Umgebungsvariablen zu ändern, bevor Sie eine Installation ausführen.
Benennen Sie jedes Skript eindeutig, um sicherzustellen, dass Sie die richtigen Variablen verwenden, bevor Sie Installations- oder Aktualisierungsbefehle ausführen.
Tipp: Wenn mehrere Personen gemeinsam an der Installation arbeiten, sollten Sie jedem Benutzer eine Kopie der entsprechenden Dateien zur Verfügung stellen. Jeder Benutzer kann die Skripte bearbeiten, um seine eigenen Anmeldedaten anzugeben und das Skript auf seinem eigenen Arbeitsplatzrechner zu verwenden.

Umgebungsvariablendatei erstellen

  1. Kopieren Sie das folgende Beispiel in einen Texteditor in Ihrem lokalen Dateisystem:
    #===============================================================================
    # IBM Software Hub installation variables
    #===============================================================================
    
    # ------------------------------------------------------------------------------
    # Client workstation 
    # ------------------------------------------------------------------------------
    # Set the following variables if you want to override the default behavior of the IBM Software Hub CLI.
    #
    # To export these variables, you must uncomment each command in this section.
    
    # export CPD_CLI_MANAGE_WORKSPACE=<enter a fully qualified directory>
    # export OLM_UTILS_LAUNCH_ARGS=<enter launch arguments>
    
    
    # ------------------------------------------------------------------------------
    # Cluster
    # ------------------------------------------------------------------------------
    
    export OCP_URL=<enter your Red Hat OpenShift Container Platform URL>
    export OPENSHIFT_TYPE=<enter your deployment type>
    export IMAGE_ARCH=<enter your cluster architecture>
    # export OCP_USERNAME=<enter your username>
    # export OCP_PASSWORD=<enter your password>
    # export OCP_TOKEN=<enter your token>
    export SERVER_ARGUMENTS="--server=${OCP_URL}"
    # export LOGIN_ARGUMENTS="--username=${OCP_USERNAME} --password=${OCP_PASSWORD}"
    # export LOGIN_ARGUMENTS="--token=${OCP_TOKEN}"
    export CPDM_OC_LOGIN="cpd-cli manage login-to-ocp ${SERVER_ARGUMENTS} ${LOGIN_ARGUMENTS}"
    export OC_LOGIN="oc login ${SERVER_ARGUMENTS} ${LOGIN_ARGUMENTS}"
    
    
    # ------------------------------------------------------------------------------
    # Proxy server
    # ------------------------------------------------------------------------------
    
    # export PROXY_HOST=<enter your proxy server hostname>
    # export PROXY_PORT=<enter your proxy server port number>
    # export PROXY_USER=<enter your proxy server username>
    # export PROXY_PASSWORD=<enter your proxy server password>
    # export NO_PROXY_LIST=<a comma-separated list of domain names>
    
    
    # ------------------------------------------------------------------------------
    # Projects
    # ------------------------------------------------------------------------------
    
    export PROJECT_LICENSE_SERVICE=<enter your License Service project>
    export PROJECT_SCHEDULING_SERVICE=<enter your scheduling service project>
    # export PROJECT_IBM_EVENTS=<enter your IBM Events Operator project>
    # export PROJECT_PRIVILEGED_MONITORING_SERVICE=<enter your privileged monitoring service project>
    export PROJECT_CPD_INST_OPERATORS=<enter your IBM Software Hub operator project>
    export PROJECT_CPD_INST_OPERANDS=<enter your IBM Software Hub operand project>
    # export PROJECT_CPD_INSTANCE_TETHERED=<enter your tethered project>
    # export PROJECT_CPD_INSTANCE_TETHERED_LIST=<a comma-separated list of tethered projects>
    
    
    
    # ------------------------------------------------------------------------------
    # Storage
    # ------------------------------------------------------------------------------
    
    export STG_CLASS_BLOCK=<RWO-storage-class-name>
    export STG_CLASS_FILE=<RWX-storage-class-name>
    
    # ------------------------------------------------------------------------------
    # IBM Entitled Registry
    # ------------------------------------------------------------------------------
    
    export IBM_ENTITLEMENT_KEY=<enter your IBM entitlement API key>
    
    
    # ------------------------------------------------------------------------------
    # Private container registry
    # ------------------------------------------------------------------------------
    # Set the following variables if you mirror images to a private container registry.
    #
    # To export these variables, you must uncomment each command in this section.
    
    # export PRIVATE_REGISTRY_LOCATION=<enter the location of your private container registry>
    # export PRIVATE_REGISTRY_PUSH_USER=<enter the username of a user that can push to the registry>
    # export PRIVATE_REGISTRY_PUSH_PASSWORD=<enter the password of the user that can push to the registry>
    # export PRIVATE_REGISTRY_PULL_USER=<enter the username of a user that can pull from the registry>
    # export PRIVATE_REGISTRY_PULL_PASSWORD=<enter the password of the user that can pull from the registry>
    
    
    # ------------------------------------------------------------------------------
    # Image pull configuration
    # ------------------------------------------------------------------------------
    
    export IMAGE_PULL_SECRET=<pull-secret-name>
    # export IMAGE_PULL_CREDENTIALS=$(echo -n "cp:$IBM_ENTITLEMENT_KEY" | base64 -w 0)
    # export IMAGE_PULL_CREDENTIALS=$(echo -n "$PRIVATE_REGISTRY_PULL_USER:$PRIVATE_REGISTRY_PULL_PASSWORD" | base64 -w 0)
    # export IMAGE_PULL_PREFIX=icr.io
    # export IMAGE_PULL_PREFIX=${PRIVATE_REGISTRY_LOCATION}
    
    
    # ------------------------------------------------------------------------------
    # IBM Software Hub version
    # ------------------------------------------------------------------------------
    
    export VERSION=5.3.1
    export OLM_UTILS_IMAGE=icr.io/cpopen/cpd/olm-utils-v4:${VERSION}
    
    
    # ------------------------------------------------------------------------------
    # Components
    # ------------------------------------------------------------------------------
    
    export COMPONENTS=ibm-licensing,scheduler,cpfs,cpd_platform
    # export COMPONENTS_TO_SKIP=<component-ID-1>,<component-ID-2>
    # export IMAGE_GROUPS=<image-group-1>,<image-group-2>
  2. Aktualisieren Sie jeden Abschnitt im Script für Ihre Umgebung. In den folgenden Abschnitten finden Sie Informationen zu den Variablen und gültigen Werten in jedem Abschnitt des Scripts:
  3. Speichern Sie die Datei als Shell-Script. Speichern Sie die Datei beispielsweise als cpd_vars.sh.
  4. Vergewissern Sie sich, dass das Script keine Fehler enthält. Wenn Sie beispielsweise das Script cpd_vars.sh benannt haben, führen Sie Folgendes aus:
    bash ./cpd_vars.sh
  5. Wenn Sie Kennwörter in der Datei gespeichert haben, verhindern Sie, dass andere Benutzer die Datei lesen. Wenn Sie beispielsweise das Script cpd_vars.sh benannt haben, führen Sie Folgendes aus:
    chmod 700 cpd_vars.sh

Umgebungsvariablen als Quelle festlegen

Speichern Sie eine Kopie des Scripts auf Ihrer Workstation und führen Sie es über eine Bash-Eingabeaufforderung aus, bevor Sie Installations- und Upgradebefehle ausführen. Das Script exportiert die Umgebungsvariablen in Ihre Befehlszeilensitzung.

Wichtig: Sie müssen das Skript jedes Mal neu ausführen, wenn Sie eine neue Bash-Eingabeaufforderung öffnen.
  1. Wechseln Sie in das Verzeichnis, in dem Sie das Script gespeichert haben.
  2. Legen Sie die Quelle für die Umgebungsvariablen fest. Wenn Sie beispielsweise das Script cpd_vars.sh benannt haben, führen Sie Folgendes aus:
    source ./cpd_vars.sh

Client-Workstation

Die Variablen im Abschnitt „Client-Workstation“ des Skripts geben Auskunft darüber, wie das cpd-cli manage Plug-in auf der Client-Workstation ausgeführt wird.

Variabel Beschreibung
CPD_CLI_MANAGE_WORKSPACE Das Verzeichnis, in dem Sie Dateien speichern möchten, die von den Befehlen von cpd-cli manage verwendet werden, z. B. CASE Dateien.

Das cpd-cli erstellt ein Verzeichnis namens work innerhalb dieses Verzeichnisses.

Standardmäßig erstellt das Programm beim ersten cpd-cli Ausführen eines cpd-cli manage Befehls automatisch das cpd-cli-workspace/olm-utils-workspace/work Verzeichnis.

Der Speicherort des Verzeichnisses hängt von mehreren Faktoren ab:

  • Wenn Sie die cpd-cli ausführbare Datei aus einem beliebigen Verzeichnis erstellt haben, wird das Verzeichnis in dem Verzeichnis erstellt, in dem Sie die cpd-cli Befehle ausführen.
  • Wenn Sie die cpd-cli ausführbare Datei nicht aus einem beliebigen Verzeichnis erstellt haben, wird das Verzeichnis in dem Verzeichnis erstellt, in dem die Datei installiert cpd-cli ist.

Sie können die CPD_CLI_MANAGE_WORKSPACE Umgebungsvariable setzen, um den Standardpfad zu überschreiben.

Die CPD_CLI_MANAGE_WORKSPACE Umgebungsvariable ist besonders nützlich, wenn Sie die cpd-cli ausführbare Datei aus einem beliebigen Verzeichnis erstellt haben. Wenn Sie die Umgebungsvariable festlegen, wird sichergestellt, dass sich die Dateien in einem Verzeichnis befinden.

Um die CPD_CLI_MANAGE_WORKSPACE Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Kein Standardwert. Das Verzeichnis wird auf Grundlage der im vorstehenden Text beschriebenen Faktoren erstellt.
Gültige Werte
Der vollständige Pfad, in dem das work Verzeichnis cpd-cli erstellt werden soll. Wenn Sie beispielsweise angeben /root/cpd-cli/, speichert das cpd-cli manage Plug-in Dateien im /root/cpd-cli/work Verzeichnis.
OLM_UTILS_LAUNCH_ARGS Eine Reihe von Argumenten, die Sie an den olm-utils-Laufzeitcontainer übergeben.

Sie können die OLM_UTILS_LAUNCH_ARGS Umgebungsvariable verwenden, um Zertifikate zu mounten, die der Container cpd-cli cpd-cli verwenden muss.

CA-Zertifikate mounten
Wichtig: Wenn Sie einen Proxy-Server zum Spiegeln von Images oder zum Herunterladen CASE von Paketen verwenden, fügen Sie mithilfe der OLM_UTILS_LAUNCH_ARGS Umgebungsvariable die CA-Zertifikate hinzu, damit der olm-utils Container Verbindungen über den Proxy-Server als vertrauenswürdig einstuft. Weitere Informationen finden Sie unter „Bei Verwendung eines Proxy-Servers kann nicht auf CASE Pakete zugegriffen werden “.

Sie können CA-Zertifikate mounten, wenn Sie einen externen HTTPS Endpunkt erreichen müssen, der ein selbstsigniertes Zertifikat verwendet.

Tipp: In der Regel befinden sich die CA-Zertifikate im /etc/pki/ca-trust Verzeichnis auf der Workstation. Wenn Sie weitere Informationen zum Hinzufügen von Zertifikaten zu einer Workstation benötigen, führen Sie Folgendes aus:
man update-ca-trust
Bestimmen Sie das richtige Argument für Ihre Umgebung:
  • Wenn sich die Zertifikate auf der Client-Workstation im /etc/pki/ca-trust Verzeichnis befinden, lautet das Argument:

    " -v /etc/pki/ca-trust:/etc/pki/ca-trust"

  • Wenn sich die Zertifikate auf der Client-Workstation in einem anderen Verzeichnis befinden, ersetzen Sie <ca-loc> durch den entsprechenden Speicherort auf der Client-Workstation:

    " -v <ca-loc>:/etc/pki/ca-trust"

Zertifikate Kubernetes mounten
Sie können Zertifikate Kubernetes mounten, wenn Sie ein Zertifikat für die Verbindung zum Kubernetes API-Server benötigen.

Das Argument hängt vom Speicherort der Zertifikate auf der Client-Workstation ab. Ersetzen Sie <k8-loc> durch den entsprechenden Speicherort auf der Client-Workstation:

" -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

Um die OLM_UTILS_LAUNCH_ARGS Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Kein Standardwert.
Gültige Werte
Die gültigen Werte hängen von den Argumenten ab, die Sie an die OLM_UTILS_LAUNCH_ARGS Umgebungsvariable übergeben müssen.
  • Um CA-Zertifikate zu übergeben, geben Sie Folgendes an:

    " -v <ca-loc>:/etc/pki/ca-trust"

  • Um Zertifikate Kubernetes zu übergeben, geben Sie Folgendes an:

    " -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

  • Um sowohl CA-Zertifikate als auch Kubernetes Zertifikate zu übergeben, geben Sie Folgendes an:

    " -v <ca-loc>:/etc/pki/ca-trust -v <k8-loc>:/etc/k8scert --env K8S_AUTH_SSL_CA_CERT=/etc/k8scert"

Cluster2

Die Variablen im Abschnitt „Cluster“ des Skripts geben Informationen zu Ihrem Red Hat OpenShift Container Platform Cluster an.

Variabel Beschreibung
OCP_URL Die „ URL ” des „ Red Hat OpenShift Container Platform ”-Servers. Beispiel: https://openshift1.example.com:8443.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie die URL Ihres Red Hat OpenShift Container Platform-Servers an.
OPENSHIFT_TYPE Der Typ des von Ihnen verwendeten „ Red Hat OpenShift Container Platform “-Clusters.
Standardwert
self-managed
Gültige Werte
aro
Geben Sie aro an, ob Sie (ARO) Azure Red Hat OpenShift ausführen, das verwaltete OpenShift Angebot auf Microsoft Azure.
roks
Geben Sie roks an, ob Sie das verwaltete OpenShift Angebot auf IBM Cloud ausführen Red Hat OpenShift on IBM Cloud.
rosa
Geben Sie rosa an, ob Sie (ROSA) Red Hat OpenShift Service on AWS ausführen, das verwaltete OpenShift Angebot auf Amazon Web Services.
self-managed
Geben Sie self-managed an, ob Sie selbstverwaltet ausführen OpenShift :
  • Lokale Infrastrktur
  • AWS Infrastruktur
  • IBM Cloud Infrastruktur
  • Microsoft Azure Infrastruktur
IMAGE_ARCH Die Architektur Ihrer „ Red Hat OpenShift Container Platform “-Cluster-Hardware.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
amd64
Geben Sie amd64 an, ob Ihr Red Hat OpenShift Container Platform Cluster auf x86-64 Hardware läuft.
ppc64le
Geben Sie ppc64le an, ob Ihr Red Hat OpenShift Container Platform Cluster auf Power Hardware läuft.
s390x
Geben Sie s390x an, ob Ihr Red Hat OpenShift Container Platform Cluster auf Z-Hardware läuft.
OCP_USERNAME Der Benutzername, den Sie zur Authentifizierung bei Ihrem Cluster verwenden. Sie müssen über ausreichende Berechtigungen verfügen, um jede Installations- oder Aktualisierungsaufgabe ausführen zu können.

Um die OCP_USERNAME Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Tipp: Es wird empfohlen, andere Benutzer daran zu hindern, den Inhalt des Umgebungsvariablenskripts zu lesen, indem Sie. ausführen chmod 700. Wenn Sie jedoch weiterhin Bedenken hinsichtlich der Speicherung Ihrer OpenShift Anmeldedaten in dieser Datei haben, können Sie Folgendes tun:
  • Geben Sie die Anmeldedaten direkt ein, anstatt die Umgebungsvariable in den Befehlen zu verwenden.
  • Exportieren Sie die Anmeldedaten manuell, bevor Sie die Befehle ausführen.
OCP_PASSWORD Das Kennwort, das Sie für die Authentifizierung bei Ihrem Cluster verwenden.

Um die OCP_PASSWORD Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

OCP_TOKEN

Sie können sich mit einem Token anstelle Ihres Benutzernamens und Passworts bei Ihrem Red Hat OpenShift Container Platform Cluster anmelden.

Sie können Ihren Token über die Red Hat OpenShift Container Platform Webkonsole abrufen. Wählen Sie im Dropdown-Menü „Benutzername“ die Option „Anmeldebefehl kopieren“ aus. Wenn Sie dazu aufgefordert werden, klicken Sie auf „Token anzeigen “.

Um die OCP_TOKEN Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

SERVER_ARGUMENTS Das Serverargument, das zur Anmeldung beim Cluster übergeben werden soll.

Ändern Sie diesen export Befehl nicht.

Die SERVER_ARGUMENTS Umgebungsvariable hängt von der OCP_URL Umgebungsvariable ab.

LOGIN_ARGUMENTS Die Anmeldeinformationen, die für die Anmeldung beim Cluster übergeben werden müssen.
Die LOGIN_ARGUMENTS Umgebungsvariable hängt von den Anmeldedaten ab, die Sie für die Anmeldung verwenden.
Ein Benutzername und ein Passwort
Wenn Sie einen Benutzernamen und ein Passwort angeben, hängt die LOGIN_ARGUMENTS Umgebungsvariable von den folgenden Umgebungsvariablen ab:
  • OCP_USERNAME
  • OCP_PASSWORD

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung des export LOGIN_ARGUMENTS Eintrags, der die Einträge für Benutzername und Passwort enthält.

Ändern Sie diesen export Befehl nicht.

Ein Zeichen
Wenn Sie ein Token angeben, hängt die LOGIN_ARGUMENTS Umgebungsvariable von der OCP_TOKEN Umgebungsvariable ab.

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung LOGIN_ARGUMENTS des Eintrags, der den Token-Eintrag enthält.

Ändern Sie diesen export Befehl nicht.

CPDM_OC_LOGIN Verknüpfung für den cpd-cli manage login-to-ocp Befehl.

Ändern Sie diesen export Befehl nicht.

Die CPDM_OC_LOGIN Umgebungsvariable hängt von den folgenden Umgebungsvariablen ab:
  • SERVER_ARGUMENTS
  • LOGIN_ARGUMENTS
OC_LOGIN Verknüpfung für den oc login Befehl.

Ändern Sie diesen export Befehl nicht.

Die OC_LOGIN Umgebungsvariable hängt von den folgenden Umgebungsvariablen ab:
  • OCP_URL
  • LOGIN_ARGUMENTS

Proxy-Server

Die Variablen im Abschnitt „Proxy-Server “ sind nur erforderlich, wenn Sie einen Proxy HTTP verwenden, um den eingehenden und ausgehenden Datenverkehr Ihres Red Hat OpenShift Container Platform Clusters zu verwalten.

Variabel Beschreibung
PROXY_HOST Der Hostname oder die IP-Adresse Ihres Proxy-Servers.

Um die PROXY_HOST Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie den Hostnamen oder die IP-Adresse Ihres HTTP Proxy-Servers an
PROXY_PORT Die Portnummer, mit der Sie sich mit Ihrem Proxy-Server verbinden möchten.

Geben Sie diese Variable nur an, wenn Ihre clusterweite Proxy-Konfiguration die Portnummer erfordert.

Um die PROXY_PORT Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie die Portnummer für Ihren HTTP Proxy-Server an
PROXY_USER Der Name eines Benutzers, der sich beim Proxy-Server authentifizieren kann.

Geben Sie diese Variable nur an, wenn Ihr Proxy-Server eine Authentifizierung erfordert.

Um die PROXY_USER Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie einen Benutzernamen an.
PROXY_PASSWORD Das Passwort des Benutzers, der sich beim Proxy-Server authentifizieren kann.

Geben Sie diese Variable nur an, wenn Ihr Proxy-Server eine Authentifizierung erfordert.

Um die PROXY_PASSWORD Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie das Kennwort an, das dem Benutzernamen zugeordnet ist.
NO_PROXY_LIST Eine durch Kommas getrennte Liste von Domänennamen, die nicht über den Proxy-Server geleitet werden sollen.

Geben Sie diese Variable nur an, wenn Sie verhindern möchten, dass bestimmte Domänennamen an Ihren Proxy-Server weitergeleitet werden.

Um die NO_PROXY_LIST Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie eine durch Kommas getrennte Liste von Domänennamen an.
Erforderliche Werte
watsonx™ Orchestrate Nur für Benutzer. Wenn Sie einen Proxy-Server auf einer Instanz von IBM Software Hub mit verwenden möchten, watsonx Orchestrate stellen Sie sicher, dass Sie die folgenden Kubernetes Service-DNS-Namen aus der Proxy-Konfiguration ausschließen:
  • ibm-lh-lakehouse-wo-milvus-milvus-svc.${PROJECT_CPD_INST_OPERANDS}.svc
  • internal-nginx-svc.${PROJECT_CPD_INST_OPERANDS}.svc.cluster.local
Zum Beispiel:
export NO_PROXY_LIST="ibm-lh-lakehouse-wo-milvus-milvus-svc.${PROJECT_CPD_INST_OPERANDS}.svc,internal-nginx-svc.${PROJECT_CPD_INST_OPERANDS}.svc.cluster.local"

Projekte

Die Variablen im Abschnitt „Projekte“ des Skripts geben an, wo die Komponenten, aus denen besteht, installiert IBM Software Hub werden.

Benötigen Sie weitere Informationen zu Projekten? Siehe:
Variabel Beschreibung
PROJECT_LICENSE_SERVICE Das Projekt für den Betreiber des Lizenzierungsdienstes.
Standardwert
ibm-licensing
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden, aber nicht zusammen IBM Certificate manager mit anderer Software.
PROJECT_SCHEDULING_SERVICE Das Projekt für den Terminplanungsdienst.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden; es wird jedoch dringend empfohlen,. zu ibm-cpd-scheduler verwenden. Installieren Sie die scheduling service Software nicht zusammen mit anderer Software.
PROJECT_IBM_EVENTS
watsonx Assistant oder nur watsonx Orchestrate für Benutzer. Das Projekt, in dem Sie die installieren IBM Events Operator möchten, oder das Projekt, in dem bereits eine clusterweite Instanz der IBM Events Operator installiert ist.

Um die PROJECT_IBM_EVENTS Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
ibm-knative-events
Gültige Werte
Verwenden Sie entweder:
  • ibm-knative-events

    Verwenden Sie ibm-knative-events , wenn Sie keine vorhandene clusterweite Instanz von haben IBM Events Operator.

  • Das Projekt, in dem eine clusterweite Instanz des IBM Events Operator installiert ist.
PROJECT_PRIVILEGED_MONITORING_SERVICE
Das OpenShift Projekt für den IBMSoftware Hub privilegierten Überwachungsdienst.

Der privilegierte Überwachungsdienst ist optional, bietet jedoch zusätzliche Überwachungs- und Protokollierungsinformationen für IBM Software Hub.

Der privilegierte Überwachungsdienst wird einmalig auf dem Cluster installiert und kann mehrere Instanzen von überwachen und mit Informationen IBM Software Hub versorgen.

Um die PROJECT_PRIVILEGED_MONITORING_SERVICE Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden; es wird jedoch dringend empfohlen,. zu ibm-cpd-privileged verwenden. Der privilegierte Überwachungsdienst darf nicht zusammen mit anderer Software installiert werden.
PROJECT_CPD_INST_OPERATORS Das Projekt, in dem Sie die Operatoren für diese Instanz von installieren IBMSoftware Hub möchten.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden, aber platzieren Sie die IBM Software Hub Operatoren nicht zusammen mit anderer Software.
PROJECT_CPD_INST_OPERANDS Das Projekt für die IBMSoftware Hub Steuerungsebene und Dienste.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden, aber platzieren Sie die control plane oder Dienste nicht zusammen mit anderer Software.
PROJECT_CPD_INSTANCE_TETHERED Ein Projekt, das an das Projekt gebunden ist, in dem die IBM Software Hub Steuerungsebene installiert ist.

Diese Variable ist nur erforderlich, wenn Sie einen Dienst installieren möchten, der die Bereitstellung von Dienstinstanzen in einem angebundenen Projekt unterstützt.

Um die PROJECT_CPD_INSTANCE_TETHERED Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Sie können jedes beliebige Red Hat OpenShift Projekt verwenden, aber keine andere Software in diesem Projekt unterbringen.
PROJECT_CPD_INSTANCE_TETHERED_LIST
Eine durch Kommas getrennte Liste von Projekten, die mit dem Projekt verknüpft sind, in dem die IBM Software Hub Steuerungsebene installiert ist.

Diese Variable ist nur erforderlich, wenn Sie einen Dienst installieren möchten, der die Bereitstellung von Dienstinstanzen in einem angebundenen Projekt unterstützt.

Um die PROJECT_CPD_INSTANCE_TETHERED_LIST Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Eine durch Kommas getrennte Liste von Projektnamen. Zum Beispiel:

cpd-instance-1-t1,cpd-instance-1-t2,cpd-instance-1-t3

Speicher

Die Variablen im Abschnitt „Storage“ des Skripts legen die Speicherklassen fest, die bei der Installation verwendet werden sollen.

Variabel Beschreibung
STG_CLASS_BLOCK Der Name einer Blockspeicherklasse im Cluster. Die Speicherklasse muss mit einer unterstützten Speicheroption verknüpft sein.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie den Namen einer Speicherklasse an, die auf Blockspeicher verweist (Speicher, der ReadWriteOnce, auch als RWO bezeichnet wird, Zugriff).
Die folgende Liste enthält die empfohlenen Speicherklassen für die unterstützten Speicheroptionen. Wenn Sie verschiedene Speicherklassen verwenden, identifizieren Sie eine gleichwertige Speicherklasse im Cluster.
  • OpenShift Data Foundation: ocs-storagecluster-ceph-rbd
  • IBM Fusion Data Foundation: ocs-storagecluster-ceph-rbd
  • IBM Fusion Global Data Platform: Je nach Ihrer Umgebung eine der folgenden Speicherklassen:
    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-sc
  • IBM Storage Scale Container Native: ibm-spectrum-scale-sc
  • Portworx: portworx-metastoredb-sc
  • NFS: managed-nfs-storage
  • Amazon Elastic Block Store: Je nach Ihrer Umgebung eine der folgenden Speicherklassen:
    • gp2-csi
    • gp3-csi
  • Nutanix: nutanix-volume
STG_CLASS_FILE Der Name einer Dateispeicherklasse im Cluster. Die Speicherklasse muss mit einer unterstützten Speicheroption verknüpft sein.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie den Namen einer Speicherklasse an, die auf Dateispeicher verweist (Speicher, der ReadWriteMany, auch als RWX-Zugriff bezeichnet wird).
Die folgende Liste enthält die empfohlenen Speicherklassen für die unterstützten Speicheroptionen. Wenn Sie verschiedene Speicherklassen verwenden, identifizieren Sie eine gleichwertige Speicherklasse im Cluster.
  • OpenShift Data Foundation: ocs-storagecluster-cephfs
  • IBM Fusion Data Foundation: ocs-storagecluster-cephfs
  • IBM Fusion Global Data Platform: Je nach Ihrer Umgebung eine der folgenden Speicherklassen:
    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-sc
  • IBM Storage Scale Container Native: ibm-spectrum-scale-sc
  • Portworx: portworx-rwx-gp3-sc
  • NFS: managed-nfs-storage
  • Amazon Elastic File System: efs-nfs-client
  • Nutanix: nutanix-file

IBM Entitled Registry

Die Variablen im IBM Entitled Registry Abschnitt des Skripts ermöglichen es Ihnen, eine Verbindung zum herzustellen IBM Entitled Registry und auf die IBM Software Hub Software-Images zuzugreifen, für die Sie berechtigt sind.

Je nachdem, ob Sie Images aus dem IBM Entitled Registry oder aus einer privaten Container-Registry abrufen, können die Variablen auch zur Konfiguration der folgenden Pull-Geheimnisse verwendet werden:
  • Das globale Image-Pull-Geheimnis (für Komponenten, die verwenden OLM)
  • Die Namespace-bezogenen Bild-Pull-Geheimnisse (für Komponenten, die verwenden Helm)

Benötigen Sie weitere Informationen über das IBM Entitled Registry? Siehe „Beziehen Ihres API-Schlüssels für den Anspruch auf „ IBM “ für IBM Software Hub.

Variabel Beschreibung
IBM_ENTITLEMENT_KEY Der Berechtigungs-API-Schlüssel, der mit Ihrem IBM Konto verknüpft ist.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie API-Schlüssel für IBM-Berechtigung an.

Private Container-Registry

Es wird dringend empfohlen, eine private Container-Registry zu verwenden. Die Variablen im Abschnitt „Private Container-Registrierung“ sind nur erforderlich, wenn Sie Images in eine private Container-Registrierung spiegeln.

Mit den Variablen im Abschnitt „Private Container Registry“ des Skripts können Sie:
  • Spiegelbilder vom IBM Entitled Registry in die private Container-Registry.
  • Bilder aus der privaten Container-Registry abrufen

Benötigen Sie weitere Informationen zu privaten Container-Registern? Siehe Anforderungen an private Container-Registries.

Variabel Was ist anzugeben
PRIVATE_REGISTRY_LOCATION Die Position der privaten Container-Registry.

Um die PRIVATE_REGISTRY_LOCATION Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie den Hostnamen oder die IP-Adresse der privaten Container-Registry an. Beachten Sie die folgenden Hinweise:
  • Geben Sie weder noch http:// an https://.
  • Wenn die Registrierung auf Port 80 oder läuft, 443 können Sie den Port weglassen. Wenn die Registrierung jedoch auf einem anderen Port ausgeführt wird, müssen Sie den Port angeben.
PRIVATE_REGISTRY_PUSH_USER Der Benutzername eines Benutzers, der über die erforderlichen Zugriffsrechte zur Übertragung (Push) von Images in die private Container-Registry verfügt.

Um die PRIVATE_REGISTRY_PUSH_USER Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie einen Benutzernamen an.
PRIVATE_REGISTRY_PUSH_PASSWORD Das Kennwort des Benutzers, der über die erforderlichen Zugriffsrechte zur Übertragung (Push) von Images in die private Container-Registry verfügt.

Um die PRIVATE_REGISTRY_PUSH_PASSWORD Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Tipp: Es wird empfohlen, andere Benutzer daran zu hindern, den Inhalt des Umgebungsvariablenskripts zu lesen, indem Sie. ausführen chmod 700. Wenn Sie jedoch weiterhin Bedenken haben, Kennwörter in dieser Datei zu speichern, können Sie Folgendes ausführen:
  • Geben Sie das Kennwort direkt ein, anstatt die Umgebungsvariable in den Befehlen zu verwenden.
  • Exportieren Sie das Passwort manuell, bevor Sie die Befehle ausführen.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie das Kennwort an, das dem Benutzernamen zugeordnet ist.
PRIVATE_REGISTRY_PULL_USER Der Benutzername eines Benutzers, der über die erforderlichen Berechtigungen für Pull-Images aus der privaten Container-Registry verfügt.

Um die PRIVATE_REGISTRY_PULL_USER Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie einen Benutzernamen an.
PRIVATE_REGISTRY_PULL_PASSWORD Das Kennwort des Benutzers mit den erforderlichen Berechtigungen für Pull-Images aus der privaten Container-Registry.

Um die PRIVATE_REGISTRY_PULL_PASSWORD Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Tipp: Es wird empfohlen, andere Benutzer daran zu hindern, den Inhalt des Umgebungsvariablenskripts zu lesen, indem Sie. ausführen chmod 700. Wenn Sie jedoch weiterhin Bedenken haben, Kennwörter in dieser Datei zu speichern, können Sie Folgendes ausführen:
  • Geben Sie das Kennwort direkt ein, anstatt die Umgebungsvariable in den Befehlen zu verwenden.
  • Exportieren Sie das Passwort manuell, bevor Sie die Befehle ausführen.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie das Kennwort an, das dem Benutzernamen zugeordnet ist.

Konfiguration des Image-Pulls

Die Variable im Abschnitt „Image pull configuration“ (Konfiguration zum Abrufen von Images) legt fest, wie Komponenten Images abrufen sollen.

Variabel Beschreibung
IMAGE_PULL_SECRET Der Name, den Sie für das Geheimnis verwenden möchten, das die base64 verschlüsselten Anmeldedaten zum Abrufen von Bildern enthält.
Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Geben Sie einen Kubernetes konformen Namen an, der nur Kleinbuchstaben, alphanumerische Zeichen, Bindestriche (-) oder Punkte (.) enthält.

Der Name muss mit einem alphanumerischen Zeichen beginnen und enden.

IMAGE_PULL_CREDENTIALS Der base64 verschlüsselte Benutzername und das Passwort, die zum Abrufen von Bildern verwendet werden sollen.
Die IMAGE_PULL_CREDENTIALS Umgebungsvariable hängt vom Repository ab, aus dem Sie Bilder abrufen:
IBM Entitled Registry
Wenn Sie Bilder aus dem IBM Entitled Registryabrufen, hängt die IMAGE_PULL_CREDENTIALS Umgebungsvariable von der folgenden Umgebungsvariable ab:
  • IBM_ENTITLEMENT_KEY

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung des export IMAGE_PULL_CREDENTIALS Eintrags, der den IBM Entitlement-API-Schlüssel enthält.

Ändern Sie diesen export Befehl nicht.

Private Container-Registry
Wenn Sie Bilder aus einer privaten Container-Registry abrufen, hängt die IMAGE_PULL_CREDENTIALS Umgebungsvariable von der folgenden Umgebungsvariable ab:
  • PRIVATE_REGISTRY_PULL_USER
  • PRIVATE_REGISTRY_PULL_PASSWORD

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung des export IMAGE_PULL_CREDENTIALS Eintrags, der den privaten Registrierungsbenutzer und das Passwort enthält.

Ändern Sie diesen export Befehl nicht.

IMAGE_PULL_PREFIX Der Speicherort, aus dem Bilder abgerufen werden sollen.
Die IMAGE_PULL_PREFIX Umgebungsvariable hängt vom Repository ab, aus dem Sie Bilder abrufen:
IBM Entitled Registry
Wenn Sie Bilder aus dem IBM Entitled Registryabrufen, verweist die IMAGE_PULL_PREFIX Umgebungsvariable auf icr.io.

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung des export IMAGE_PULL_PREFIX Eintrags, der enthält icr.io.

Ändern Sie diesen export Befehl nicht.

Private Container-Registry
Wenn Sie Bilder aus einer privaten Container-Registry abrufen, hängt die IMAGE_PULL_PREFIX Umgebungsvariable von der folgenden Umgebungsvariable ab:
  • PRIVATE_REGISTRY_LOCATION

Wenn Sie mit dem Beispielskript für Umgebungsvariablen arbeiten, entfernen Sie die Auskommentierung des export IMAGE_PULL_PREFIX Eintrags, der den Speicherort der privaten Registrierung enthält.

Ändern Sie diesen export Befehl nicht.

IBM Software Hub-Version

Die Variable im Abschnitt IBM Software Hub Version gibt an, welche Version von installiert oder IBM Software Hub aktualisiert werden soll.

Beachten Sie: Alle Komponenten einer Instanz müssen in derselben Version installiert sein.
Variabel Beschreibung
VERSION Die zu installierende Version der IBM Software Hub Software.
Standardwert
5.3.1
Gültige Werte
  • 5.3.0
  • 5.3.1
OLM_UTILS_IMAGE Der vollständige Pfad des olm-utils-Images.
Standardwert
icr.io/cpopen/cpd/olm-utils-v4:${VERSION}
Wichtig: Wenn Ihr Cluster Images aus einer privaten Container-Registry abruft, können Sie diese Umgebungsvariable aktualisieren, nachdem Sie das Image in Ihre private Container-Registry gespiegelt haben.

Komponenten

Die Variablen im Abschnitt „Komponenten“ helfen Ihnen bei der Verwaltung der Software, die mit einer Instanz von IBM Software Hubverbunden ist.

Beispielsweise können Sie die COMPONENTS Umgebungsvariable verwenden, um sicherzustellen, dass Sie dieselben Komponenten angeben, wenn Sie:
  • Spiegelbilder in eine private Container-Registry
  • Erstellen Sie die Operatoren für eine Instanz von IBM Software Hub
  • Installieren Sie die Software für eine Instanz von IBM Software Hub
Variabel Beschreibung
COMPONENTS Eine durch Kommas getrennte Liste der Komponenten, die Sie installieren oder aktualisieren möchten.
Standardwert
Standardmäßig enthält die Liste die erforderlichen und empfohlenen Komponenten:
  • ibm-licensing
  • scheduler
  • cpd_platform
Die Komponenten werden durch Kommas ohne Leerzeichen voneinander getrennt. Zum Beispiel:
ibm-licensing,scheduler...
Sie können die scheduler Komponente entfernen, wenn Sie die folgenden Funktionen und Dienste nicht verwenden möchten:
Wichtig: Entfernen Sie keine anderen Komponenten aus der COMPONENTS Umgebungsvariable. Diese Komponenten sind für alle Installationen erforderlich.
Gültige Werte
Lesen Sie die Anleitung unter „Festlegen, welche Komponenten installiert werden sollen“, um zu ermitteln, welche Servicekomponenten-IDs angegeben werden müssen.
COMPONENTS_TO_SKIP Eine durch Kommas getrennte Liste von Komponenten, die bereits auf dem Cluster installiert sind und über clusterweite Operatoren verfügen.

Wenn eine Komponente über einen clusterweiten Operator verfügt, können Sie diese Umgebungsvariable verwenden, um zu verhindern, cpd-cli dass eine namespace-weite Instanz des Operators erstellt.

Wenn Sie beispielsweise über eine clusterweite Instanz des Cloud Native PostgreSQL Operators verfügen, können Sie verhindern, dass cpd-cli der einen namensraumweiten Operator erstellt, wenn eine andere Cloud Native PostgreSQLKomponente eine Abhängigkeit von hat.

Um die COMPONENTS_TO_SKIP Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Setzen Sie diese Umgebungsvariable nur, wenn Sie Cluster-Operatoren für eine oder mehrere der Komponenten in „Gemeinsam genutzte Komponenten“ (automatisch installierte Abhängigkeiten) haben.
IMAGE_GROUPS
Eine durch Kommas getrennte Liste von Modellen oder optionalen Bildern, die in Ihre private Container-Registry gespiegelt werden sollen.

Wenn eine Komponente Modelle oder optionale Bilder enthält, die standardmäßig nicht gespiegelt werden, müssen Sie diese Bilder explizit in Ihre private Container-Registry spiegeln.

Wenn Sie beispielsweise eine Installation planen watsonx.ai™, müssen Sie auswählen, welche Modelle Sie in Ihre private Container-Registrierung spiegeln möchten.

Um die IMAGE_GROUPS Variable zu verwenden, müssen Sie den export Befehl in der Umgebungsvariablendatei auskommentieren.

Standardwert
Es gibt keinen Standardwert.
Gültige Werte
Lesen Sie die Anleitung unter Festlegen, welche Modelle und optionalen Images in Ihre private Container-Registrierung gespiegelt werden sollen, um zu ermitteln, welche Dienste über Modelle oder optionale Images verfügen, die Sie spiegeln müssen.

Nächste Schritte

Nachdem Sie nun Ihre Installationsumgebungsvariablen eingerichtet haben, können Sie mit der Vorbereitung der Ausführung von „ IBM “ fortfahren. Software Hub installiert aus einer privaten Container-Registrierung.