Instalowanie portalu

Edge for Private Cloud w wersji 4.19.01

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 jako część instalacji Edge lub zainstalować Postgres jako samodzielną aplikację na potrzeby portalu.
    • Jeśli zainstalujesz samodzielną wersję Postgresa, może on znajdować się na tym samym węźle co portal.
    • Jeśli łączysz się z serwerem Postgres zainstalowanym w ramach Edge, a serwer Postgres jest skonfigurowany w trybie głównym/w trybie gotowości, określ 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 w sekcji Obsługiwane oprogramowanie i wersje.
  3. Yum jest zainstalowany.

Instalator zawiera tylko moduły Drupala wymagane przez portal usług dla deweloperów Apigee (lub po prostu portal). Informacje o instalowaniu innych modułów znajdziesz w artykule Rozszerzanie Drupala 7.

Omówienie instalacji

Aby zainstalować portal, wykonaj te czynności. W kolejnych sekcjach znajdziesz szczegółowe informacje o każdym z tych kroków.

  1. Sprawdzanie połączenia
  2. Usuwanie starszych wersji PHP
  3. Zainstaluj Postgres
  4. Instalowanie portalu
  5. Sprawdzanie, czy Menedżer aktualizacji jest włączony
  6. (Opcjonalnie) Konfigurowanie Apache Solr
  7. (Opcjonalnie) Instalowanie SmartDocs
  8. (Opcjonalnie) Skonfiguruj JQuery

Wycofanie właściwości SMTPSSL

W poprzednich wersjach do ustawienia protokołu używanego przez serwer SMTP połączony z portalem służyła właściwość SMTPSSL. Ta właściwość została wycofana.

Aby ustawić protokół używany przez serwer SMTP połączony z portalem, teraz używasz właściwości SMTP_PROTOCOL zamiast właściwości SMTPSSL. Prawidłowe wartości to „standard”, „ssl” lub „tls”.

Tworzenie pliku konfiguracji portalu

Poniżej znajduje się przykładowy plik konfiguracji w trybie bez obrazu dla instalacji portalu. W razie potrzeby edytuj ten plik w celu dostosowania go do swojej konfiguracji. Użyj opcji -f, aby setup.sh, aby uwzględnić ten plik.

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

Sprawdź połączenie między serwerem, na którym chcesz zainstalować portal, a serwerem zarządzania Edge, 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 administratora zespołu ORGNAME.

Pamiętaj, aby podać nazwę hosta i numer portu odpowiadające Twojej instalacji Edge. Port 8080 jest domyślnym portem używanym przez Edge. Jeśli łączysz się z organizacją w chmurze, adres URL żądania to: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Jeśli operacja się powiedzie, 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. Usuń wersje PHP starsze niż 7.0

Przed rozpoczęciem instalacji skrypt sprawdza, czy w systemie są zainstalowane wersje PHP starsze niż 7.0. 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ą tego polecenia:

yum remove package_name

Jeśli nie masz pewności, czy PHP jest zainstalowane na serwerze, użyj tego polecenia:

rpm -qa | grep -i php

Pamiętaj, że portal używa PHP w wersji 4.18.01-0.0.49. Nie jest to numer wersji Apigee Edge for Private Cloud.

3. Instalowanie Postgres

Aby zainstalować portal, musisz najpierw zainstalować Postgres. Możesz zainstalować Postgres jako część instalacji Edge lub zainstalować Postgres jako samodzielną aplikację do użytku w portalu.

  • Jeśli łączysz się z serwerem Postgres zainstalowanym w ramach Edge, a serwer Postgres jest skonfigurowany w trybie głównym/w trybie gotowości, określ adres IP głównego serwera Postgres.
  • Jeśli zainstalujesz samodzielną wersję Postgresa, może on znajdować się na tym samym węźle co portal.

Informacje o instalowaniu Postgresa w ramach instalowania Edge znajdziesz w artykule Instalowanie komponentów Edge na węźle.

Aby zainstalować samodzielną wersję Postgresa:

  1. Zainstaluj na węźle narzędzie Edge apigee-setup, korzystając z internetu lub procedury bez użycia internetu. Więcej informacji znajdziesz w artykule Instalowanie narzędzia apige-setup w Edge.
  2. Utwórz plik konfiguracji Postgres, jak pokazano w tym przykładzie: 
    # 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. Aby zainstalować Postgresa, uruchom skrypt konfiguracji w wierszu poleceń: 
    /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ępny lub czytelny dla użytkownika „apigee”.

4. Zainstaluj portal

Zanim zainstalujesz portal, wykonaj czynności opisane w sekcji 3. Instalowanie Postgres:

  1. Zainstaluj narzędzie Edge apigee-setup w węźle portalu
  2. Zainstaluj Postgres samodzielnie lub jako część instalacji Edge.

Aby zainstalować portal:

  1. Uruchom skrypt setup w wierszu poleceń: 
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Gdzie:

    • configFile to plik konfiguracji portalu, jak opisano w sekcji Tworzenie pliku konfiguracji portalu.
    • -p dp instruuje skrypt setup, aby zainstalował portal.

Aby sprawdzić, czy instalacja portalu przebiegła pomyślnie:

  1. Otwórz stronę główną portalu (http://localhost:8079) lub jego nazwę DNS.
  2. Zaloguj się w portalu przy użyciu danych logowania administratora skonfigurowanych w pliku konfiguracji portalu.
  3. Aby sprawdzić bieżący stan portalu, w menu Drupal wybierz Raporty > Raport o stanie.
  4. Upewnij się, że połączenie z serwerem zarządzania zostało nawiązane. Jeśli nie:
    1. Otwórz stronę konfiguracji połączenia z portalem (na przykład http://portal_IP:8079/admin/config/devconnect).
    2. Kliknij przycisk Testuj połączenie. Jeśli uda się nawiązać połączenie, wszystko gotowe. Jeśli nie uda się nawiązać połączenia, przejdź dalej.
    3. Sprawdź ustawienia punktu końcowego i uwierzytelniania:
      • URL punktu końcowego interfejsu Management API: sprawdź, czy protokół (HTTP lub HTTPS), adres IP lub nazwa DNS oraz numer portu są prawidłowe. Przykład: 
        http://10.10.10.10:8080/v1
      • Uwierzytelniony użytkownik punktu końcowego: nazwa użytkownika administratora organizacji.
      • Hasło uwierzytelnionego użytkownika: hasło administratora organizacji.

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

      Wartości te powinny być zgodne z wartościami ms_IP_or_DNS, email i password użytymi w kroku 1: sprawdź połączenie z Apigee Edge. Nazwa użytkownika i hasło powinny też odpowiadać wartościom właściwości USER_NAME i USER_PWD w pliku konfiguracyjnym onboardingu lub danym uwierzytelniającym dowolnego użytkownika, którego rola to Administrator organizacji.

    4. Po nawiązaniu połączenia z serwerem zarządzania kliknij przycisk Zapisz konfigurację u dołu strony, aby zapisać zmiany.

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

Aby otrzymywać powiadomienia o aktualizacjach Drupala, upewnij się, że moduł menedżera aktualizacji Drupal jest włączony. W menu Drupal wybierz Moduły i przewiń w dół do modułu Menedżer aktualizacji. Jeśli nie jest włączona, włącz ją.

Po włączeniu tej funkcji dostępne aktualizacje możesz wyświetlić w menu Raporty > Dostępne aktualizacje. Możesz też użyć tego polecenia pędzla:

drush pm-info update

Musisz uruchomić to polecenie w katalogu głównym witryny. Domyślnie portal jest instalowany pod adresem /opt/apigee/apigee-drupal/wwwroot. Dlatego przed uruchomieniem polecenia musisz zmienić katalog na /opt/apigee/apigee-drupal/wwwroot. Jeśli portal nie został zainstalowany w katalogu domyślnym, przejdź do katalogu instalacji.

Użyj pozycji menu Raporty > Dostępne aktualizacje > Ustawienia, aby skonfigurować moduł do wysyłania e-maili o dostępności aktualizacji oraz ustawienia częstotliwości sprawdzania dostępności aktualizacji.

6. Skonfiguruj wyszukiwarkę Apache Solr (opcjonalnie).

Domyślnie moduły Drupala, które łączą się z wyszukiwarką Apache Solr, są wyłączone po zainstalowaniu portalu. Większość portali używa wewnętrznej wyszukiwarki Drupal, więc nie wymagają modułów Solr Drupala.

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

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

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
  2. W menu Drupala kliknij Moduły.
  3. Włącz moduły Apache Solr Framework i Apache Solr Search.
  4. Zapisz zmiany.
  5. Skonfiguruj Solr zgodnie z instrukcjami podanymi na stronie https://drupal.org/node/1999280.

7. Instalowanie SmartDocs (opcjonalnie)

SmartDocs umożliwia dokumentowanie interfejsów API w portalu w sposób, który sprawia, że dokumentacja API staje się w pełni interaktywna. Aby jednak korzystać z SmartDocs w portalu, musisz najpierw zainstalować SmartDocs w Edge.

  • Jeśli łączysz portal z instalacją Edge Cloud, aplikacja SmartDocs jest już zainstalowana i nie musisz jej konfigurować.
  • Jeśli łączysz portal z instalacją Edge for Private Cloud, musisz upewnić się, że usługa SmartDocuments jest zainstalowana na Edge. Więcej informacji o instalowaniu Edge i SmartDocuments znajdziesz w artykule o instalowaniu SmartDocuments.

Musisz też włączyć SmartDocs na portalu. Więcej informacji o SmartDocs znajdziesz w artykule Używanie SmartDocs do dokumentowania interfejsów API.

8. Konfigurowanie modułu aktualizacji JQuery w przypadku instalacji bez dostępu do internetu (opcjonalnie)

Jeśli zainstalujesz i użyjesz modułu JQuery Update w instalacji bez dostępu do internetu, musisz skonfigurować moduł tak, aby używał lokalnej wersji JQuery. Jeśli skonfigurujesz moduł do korzystania z sieci CDN w przypadku instalacji niezwiązanej z internetem, spróbuje on uzyskać dostęp do tej sieci, co spowoduje opóźnienia przy wczytywaniu strony. Więcej informacji o module JQuery Update znajdziesz na stronie https://www.drupal.org/project/jquery_update.

Aby skonfigurować moduł JQuery Update tak, aby używał lokalnej wersji JQuery:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
  2. W menu Drupal wybierz Konfiguracja > Programowanie > Aktualizacja JQuery.
  3. W panelu użytkownika po lewej stronie kliknij Skuteczność.
  4. W menu CDN JQuery i JQuery UI wybierz Brak.
  5. Kliknij Zapisz konfigurację.

9. Dalsze kroki

W tabeli poniżej znajdziesz listę najczęstszych czynności wykonywanych po instalacji oraz linki do dokumentacji Apigee, w której znajdziesz więcej informacji:

Zadanie Opis

Dostosowywanie motywu

Motyw określa wygląd portalu, w tym kolory, styl i inne aspekty wizualne.

Dostosowywanie wyglądu

Strona główna zawiera menu główne, wiadomość powitalną, nagłówek, stopkę i tytuł.

Dodawanie kont użytkowników i zarządzanie nimi

Proces rejestracji określa sposób rejestrowania kont przez nowych deweloperów w portalu. Na przykład czy nowi deweloperzy mają natychmiastowy dostęp do portalu, czy muszą zostać zweryfikowani przez administratora? Ten proces określa też sposób powiadamiania administratora portalu o tworzeniu nowego konta.

Konfigurowanie poczty e-mail

Portal wysyła e-maile w odpowiedzi na określone zdarzenia. Może się to zdarzyć na przykład, gdy nowy deweloper rejestruje się w portalu lub gdy deweloper zgubi hasło.

Dodawanie kont użytkowników i zarządzanie nimi

Dodaj stronę Warunki korzystania z usługi, którą deweloperzy muszą zaakceptować, aby uzyskać dostęp do portalu.

Dodawanie kont użytkowników i zarządzanie nimi

Portal korzysta z modelu autoryzacji opartego na rolach. Zanim zezwolisz deweloperom na rejestrację, zdefiniuj uprawnienia i role używane przez portal.

Dodawanie postów na blogu i na forum

Portal ma wbudowaną obsługę blogów i forów z wątkami. Określ uprawnienia wymagane do wyświetlania, dodawania, edytowania i usuwania postów na blogu i na forum.

Utwórz kopie zapasowe bazy danych

Utwórz kopię zapasową bazy danych Drupal. Pamiętaj, że każda instalacja jest inna, dlatego to od Ciebie zależy, jak najlepiej utworzyć kopię zapasową bazy danych.

Zobacz też Jak utworzyć kopię zapasową.

Skonfiguruj nazwę hosta

Jeśli nie skonfigurujesz nazwy hosta na serwerze DNS, zawsze możesz uzyskać dostęp do witryny za pomocą adresu IP serwera. Jeśli chcesz użyć nazwy hosta, możesz skonfigurować DNS dla serwera. W przypadku podstawowej konfiguracji powinien on działać prawidłowo bez żadnej innej konfiguracji.

Jeśli masz skonfigurowany równowaznik obciążenia lub z jakiegoś innego powodu w Twojej witrynie pojawiają się nieprawidłowe adresy URL, możesz ustawić wartość $base_url dla Drupala, wykonując te czynności:

  1. Utwórz katalog /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, jeśli go nie ma.
  2. Utwórz w tym katalogu plik o nazwie settings.php.
  3. Dodaj do pliku settings.php te informacje: 
    /**
* Base URL (optional).
*
* If Drupal is generating incorrect URLs on your site, which could
* be in HTML headers (links to CSS and JS files) or visible links
* on pages (such as in menus), uncomment the Base URL statement
* below (remove the leading hash sign) and fill in the absolute URL
* to your Drupal installation.
*
* You might also want to force users to use a given domain.
* See the .htaccess file for more information.
*
* Examples:
*   $base_url = 'http://www.example.com';
*   $base_url = 'http://www.example.com:8888';
*   $base_url = 'http://www.example.com/drupal';
*   $base_url = 'https://www.example.com:8888/drupal';
*
* It is not allowed to have a trailing slash; Drupal will add it
* for you.
*/
# $base_url = 'http://www.example.com/';  // NO trailing slash!
$base_url = ‘http://www.example.com’;
  4. Zmień ostatni wiersz $base_url, aby był nazwą hosta Twojej witryny.
  5. Zapisz plik.

Pamiętaj, że w tym pliku możesz umieścić dowolne inne ustawienia z plików /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php.

Więcej informacji o właściwości $base_url znajdziesz w tych materiałach:
Programowanie niestandardowe Możesz też rozszerzyć możliwości portalu za pomocą kodu niestandardowego poza motywem. Aby to zrobić, utwórz własny moduł Drupala zgodnie z opisem w tematach tworzenia modułów Drupala i umieść go w katalogu /sites/all/modules.