Instalacja portalu usług dla deweloperów

Edge for Private Cloud, wersja 4.18.01

Przed instalacją upewnij się, że:

  • Zanim zainstalujesz portal, musisz zainstalować Postgres. Możesz zainstalować Postgres w ramach instalacji Edge lub zainstalować Postgres samodzielnie do użycia w portalu.
    • Jeśli zainstalujesz Postgres samodzielnie, może on być w tym samym węźle co portal.
    • Jeśli łączysz się z Postgres zainstalowanym w ramach Edge, a Postgres jest skonfigurowany w trybie master/standby, podaj adres IP głównego serwera Postgres.
  • Przeprowadzasz instalację w 64-bitowej wersji obsługiwanej wersji Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz w artykule Obsługiwane oprogramowanie i obsługiwane wersje.
  • Aplikacja Yum jest zainstalowana.

Instalator zawiera tylko moduły udostępniane przez Drupal, które są wymagane w portalu usług dla programistów Apigee (lub w portalu). Informacje na temat instalowania innych opublikowanych modułów znajdziesz w artykule Rozszerzanie platformy 7.

Omówienie instalacji

Gdy zainstalujesz narzędzie apigee-setup na węźle, użyj go do zainstalowania portalu w tym węźle. Narzędzie apigee-setup ma postać:

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

Przekaż plik konfiguracji do narzędzia apigee-setup zawierającego informacje o instalacji. Jeśli w pliku konfiguracji brakuje jakichkolwiek wymaganych informacji, narzędzie apigee-setup poprosi o jego wpisanie w wierszu poleceń.

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

Aby na przykład zainstalować portal, użyj tego polecenia:

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

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

Wycofanie usługi SMTPSSL

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

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

Tworzenie pliku konfiguracji

Poniżej znajduje się przykładowy plik cichej konfiguracji portalu. Odpowiednio edytuj plik. Aby uwzględnić ten plik, użyj opcji -f do 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 

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

1. Testowanie połączenia z Apigee Edge

Przetestuj połączenie z serwerem zarządzania Edge, wykonując następujące polecenie cURL z poziomu wiersza poleceń 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 EMAIL i PASSWORD to adres e-mail i hasło administratora konta ORGNAME.

Pamiętaj, aby podać nazwę hosta i numer portu właściwe dla Twojej instalacji Edge. Port 8080 jest portem domyślnym Edge. Jeśli łączysz się z organizacją w chmurze, adres 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. Usuń wersje PHP starsze niż 7.0

Skrypt instalacji przed rozpoczęciem instalacji sprawdza w systemie system w wersji PHP starszej niż 7.0. Jeśli istnieje wersja PHP inna niż 7.0, pojawi się następujący komunikat:

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

3. Zainstaluj Postgres

Portal wymaga zainstalowania Postgresa. Możesz zainstalować Postgres w ramach instalacji Edge lub zainstalować Postgres samodzielnie do użycia w portalu.

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

Informacje na temat instalowania Postgres w ramach instalacji Edge znajdziesz w artykule Instalowanie komponentów Edge w węźle.

Aby zainstalować samodzielną aplikację Postgres:

  1. Zainstaluj narzędzie brzegowe apigee-setup w węźle za pomocą internetu lub innej procedury. Więcej informacji znajdziesz w sekcji Instalowanie narzędzia Edge apigee-setup.
  2. Utwórz plik konfiguracyjny dla Postgres, jak pokazano poniżej: 
    # 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 configFile

    Opcja -p pdb określa instalację Postgre. Plik konfiguracyjny musi być dostępny lub czytelny dla użytkownika „apigee”.

4. Instalowanie portalu

Aby zainstalować portal:

  1. Zainstaluj narzędzie brzegowe apigee-setup w węźle za pomocą procedury internetowej lub innej niż internet. Więcej informacji znajdziesz w sekcji Instalowanie narzędzia Edge apigee-setup.
  2. Sprawdź, czy zainstalowano Postgres – samodzielnie lub jako część instalacji Edge.
  3. W wierszu polecenia uruchom skrypt konfiguracji: 
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Opcja -p dp pozwala zainstalować portal.

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

  4. Przejdź na stronę główną portalu pod adresem http://localhost:8079 lub otwórz nazwę DNS portalu.
  5. Zaloguj się w portalu za pomocą danych logowania administratora ustawionych w pliku konfiguracyjnym, aby upewnić się, że portal działa prawidłowo.
  6. Wybierz Raporty > Raport o stanie w menu Drupal, aby mieć pewność, że zobaczysz bieżący stan portalu.

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

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

Po włączeniu dostępnych aktualizacji możesz je wyświetlić, korzystając z menu Raporty > Dostępne aktualizacje. Możesz też użyć tego polecenia Drush:

drush pm-info update

Musisz uruchomić to polecenie w katalogu głównym witryny. Domyślnie portal dla programistów jest zainstalowany w /opt/apigee/apigee-drupal/wwwroot. W związku z tym przed uruchomieniem polecenia zmień katalog na /opt/apigee/apigee-drupal/wwwroot. Jeśli portal nie został zainstalowany w katalogu domyślnym, przejdź do katalogu instalacji.

W menu Raporty > Dostępne aktualizacje > Ustawienia skonfiguruj moduł, aby wysyłać Ci e-maile z powiadomieniami o dostępnych aktualizacjach. Możesz też określić częstotliwość sprawdzania, czy są dostępne aktualizacje.

6. Skonfiguruj wyszukiwarkę Apache Solr (opcjonalnie)

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

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

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

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

7. Zainstaluj SmartDokumenty (opcjonalnie)

Dzięki Dokumentom Smart możesz udostępniać interfejsy API w portalu usług dla deweloperów w sposób, który zapewnia pełną interaktywność dokumentacji API. Aby jednak korzystać z tej usługi w portalu, musisz najpierw zainstalować ją w Edge.

  • Jeśli łączysz portal z instalacją Edge Cloud, aplikacja SmartDokumenty jest już zainstalowana i nie musisz nic więcej konfigurować.
  • Jeśli łączysz portal z brzegiem instalacji Private Cloud, musisz zainstalować SmartSmart na urządzeniu Edge. Więcej informacji o instalowaniu Edge i SmartDocuments znajdziesz w tym artykule.

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

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

Jeśli instalujesz moduł JQuery Update i używasz go w instalacji innej niż internetowa, musisz skonfigurować go tak, aby używał lokalnej wersji JQuery. Jeśli skonfigurujesz moduł do korzystania z sieci CDN na potrzeby instalacji innej niż internet, spróbuje ona uzyskać dostęp do sieci CDN i może spowodować opóźnienia podczas wczytywania strony. Więcej informacji o module JQuery Update znajdziesz na stronie https://www.drupal.org/project/jquery_update.

Aby skonfigurować moduł JQuery Update do korzystania z lokalnej wersji JQuery:

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

9. Co dalej?

Następnym krokiem po zainstalowaniu portalu usług dla deweloperów jest skonfigurowanie i dostosowanie go do własnych wymagań. Dokumentacja na stronie internetowej Apigee zawiera wszystkie informacje na temat konfigurowania portalu i zarządzania nim. Otwórz dokumentację pod adresem http://apigee.com/docs/developer-services/content/what-developer-portal.

Poniższa tabela zawiera listę najczęstszych zadań, które wykonujesz po instalacji. Zawiera ona także 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 elementy 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 rejestracji konta w portalu przez nowych deweloperów. Na przykład: czy nowi deweloperzy mają natychmiastowy dostęp do portalu, czy muszą zostać zweryfikowani przez administratora. Ten proces kontroluje 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 deweloper rejestruje się w portalu lub gdy zapomni swoje hasło.

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

Dodaj stronę z Warunkami 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 wdraża model autoryzacji oparty na rolach. Zanim zezwolisz deweloperom na rejestrację, określ uprawnienia i role używane w portalu.

Dodawanie postów na blogu i na forum

Portal ma wbudowaną obsługę blogów i forów z wątkami. Zdefiniuj uprawnienia dotyczące wyświetlania, dodawania, edytowania i usuwania postów na blogu oraz forum.

Upewnij się, że tworzysz kopie zapasowe bazy danych

Sprawdź, czy tworzysz kopię zapasową bazy danych Drupal. Pamiętaj, że każda instalacja jest inna, dlatego to Ty decydujesz, jak najlepiej utworzyć kopię zapasową bazy danych.

Uwaga: moduł Kopia zapasowa i migracja jest niezgodny z bazami danych Postgres.

Zobacz też, jak wykonać kopię zapasową.

Konfigurowanie nazwy hosta

Jeśli nie skonfigurujesz nazwy hosta na serwerze DNS, zawsze możesz uzyskać dostęp do witryny przez adres IP serwera. Jeśli chcesz użyć nazwy hosta, możesz skonfigurować serwer DNS, który powinien działać prawidłowo bez żadnej innej konfiguracji podstawowej.

Jeśli skonfigurujesz system równoważenia obciążenia lub z jakiegoś powodu witryna otrzyma nieprawidłowe adresy URL, możesz ustawić $base_url w Drupal, wykonując te czynności:

  1. Utwórz katalog /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, jeśli nie istnieje.
  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 na nazwę hosta witryny.
  5. Zapisz plik.

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

Więcej informacji o właściwości $base_url znajdziesz w tych sekcjach:
Programowanie niestandardowe Możesz też poszerzyć możliwości portalu o niestandardowy kod spoza motywu. Aby to zrobić, utwórz własny moduł Drupal zgodnie z opisem w sekcji poświęconej rozwijaniu modułów w serwisie Drupal i umieść go w katalogu /sites/all/modules.