Creazione di un Runbook

Creare un runbook personalizzato in Fleet Application Management utilizzando Visual Designer.

Fleet Application Management fornisce diversi runbook con passi predefiniti che è possibile utilizzare per eseguire task comuni di gestione del ciclo di vita, come i controlli dello stato pre-esecuzione e la ricerca automatica del server HTTP Oracle. Questi runbook sono disponibili nella libreria dei runbook. È inoltre possibile creare runbook personalizzati e pubblicarli per tutti gli utenti.

Nella pagina elenco Runbook, selezionare Crea runbook. Per informazioni su come trovare la pagina di elenco, vedere Elenca runbook.

La creazione di un runbook è costituita dalle seguenti pagine:
Eseguire ciascuno dei flussi di lavoro riportati di seguito in ordine. È possibile tornare a una pagina precedente selezionando Precedente.
1. Informazioni di base
Nella pagina Informazioni di base vengono fornite le informazioni di base per il runbook.

Immettere le informazioni riportate di seguito.
- Nome: immettere un nome descrittivo per il runbook. Il nome non deve essere univoco, ma non può essere modificato nella console. Tuttavia, puoi modificarlo con l'API. Evitare di fornire informazioni riservate.
- Descrizione: immettere una descrizione appropriata per il runbook.
- Crea nel compartimento: selezionare il compartimento in cui si desidera creare il runbook.
- Compartimento delle operazioni del ciclo di vita: selezionare un compartimento in cui esiste l'operazione specifica del ciclo di vita. Per informazioni sulle varie operazioni del ciclo di vita, vedere Operazione del ciclo di vita in Fleet Application Management.
- Operazione del ciclo di vita: selezionare un'operazione del ciclo di vita, ad esempio patch, ricerca automatica, provisioning o personalizzata.
- Per le operazioni del ciclo di vita di patch o ricerca automatica, immettere le informazioni riportate di seguito.
  
  Compartimento stack prodotto/prodotto: selezionare il compartimento in cui si trova il prodotto o lo stack di prodotti.
  
  Pila prodotto/prodotto: selezionare uno stack di prodotti o prodotti a cui appartiene il task dal compartimento.
- Tipo di sistema operativo: selezionare una piattaforma supportata dalle opzioni in cui viene eseguito il runbook.
- Tempo stimato (ore): selezionare il tempo stimato in ore per completare l'esecuzione del runbook.
- Imposta come runbook predefinito: attiva l'attivazione/disattivazione per consentire a Fleet Application Management di utilizzare questo runbook come runbook predefinito per l'esecuzione delle operazioni del ciclo di vita.
  
  Nota
  
  È possibile impostare come runbook predefinito un solo runbook per una determinata operazione del ciclo di vita e combinazione di prodotti o stack di prodotti. Fleet Application Management utilizza il runbook di ricerca automatica predefinito di uno stack di prodotti o prodotti per individuare l'inventario software del prodotto e il runbook di applicazione delle patch predefinito per selezionare automaticamente un runbook durante i task di creazione della pianificazione e correzione della conformità.
- Questo runbook richiede l'accesso SUDO: attiva l'attivazione/disattivazione se il tipo di sistema operativo è Oracle Linux per trovare e applicare patch per il software in esecuzione sulle istanze di computazione.
  L'accesso sudo è necessario quando il supporto del prodotto è necessario per Oracle WebLogic Server, Oracle HTTP Server (OHS) e Oracle Java, che non sono specifici di OCI.
  Nota
  
  Quando per il runbook è abilitato l'accesso sudo, il plugin Fleet Application Management esegue i task con il privilegio sudo. Il plugin Fleet Application Management utilizza un privilegio sudo integrato, ma è completamente controllato tramite la proprietà runbook isSudoAccessNeeded. Vedere Riferimento runbook.
Selezionare Successivo per passare al passo successivo.
2. Semplifica (Design Runbook)
La pagina Streamline (Design runbook) consente di progettare un flusso di lavoro di runbook utilizzando il visual designer o il codice di runbook.

Con Visual Designer, è possibile trascinare un'azione dal riquadro azioni nello sfondo, posizionandola dove si desidera nel flusso di lavoro del runbook. È inoltre possibile riordinare le azioni nel flusso di lavoro trascinandole in un'altra posizione.
Selezionare una delle opzioni seguenti.

Vista Progettazione: utilizzare Visual Designer trascinando i componenti e configurandoli. Saltare al passo 2.

Vista Codice: caricare il codice del runbook in un file YAML o JSON. Saltare al passo 3.

Se è stata selezionata l'opzione Progetta vista per la creazione del runbook, effettuare le operazioni riportate di seguito.

Importante

Per aggiungere un task, è innanzitutto necessario aggiungere un gruppo di risorse parallele o in sequenza. Un task deve essere all'interno di un gruppo. Per ulteriori informazioni sull'utilizzo di Visual Designer, vedere Progettazione di un runbook con Visual Designer.

Nella scheda Componenti del riquadro delle azioni, selezionare un gruppo di risorse parallelo o un gruppo di risorse in sequenza e trascinarlo nell'area di creazione. Aggiungere tutti i gruppi necessari.

Per l'esecuzione parallela dei task del runbook tra le risorse, selezionare un gruppo parallelo. Un gruppo di risorse parallele è un segnaposto per uno o più task al suo interno o un altro gruppo di task parallelo che esegue più task su una risorsa di destinazione in parallelo. Per ogni task aggiunto a un gruppo di risorse parallelo, l'elenco di task viene eseguito uno dopo l'altro su una risorsa specifica ma contemporaneamente in un elenco di risorse.

Per l'esecuzione sequenziale dei task del runbook, selezionare un gruppo di risorse in sequenza. Un gruppo di risorse in sequenza è un segnaposto per uno o più task in cui l'elenco di task viene eseguito uno dopo l'altro su una risorsa specifica. Dopo la corretta esecuzione dei task nella risorsa, il task successivo viene eseguito su un'altra risorsa.

Suggerimento

È possibile riordinare i componenti utilizzando l'icona di trascinamento () nell'angolo destro di un componente e trascinandolo in una posizione diversa nell'area di lavoro del runbook. Dopo aver inserito un componente nello sfondo, il relativo codice viene generato e aggiunto automaticamente al codice del runbook.

Selezionare un nuovo task e trascinarlo in un gruppo di risorse aggiunto. Immettere i dettagli nella pagina Crea task. Per istruzioni, vedere i passi da 4 a 17 in Creazione di un task utilizzando la console. È inoltre possibile aggiungere un task predefinito trascinandolo in un gruppo di risorse.

I task creati all'interno del runbook sono locali al runbook e non possono essere riutilizzati da altri runbook.

La libreria dei task fornisce un elenco di task riutilizzabili esistenti o creati dall'utente. È possibile utilizzare l'icona del trascinamento () nell'angolo destro di un task per trascinarlo nel gruppo di risorse.
Suggerimento

È innanzitutto possibile creare task di runbook in base alle esigenze, quindi aggiungerli a uno o più runbook in un secondo momento.

Per creare una copia del task nella libreria di task, selezionare Crea una copia di questo task nella libreria. Questo task fa quindi parte del runbook e della libreria di task. È tuttavia possibile riutilizzare e aggiornare il task della libreria indipendentemente dal task del runbook.

Per aggiornare le proprietà di un task, selezionare l'icona di modifica accanto al task, quindi aggiornare i valori dei campi nella pagina Modifica task.

Dopo aver aggiunto i componenti richiesti al runbook, selezionare l'icona delle proprietà () del componente per configurarlo utilizzando la scheda Proprietà.

Immettere un nome di passo univoco preferibilmente in base allo scopo. Evitare di inserire informazioni riservate.

Selezionare una delle seguenti azioni dall'elenco In caso di errore per configurare la modalità di gestione degli errori nel flusso di lavoro del runbook da parte dell'automazione:

Nota

Per impostazione predefinita, quando un componente runbook segnala un errore, l'automazione di Fleet Application Management arresta completamente il flusso di lavoro del runbook. Questo perché il valore predefinito per la proprietà In caso di errore per tutti i componenti è Interrompi.

Interrompi: interrompe completamente il workflow del runbook quando l'esecuzione del componente non riesce. Questa azione è impostata per impostazione predefinita.

Continua: consente di passare al passo successivo del workflow del runbook quando l'esecuzione del componente non riesce.

Rollback: annullare la modifica e tornare al livello iniziale del componente runbook.
Per eseguire il rollback, assicurarsi di selezionare la proprietà In caso di errore come Rollback. È possibile specificare la funzione di rollback a livello di destinazione o di gruppo (gruppo di azioni). Per eseguire il rollback a livello di destinazione, selezionare In caso di errore dei task oppure selezionare In caso di errore dei task di rollback per eseguire il rollback a livello di gruppo.

Per creare istruzioni condizionali per ogni componente del runbook utilizzando l'opzione Condizione,
Immettere una variabile nella casella della condizione, selezionare uno degli operatori aritmetici, ad esempio AND, NOT o altri, e immettere un valore per la condizione. Di seguito è riportato un esempio di istruzione condizionale.
Per la condizione seguente, se la variabile backuptype per un task è uguale al valore hot, il task viene eseguito oppure la Costruzione guidata condizione salta e passa al task successivo.
backuptype=hot

Configurare Esegui su per selezionare una delle seguenti opzioni per eseguire un task:

Istanze specificate dalla pianificazione: per consentire l'esecuzione di un task in modo condizionale solo su determinati componenti applicabili al prodotto (come definito nei metadati del prodotto) nella risorsa, selezionare Filtra istanze. Per istruzioni su come aggiungere condizioni di filtro, vedere il punto i.

Istanza self-hosted: per verificare la presenza di attività successive al provisioning, se necessario, selezionare un'istanza self-hosted appropriata creata in Gestione metadati nella sezione Amministrazione.
Nota

La selezione di un'istanza garantisce che il task venga eseguito solo su questo host (istanza).
Ad esempio, possono esistere due task in cui il tipo di azione del primo task è Esegui un Terraform che esegue il provisioning delle risorse. Il secondo task può essere con il tipo di azione Esegui uno script, in cui lo script include l'istanza self-hosted (host centrale) che controlla se le risorse vengono sottoposte a provisioning e in esecuzione.

Importante

Assicurarsi di abilitare il plugin Gestione applicazioni flotta nell'istanza self-hosted e nell'istanza associata. Questo passo garantisce che Fleet Application Management possa prendere in considerazione in modo efficace queste istanze per le operazioni del ciclo di vita.

Istanza specificata dal task precedente: per verificare se le risorse di cui è stato eseguito il provisioning vengono create ed eseguite quando non si configura un host centrale.
Ad esempio, possono essere presenti due task che eseguono le operazioni riportate di seguito.

Creare un primo task con il tipo di azione Esegui Terraform che esegue il provisioning delle istanze di computazione e restituisce l'OCID delle risorse di cui è stato eseguito il provisioning come variabile di output.

Creare un secondo task con il tipo di azione Eseguire uno script.

Selezionare Variabile di output del task precedente per fornire le variabili del task.

Immettere l'OCID risorsa restituito dal passo i o un tipo di risorsa facoltativo. Aggiungere ulteriori informazioni sull'host create dal primo task. Gli OCID o i tipi di risorsa fungono da input per il secondo task.
Suggerimento

Le informazioni sull'host possono essere fornite come file JSON con OCID risorsa descritti come array.

Fleet Application Management ora analizza le variabili di output ed esegue lo script sulle risorse.

Se nel passo secondario h è stata selezionata l'opzione Istanze specificate dalla pianificazione, selezionare Istanze per aprire la finestra di dialogo Filtra istanze.

Selezionare le proprietà del prodotto o del componente dalla casella sul lato sinistro per aggiungerlo alla casella di filtro sul lato destro.

Selezionare uno degli operatori aritmetici, ad esempio AND, NOT o altri.

Immettere un valore per la condizione nella casella Condizione.
Nota

Quando si selezionano le proprietà del prodotto o del componente, la casella di filtro viene popolata con una condizione grammaticale pertinente.
Di seguito è riportato un esempio della condizione di grammatica Run on.
target.product.name = <product_name> target.product.properties.<property_name> = <property_value> target.product.components.has(<component_name>) target.product.components.<component_name>.properties.<property_name> = <property_value>
Nota

Le condizioni basate sulle proprietà dipendono dalla comprensione della ricerca automatica dei prodotti.

Aggiungere altre istanze di filtro in base alle esigenze. Queste istanze vengono aggiunte alla riga successiva nella casella di filtro.

Attivare l'opzione Sospendi esecuzione per interrompere o ritardare l'esecuzione dei task per un periodo di tempo specifico finché non vengono soddisfatte determinate condizioni. Ad esempio, è possibile scegliere di sospendere l'esecuzione di un task a tempo indeterminato o finché non si riprende il task o per un periodo di tempo specifico selezionato.

Per ricevere una notifica quando lo stato del task cambia, attivare il pulsante di attivazione/disattivazione Notifica, quindi selezionare la casella di controllo per l'attività del task per il quale si desidera ricevere una notifica, ad esempio in caso di errore del task, in pausa o quando il task riesce.

Configurare le proprietà dei task aggiunti. Per una descrizione dei campi delle proprietà dei task, vedere i passi da 4 a 17 in Creazione di un task utilizzando la console.

Se nel passo 1 è stata selezionata la vista Codice per la creazione del runbook, selezionare se si utilizza JSON o YAML, quindi selezionare Carica codice runbook per aggiungere il file appropriato.
Selezionare Successivo per continuare con il passo successivo.
3. Revisione

Verificare il contenuto del runbook nella pagina Review. Modificare le impostazioni o tornare alle schermate precedenti per aggiungere informazioni.

Selezionare Salva come bozza per salvare inizialmente il runbook finché non si è certi di tutti i componenti.
Nota

Questa versione bozza del runbook non è attiva, non può essere utilizzata ed è contrassegnata come Bozza.

Per rendere il runbook utilizzabile dopo aver verificato tutti i relativi task e semplificare (sequenza di esecuzione), selezionare Pubblica versione più recente dalla pagina dei dettagli del runbook.

Il runbook pubblicato è disponibile per l'uso nel provisioning, nella ricerca automatica, nell'applicazione di patch o nel rollback e ha uno stato attivo.
Nota

Il runbook viene creato con la versione 1 come versione iniziale e ha uno stato attivo.
Utilizzare il comando oci fleet-apps-management fleet-apps-management-runbook create e i parametri necessari per creare un runbook personalizzato:
oci fleet-apps-management fleet-apps-management-runbooks runbook create --compartment-id <compartment_OCID> --display-name <text> --operation <text> --runbook-version <json_file_or_string> [OPTIONS]
Per un elenco completo dei flag e delle opzioni variabili per i comandi CLI di Fleet Application Management, vedere la sezione CLI for Fleet Application Management.
Eseguire l'operazione CreateRunbook per creare un runbook personalizzato.

Documentazione dell'infrastruttura Oracle Cloud

Creazione di un Runbook

1. Informazioni di base

2. Semplifica (Design Runbook)

3. Revisione