Instalowanie portalu

Edge for Private Cloud w wersji 4.18.05

Zanim zainstalujesz portal usług dla deweloperów Apigee (lub po prostu portal), sprawdź, czy:

1. Przed zainstalowaniem portalu musisz zainstalować Postgres. Możesz zainstalować Postgres zainstalować Edge lub zainstalować autonomiczną wersję Postgres na potrzeby portalu.
   • Jeśli zainstalujesz samodzielną wersję Postgres, może się ona znajdować w tym samym węźle co portal.
   • Jeśli łączysz się z Postgresem zainstalowanym w ramach Edge i skonfigurowanym Postgres w trybie mastera/gotowania podaj adres IP głównego serwera Postgres.
2. Instalujesz 64-bitową wersję obsługiwanej wersji Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz na stronie Obsługiwane oprogramowanie i obsługiwane wersje
3. Zainstalowano pakiet Yum.

Instalator zawiera tylko moduły pochodzące z platformy Drupal, które są wymagane przez portalu Apigee dla programistów (lub po prostu portalu). Informacje o instalowaniu innych dodanych modułów znajdziesz tutaj: Przedłużam Drupal 7.

Omówienie instalacji

Aby zainstalować portal, wykonaj te czynności. Każdy z tych kroków jest opisany w bardziej szczegółowe informacje znajdziesz w dalszej części tego artykułu.

1. Sprawdzanie połączenia
2. Usuwanie języka PHP w wersji starszej niż 7.0
3. Zainstaluj Postgres
4. Instalowanie portalu
5. Sprawdzanie, czy menedżer aktualizacji jest włączony
6. (Opcjonalnie) Konfigurowanie Apache Solr
7. (Opcjonalnie) Zainstaluj Dokumenty Google
8. (Opcjonalnie) Skonfiguruj JQuery

Wycofanie właściwości SMTPSSL

W poprzednich wersjach właściwość SMTPSSL służyła do: ustaw protokół używany przez serwer SMTP połączony z portalem. Ta właściwość została wycofane.

Korzystasz teraz z właściwości SMTP_PROTOCOL, zamiast właściwości SMTPSSL, aby ustawić protokołu używanego przez serwer SMTP połączony z portalem. Prawidłowe wartości to: „standard”, „ssl” lub „tls”.

Tworzenie pliku konfiguracji portalu

Poniżej znajduje się przykładowy plik konfiguracji cichej instalacji portalu. Edytuj ten plik zgodnie z potrzebami konfiguracji. Aby uwzględnić te wartości, użyj opcji -f, aby setup.sh .

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres.
PG_NAME=devportal

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal
# to access the Postgres database,
# This account is created if it does not already exist.
DRUPAL_PG_USER=drupaladmin
DRUPAL_PG_PASS=portalSecret

# Specify 'postgres' as the database.
DEFAULT_DB=postgres

# Specify the Drupal admin account details.
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin.
# The installer creates this user on the portal.
DEVPORTAL_ADMIN_FIRSTNAME=firstName
DEVPORTAL_ADMIN_LASTNAME=lastName
DEVPORTAL_ADMIN_USERNAME=userName
DEVPORTAL_ADMIN_PWD=PORTAL_ADMIN_PASSWORD
DEVPORTAL_ADMIN_EMAIL=foo@bar.com

# Edge connection details.
# If omitted, you can set them in the portal UI.
# Specify the Edge organization associated with the portal.
EDGE_ORG=edgeOrgName

# Specify the URL of the Edge management API.
# For a Cloud based installation of Edge, the URL is:
# https://api.enterprise.apigee.com/v1
# For a Private Cloud installation, it is in the form:
# http://ms_IP_or_DNS:8080/v1 or
# https://ms_IP_or_DNS:TLSport/v1
MGMT_URL=https://api.enterprise.apigee.com/v1

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword.
# The portal uses this information to connect to Edge.
DEVADMIN_USER=orgAdmin@myCorp.com
DEVADMIN_PWD=ORG_ADMIN_PASSWORD

# The PHP port.
# If omitted, it defaults to 8888.
PHP_FPM_PORT=8888

# Optionally configure the SMTP server used by the portal.
# If you do, the properties SMTPHOST and SMTPPORT are required.
# The others are optional with a default value as notated below.
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com.
SMTPHOST=smtp.gmail.com

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# SMTP port (usually 25).
# The value can be different based on the selected encryption protocol.
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS.
SMTPPORT=25

# Username used for SMTP authentication, defaults is blank.
SMTPUSER=your@email.com

# Password used for SMTP authentication, default is blank.
SMTPPASSWORD=YOUR_EMAIL_PASSWORD

1. Testowanie połączenia z Apigee Edge

Testowanie połączenia między serwerem, na którym chcesz zainstalować portal, a serwerem Edge do zarządzania serwerem, wykonując na serwerze portalu to polecenie curl:

curl -u EMAIL:PASSWORD http://ms_IP_or_DNS:8080/v1/organizations/ORGNAME

lub

curl -u EMAIL:PASSWORD https://ms_IP_or_DNS:TLSPort/v1/organizations/ORGNAME

Gdzie EMAIL i PASSWORD to adres e-mail i hasło do administratorem domeny ORGNAME.

Pamiętaj, aby podać nazwę hosta i numer portu właściwe dla instalacji Edge. Porto 8080 to domyślny port używany przez Edge. Jeśli łączysz się z organizacją w chmurze, URL żądania to: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Jeśli operacja się uda, curl zwróci odpowiedź podobną do tej:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Usuwanie wersji PHP starszych niż 7.0

Skrypt instalacyjny sprawdza, czy w systemie są wersje PHP w wersji starszej niż 7.0, zanim rozpocznie się instalacji. Jeśli istnieją wersje języka PHP starszych niż 7.0, wyświetli się następujący komunikat ostrzegawczy:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Usuń pakiety PHP za pomocą następującego polecenia:

yum remove package_name

Jeśli nie masz pewności, czy na serwerze jest zainstalowany język PHP, użyj następującego polecenia:

rpm -qa | grep -i php

3. Zainstaluj Postgres

Aby było możliwe zainstalowanie portalu, portal wymaga zainstalowania Postgres. Możesz: zainstaluj Postgres w ramach instalowania Edge lub zainstaluj Postgres samodzielnie do użytku przez z portalu.

• Jeśli łączysz się z Postgresem zainstalowanym w ramach Edge, a Postgres jest skonfigurowany w w trybie mastera/gotowy podaj adres IP głównego serwera Postgres.
• Jeśli zainstalujesz samodzielną wersję Postgres, może się ona znajdować w tym samym węźle co portal.

Informacje o instalowaniu Postgres w ramach instalowania Edge znajdziesz w artykule Zainstaluj w węźle komponenty Edge.

Aby zainstalować autonomiczną wersję Postgres:

1. Zainstaluj w węźle narzędzie Edge apigee-setup za pomocą za pomocą internetu, czy też poza internetem. Zobacz Aby dowiedzieć się więcej, zainstaluj narzędzie Edge apigee-setup.
2. Utwórz plik konfiguracji Postgres zgodnie z poniższym przykładem:

   # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
   HOSTIP=$(hostname -i)
   
   # The pod and region of Postgres. Use the default values shown below.
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. The default value is 'postgres'.
   PG_PWD=postgres

3. W wierszu polecenia uruchom skrypt konfiguracji, aby zainstalować Postgres:

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

   Opcja -p pdb określa, czy należy zainstalować Postgre. Plik konfiguracji musi być dostępna lub czytelna dla „apigee” użytkownika.

4. Zainstaluj portal

Zanim zainstalujesz portal, wykonaj te czynności zgodnie z opisem w sekcji 3. Zainstaluj Postgres:

1. Zainstaluj narzędzie Edge apigee-setup w węźle portalu
2. Zainstaluj Postgres – samodzielną wersję Postgres lub w ramach instalowania Edge

Aby zainstalować portal:

1. W wierszu polecenia uruchom skrypt setup:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Gdzie:

   • configFile to plik konfiguracji portalu zgodnie z opisem w sekcji Utwórz plik konfiguracji portalu.
   • -p dp instruuje skrypt setup, aby zainstalować portal.

Aby sprawdzić, czy instalacja portalu się powiodła:

1. Przejdź na stronę główną portalu pod adresem http://localhost:8079 lub do nazwy DNS Twojego portalu.
2. Zaloguj się w portalu za pomocą danych logowania administratora ustawionych w portalu .
3. Wybierz Raporty > raportu stanu w menu Drupala, aby upewnić się, że zobaczysz bieżący stan portalu.
4. Sprawdź, czy udało się nawiązać połączenie z serwerem zarządzania. Jeśli nie:
   1. Otwórz stronę Konfiguracja połączenia z portalem (na przykład http://portal_IP:8079/admin/config/devconnect).
   2. Kliknij przycisk Test Connection (Testuj połączenie). Jeśli uda się nawiązać połączenie, Gotowe. Jeśli nie uda się nawiązać połączenia, przejdź dalej.
   3. Sprawdź punkt końcowy i ustawienia uwierzytelniania:
      • Adres URL punktu końcowego interfejsu API zarządzania: sprawdź, czy protokół (HTTP lub HTTPS), nazwa IP lub DNS i numer portu są prawidłowe; np.:

        http://10.10.10.10:8080/v1

      • Użytkownik uwierzytelniony w punkcie końcowym: adres e-mail administratora organizacji nazwa użytkownika.
      • Hasło uwierzytelnionego użytkownika: adres e-mail administratora organizacji, hasła.

      Wartości domyślne odzwierciedlają ustawienia w pliku konfiguracji portalu utworzonych podczas instalacji.

      Te wartości powinny być zgodne z wartościami ms_IP_or_DNS, email i Wartości użyte w kroku: password 1. Przetestuj połączenie z Apigee Edge. Nazwa użytkownika i hasło powinny być też zgodne z wartościami w pliku USER_NAME i USER_PWD w funkcji pliku konfiguracji rejestracji lub dane logowania dowolnego użytkownika, którego rola jest administratorem organizacji.

   4. Po nawiązaniu połączenia z serwerem zarządzania kliknij przycisk Zapisz konfiguracji na dole strony, aby zapisać zmiany.

5. Upewnij się, że moduł Menedżer aktualizacji jest włączono

Aby otrzymywać powiadomienia o aktualizacjach Drupala, sprawdź, czy moduł Menedżera aktualizacji Drupal jest . W menu Drupal wybierz Modules (Moduły) i przewiń w dół do Moduł menedżera. Jeśli nie jest, włącz ją.

Po włączeniu możesz zobaczyć dostępne aktualizacje w sekcji Raporty > Dostępny(-a) Aktualizacje. Możesz też użyć tego polecenia pędzla:

drush pm-info update

To polecenie musisz uruchomić w katalogu głównym witryny. Domyślnie atrybut jest zainstalowany pod adresem /opt/apigee/apigee-drupal/wwwroot. Dlatego musisz najpierw zmienić katalog na /opt/apigee/apigee-drupal/wwwroot przed po uruchomieniu polecenia. Jeśli portal nie został zainstalowany w katalogu domyślnym, zmień go na katalogu instalacyjnego.

Skorzystaj z menu Raporty > Dostępne aktualizacje > Ustawienia do skonfigurowania. modułu wysyłania e-maili o dostępności aktualizacji oraz ustawiania częstotliwości sprawdzania aktualizacje.

6. Konfigurowanie wyszukiwarki Apache Solr (Opcjonalnie)

Domyślnie moduły Drupal łączące się z wyszukiwarką Apache Solr są wyłączone, gdy musisz zainstalować portal. Większość portali korzysta z wewnętrznej wyszukiwarki Drupala, więc nie wymagają modułów Drupal Solr.

Jeśli zdecydujesz się używać Solr jako wyszukiwarki, musisz zainstalować Solr lokalnie na serwerze a następnie włącz i skonfiguruj moduły Drupal Solr w portalu.

Aby włączyć moduły Drupal Solr:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
2. W menu Drupal wybierz Modules (Moduły).
3. Włącz moduły Apache Solr Framework i Apache Solr. w module wyszukiwania.
4. Zapisz zmiany.
5. Skonfiguruj Solr zgodnie z opisem na https://drupal.org/node/1999280.

7. Zainstaluj SmartDocuments (opcjonalnie)

SmartDocuments pozwala dokumentować interfejsy API w portalu w sposób Dokumentacja interfejsu API jest w pełni interaktywna. Aby jednak używać w portalu SmartDokumentów, musisz najpierw Zainstaluj SmartDocuments na Edge.

• Jeśli łączysz portal z instalacją Edge Cloud, usługa SmartDocuments jest już zainstalowana i nie jest wymagana żadna dodatkowa konfiguracja.
• Jeśli łączysz portal z instalacją Edge for Private Cloud, musisz upewnić się, że aplikacja SmartDokumenty jest zainstalowana na urządzeniu Edge. Więcej informacji o instalowaniu Edge i SmartDocuments znajdziesz na stronie Zainstaluj Dokumenty Google.

Musisz też włączyć Dokumenty SmartDokumenty w portalu. Więcej informacji na temat Dokumentów Google znajdziesz tutaj: Tworzenie dokumentów za pomocą Dokumentów Google interfejsów API.

8. Skonfiguruj Moduł aktualizacji JQuery dla instalacji innych niż internetowe (opcjonalny)

Jeśli instalujesz moduł JQuery Update i używasz go w instalacji innej niż internet, musisz wykonać skonfigurować moduł do używania lokalnej wersji JQuery. Jeśli skonfigurujesz moduł tak, aby używał sieci CDN w przypadku instalacji niezwiązanej z internetem spróbuje uzyskać dostęp do sieci CDN, co spowoduje opóźnienia na stronie wczytuję. Więcej informacji o module JQuery Update znajdziesz w artykule https://www.drupal.org/project/jquery_update.

Aby skonfigurować moduł aktualizacji JQuery do używania lokalnej wersji JQuery:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
2. Wybierz Konfiguracja > Tworzenie > JQuery Update w menu Drupala.
3. W panelu nawigacyjnym po lewej stronie kliknij Skuteczność.
4. W menu CDN JQuery i JQuery UI wybierz Brak.
5. Kliknij Save Configuration (Zapisz konfigurację).

9. Dalsze kroki

W tabeli poniżej znajdziesz najczęściej występujące czynności, które możesz wykonać po instalacji: i zawiera linki do dokumentacji Apigee, w której można znaleźć więcej informacji: