Installa il portale

Edge for Private Cloud v4.19.01

Prima di installare il portale Apigee Developer Services (o semplicemente il portale), assicurati che:

  1. 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.
  2. 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 all'indirizzo Software e versioni supportati.
  3. Yum è installato.

L'installatore include solo i moduli Drupal donati che sono richiesti dal portale Apigee Developer Services (o semplicemente il portale). Per informazioni sull'installazione di altri moduli di contributo, consulta Estensione di Drupal 7.

Panoramica dell'installazione

Per installare il portale, svolgi i seguenti passaggi. Ogni passaggio è descritto in modo più dettagliato nelle sezioni seguenti.

  1. Verifica la connessione
  2. Rimuovere le versioni di PHP precedenti alla 7.0
  3. Installa Postgres
  4. Installare il portale
  5. Assicurati che Gestione aggiornamenti sia attivata
  6. (Facoltativo) Configurare Apache Solr
  7. (Facoltativo) Installare SmartDocumenti
  8. (Facoltativo) Configura jQuery

Ritiro della proprietà SMTPSSL

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

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

Crea un file di configurazione del portale

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

# 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=YOUR_EMAIL_PASSWORD

1. Testare la connessione ad Apigee Edge

Testa la connessione tra il server su cui installerai il portale e il server di gestione Edge eseguendo il seguente comando curl 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.

Se l'esito è positivo, curl 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

Rimuovi i pacchetti PHP utilizzando il seguente comando:

yum remove package_name

Se non sai con certezza se PHP è installato sul tuo server, utilizza il seguente comando:

rpm -qa | grep -i php

Si noti che il portale utilizza PHP versione 4.18.01-0.0.49. Non è inteso che corrisponda al numero di versione di Apigee Edge for Private Cloud.

3. Installa Postgres

È necessario che Postgres sia installato nel portale. 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, consulta Installare i componenti di Edge su un nodo.

Per installare Postgres autonomamente:

  1. Installa l'utilità Edge apigee-setup sul nodo utilizzando la procedura con o senza internet. Per saperne di più, consulta Installare l'utilità apigee-setup di Edge.
  2. Crea un file di configurazione Postgres, come mostrato nell'esempio seguente:
    # 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 postgres_config_file

    L'opzione -p pdb specifica di installare Postgre. Il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".

4. Installare il portale

Prima di poter installare il portale, assicurati di aver eseguito quanto descritto in 3. Installa Postgres:

  1. Installa l'utilità Edge apigee-setup sul nodo del portale
  2. Installa Postgres, autonomo o nell'ambito dell'installazione di Edge

Per installare il portale:

  1. Al prompt dei comandi, esegui lo script setup:
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Dove:

    • configFile è il file di configurazione del portale come descritto in Creare un file di configurazione del portale.
    • -p dp indica allo script setup di installare il portale.

Per verificare che l'installazione del portale sia andata a buon fine:

  1. Vai alla home page del portale all'indirizzo http://localhost:8079 o al nome DNS del tuo portale.
  2. Accedi al portale utilizzando le credenziali di amministratore impostate nel file di configurazione del portale.
  3. Seleziona Report > Report sullo stato nel menu di Drupal per assicurarti di poter visualizzare lo stato corrente del portale.
  4. Assicurati che la connessione al server di gestione sia riuscita. In caso contrario:
    1. Vai alla pagina Configurazione connessione del portale (ad es. http://portal_IP:8079/admin/config/devconnect).
    2. Fai clic sul pulsante Test Connection (Verifica connessione). Se la connessione viene stabilita, non devi fare altro. Se la connessione non riesce, continua.
    3. Controlla le impostazioni dell'endpoint e dell'autenticazione:
      • URL dell'endpoint dell'API di gestione:verifica che il protocollo (HTTP o HTTPS), il nome IP o DNS e il numero di porta siano corretti, ad esempio:
        http://10.10.10.10:8080/v1
      • Utente autenticato endpoint: il nome utente dell'amministratore dell'organizzazione.
      • Password dell'utente autenticato: la password dell'amministratore dell'organizzazione.

      I valori predefiniti riflettono le impostazioni nel file di configurazione del portale che hai creato durante la procedura di installazione.

      Questi valori devono corrispondere ai valori ms_IP_or_DNS, email e password che hai utilizzato nel passaggio 1: verifica la connessione ad Apigee Edge. Il nome utente e la password devono corrispondere anche ai valori delle proprietà USER_NAME e USER_PWD nel file di configurazione dell'onboarding o alle credenziali di qualsiasi utente il cui ruolo è Amministratore dell'organizzazione.

    4. Dopo aver eseguito correttamente la connessione al server di gestione, fai clic sul pulsante Salva configurazione nella parte inferiore della pagina per salvare le modifiche.

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 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 è 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, 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 disabilitati 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 amministrativi 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 in modo da rendere la documentazione dell'API completamente interattiva. Tuttavia, per utilizzare SmartDocs con il portale, devi prima installarlo su Edge.

  • Se colleghi il portale a un'installazione Edge Cloud, SmartDocs è già installato e non è necessaria alcuna ulteriore configurazione.
  • Se colleghi il portale a un'installazione di Edge per il cloud privato, devi assicurarti che SmartDocs sia installato su Edge. Per saperne di più sull'installazione di Edge e SmartDocs, consulta Installare SmartDocs.

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

8. Configura il modulo Aggiornamento jQuery per le installazioni non su internet (facoltativo)

Se installi e utilizzi il modulo JQuery Update in un'installazione non su internet, devi configurare il modulo in modo che utilizzi 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 Aggiornamento jQuery, consulta 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 tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
  2. Seleziona Configurazione > Sviluppo > Aggiornamento JQuery nel menu di 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. Passaggi successivi

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 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 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.

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 se ricevi URL errati sul tuo sito per qualche altro motivo, puoi impostare $base_url per Drupal seguendo questi passaggi:

  1. Crea la directory /opt/apigee/data/apigee-drupal-devportal/sites/default/includes se non esiste.
  2. Crea un file denominato settings.php in quella directory.
  3. Aggiungi quanto segue al file settings.php:
    /**
    * 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. Modifica l'ultima riga $base_url in modo che corrisponda al nome host del tuo sito.
  5. Salva il file.

Tieni presente che in questo file puoi inserire qualsiasi altra impostazione da /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php.

Per ulteriori informazioni sulla proprietà $base_url, consulta quanto segue:

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 su sviluppo dei moduli di Drupal e inseriscilo nella directory /sites/all/modules.