Instalacja portalu usług dla deweloperów

Edge for Private Cloud w wersji 4.17.01

Przed instalacją:

• 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 Postgresem zainstalowanym w ramach Edge, a Postgres jest skonfigurowany w trybie mastera/gotowości, podaj adres IP głównego serwera Postgres.
• Instalacja jest wykonywana w obsługiwanej wersji 64-bitowej systemu Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz w sekcji Obsługiwane oprogramowanie i wersje.
• Yum jest zainstalowany.

Omówienie instalacji

Po zainstalowaniu w węźle Edge narzędzia apigee-setup użyj go, aby zainstalować w nim portal. 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, który zawiera informacje o instalacji. Jeśli w pliku konfiguracji brakuje jakichkolwiek wymaganych informacji, narzędzie apigee-setup wyświetli prośbę o ich wpisanie w wierszu poleceń.

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

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

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

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

Tworzenie pliku konfiguracji

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 uwzględnić plik 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 Edge, wykonując to polecenie cURL w wierszu 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 ORGNAME.

Pamiętaj, aby podać nazwę hosta i numer portu właściwe dla 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 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

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

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

yum remove <package-name>

3. Zainstaluj Postgres

Aby zainstalować portal, musisz najpierw zainstalować Postgres. Możesz zainstalować Postgres w ramach instalowania Edge lub zainstalować autonomiczną wersję Postgres do użycia 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 autonomiczną wersję Postgres, może się ona znajdować w tym samym węźle co portal.

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

Aby zainstalować samodzielną wersję Postgresa:

1. Zainstaluj na węźle narzędzie apigee-setup Edge, korzystając z internetu lub procedury bez dostępu do internetu. Więcej informacji znajdziesz w artykule Instalowanie narzędzia apige-setup w Edge.
2. Utwórz plik konfiguracji dla Postgres, jak pokazano poniżej:
   
   # Wątek i region Postgres. Użyj wartości domyślnych podanych poniżej.
   MP_POD=brama
   REGION=dc-1
   
   # Ustaw hasło Postgres. Wartość domyślna to „postgres”.
   PG_PWD=postgres
3. W wierszu poleceń uruchom skrypt konfiguracji, aby zainstalować Postgres:
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   Opcja „-p pdb” wskazuje, że należy zainstalować Postgres.
   
   Plik konfiguracji musi być dostępny lub czytelny dla użytkownika „apigee”.

4. Instalowanie portalu

Aby zainstalować portal:

1. Zainstaluj na węźle narzędzie apigee-setup Edge, korzystając z internetu lub procedury bez internetu. Więcej informacji znajdziesz w artykule Instalowanie narzędzia apige-setup w Edge.
2. Upewnij się, że masz zainstalowaną bazę danych Postgres, samodzielnie lub jako część instalacji Edge.
3. W wierszu poleceń uruchom skrypt konfiguracji:
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   Opcja „-p dp” wskazuje, że chcesz zainstalować portal.
   
   Plik konfiguracji musi być dostępny lub czytelny dla użytkownika „apigee”.
4. Otwórz stronę główną portalu pod adresem http://localhost:8079 lub podaj jego nazwę DNS.
5. Zaloguj się w portalu, używając danych logowania administratora skonfigurowanych w pliku konfiguracji.

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

Aby otrzymywać powiadomienia o aktualizacjach Drupala, włącz moduł Menedżer aktualizacji Drupala. 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 Drush:

> drush pm-info update

To polecenie musisz uruchomić w katalogu głównym witryny. Domyślnie portal dla programistów jest zainstalowany pod adresem /opt/apigee/apigee-drupal. Dlatego przed uruchomieniem polecenia musisz najpierw zmienić katalog na /opt/apigee/apigee-drupal. 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 korzysta z wewnętrznej wyszukiwarki Drupal, więc nie wymaga modułów Drupal Solr.

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ł Apache Solr Framework i moduł Apache Solr Search.
4. Zapisz zmiany.
5. Skonfiguruj Solr zgodnie z instrukcjami podanymi na stronie https://drupal.org/node/1999280.

7. Instalowanie SmartDocs (opcjonalnie)

SmartDocuments umożliwia dokumentowanie interfejsów API w portalu usług dla deweloperów w taki sposób, że dokumentacja interfejsu API jest 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 trzeba jej dodatkowo konfigurować.
• Jeśli łączysz portal z instalacją Edge for Private Cloud, musisz mieć pewność, że w Edge jest zainstalowany SmartDocs. Więcej informacji o instalowaniu aplikacji Edge i SmartDocs znajdziesz w artykule Instalowanie aplikacji SmartDocs.

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

8. Co dalej?

Po zainstalowaniu portalu Usługi dla deweloperów należy go skonfigurować i dostosowywać do swoich potrzeb. Dokumentacja na stronie internetowej Apigee zawiera wszystkie informacje o konfigurowaniu, stylizowaniu i zarządzaniu portalem. Zapoznaj się z dokumentacją na stronie http://apigee.com/docs/developer-services/content/what-developer-portal.

Poniższa tabela zawiera niektóre z najczęstszych zadań, które wykonuje się 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. Uwaga: moduł Tworzenie kopii zapasowych i Migracja nie jest zgodny 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żyć nazwy hosta, możesz skonfigurować DNS serwera. W ramach konfiguracji podstawowej powinno to działać prawidłowo bez żadnej dodatkowej konfiguracji. Jeśli masz skonfigurowany równoważyciel obciążenia lub z jakiegoś innego powodu w swojej witrynie występują nieprawidłowe adresy URL, możesz ustawić zmienną $base_url w pliku settings.php na stronie Dev Portal, który domyślnie znajduje się w katalogu /opt/apigee/apigee-drupal/sites/default.
Rozwój niestandardowy	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 dotyczących tworzenia modułów Drupala i umieść go w katalogu /sites/all/modules.