Instalacja portalu usług dla deweloperów

Edge for Private Cloud w wersji 4.18.01

Przed instalacją upewnij się, że:

  • Przed zainstalowaniem portalu musisz zainstalować Postgres. Możesz zainstalować Postgres zainstalować Edge lub zainstalować autonomiczną wersję Postgres na potrzeby portalu.
    • Jeśli zainstalujesz autonomiczną wersję Postgres, może się ona znajdować w tym samym węźle co portal.
    • Jeśli łączysz się z Postgresem zainstalowanym w ramach Edge i skonfigurowanym Postgres w trybie mastera/gotowania podaj adres IP głównego serwera Postgres.
  • Instalujesz 64-bitową wersję obsługiwanej wersji Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz na stronie Obsługiwane oprogramowanie i obsługiwane wersje
  • Zainstalowano pakiet Yum.

Instalator zawiera tylko moduły pochodzące z platformy Drupal, które są wymagane przez portalu Apigee dla programistów (lub po prostu portalu). Informacje o instalowaniu innych dodanych modułów znajdziesz tutaj: Przedłużam Drupal 7.

Omówienie instalacji

Po zainstalowaniu w węźle narzędzia Edge apigee-setup użyj go do zainstalowania portalu w węźle. Narzędzie apigee-setup ma postać:

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

Przekaż do narzędzia apigee-setup plik konfiguracji, który zawiera informacje na temat instalacji. Jeśli w pliku konfiguracji brakuje jakichkolwiek wymaganych informacje, apigee-setup wyświetli prośbę o jego wpisanie w wierszu poleceń.

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

Możesz na przykład zainstalować portal za pomocą tego polecenia:

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

Zobacz Instalowanie narzędzia Edge apigee-setup aby dowiedzieć się więcej.

Wycofanie właściwości SMTPSSL

W poprzednich wersjach właściwość SMTPSSL służyła do: ustaw protokół używany przez serwer SMTP połączony z portalem. Ta właściwość została wycofane.

Korzystasz teraz z właściwości SMTP_PROTOCOL, zamiast właściwości SMTPSSL, aby ustawić protokołu używanego przez serwer SMTP połączony z portalem. Prawidłowe wartości to: „standard”, „ssl” lub „tls”.

Tworzenie pliku konfiguracji

Poniżej znajduje się przykładowy plik konfiguracji cichej instalacji portalu. Edytuj ten plik zgodnie z potrzebami konfiguracji. Aby uwzględnić te wartości, użyj opcji -f, aby 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 brzegowego, wykonując następujące 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 adres i hasło administratora domeny ORGNAME.

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

Skrypt instalacyjny sprawdza, czy w systemie są wersje PHP w wersji starszej niż 7.0, zanim rozpocznie się instalacji. 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ą następującego polecenia:

yum remove package-name

3. Zainstaluj Postgres

Aby było możliwe zainstalowanie portalu, portal wymaga zainstalowania Postgres. Możesz: zainstaluj Postgres w ramach instalowania Edge lub zainstaluj Postgres samodzielnie do użytku przez z portalu.

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

Informacje o instalowaniu Postgres w ramach instalowania Edge znajdziesz w artykule Zainstaluj w węźle komponenty Edge.

Aby zainstalować autonomiczną wersję Postgres:

  1. Zainstaluj w węźle narzędzie Edge apigee-setup za pomocą procedury stosowanej przez internet lub poza internetem. Zobacz Aby dowiedzieć się więcej, zainstaluj narzędzie Edge apigee-setup.
  2. Utwórz plik konfiguracyjny dla Postgres w następujący sposób:
    # 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, czy należy zainstalować Postgre. Plik konfiguracji musi być dostępna lub czytelna dla „apigee” użytkownika.

4. Zainstaluj portal

Aby zainstalować portal:

  1. Zainstaluj narzędzie Edge apigee-setup na za pomocą procedury internetowej lub poza internetem. Zobacz Zainstaluj narzędzie Edge apigee-setup dla i innych.
  2. Sprawdź, czy masz zainstalowaną aplikację Postgres – samodzielną lub częścią instaluję Edge.
  3. W wierszu polecenia uruchom skrypt konfiguracji:
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Opcja -p dp określa, czy należy zainstalować portal.

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

  4. Przejdź na stronę główną portalu http://localhost:8079 lub do nazwy DNS do swojego portalu.
  5. Zaloguj się w portalu za pomocą danych logowania administratora określonych w pliku konfiguracji na należy sprawdzić, czy portal działa poprawnie.
  6. Wybierz Raporty > Raport stanu w menu Drupala, aby zobaczyć aktualny stan portalu.

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

Aby otrzymywać powiadomienia o aktualizacjach Drupala, sprawdź, czy moduł Menedżera aktualizacji Drupal jest . W menu Drupal wybierz Modules (Moduły) i przewiń w dół do Moduł menedżera. Jeśli nie jest, włącz ją.

Po włączeniu możesz zobaczyć dostępne aktualizacje w sekcji Raporty > Dostępny(-a) Aktualizacje. Możesz też użyć tego polecenia pędzla:

drush pm-info update

To polecenie musisz uruchomić w katalogu głównym witryny. Domyślnie Deweloper Portal jest zainstalowany w /opt/apigee/apigee-drupal/wwwroot. Dlatego musisz najpierw zmienić katalog na /opt/apigee/apigee-drupal/wwwroot przed po uruchomieniu polecenia. Jeśli portal nie został zainstalowany w katalogu domyślnym, zmień go na katalogu instalacyjnego.

Skorzystaj z menu Raporty > Dostępne aktualizacje > Ustawienia do skonfigurowania. modułu wysyłania e-maili o dostępności aktualizacji oraz ustawiania częstotliwości sprawdzania aktualizacje.

6. Konfigurowanie wyszukiwarki Apache Solr (Opcjonalnie)

Domyślnie moduły Drupal łączące się z wyszukiwarką Apache Solr są wyłączone, gdy musisz zainstalować portal. Większość portali korzysta z wewnętrznej wyszukiwarki Drupala, więc nie wymagają modułów Drupal Solr.

Jeśli zdecydujesz się używać Solr jako wyszukiwarki, musisz zainstalować Solr lokalnie na serwerze a następnie włącz i skonfiguruj 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 do tworzenia treści.
  2. W menu Drupal wybierz Modules (Moduły).
  3. Włącz moduły Apache Solr Framework i Apache Solr. w module wyszukiwania.
  4. Zapisz zmiany.
  5. Skonfiguruj Solr zgodnie z opisem na stronie https://drupal.org/node/1999280.

7. Zainstaluj SmartDocuments (opcjonalnie)

SmartDokumenty umożliwiają dokumentowanie interfejsów API w portalu usług dla deweloperów w sposób, który sprawia, Dokumentacja interfejsu API jest w pełni interaktywna. Aby jednak używać w portalu SmartDokumentów, musisz najpierw Zainstaluj SmartDocuments na Edge.

  • Jeśli łączysz portal z instalacją Edge Cloud, SmartDocuments już jest jest już zainstalowana i nie jest wymagana żadna dodatkowa konfiguracja.
  • Jeśli łączysz portal z instalacją Edge for Private Cloud, musisz upewnić się, że aplikacja SmartDokumenty jest zainstalowana na urządzeniu Edge. Więcej informacji o instalowaniu Edge i SmartDocuments znajdziesz na stronie Zainstaluj Dokumenty Google.

Musisz też włączyć Dokumenty SmartDokumenty w portalu. Więcej informacji na temat Dokumentów Google znajdziesz tutaj: Tworzenie dokumentów za pomocą Dokumentów Google interfejsów API.

8. Skonfiguruj Moduł aktualizacji JQuery dla instalacji innych niż internetowe (opcjonalny)

Jeśli instalujesz moduł JQuery Update i używasz go w instalacji innej niż internet, musisz wykonać skonfigurować moduł do używania lokalnej wersji JQuery. Jeśli skonfigurujesz moduł tak, aby używał sieci CDN w przypadku instalacji niezwiązanej z internetem spróbuje uzyskać dostęp do sieci CDN, co spowoduje opóźnienia na stronie wczytuję. Więcej informacji o module JQuery Update znajdziesz w artykule https://www.drupal.org/project/jquery_update.

Aby skonfigurować moduł aktualizacji JQuery do używania lokalnej wersji JQuery:

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

9. Co dalej?

Następnym krokiem po zainstalowaniu portalu usług dla deweloperów jest skonfigurowanie i dostosowanie jej pod kątem swoich wymagań. Dokumentacja na stronie Apigee zawiera informacje o konfigurowaniu portalu, jego stylu i zarządzaniu. Dokumentację znajdziesz na stronie http://apigee.com/docs/developer-services/content/what-developer-portal.

W tabeli poniżej znajdziesz najczęściej występujące czynności, które możesz wykonać po instalacji: i zawiera linki do dokumentacji Apigee, w której można znaleźć więcej informacji:

Zadanie Opis

Dostosowywanie motywu

Motyw określa wygląd portalu, w tym kolory, styl i inne elementy aspektach wizualnych.

Dostosuj wygląd

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

Dodawanie i zarządzanie kontami użytkowników

Proces rejestracji określa, w jaki sposób nowi deweloperzy rejestrują konto na z portalu. Na przykład czy nowi deweloperzy uzyskują natychmiastowy dostęp do portalu, musi zostać zweryfikowany przez administratora. Ten proces określa też sposób, w jaki portal administrator jest powiadamiany o utworzeniu nowego konta.

Konfigurowanie e-mail

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

Dodawanie i zarządzanie kontami użytkowników

Dodaj warunki & Strona z warunkami, które deweloperzy muszą zaakceptować, zanim będą mogli spełnić te warunki. uzyskać dostęp do portalu.

Dodawanie i zarządzanie kontami użytkowników

W portalu stosowany jest model autoryzacji oparty na rolach. Zanim zezwolisz deweloperom na rejestrować i określać uprawnienia i role używane przez portal.

Dodaj bloga i posty na forum

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

Wykonywanie kopii zapasowych bazy danych

Sprawdź, czy tworzysz kopię zapasową bazy danych Drupal. Pamiętaj, że ponieważ jest inny, to od Ciebie zależy, jak najlepiej utworzyć kopię zapasową w bazie danych.

Uwaga: moduł kopii zapasowej i migracji jest niezgodny z Postgresem. baz danych.

Zobacz też Jak wykonać kopię zapasową.

Skonfiguruj nazwę hosta

Jeśli nie skonfigurujesz nazwy hosta na swoim serwerze DNS, zawsze możesz uzyskać dostęp do witryny za pomocą pod adresem IP serwera. Jeśli chcesz użyć nazwy hosta, możesz skonfigurować DNS dla serwera, które powinno działać prawidłowo bez dodatkowej konfiguracji w ramach konfiguracji podstawowej.

Jeśli masz skonfigurowany system równoważenia obciążenia lub w przypadku niektórych witryn występują nieprawidłowe adresy URL, z innego powodu, możesz ustawić $base_url na potrzeby Drupala, wykonując te czynności:

  1. Utwórz katalog /opt/apigee/data/apigee-drupal-devportal/sites/default/includes jeśli taki 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 swojej witryny.
  5. Zapisz plik.

Pamiętaj, że w tym pliku możesz umieścić 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:

Programowanie niestandardowe Możesz także rozszerzyć możliwości portalu za pomocą kodu niestandardowego spoza motyw. Aby to zrobić, utwórz własny moduł Drupala zgodnie z opisem na stronie moduł , a także umieścić moduł w sekcji /sites/all/modules katalogu.