Installazione del portale Servizi per gli sviluppatori

Portale di Servizi per gli sviluppatori v. 4.16.05

Per installare il portale Developer Channel Services, procedi nel seguente modo.

Prima di procedere con l'installazione, esegui un backup dell'intera directory root web di Drupal. Il percorso di installazione predefinito è /var/www/html, ma potresti averlo modificato al momento dell'installazione. Dopo aver eseguito la procedura di installazione descritta di seguito, puoi ripristinare le personalizzazioni dal backup.

1. Acquistare il pacchetto Developer Channel Services

Vai a http://community.apigee.com/content/apigee-customer-support e seleziona Accedi al tuo portale di assistenza per richiedere il file .tar di Developer Channel Services in uno dei due modi seguenti:

  • Richiedi l'accesso alla directory di download di Edge per Cloud privato.
  • 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 tuo 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 sotto forma di singolo file .tar.gz. Per eseguire l'installazione, copia quindi il file .tar.gz sul server senza connessione a Internet.
    1. Accedi a un server con una connessione Internet come utente root o come super user.
    2. Crea una directory per i file di installazione, ad esempio portal_tar.
    3. nella 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 questo comando:
      > tar -xvf <tar file>
    5. CD per DeveloperServices-4.x.y.z.
    6. Crea il file .tar.gz del portale utilizzando questo comando:
      > ./non-networked-install.sh

      Questo comando scarica tutti i file necessari e li esegue in un unico file .tar.gz. Quindi, per completare l'installazione, copia il file .tar.gz sul server senza connessione a internet.
  4. Verifica la tua connessione al server di gestione perimetrale 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 l'indirizzo email dell'amministratore

    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 foo2 nel cloud, l'URL della richiesta è:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    Se l'operazione ha esito positivo, questo comando restituisce una risposta simile alla seguente:
    {
    "createdAt" : 1348689232699,
    "createdBy" : "displayName"









3. Installa Developer Channel Services utilizzando lo script di installazione automatica

Per installare il portale utilizzando lo script di installazione automatica, procedi nel seguente modo. Questa procedura funziona per i server con o senza una connessione a internet esterna.

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

      Puoi scaricare un file dal link che ti è stato inviato da Apigee in un browser oppure copiandolo e aggiungendolo al seguente comando cURL:
      > curl -kOL <Incolla link qui>
    2. Estrai i contenuti del file .tar di Developer Channel Services utilizzando questo comando:
      > tar -xvf <tar file>
    3. CD per DeveloperServices-4.x.y.z.
    4. Esegui lo script di installazione utilizzando questo comando:
      > ./networked-install.sh
  4. Su un server senza connessione a internet:
    1. Copia il file .tar.gz creato nella sezione 2. Assicurati che il tuo sistema soddisfi i requisiti di sistema.
    2. Estrai i contenuti del file .tar.gz utilizzando questo comando:
      > tar -xvf <tar file>
    3. nella directory creata dal comando tar.
    4. Imposta le autorizzazioni nello script install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
    5. Esegui lo script install-from-rpm-bundle.sh utilizzando questo comando:
      > ./install-from-rpm-bundle.sh
  5. Rispondi alle richieste.
  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://indirizzo_IP o http://nome_DNS.

    Verrà visualizzata la pagina di configurazione del database del profilo Apigee.

    Nota: in genere, hai già configurato un nome host e lo hai registrato con il 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 sulla connessione al computer, quindi seleziona Salva e continua.
  8. Configura la connessione all'endpoint Apigee inserendo le seguenti informazioni e quindi seleziona Salva:
    Per saperne di più su questi valori, consulta la sezione "Informazioni richieste prima di avviare l'installazione" nei requisiti del portale Servizi per gli sviluppatori.
    1. Organizzazione del portale di sviluppo
    2. URL endpoint portale per sviluppatori
    3. Utente autenticato con endpoint
    4. Password utente autenticata
  9. Quando richiesto, seleziona il pulsante Installa SmartDocumenti WADL di esempio per installare il WADL di SmartDocs di esempio. Se salti questo passaggio, l'API SmartDocs di esempio non verrà visualizzata sul tuo portale.
    Nota: se il tuo portale si connette a un'installazione di Apigee Edge per Private Cloud e questa non ha una connessione a internet esterna, devi eseguire una configurazione aggiuntiva del modulo SmartDocumenti prima di poter utilizzare SmartDocumenti. Per ulteriori informazioni su SmartDocs, vedi http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Configura le impostazioni del server SMTP. Apigee richiede la configurazione di un server SMTP per l'invio di messaggi email dal portale.
    Per ulteriori informazioni, vedi http://apigee.com/docs/developer-services/content/configuring-email.
  11. Configura l'utente amministratore inserendo le seguenti informazioni e 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 nella sezione 4 di seguito. Crea un utente amministratore.
    1. Nome e cognome dello sviluppatore
    2. Nome utente del portale per gli sviluppatori
    3. Password
    4. Indirizzo email
  12. Al termine dell'installazione, imposta le autorizzazioni sul 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 dell'amministratore.

4. Crea un utente amministratore

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

  1. nella 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 di scrittura sui file Drupal privati:
    > drush vget file_private_path

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

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

5. Imposta la password root di MySQL

Se hai installato MySQL durante l'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 cambiarla, utilizza il seguente comando:

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

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

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

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 consente di limitare l'accesso root solo al localhost e di rimuovere i database di test e l'utente anonimo creati per impostazione predefinita. L'esecuzione di questo script è vivamente consigliata per i server di produzione.
  2. Se richiesto dai criteri aziendali, abilita 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 vengono disabilitati quando installi il portale. La maggior parte dei portali utilizza il motore di ricerca interno Drupal, pertanto non richiedono 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.

9. (Facoltativo) Installa mod_ssl per supportare HTTPS

Il modulo mod_ssl viene utilizzato da Apache HTTP Server per gestire le pagine web tramite HTTPS. Se vuoi utilizzare HTTPS, usa il seguente comando per installare mod_ssl:

> yum install mod_ssl

Per ulteriori informazioni sulla configurazione del portale per l'utilizzo di SSL, vedi http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Facoltativo - Installa SmartDocumenti

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.

Per ulteriori informazioni su SmartDocumenti, vedi Utilizzare SmartDocs per documentare le API.

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

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 qualche altro motivo, puoi impostare $base_url nel file Dev Portal settings.php, che per impostazione predefinita si trova nella directory /var/www/html/sites/default.