Installazione del portale Servizi per gli sviluppatori

Edge per Private Cloud v. 4.17.01

Prima di eseguire l'installazione, assicurati di:

  • Devi installare Postgres prima di installare il portale. Puoi installare Postgres durante l'installazione di Edge o installare Postgres standalone per l'utilizzo da parte del portale.
    • Se installi Postgres autonomo, può trovarsi sullo stesso nodo del portale.
    • Se ti stai connettendo 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 supportate.
  • Yum è installato.

Panoramica dell'installazione

Dopo aver installato Edge, l'utilità apigee-setup su un nodo, utilizza questa utilità per installare il portale sul nodo. L'utilità apigee-setup ha il seguente 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 eventuali informazioni richieste, l'utilità apigee-setup ti chiede di inserirle nella riga di comando.

L'unico requisito è che il file di configurazione sia 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

Per saperne di più, consulta Installare l'utilità Edge apigee-setup.

Creazione di un file di configurazione

Di seguito è mostrato un esempio di file di configurazione silenziosa per l'installazione di un portale. Modifica questo file in base alle esigenze della tua configurazione. Utilizza l'opzione -f per 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. Testa la connessione ad Apigee Edge

Verifica la tua connessione a Edge Management Server eseguendo il seguente 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 della tua installazione di Edge. La porta 8080 è quella 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, il 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 di PHP precedenti alla 7.0

Lo script di installazione verifica la presenza di versioni di PHP precedenti alla 7.0 sul sistema prima di iniziare 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

Per installare il portale è necessario installare Postgres. Puoi installare Postgres durante l'installazione di Edge o installare Postgres standalone per l'utilizzo da parte del portale.

  • Se ti stai connettendo 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 come parte dell'installazione di Edge, vedi Installare i componenti Edge su un nodo.

Per installare la versione autonoma di Postgres:

  1. Installa l'utilità Edge apigee-setup sul nodo utilizzando la procedura Internet o non internet. Per saperne di più, consulta Installare l'utilità Edge apigee-setup.
  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 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. Installa il portale

Per installare il portale:

  1. Installa l'utilità Edge apigee-setup sul nodo utilizzando la procedura internet o non internet. Per saperne di più, consulta Installare l'utilità Edge apigee-setup.
  2. Assicurati di aver installato Postgres, in modalità autonoma o durante l'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 amministrative che hai impostato nel file di configurazione.

5. Assicurati che il modulo Gestione aggiornamenti sia abilitato

Per ricevere notifiche sugli aggiornamenti di Drupal, assicurati che il modulo di gestione degli aggiornamenti di Drupal sia abilitato. Dal menu Drupal, seleziona Moduli e scorri verso il basso fino al modulo Gestione aggiornamenti. Se non è attivato, abilitalo.

Una volta attivati, puoi visualizzare gli aggiornamenti disponibili utilizzando la voce 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 gli sviluppatori è installato all'indirizzo /opt/apigee/apigee-drupal. Pertanto, devi cambiare la directory in /opt/apigee/apigee-drupal prima di eseguire il comando. Se non hai installato il portale nella directory predefinita, passa alla directory di installazione.

Utilizza la voce di menu Report > Aggiornamenti disponibili > Impostazioni per configurare il modulo in modo che ti invii un'email quando sono disponibili aggiornamenti e per impostare la frequenza di controllo degli 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 vengono disabilitati quando installi il portale. La maggior parte dei portali utilizza il motore di ricerca interno Drupal, pertanto non richiede i moduli Drupal Solr.

Se decidi di utilizzare Solr come motore di ricerca, devi installare Solr localmente sul server e quindi abilitare e configurare i moduli di Drupal Solr sul portale.

Per abilitare i moduli Drupal Solr:

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

7. Installa SmartDocumenti (facoltativo)

SmartDocumenti consente di documentare le API sul portale Developer Services in modo da rendere la documentazione delle API completamente interattiva. Tuttavia, per utilizzare SmartDocumenti con il portale, devi prima installare SmartDocumenti su Edge.

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

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

8. E adesso?

Dopo l'installazione del portale Servizi per gli sviluppatori, i passaggi successivi spiegano come configurarlo e personalizzarlo in base ai tuoi requisiti specifici. La documentazione sul sito web di Apigee contiene tutte le informazioni sulla configurazione, l'applicazione di stili e la gestione di 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 da eseguire dopo l'installazione e include i link alla documentazione di Apigee dove puoi trovare ulteriori informazioni:

Attività

Descrizione

Personalizzazione del tema

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

Personalizza 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 gli account utente

Il processo di registrazione controlla il modo in cui i nuovi sviluppatori registrano un account sul portale. Ad esempio, i nuovi sviluppatori possono accedere immediatamente 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 dell'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 gli 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 sui ruoli. Prima di consentire agli sviluppatori di registrarsi, definisci le autorizzazioni e i ruoli utilizzati dal portale.

Aggiungi post di blog e forum

Il portale dispone di supporto integrato per blog e forum con conversazioni in thread. Definisci le autorizzazioni necessarie per visualizzare, aggiungere, modificare ed eliminare post di blog e forum.

Assicurati di eseguire backup del database

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

Nota: il modulo Backup e 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 su una configurazione di base.

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

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