Installazione del portale Servizi per gli sviluppatori

Edge for Private Cloud versione 4.17.01

Prima di eseguire l'installazione, assicurati di:

  • Devi installare Postgres prima di installare il portale. Puoi installare Postgres nell'ambito dell'installazione di Edge oppure installare Postgres autonomamente per l'utilizzo da parte del portale.
    • Se installi Postgres autonomo, può trovarsi sullo stesso nodo del portale.
    • Se ti connetti a Postgres installato come parte di Edge e Postgres è configurato in modalità master/standby, specifica l'indirizzo IP del server Postgres master.
  • Stai eseguendo l'installazione sulla versione a 64 bit di una versione supportata di Red Hat Enterprise Linux, CentOS o Oracle. Consulta l'elenco delle versioni supportate in Software e versioni supportati.
  • Yum è installato.

Panoramica dell'installazione

Dopo aver installato l'utility apigee-setup su un nodo, utilizzala per installare il portale sul nodo. L'utilità apigee-setup ha il formato:

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

Passa un file di configurazione all'utilità apigee-setup che contiene le informazioni sull'installazione. Se nel file di configurazione mancano informazioni obbligatorie, l'utilità apigee-setup ti chiede di inserirle nella riga di comando.

L'unico requisito è che il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".

Ad esempio, utilizza il seguente comando per installare il portale:

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

Vedi Installare l'utilità apigee-setup Edge per ulteriori informazioni.

Creazione di un file di configurazione

Di seguito è riportato un esempio di file di configurazione silenzioso per un'installazione del portale. Modifica questo file in base alle esigenze della tua configurazione. Utilizza l'opzione -f in setup.sh per includere questo file.

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. Testare la connessione ad Apigee Edge

Verifica la tua connessione al server di gestione perimetrale eseguendo questo comando cURL da un prompt dei comandi sul server del portale:

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

oppure:

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

dove EMAIL e PASSWORD sono l'indirizzo email e la password dell'amministratore di ORGNAME.

Assicurati di specificare il nome host e il numero di porta specifici per la tua installazione di Edge. La porta 8080 è la porta predefinita utilizzata da Edge. Se ti connetti a un'organizzazione nel cloud, l'URL della richiesta è: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

In caso di esito positivo, questo comando restituisce una risposta simile alla seguente:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Rimuovi le versioni precedenti a 7.0 di PHP

Lo script di installazione verifica la presenza di versioni precedenti alla 7.0 di PHP sul sistema prima di avviare l'installazione. Se esistono versioni di PHP precedenti alla 7.0, viene visualizzato il seguente messaggio di avviso:

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

Per CentOS e RedHat Enterprise Linux (RHEL), rimuovi i pacchetti PHP utilizzando il seguente comando:

yum remove <package-name>

3. Installa Postgres

Il portale richiede l'installazione di Postgres prima di poter essere installato. Puoi installare Postgres nell'ambito dell'installazione di Edge oppure installare Postgres autonomo per l'utilizzo da parte del portale.

  • Se ti connetti a Postgres installato come parte di Edge e Postgres è configurato in modalità master/standby, specifica l'indirizzo IP del server Postgres master.
  • Se installi Postgres autonomo, può trovarsi sullo stesso nodo del portale.

Per informazioni sull'installazione di Postgres nell'ambito dell'installazione di Edge, vedi Installare i componenti di Edge su un nodo.

Per installare Postgres autonomamente:

  1. Installa l'utilità apigee-setup di Edge sul nodo utilizzando la procedura su internet o non su internet. Per saperne di più, consulta Installare l'utilità apigee-setup di Edge.
  2. Crea un file di configurazione per Postgres, come mostrato di seguito:

    # Il pod e la regione di Postgres. Utilizza i valori predefiniti mostrati di seguito.
    MP_POD=gateway
    REGION=dc-1

    # Imposta la password di Postgres. Il valore predefinito è "postgres".
    PG_PWD=postgres
  3. Al prompt dei comandi, esegui lo script di configurazione per installare Postgres:
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    L'opzione "-p pdb" specifica di installare Postgres.

    Il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".

4. Installare il portale

Per installare il portale:

  1. Installa l'utilità apigee-setup di Edge sul nodo utilizzando la procedura su internet o non su internet. Per saperne di più, consulta Installare l'utilità apigee-setup di Edge.
  2. Assicurati di aver installato Postgres, in modalità autonoma o nell'ambito dell'installazione di Edge.
  3. Al prompt dei comandi, esegui lo script di configurazione:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    L'opzione "-p dp" specifica di installare il portale.

    Il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".
  4. Vai alla home page del portale all'indirizzo http://localhost:8079 o al nome DNS del tuo portale.
  5. Accedi al portale utilizzando le credenziali di amministratore impostate nel file di configurazione.

5. Assicurati che il modulo Gestione aggiornamenti sia attivo

Per ricevere notifiche degli aggiornamenti di Drupal, assicurati che il modulo Drupal Update Manager sia attivo. Dal menu Drupal, seleziona Moduli e scorri verso il basso fino al modulo Gestione aggiornamenti. Se non è attivata, attivala.

Una volta attivata, puoi visualizzare gli aggiornamenti disponibili utilizzando l'opzione di menu Report > Aggiornamenti disponibili. Puoi anche utilizzare il seguente comando Drush:

> drush pm-info update

Devi eseguire questo comando dalla directory principale del sito. Per impostazione predefinita, il Portale per sviluppatori è installato in /opt/apigee/apigee-drupal. Pertanto, devi prima cambiare la directory in /opt/apigee/apigee-drupal prima di eseguire il comando. Se non hai installato il portale nella directory predefinita, vai alla directory di installazione.

Utilizza la voce di menu Report > Aggiornamenti disponibili > Impostazioni per configurare il modulo in modo che ti venga inviata un'email quando gli aggiornamenti sono disponibili e per impostare la frequenza di controllo della disponibilità di aggiornamenti.

6. (Facoltativo) Configura il motore di ricerca Apache Solr

Per impostazione predefinita, i moduli Drupal che si connettono al motore di ricerca Apache Solr sono disattivati quando installi il portale. La maggior parte dei portali utilizza il motore di ricerca interno di Drupal e, pertanto, non richiede i moduli Drupal Solr.

Se decidi di utilizzare Solr come motore di ricerca, devi installarlo localmente sul tuo server e poi attivare e configurare i moduli Drupal Solr sul portale.

Per attivare i moduli Drupal Solr:

  1. Accedi al tuo portale come utente con privilegi di amministratore o di creazione di contenuti.
  2. Seleziona Moduli nel menu di Drupal.
  3. Attiva il modulo Apache Solr Framework e il modulo Apache Solr Search.
  4. Salva le modifiche.
  5. Configura Solr come descritto all'indirizzo https://drupal.org/node/1999280.

7. (Facoltativo) Installa SmartDocs

SmartDocumenti consente di documentare le API sul portale dei Servizi per gli sviluppatori in modo da rendere la documentazione delle API completamente interattiva. Tuttavia, per utilizzare SmartDocs con il portale, devi prima installarlo su Edge.

  • Se stai connettendo il portale a un'installazione Edge Cloud, SmartDocs è già installato e non sono necessarie ulteriori configurazioni.
  • Se connetti il portale a un'installazione di Edge per il cloud privato, devi assicurarti che SmartDocs sia installato su Edge. Per ulteriori informazioni sull'installazione di Edge e SmartDocs, vedi Installare SmartDocs.

Devi anche attivare SmartDocs sul portale. Per ulteriori informazioni su SmartDocs, consulta Utilizzare SmartDocs per documentare le API.

8. E adesso?

Dopo aver installato il portale per i servizi per sviluppatori, devi configurarlo e personalizzarlo in base alle tue esigenze specifiche. La documentazione sul sito web di Apigee contiene tutte le informazioni su come configurare, applicare stili e gestire un portale. Accedi alla documentazione all'indirizzo http://apigee.com/docs/developer-services/content/what-developer-portal.

La tabella seguente elenca alcune delle attività più comuni che esegui dopo l'installazione e include link alla documentazione di Apigee in cui puoi trovare ulteriori informazioni:

Attività

Descrizione

Personalizzazione del tema

Il tema definisce l'aspetto del portale, inclusi colori, stile e altri aspetti visivi.

Personalizzare l'aspetto

La home page include il menu principale, il messaggio di benvenuto, l'intestazione, il piè di pagina e il titolo.

Aggiungere e gestire account utente

La procedura di registrazione controlla la modalità di registrazione di un account sul portale da parte dei nuovi sviluppatori. Ad esempio, i nuovi sviluppatori hanno accesso immediato al portale o devono essere verificati da un amministratore? Questo processo controlla anche il modo in cui un amministratore del portale viene avvisato quando viene creato un nuovo account.

Configurazione email

Il portale invia email in risposta a determinati eventi. ad esempio quando un nuovo sviluppatore si registra sul portale e quando uno sviluppatore perde la password.

Aggiungere e gestire account utente

Aggiungi una pagina Termini e condizioni che gli sviluppatori devono accettare prima di poter accedere al portale.

Aggiungere e gestire gli account utente

Il portale implementa un modello di autorizzazione basato su ruoli. Prima di consentire agli sviluppatori di registrarsi, definisci le autorizzazioni e i ruoli utilizzati dal portale.

Aggiungere post di blog e forum

Il portale supporta di serie i blog e i forum organizzati in thread. Definisci le autorizzazioni necessarie per visualizzare, aggiungere, modificare ed eliminare i post di blog e forum.

Assicurati di eseguire i backup del database

Assicurati di eseguire il backup del database Drupal. Tieni presente che, poiché ogni installazione è diversa, spetta a te stabilire il modo migliore per eseguire il backup del database.

Nota: il modulo Esegui il backup e esegui la migrazione non è compatibile con i database Postgres.

Vedi anche Come eseguire un backup.

Configurare un nome host

Se non configuri un nome host nel server DNS, puoi sempre accedere al sito tramite l'indirizzo IP del server. Se vuoi utilizzare un nome host, puoi configurare il DNS per il server, che dovrebbe funzionare correttamente senza alcuna altra configurazione in una configurazione di base.

Se hai configurato un bilanciatore del carico o ricevi URL errati sul tuo sito per qualche altro motivo, puoi impostare $base_url nel file settings.php del Dev Portal, che per impostazione predefinita si trova nella directory /opt/apigee/apigee-drupal/sites/default.

Sviluppo personalizzato Potresti anche voler estendere le funzionalità del tuo portale con codice personalizzato al di fuori del tema. Per farlo, crea il tuo modulo Drupal come descritto negli argomenti di sviluppo dei moduli di Drupal e inseriscilo nella directory /sites/all/modules.