Installazione del portale Servizi per gli sviluppatori

Edge per Private Cloud v. 4.17.05

Prima di eseguire l'installazione, assicurati di:

  • Devi installare Postgres prima di installare il portale. Puoi installare Postgres come parte sull'installazione di Edge o sull'installazione autonoma di Postgres per l'uso nel portale.
    • Se installi Postgres standalone, 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.
  • L'app Yum è installata.

Panoramica dell'installazione

Dopo aver installato l'utilità Edge apigee-setup su un nodo, usa quella 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 il parametro informazioni sull'installazione. Se nel file di configurazione mancano alcuni dati obbligatori informazioni, l'apigee-setup richiede di inserirlo nella riga di comando.

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

Ad esempio, usa 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 altre risorse.

Creazione di un file di configurazione

Di seguito è riportato un esempio di file di configurazione invisibile 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. Testare la tua 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'email indirizzo e password dell'amministratore di ORGNAME.

Assicurati di specificare il nome host e il numero di porta specifici per la tua installazione di Edge. Porta 8080 è la porta predefinita utilizzata da Edge. Se ti connetti a un'organizzazione nel cloud, allora 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. Rimozione delle versioni precedenti alla 7.0 di PHP

Lo script di installazione controlla la presenza di versioni precedenti a 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

Rimuovi i pacchetti PHP utilizzando il seguente comando:

yum remove <package-name>

3. Installa Postgres

È necessario che Postgres sia installato nel portale. Puoi installare Postgres durante l'installazione di Edge oppure installare Postgres standalone per l'utilizzo 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 standalone, 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 la versione autonoma di Postgres:

  1. Installa l'utilità Edge apigee-setup sul nodo utilizzando internet o una procedura non connessa a 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:

    # Deve risolversi in un indirizzo IP o DNS nome dell'host, non a 127.0.0.1 o localhost.
    HOSTIP=$(nome host -i)

    # Il pod e la regione di Postgres. Utilizza i valori predefiniti mostrati di seguito.
    MP_POD=gateway
    REGIONE=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 Postgre.

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

4. Installa il portale

Per installare il portale:

  1. Installa l'utilità Edge apigee-setup su al nodo utilizzando una procedura internet o non internet. Vedi Installare l'utilità apigee-setup Edge per altro ancora.
  2. Assicurati di aver installato Postgres, singolarmente o nell'ambito di l'installazione di Edge.
  3. Al prompt dei comandi, esegui lo script di configurazione:
    &gt; /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 da "apigee" utente.
  4. Vai alla home page del portale all'indirizzo http://localhost:8079 o al nome DNS di il tuo portale.
  5. Accedi al portale utilizzando le credenziali di amministratore impostate nel file di configurazione.

5. Assicurati che il modulo Gestore aggiornamenti sia attivata

Per ricevere notifiche relative agli aggiornamenti di Drupal, assicurati che il modulo gestore degli aggiornamenti di Drupal sia in un bucket con il controllo delle versioni attivo. Dal menu Drupal, seleziona Moduli e scorri verso il basso fino Modulo Gestione aggiornamenti. Se non è abilitato, abilitalo.

Una volta attivati, puoi visualizzare gli aggiornamenti disponibili nella sezione Report > Disponibile Voce di menu Aggiornamenti. Puoi anche utilizzare il seguente comando Drush:

> drush pm-info update

Devi eseguire questo comando dalla directory principale del sito. Per impostazione predefinita, lo sviluppatore Il portale è installato all'indirizzo /opt/apigee/apigee-drupal/wwwroot. Pertanto, dovresti prima cambiare la directory in /opt/apigee/apigee-drupal/wwwroot prima eseguendo il comando. Se non hai installato il portale nella directory predefinita, passa a nella directory di installazione.

Utilizza l'opzione 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 ricerca 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 disabilitati di installare 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 abilitare e configurare i moduli Drupal Solr sul portale.

Per abilitare 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. Installare SmartDocs (facoltativo)

SmartDocs ti consente di documentare le tue API sul portale 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 Edge Cloud, SmartDocs è già installato e non sono necessarie ulteriori configurazioni.
  • Se connetti il portale a un'installazione Edge per il cloud privato, devi assicurarti che SmartDocs è 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, vedi Utilizzo di SmartDocs per documentare per le API.

8. Configura il Modulo di aggiornamento JQuery per installazioni non internet (facoltativo)

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

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

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

9. E adesso?

I passaggi successivi dopo l'installazione del portale Servizi per gli sviluppatori sono la configurazione e la personalizzazione per soddisfare le tue esigenze specifiche. La documentazione sul sito web di Apigee contiene tutti i informazioni su configurazione, stile e gestione di un portale. Accedi alla documentazione all'indirizzo http://apigee.com/docs/developer-services/content/what-developer-portal.

Nella tabella seguente sono elencate 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

Personalizzare il tema

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

Personalizza il 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 nella portale. Ad esempio, i nuovi sviluppatori hanno accesso immediato al portale? devono essere verificati da un amministratore. Questo processo controlla anche il modo in cui un portale l'amministratore riceve una notifica quando viene creato un nuovo account.

Configurazione email

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

Aggiungere e gestire gli account utente

Aggiungi termini e Pagina delle condizioni che gli sviluppatori devono accettare prima di poterle consentire per 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, definire 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 necessaria 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, spetta a te stabilire il modo migliore per eseguire il backup del database.

Nota: il modulo Backup e migrazione non è compatibile con Postgres o Microsoft SQL Server.

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 all'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 configuri un bilanciatore del carico o ricevi URL errati sul tuo sito per alcuni Per un altro motivo, puoi impostare $base_url nel file settings.php del portale per sviluppatori, che per impostazione predefinita si trova /opt/apigee/apigee-drupal/wwwroot/sites/default.

Sviluppo personalizzato Potresti anche voler estendere le funzionalità del tuo portale con codice personalizzato al di fuori del tuo tema. Per farlo, crea il tuo modulo Drupal come descritto nella sua guida sviluppo e inserisci il modulo nel /sites/all/modules .