Installazione del portale Servizi per gli sviluppatori

Edge for Private Cloud v4.18.01

Prima di eseguire l'installazione, assicurati che:

• Installa Postgres prima di installare il portale. Puoi installare Postgres nell'ambito dell'installazione di Edge o installare Postgres in modalità autonoma per l'utilizzo da parte del portale.
  • Se installi Postgres in modalità autonoma, può trovarsi sullo stesso nodo del portale.
  • Se ti connetti a Postgres installato nell'ambito 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.

Il programma di installazione include solo i moduli forniti da Drupal richiesti dal portale Apigee Developer Services (o semplicemente il portale). Per informazioni sull'installazione di altri moduli forniti, consulta Estensione di Drupal 7.

Panoramica dell'installazione

Dopo aver installato l'utilità apigee-setup di Edge su un nodo, utilizzala 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 all'utilità apigee-setup un file di configurazione contenente 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

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

Ritiro della proprietà SMTPSSL

Nelle versioni precedenti, utilizzavi la proprietà SMTPSSL per impostare il protocollo utilizzato dal server SMTP connesso al portale. Questa proprietà è stata ritirata.

Ora utilizzi la proprietà SMTP_PROTOCOL, anziché la proprietà SMTPSSL, per impostare il protocollo utilizzato dal server SMTP connesso al portale. I valori validi sono: "standard", "ssl" o "tls".

Creazione di un file di configurazione

Di seguito è riportato un esempio di file di configurazione invisibile all'utente per un'installazione del portale. Modifica questo file in base alle tue esigenze di 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 

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

Testa la connessione al server di gestione Edge 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 per la 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.

Se l'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 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 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

Rimuovi i pacchetti PHP utilizzando il seguente comando:

yum remove package-name

3. Installa Postgres

Per installare il portale, è necessario che Postgres sia installato. Puoi installare Postgres nell'ambito dell'installazione di Edge o installare Postgres in modalità autonoma 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 in modalità autonoma, può trovarsi sullo stesso nodo del portale.

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

Per installare Postgres autonomo:

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

   # 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. 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 PostgreSQL. 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 con o senza connessione a internet. Per saperne di più, consulta Installa l'utilità apigee-setup di Edge.
2. Assicurati di aver installato Postgres, in modalità autonoma o come parte 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 per assicurarti che il portale funzioni correttamente.
6. Seleziona Report > Report sullo stato nel menu Drupal per assicurarti di poter visualizzare lo stato attuale del portale.

5. Assicurati che il modulo Update manager sia abilitato

Per ricevere notifiche sugli aggiornamenti di Drupal, assicurati che il modulo Drupal Update manager sia abilitato. Dal menu Drupal, seleziona Modules (Moduli) e scorri verso il basso fino al modulo Update manager (Gestore aggiornamenti). Se non è abilitata, abilitala.

Una volta abilitata, 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 root del sito. Per impostazione predefinita, il portale per sviluppatori è installato in /opt/apigee/apigee-drupal/wwwroot. Pertanto, devi prima cambiare directory in /opt/apigee/apigee-drupal/wwwroot 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. Configura il motore di ricerca Apache Solr (facoltativo)

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 Solr di Drupal.

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

Per attivare i moduli Drupal Solr:

1. Accedi al 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. Installa SmartDocs (facoltativo)

SmartDocs ti consente di documentare le tue API sul portale dei servizi per sviluppatori in modo da rendere la documentazione dell'API completamente interattiva. Tuttavia, per utilizzare SmartDocs con il portale, devi prima installare SmartDocs su Edge.

• Se stai connettendo il portale a un'installazione di Edge Cloud, SmartDocs è già installato e non è necessaria alcuna ulteriore configurazione.
• Se stai connettendo il portale a un'installazione di Edge for Private Cloud, devi assicurarti che SmartDocs sia installato su Edge. Per saperne di più sull'installazione di Edge e SmartDocs, consulta Installa SmartDocs.

Devi anche attivare SmartDocs sul portale. Per saperne di più su SmartDocs, consulta Utilizzo di SmartDocs per documentare le API.

8. Configura il modulo JQuery Update per le installazioni non connesse a internet (facoltativo)

Se installi e utilizzi il modulo JQuery Update in un'installazione non connessa a internet, devi configurare il modulo in modo che utilizzi la versione locale di JQuery. Se configuri il modulo in modo che utilizzi una CDN per un'installazione non internet, tenterà di accedere alla CDN e causerà ritardi nel caricamento della pagina. Per ulteriori informazioni sul modulo di aggiornamento di JQuery, visita la pagina https://www.drupal.org/project/jquery_update.

Per configurare il modulo JQuery Update in modo che utilizzi la versione locale di JQuery:

1. Accedi al portale come utente con privilegi di amministratore o di creazione di contenuti.
2. Seleziona Configuration (Configurazione) > Development (Sviluppo) > JQuery Update (Aggiornamento JQuery) nel menu di Drupal.
3. Fai clic su Rendimento nel menu di navigazione a sinistra.
4. Nel menu a discesa CDN JQuery e JQuery UI, seleziona Nessuno.
5. Fai clic su Salva configurazione.

9. E adesso?

I passaggi successivi all'installazione del portale Developer Services consistono nella configurazione e nella personalizzazione in base ai tuoi requisiti specifici. La documentazione sul sito web di Apigee contiene tutte le informazioni sulla configurazione, sullo stile e sulla 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 che esegui dopo l'installazione e include link alla documentazione di Apigee dove puoi trovare ulteriori informazioni: