Configurare gli avvisi relativi alla scadenza

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Utilizza un avviso di scadenza TLS per inviare una notifica quando il certificato TLS in un ambiente sta per scadere.

Informazioni sui certificati TLS

TLS (Transport Layer Security) è la tecnologia di sicurezza standard per stabilire un collegamento criptato tra un server web e un client web, ad esempio un browser o un'app. Un link criptato garantisce che tutti i dati trasmessi tra il server e il client rimangano privati.

Un certificato TLS è un file digitale che identifica un'entità in una transazione TLS. Edge utilizza un certificato TLS per configurare TLS per:

Un certificato TLS contiene una data di scadenza. Se un certificato TLS scade, la connessione TLS non va a buon fine fino all'aggiornamento del certificato. Ciò significa che tutte le richieste all'API non andranno a buon fine finché non aggiorni il certificato.

Informazioni sugli avvisi relativi alla scadenza

Anziché attendere la scadenza di un certificato e l'esito negativo delle richieste all'API, utilizza un avviso di scadenza per inviare una notifica quando un certificato TLS in un ambiente sta per scadere. Una volta attivato l'avviso, puoi aggiornarlo in modo che i clienti non vedano interruzioni del servizio.

Quando configuri l'avviso, non specificare un singolo certificato, ma un ambiente specifico. L'avviso viene attivato quando viene pianificata la scadenza di un certificato di cui è stato eseguito il deployment nell'intervallo di tempo specificato.

Puoi impostare l'avviso di scadenza in modo che venga applicato:

  • 1 giorno prima della scadenza di qualsiasi certificato
  • 14 giorni prima della scadenza del certificato
  • 30 giorni prima della scadenza di qualsiasi certificato
Per saperne di più sugli avvisi, vedi Configurare avvisi e notifiche.

Aggiungi avvisi e notifiche relativi alla scadenza

Per aggiungere avvisi e notifiche relativi alla scadenza:
  1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
  2. Fai clic su +Avviso.
  3. Inserisci le seguenti informazioni generali sull'avviso:
    Campo Descrizione
    Nome dell'avviso Nome dell'avviso. Utilizza un nome che descriva l'attivatore e che sia significativo per te. Il nome non può superare i 128 caratteri.
    Descrizione Descrizione dell'avviso.
    Tipo di avviso: Seleziona Scadenza TLS. Per saperne di più, consulta Informazioni sui tipi di avvisi.
    Ambiente Seleziona l'ambiente dall'elenco a discesa.
    Stato Attiva/disattiva per abilitare o disabilitare l'avviso.
  4. Definisci la soglia e la dimensione per la condizione che attiverà l'avviso.
    Campo Condizione Descrizione
    Soglia

    Configura l'intervallo di tempo per i certificati in scadenza. Puoi scegliere di attivare un avviso quando un certificato sta per scadere:

    • 1 giorno
    • 14 giorni
    • 30 giorni
    Dimensione Le dimensioni sono fisse sul valore Qualsiasi certificato TLS corrispondente a qualsiasi certificato TLS nell'ambiente.
  5. Fai clic su + Notifica per aggiungere una notifica di avviso.
    Dettagli notifica Descrizione
    Canale Seleziona il canale di notifica che vuoi utilizzare e specifica la destinazione: Email, Slack, PagerDuty o webhook.
    Destinazione Specifica la destinazione in base al tipo di canale selezionato:
    • Email - Indirizzo email, ad esempio joe@company.com
    • Slack - URL del canale Slack, ad esempio https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - Codice PagerDuty, ad esempio abcd1234efgh56789
    • Webhook - URL webhook, ad esempio https://apigee.com/test-webhook

      Nota: puoi specificare una sola destinazione per notifica. Per specificare più destinazioni per lo stesso tipo di canale, aggiungi altre notifiche.

  6. Per aggiungere altre notifiche, ripeti il passaggio precedente.
  7. Se hai aggiunto una notifica, imposta i seguenti campi:
    Campo Descrizione
    Playbook (Facoltativo) Campo di testo in formato libero per fornire una breve descrizione delle azioni consigliate per risolvere gli avvisi quando vengono attivati. Puoi anche specificare un link alla tua pagina wiki interna o della tua community in cui fare riferimento alle best practice. Le informazioni in questo campo verranno incluse nella notifica. Il contenuto di questo campo non può superare i 1500 caratteri.
    Limitazione Frequenza con cui inviare notifiche. Seleziona un valore dall'elenco a discesa.
  8. Fai clic su Salva.

Visualizzare gli avvisi nella dashboard Eventi

Quando Edge rileva una condizione di avviso, la registra automaticamente nella dashboard Eventi nell'interfaccia utente perimetrale. L'elenco degli eventi visualizzati nella dashboard Eventi include tutti gli avvisi, fissi e certificati.

Per visualizzare un avviso:

  1. Fai clic su Analizza > Eventi nell'interfaccia utente Edge. Viene visualizzata la nuova dashboard Eventi:

  2. Filtra la dashboard Eventi per:

    • Ambiente
    • Regione
    • Periodo di tempo
  3. Seleziona una riga nella dashboard Eventi per visualizzare l'archivio chiavi contenente il certificato in scadenza al fine di esaminare ulteriormente l'avviso. Dalla pagina dell'archivio chiavi puoi caricare un nuovo certificato ed eliminare quello in scadenza.

Usa le API di avviso con avvisi di scadenza

La maggior parte delle API che utilizzi per creare e gestire gli avvisi di scadenza sono le stesse che utilizzi con gli avvisi corretti. Le seguenti API di avviso funzionano nello stesso modo sia per gli avvisi corretti che per quelli di scadenza:

Tuttavia, alcune API hanno proprietà aggiuntive utilizzate per supportare gli avvisi di anomalie, tra cui:

Crea o aggiorna un avviso di scadenza

Utilizza le stesse API per creare o aggiornare un avviso di scadenza come fai attualmente per un avviso corretto. Il corpo della chiamata API per creare o aggiornare un avviso di scadenza è lo stesso utilizzato per un avviso fisso, con le seguenti modifiche:

  • Devi aggiungere le seguenti nuove proprietà per specificare che si tratta di un avviso di scadenza:

    "alertType": "cert"
    "alertSubType": "certfixed"

    I valori predefiniti di queste proprietà sono:

    "alertType": "runtime"
    "alertSubType": "fixed"
  • Nell'array conditions:

    • La proprietà metrics accetta solo i valori di expiration.
    • Utilizza la proprietà gracePeriodSeconds per specificare l'intervallo di tempo in secondi per la scadenza del certificato, fino a una durata massima di 30 giorni.
    • Le proprietà threshold, durationSeconds e comparator non sono supportate.
  • Nell'elemento dimensions dell'array conditions:
    • Devi impostare il valore della proprietà certificate su ANY.
    • Devi impostare il valore della proprietà proxy su ALL.
    • Le proprietà statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory e faultCodeName non sono supportate.
  • La proprietà reportEnabled non è supportata per gli avvisi relativi alla scadenza.

La chiamata API di esempio seguente crea un avviso di scadenza che viene attivato quando una chiamata nell'ambiente di produzione scade nei 30 giorni successivi. Viene inviata una notifica all'indirizzo email specificato quando viene attivato l'avviso:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso per OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzo di cURL.

Ricevi avvisi sulle scadenze

Per impostazione predefinita, l'API Get Alerts restituisce informazioni su tutti gli avvisi definiti, sia fissi che con scadenza. Questa API ora utilizza i parametri di query per consentirti di filtrare i risultati:

  • enabled - Se true specifica di restituire solo avvisi abilitati. Il valore predefinito è false.
  • alertType: specifica il tipo di avviso da restituire. I valori consentiti sono runtime, il valore predefinito e cert.
  • alertSubType: specifica il sottotipo di avviso da restituire. Il valore predefinito non è impostato, il che significa che vengono restituiti tutti i sottotipi di avvisi. Specifica certfixed per restituire avvisi sulla scadenza.

Ad esempio, utilizza la seguente chiamata API per restituire l'attivazione solo degli avvisi per l'organizzazione denominata myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

La chiamata seguente restituisce solo avvisi di scadenza, sia abilitati che disattivati:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso per OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzo di cURL.