Instalacja portalu usług dla deweloperów

Edge for Private Cloud wer. 4.17.01

Przed instalacją upewnij się, że:

  • 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.
  • Wykonujesz instalację w 64-bitowej wersji obsługiwanej wersji systemu Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz w artykule Obsługiwane oprogramowanie i obsługiwane wersje.
  • Zainstalowano aplikację Yum.

Omówienie instalacji

Po zainstalowaniu narzędzia Edge apigee-setup w węźle, zainstaluj go za pomocą tego narzędzia. Narzędzie apigee-setup ma taki format:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Przekaż do narzędzia apigee-setup plik konfiguracji zawierający informacje o instalacji. Jeśli w pliku konfiguracji brakuje jakichkolwiek wymaganych informacji, narzędzie apigee-setup wyświetli prośbę o wpisanie go w wierszu poleceń.

Jedynym wymaganiem jest to, aby plik konfiguracji był dostępny i czytelny dla użytkownika „apigee”.

Na przykład przy użyciu tego polecenia możesz zainstalować portal:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Więcej informacji znajdziesz w artykule Instalowanie narzędzia Edge apigee-setup.

Tworzenie pliku konfiguracji

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 -f 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=pWord 
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=pWord 

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

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# 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=yourEmailPassword

1. Testowanie połączenia z Apigee Edge

Przetestuj połączenie z serwerem zarządzania brzegowym, wykonując to polecenie cURL z wiersza polecenia na serwerze portalu:

> 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 E-MAIL i HASŁO to adres e-mail i hasło administratora organizacji 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 polecenie zadziała, 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

W przypadku CentOS i RedHat Enterprise Linux (RHEL) usuń pakiety PHP za pomocą tego polecenia:

yum remove <package-name>

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 Instalowanie komponentów Edge w węźle.

Aby zainstalować samodzielną wersję Postgres:

  1. Zainstaluj narzędzie Edge apigee-setup w węźle, korzystając z procedury przez internet lub bez połączenia z internetem. Więcej informacji znajdziesz w artykule Instalowanie narzędzia Edge apigee-setup.
  2. Utwórz plik konfiguracyjny Postgres, jak pokazano poniżej:

    # Pod i region Postgres. Użyj wartości domyślnych pokazanych poniżej.
    MP_POD=gateway
    REGION=dc-1

    # Ustaw hasło do Postgres. Wartością domyślną jest „postgres”.
    PG_PWD=postgres
  3. W wierszu polecenia uruchom skrypt konfiguracji, aby zainstalować Postgres:
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    Opcja „-p pdb” wskazuje, czy chcesz zainstalować Postgres.

    Plik konfiguracji musi być dostępny i czytelny dla użytkownika „apigee”.

4. Instalowanie portalu

Aby zainstalować portal:

  1. Zainstaluj narzędzie Edge apigee-setup w węźle, korzystając z procedury przez internet lub bez połączenia z internetem. Więcej informacji znajdziesz w artykule Instalowanie narzędzia Edge apigee-setup.
  2. Sprawdź, czy masz zainstalowany Postgres. Możesz to zrobić samodzielnie lub w ramach instalowania Edge.
  3. W wierszu polecenia uruchom skrypt konfiguracji:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Opcja „-p dp” określa instalację portalu.

    Plik konfiguracji musi być dostępny i czytelny dla użytkownika „apigee”.
  4. Wejdź na stronę główną portalu pod adresem http://localhost:8079 lub do nazwy DNS portalu.
  5. Zaloguj się w portalu przy użyciu danych logowania administratora ustawionych w pliku konfiguracji.

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 dla programistów jest instalowany pod adresem /opt/apigee/apigee-drupal. Dlatego przed uruchomieniem polecenia zmień katalog na /opt/apigee/apigee-drupal. Jeśli portal nie został zainstalowany w domyślnym katalogu, 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 usług dla programistów w taki sposób, że dokumentacja interfejsu 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 SmartDokumentów znajdziesz w artykule Instalowanie SmartDokumentów.

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

8. Co dalej?

Następnym krokiem po zainstalowaniu portalu usług dla programistów jest jego skonfigurowanie i dostosowanie do swoich potrzeb. Dokumentacja w witrynie Apigee zawiera wszystkie informacje na temat konfigurowania portalu i określania jego stylu oraz zarządzania nim. Zapoznaj się z dokumentacją na stronie http://apigee.com/docs/developer-services/content/what-developer-portal.

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:

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 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.

Konfiguruję pocztę 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.

Uwaga: moduł tworzenia kopii zapasowych i migracji jest niezgodny z bazami danych Postgres.

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 dla niego skonfigurować DNS. Powinien on działać prawidłowo bez żadnej innej konfiguracji w ramach konfiguracji podstawowej.

Jeśli skonfigurujesz system równoważenia obciążenia lub z jakiegoś powodu w witrynie otrzymujesz nieprawidłowe adresy URL, możesz ustawić parametr $base_url w pliku settings.php portalu dla programistów, który domyślnie znajduje się w katalogu /opt/apigee/apigee-drupal/sites/default.

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