Installazione del portale Servizi per gli sviluppatori

Developer Services Portal v. 4.16.05

Segui questi passaggi per installare il portale dei servizi per i canali per sviluppatori.

Prima di procedere con l'installazione, esegui il backup dell'intera directory principale web di Drupal. La posizione di installazione predefinita è /var/www/html, ma potresti averla modificata al momento dell'installazione. Dopo aver eseguito i passaggi di installazione descritti di seguito, puoi ripristinare le personalizzazioni dal backup.

1. Acquista il bundle Developer Channel Services

Vai su http://community.apigee.com/content/apigee-customer-support e seleziona Accedi al portale di assistenza per richiedere il file .tar dei servizi per i canali per sviluppatori in uno dei due modi seguenti:

  • Richiedi l'accesso alla directory di download di Edge for Private Cloud.
  • Richiedi un URL per il file .tar di Developer Channel Services.

2. Assicurati che il tuo sistema soddisfi i requisiti di sistema

Prima di installare il portale, il server deve soddisfare i seguenti requisiti:

  1. Assicurati di eseguire 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 qui.
  2. Assicurati che Yum sia installato.
  3. (Per un'installazione su un server senza connessione a internet) Devi prima scaricare tutti i file necessari su un server con connessione a internet come singolo file .tar.gz. Quindi, copia il file .tar.gz sul server senza connessione a internet per eseguire l'installazione.
    1. Accedi a un server con una connessione a internet come utente root o super utente.
    2. Crea una directory per i file di installazione, ad esempio portal_tar.
    3. Passa alla nuova directory e scarica il file Developer Channel Services DeveloperServices_x.y.z.tar, dove x.y.z corrisponde al numero di versione del portale.
    4. Estrai i contenuti del file .tar di Developer Channel Services utilizzando il comando:
      > tar -xvf <tar file>
    5. Passa alla directory DeveloperServices-4.x.y.z.
    6. Crea il file .tar.gz del portale utilizzando il comando:
      > ./non-networked-install.sh

      Questo comando scarica tutti i file necessari e li inserisce in un unico file .tar.gz. Poi, copia il file .tar.gz sul server senza connessione a internet per completare l'installazione.
  4. 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} https://{hostname}:8080/v1/organizations/{ORGNAME}

    Dove EMAIL e PASSWORD sono l'indirizzo email e la password dell'amministratore per 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'operazione va a buon fine, 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"
    }

3. Installa i servizi del canale per gli sviluppatori utilizzando lo script di installazione automatica

Utilizza la seguente procedura per installare il portale utilizzando lo script di installazione automatica. Questa procedura funziona per i server con o senza una connessione a internet esterna.

  1. Accedi al server come utente root o super utente.
  2. Crea una directory per i file di installazione, ad esempio portal.
  3. Su un server con una connessione a internet:
    1. Passa alla nuova directory portal e scarica il file DeveloperServices_x.y.z.tar di Developer Channel Services, dove x.y.z corrisponde al numero di versione del portale.

      Puoi scaricare un file dal link inviato da Apigee in un browser o copiandolo e aggiungendolo al seguente comando cURL:
      > curl -kOL <paste link here>
    2. Estrai i contenuti del file .tar di Developer Channel Services utilizzando il comando:
      > tar -xvf <tar file>
    3. Passa alla directory DeveloperServices-4.x.y.z.
    4. Esegui lo script di installazione utilizzando il seguente comando:
      > ./networked-install.sh
  4. Su un server senza connessione a internet:
    1. Copia il file .tar.gz che hai creato nella sezione 2. Assicurati che il tuo sistema soddisfi i requisiti di sistema.
    2. Estrai i contenuti del file .tar.gz utilizzando il comando:
      > tar -xvf <tar file>
    3. Passa alla directory creata dal comando tar.
    4. Imposta le autorizzazioni per lo script install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
    5. Esegui lo script install-from-rpm-bundle.sh utilizzando il comando:
      > ./install-from-rpm-bundle.sh
  5. Rispondi ai prompt.
  6. Al termine dell'installazione, vai all'URL del server in un browser, ad esempio:
    http://localhost. In alternativa, se hai configurato un IP o un DNS specifico, vai a http://IP_address o http://DNS_name.

    Viene visualizzata la pagina di configurazione del database del profilo Apigee.

    Nota: in genere, avrai già configurato un nome host e lo avrai registrato con il tuo server DNS in modo da non dover utilizzare http://localhost.
  7. Configura la connessione a MySQL. Se MySQL si trova su una macchina remota, espandi la sezione Opzioni avanzate e inserisci le informazioni di connessione alla macchina, quindi seleziona Salva e continua.
  8. Configura la connessione all'endpoint Apigee inserendo le seguenti informazioni, quindi seleziona Salva:
    Per ulteriori informazioni su questi valori, consulta "Informazioni richieste prima di iniziare l'installazione" nella sezione Requisiti del portale dei servizi per sviluppatori.
    1. Organizzazione del portale per gli sviluppatori
    2. URL endpoint del portale per sviluppatori
    3. Endpoint Authenticated User
    4. Password degli utenti autenticati
  9. Quando richiesto, seleziona il pulsante Install Sample SmartDocs WADL per installare il WADL SmartDocs di esempio. Se salti questo passaggio, l'API SmartDocs di esempio non verrà visualizzata nel tuo portale.
    Nota: se il portale si connette a un'installazione di Apigee Edge for Private Cloud e l'installazione di Edge non dispone di una connessione a internet esterna, devi eseguire una configurazione aggiuntiva del modulo SmartDocs prima di poter utilizzare SmartDocs. Per saperne di più su SmartDocs, consulta http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Configura le impostazioni del server SMTP. Apigee richiede di configurare un server SMTP per inviare messaggi email dal portale.
    Per ulteriori informazioni, consulta http://apigee.com/docs/developer-services/content/configuring-email.
  11. Configura l'utente amministratore inserendo le seguenti informazioni, quindi seleziona Salva. Tieni presente che Drupal crea un utente amministratore denominato "admin" per impostazione predefinita, quindi non utilizzare "admin" come nome utente.
    Se salti questo passaggio, puoi comunque utilizzare Drush per creare un amministratore come descritto di seguito al punto 4. Crea un utente amministratore.
    1. Nome e cognome dello sviluppatore
    2. Nome utente del portale per sviluppatori
    3. Password
    4. Indirizzo email
  12. Al termine dell'installazione, imposta le autorizzazioni per il file settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. Vai alla home page del portale all'indirizzo http://localhost/ o al nome DNS del tuo portale.
  14. Accedi al portale utilizzando le credenziali di amministratore.

4. Crea un utente amministratore

Utilizza Drush per creare un utente amministrativo per l'installazione di Developer Channel Services. Drupal crea automaticamente un utente amministratore denominato "admin" per impostazione predefinita, quindi non utilizzare "admin" come nome utente.

  1. Passa alla directory drupal_root/sites/default. La posizione standard della directory root di Drupal è /var/www/html:
    > cd <drupal_root>/sites/default
  2. Assicurati di disporre delle autorizzazioni in scrittura sui file Drupal privati:
    > drush vget file_private_path

    Questo comando restituisce il percorso dei file Drupal privati, ad esempio:
    file_private_path: 'sites/default/private'

    Corrispondente a /var/www/html/sites/default/private/. Utilizza il seguente comando per assicurarti che questa directory sia scrivibile dal proprietario e dal gruppo:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Inserisci i seguenti comandi per creare un utente amministratore, sostituendo i comandi tra "< >" con i tuoi valori:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush user-add-role Administrator <username>
  4. Accedi al portale per sviluppatori come amministratore utilizzando il nome utente e la password specificati sopra.

5. Imposta la password root di MySQL

Se hai installato MySQL nell'ambito dell'installazione del portale, lo script di installazione lascia la password root di MySQL impostata sul valore predefinito, che è vuoto.

Utilizza il seguente comando per impostare la password root:

> mysqladmin -u root password NEWPASSWORD

Se hai già impostato la password root e vuoi modificarla, utilizza il seguente comando:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

Devi anche aggiornare la password nel file /var/www/html/sites/default/settings.php.

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

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.

7. (Facoltativo) Deployment su un server di produzione

Se esegui il deployment del portale su un server di produzione, devi eseguire ulteriori passaggi di sicurezza, tra cui:

  1. Esegui il seguente script per proteggere l'installazione di MySQL:
    > /usr/bin/mysql_secure_installation

    Questo script imposta la password root e ti offre la possibilità di limitare l'accesso root solo a localhost e di rimuovere i database di test e l'utente anonimo creato per impostazione predefinita. L'esecuzione di questo script è vivamente consigliata per i server di produzione.
  2. Se richiesto dalle policy aziendali, attiva e configura SELinux.

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

9. (Facoltativo) Installa mod_ssl per supportare HTTPS

Il modulo mod_ssl viene utilizzato dal server web Apache per pubblicare pagine web tramite HTTPS. Se vuoi utilizzare HTTPS, utilizza il seguente comando per installare mod_ssl:

> yum install mod_ssl

Per saperne di più sulla configurazione del portale per l'utilizzo di SSL, consulta http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. (Facoltativo) Installa SmartDocs

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.

Per saperne di più su SmartDocs, consulta Utilizzo di SmartDocs per documentare le API.

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

Attività

Descrizione

Personalizzazione del tema

Il tema definisce l'aspetto del portale, inclusi colori, 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.

Aggiungi e gestisci gli account utente

La procedura di registrazione controlla il modo in cui i nuovi sviluppatori registrano un account sul portale. Ad esempio, i nuovi sviluppatori ottengono l'accesso immediato al portale o devono essere verificati da un amministratore. Questo processo controlla anche il modo in cui un amministratore del portale riceve una notifica 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.

Aggiungi e gestisci gli account utente

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

Aggiungi e gestisci 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 ha un supporto integrato per blog e forum con 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 determinare il modo migliore per eseguire il backup del database.

Configura 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 altre configurazioni in una configurazione di base.

Se configuri un bilanciatore del carico o ricevi URL errati sul tuo sito per qualche altro motivo, puoi impostare $base_url nel file settings.php del portale per sviluppatori, che per impostazione predefinita si trova nella directory /var/www/html/sites/default.