Instalowanie portalu

Edge for Private Cloud w wersji 4.18.05

Zanim zainstalujesz portal Apigee Developer Services (lub po prostu portal), sprawdź, czy:

  1. Przed zainstalowaniem portalu musisz zainstalować Postgres. Możesz zainstalować Postgres w ramach instalowania Edge lub zainstalować samodzielną wersję Postgres do użytku w portalu.
    • Jeśli zainstalujesz wersję autonomiczną Postgres, może ona być w tym samym węźle co portal.
    • Jeśli łączysz się z Postgres zainstalowanym w ramach Edge, a Postgres jest skonfigurowany w trybie mastera/gotowości, podaj adres IP głównego serwera Postgres.
  2. Wykonujesz instalację w 64-bitowej wersji obsługiwanej wersji systemu Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz w sekcji Obsługiwane oprogramowanie i obsługiwane wersje.
  3. Zainstalowano aplikację Yum.

Instalator zawiera tylko moduły dostarczone z platformy Drupal, które są wymagane przez portal usług dla programistów Apigee (lub po prostu portal). Informacje o instalowaniu innych dodanych modułów znajdziesz w artykule na temat rozszerzenia Drupal 7.

Omówienie instalacji

Aby zainstalować portal, wykonaj te czynności. Opis każdego z tych działań znajdziesz bardziej szczegółowo w poniższych sekcjach.

  1. Testowanie połączenia
  2. Usuwanie wersji PHP starszych niż 7.0
  3. Instalowanie Postgres
  4. Instalowanie portalu
  5. Upewnij się, że menedżer aktualizacji jest włączony
  6. (Opcjonalnie) Skonfiguruj Apache Solr
  7. (Opcjonalnie) Instalowanie SmartDokumentów
  8. (Opcjonalnie) Skonfiguruj JQuery

Wycofanie właściwości SMTPSSL

W poprzednich wersjach do ustawiania 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.

Do ustawiania protokołu używanego przez serwer SMTP połączony z portalem używasz teraz właściwości SMTP_PROTOCOL, a nie SMTPSSL. Prawidłowe wartości to: „standard”, „ssl” lub „tls”.

Tworzenie pliku konfiguracji portalu

Poniżej znajduje się przykładowy plik konfiguracji cichej instalacji portalu. Zmodyfikuj ten plik zgodnie z potrzebami konfiguracji. Aby dołączyć ten plik, użyj opcji setup.sh, aby go uwzględnić.

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

Przetestuj połączenie między serwerem, na którym chcesz zainstalować portal, a serwerem zarządzania brzegowymi, 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 domeny ORGNAME.

Pamiętaj, aby podać nazwę hosta i numer portu właściwe dla instalacji Edge. Port 8080 to port domyślny 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

Przed rozpoczęciem instalacji skrypt instalacyjny sprawdza, czy w systemie są wersje języka PHP starsze niż 7.0. Jeśli istnieją wersje PHP w wersjach starszych niż 7.0, zobaczysz ten 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 na serwerze jest zainstalowany język PHP, użyj tego polecenia:

rpm -qa | grep -i php

3. Instalowanie Postgres

Portal wymaga zainstalowania Postgres, zanim będzie można go zainstalować. Możesz zainstalować Postgres w ramach instalowania Edge lub zainstalować samodzielną wersję Postgres do użytku w portalu.

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

Informacje o instalowaniu Postgres w ramach instalowania Edge znajdziesz w artykule o instalowaniu komponentów Edge w węźle.

Aby zainstalować samodzielną wersję Postgres:

  1. Zainstaluj w węźle narzędzie Edge apigee-setup, korzystając z procedury z internetu lub bez połączenia z internetem. Więcej informacji znajdziesz w artykule Instalowanie narzędzia Edge apigee-setup.
  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. 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 chcesz zainstalować Postgre. Plik konfiguracji musi być dostępny i czytelny dla użytkownika „apigee”.

4. Instalowanie portalu

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

  1. Zainstaluj narzędzie Edge apigee-setup w węźle portalu
  2. Zainstaluj Postgres (samodzielnie 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 Tworzenie pliku konfiguracji portalu.
    • -p dp nakazuje skryptowi setup zainstalowanie portalu.

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

  1. Przejdź na stronę główną portalu pod adresem http://localhost:8079 lub do nazwy DNS portalu.
  2. Zaloguj się w portalu przy użyciu danych logowania administratora ustawionych w pliku konfiguracji portalu.
  3. W menu Drupal wybierz Raporty > Raport o stanie, aby sprawdzić bieżący stan portalu.
  4. Sprawdź, czy udało się nawiązać połączenie z serwerem zarządzania. W przeciwnym razie:
    1. Otwórz stronę konfiguracji połączenia portalu (na przykład http://portal_IP:8079/admin/config/devconnect).
    2. Kliknij przycisk Test Connection (Testuj połączenie). Jeśli połączenie się powiedzie, wszystko jest 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 API zarządzania: sprawdź, czy protokół (HTTP lub HTTPS), adres IP lub DNS oraz numer portu są poprawne, np. 
        http://10.10.10.10:8080/v1
      • Uwierzytelniony użytkownik w punkcie końcowym: 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. Przetestuj połączenie z Apigee Edge. Nazwa użytkownika i hasło powinny być też zgodne z wartościami właściwości USER_NAME i USER_PWD w pliku konfiguracji rejestracji lub danymi logowania dowolnego użytkownika, którego rola jest administratorem organizacji.

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

5. Sprawdź, czy moduł menedżera aktualizacji jest włączony

Aby otrzymywać powiadomienia o aktualizacjach w serwisie Drupal, musisz włączyć moduł menedżera aktualizacji Drupal. W menu Drupal wybierz Modules (Moduły) i przewiń w dół do modułu Zaktualizuj menedżera. Jeśli nie jest włączony, włącz go.

Po włączeniu tej funkcji możesz zobaczyć dostępne aktualizacje w menu Raporty > Dostępne aktualizacje. Możesz też użyć tego polecenia w Drush:

drush pm-info update

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

Użyj opcji Raporty > Dostępne aktualizacje > Ustawienia, aby skonfigurować wysyłanie e-maili z modułem o dostępności aktualizacji oraz ustawić częstotliwość sprawdzania dostępności aktualizacji.

6. Skonfiguruj wyszukiwarkę Apache Solr (opcjonalnie)

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

Jeśli chcesz używać Solr jako wyszukiwarki, musisz zainstalować Solr lokalnie na serwerze, a następnie włączyć i skonfigurować 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 z uprawnieniami do tworzenia treści.
  2. W menu Drupal wybierz Modules (Moduły).
  3. Włącz moduł Apache Solr Framework i Apache Solr Search.
  4. Zapisz zmiany.
  5. Skonfiguruj oprogramowanie Solr w sposób opisany na stronie https://drupal.org/node/1999280.

7. Zainstaluj SmartDokumenty (opcjonalnie)

SmartDokumentacja umożliwia dokumentowanie interfejsów API w portalu w taki sposób, że dokumentacja interfejsów API jest w pełni interaktywna. Jeśli jednak chcesz używać aplikacji SmartDokumentacja w portalu, musisz najpierw zainstalować te dokumenty w przeglądarce Edge.

  • Jeśli łączysz portal z instalacją Edge Cloud, aplikacja SmartDokumentacja jest już zainstalowana i nie jest wymagana żadna dodatkowa konfiguracja.
  • Jeśli łączysz portal z instalacją Edge dla Private Cloud, musisz zainstalować aplikację SmartDokumentacja w Edge. Więcej informacji o instalowaniu Edge i SmartDokumentacja znajdziesz w artykule Instalowanie SmartDokumentacja.

Musisz też włączyć SmartDokumenty w portalu. Więcej informacji o SmartDokumentach znajdziesz w artykule o używaniu SmartDokumentów do dokumentowania interfejsów API.

8. Skonfiguruj moduł JQuery Update na potrzeby instalacji spoza internetu (opcjonalnie)

Jeśli zainstalujesz moduł aktualizacji JQuery i będziesz go używać w instalacji innej niż internet, musisz skonfigurować go tak, aby używał lokalnej wersji JQuery. Jeśli skonfigurujesz moduł do korzystania z sieci CDN w przypadku instalacji innej niż internetowa, będzie ona próbowała uzyskać dostęp do sieci CDN, co opóźni wczytywanie stron. Więcej informacji o module JQuery Update znajdziesz na stronie https://www.drupal.org/project/jquery_update.

Aby skonfigurować moduł JQuery Update do użycia lokalnej wersji JQuery:

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

9. Dalsze kroki

W tabeli poniżej znajdziesz niektóre z najczęstszych zadań, które wykonujesz po instalacji, oraz linki do dokumentacji Apigee, gdzie znajdziesz więcej informacji:

Działanie 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 kontroluje sposób, w jaki nowi deweloperzy rejestrują konto w portalu. Na przykład nowi deweloperzy uzyskają natychmiastowy dostęp do portalu lub muszą zostać zweryfikowani przez administratora. Ten proces określa też sposób powiadamiania administratora portalu o utworzeniu nowego konta.

Konfigurowanie poczty e-mail

Portal wysyła e-maile w odpowiedzi na określone zdarzenia. na przykład gdy nowy deweloper zarejestruje się w portalu i utraci hasło.

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

Dodaj stronę z warunkami korzystania z usługi, którą deweloperzy muszą zaakceptować, zanim będą mogli uzyskać dostęp do portalu.

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

Portal stosuje model autoryzacji na podstawie ról. Zanim zezwolisz deweloperom na rejestrację, określ uprawnienia i role używane przez portal.

Dodawanie postów na blogu i 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 forum.

Sprawdź, czy wykonujesz kopie zapasowe bazy danych

Upewnij się, że tworzysz kopię zapasową bazy danych Drupal. Każda instalacja jest inna, dlatego to Ty decydujesz, 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żywać nazwy hosta, możesz skonfigurować dla niego DNS, który powinien działać prawidłowo bez żadnej innej konfiguracji w ramach konfiguracji podstawowej.

Jeśli konfigurujesz system równoważenia obciążenia lub z jakiegoś powodu otrzymujesz nieprawidłowe adresy URL w witrynie, możesz ustawić system $base_url pod kątem platformy Drupal, wykonując te czynności:

  1. Utwórz katalog /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, jeśli nie istnieje.
  2. W tym katalogu utwórz plik o nazwie settings.php.
  3. Do pliku settings.php dodaj te wiersze: 
    /**
* 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 na nazwę hosta witryny.
  5. Zapisz plik.

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

Więcej informacji o właściwości $base_url znajdziesz tutaj:
Programowanie niestandardowe Możesz też rozszerzyć możliwości portalu za pomocą niestandardowego kodu poza motywem. Aby to zrobić, utwórz własny moduł w serwisie Drupal zgodnie z opisem w sekcji poświęconej tworzeniu modułów na platformie Drupal i umieść go w katalogu /sites/all/modules.