Gestione della configurazione dell'agente utilizzando Git

Se ospiti tu stesso il Git repository, puoi utilizzare un certificato autofirmato. Affinché l'agente possa connettersi in modo sicuro a un Git repository, è necessario importare il certificato autofirmato nell'archivio di certificati Java. Per ulteriori informazioni, consulta Certificati autofirmati.

L'accesso a un Git repository può essere autorizzato utilizzando un .netrc file per fornire la password o il token di accesso. .netrc è ampiamente utilizzato e ulteriori dettagli al riguardo sono disponibili nella pagina man di.netrc.

È possibile configurare il .netrc file nella directory home dell'utente (ad esempio, root) in cui è in esecuzione l'host agent Instana. Vedi il seguente file di .netrc esempio per il github.com repository:

machine github.com
login oauth2
password <access_token>

Nel Git repository è necessario avere la stessa struttura di directory presente in *instanaAgentDir*/etc. Ad esempio, se si desidera ottenere i dati dal Git file denominato configuration-mysql.yaml, questo file deve essere inserito nella Git directory denominata instana (ovvero il file instana/configuration-mysql.yaml). Altrimenti, quando il file viene ottenuto dal Git repository, viene collocato nella posizione errata sul server e non viene utilizzato dall'agente host Instana.

La figura seguente mostra la struttura esemplificativa di un Git repository:

repository-root/
├── instana/
│   ├── configuration-mysql.yaml
│   └── com.instana.agent.main.config.UpdateManager.cfg
└── org.ops4j.pax.url.mvn.cfg

Utilizzando systemd, il modo più semplice per specificare i parametri aggiuntivi è utilizzare un file drop-in. Per visualizzare il percorso della directory drop-in, eseguire il seguente comando:

systemctl status instana-agent

I file in questa directory devono avere l'estensione .conf, altrimenti vengono ignorati.

1. Crea un nuovo file nella /etc/systemd/system/instana-agent.service.d/ directory con estensione .conf, ad esempio git-configuration-environments.conf.
2. Aggiungere il seguente contesto al file:

   [Service]
   Environment=INSTANA_GIT_REMOTE_BRANCH=<branch>
   Environment=INSTANA_GIT_REMOTE_REPOSITORY=<repository_url>
   Environment=INSTANA_GIT_REMOTE_USERNAME=<username>
   Environment=INSTANA_GIT_REMOTE_PASSWORD=<access_token>
   ```   **Notes:**
    - Replace *<branch>* with the name of the remote branch that the Instana host agent connects to.
    - Replace *<repository_url>* with the URL of the remote Git repository; for example, `https://github.com/<your_account>/<your_repo>.git`.
    - Replace *<username>* with a username or access token (for basic authentication). If you are using a `.netrc` file or a public repository, you can remove the whole line `Environment=INSTANA_GIT_REMOTE_USERNAME=<username>`.
    - Replace *<access_token>* with an access token. If you are using an access token as username (basic authentication), a `.netrc` file, or a public repository, you can remove the whole line `Environment=INSTANA_GIT_REMOTE_PASSWORD=<access_token>`.
   
   

Dopo aver aggiunto o modificato un file drop-in, completare i seguenti passaggi:

1. Ricarica i file drop-in eseguendo il comando systemctl daemon-reload.
2. Riavvia l'agente host Instana eseguendo il comando systemctl restart instana-agent.

Se sono state impostate le seguenti variabili di ambiente, all'avvio l'agente host verifica la presenza del repository Git locale nella *instanaAgentDir*/etc/ cartella. Se il repository Git locale non è presente, l'agente host crea un repository locale collegato al repository remoto.

Se l'agente Instana è in esecuzione direttamente su un host, è necessario impostare le seguenti variabili di ambiente sull'host. Se l'agente host è in esecuzione in un ambiente containerizzato, impostare le variabili a livello di container.

Fare riferimento alla -g, -b, -u e -p opzioni nella OneLiner documentazione, che mappa le variabili di INSTANA_GIT_REMOTE_REPOSITORY INSTANA_GIT_REMOTE_PASSWORD ambiente, INSTANA_GIT_REMOTE_BRANCH, INSTANA_GIT_REMOTE_USERNAME e per il metodo ambientale.

La tabella seguente mostra la corrispondenza tra le variabili d'ambiente e i parametri del comando one-liner:

I passaggi sono fondamentalmente gli stessi del metodo environment, aggiungendo le variabili di INSTANA_GIT_REMOTE_REPOSITORY INSTANA_GIT_REMOTE_PASSWORD ambiente, INSTANA_GIT_REMOTE_BRANCH, INSTANA_GIT_REMOTE_USERNAME e al Docker contenitore.

Ad esempio, il seguente esempio di codice fornisce i parametri necessari per avviare l'agente host in un contenitore e i parametri Git richiesti per abilitare la gestione della Git configurazione basata su :

# Please enter proper values for all --env arguments.
docker run \
   --detach \
   --name instana-agent \
   --volume /var/run:/var/run \
   --volume /run:/run \
   --volume /dev:/dev:ro \
   --volume /sys:/sys:ro \
   --volume /var/log:/var/log:ro \
   --privileged \
   --net=host \
   --pid=host \
   --env="INSTANA_AGENT_ENDPOINT=" \
   --env="INSTANA_AGENT_ENDPOINT_PORT=" \
   --env="INSTANA_AGENT_KEY=" \
   --env="INSTANA_DOWNLOAD_KEY=" \
   --env="INSTANA_AGENT_ZONE=" \
   --env="INSTANA_GIT_REMOTE_BRANCH=" \
   --env="INSTANA_GIT_REMOTE_PASSWORD=" \
   --env="INSTANA_GIT_REMOTE_REPOSITORY=" \
   --env="INSTANA_GIT_REMOTE_USERNAME=" \
   icr.io/instana/agent

La gestione della Git configurazione basata su può essere impostata nella sezione Gestione della configurazione nella dashboard Gestione agente.

La gestione della Git configurazione basata su può essere inizializzata e configurata utilizzando l'API come descritto nella Host Agent sezione della documentazione dell'API REST Web.

Una configurazione manuale consiste nell'inizializzare un Git repository nella *instanaAgentDir*/etc/ cartella e aggiungere un remote denominato configuration.

L'agente host estrae il ramo main locale utilizzando il ramo di tracciamento configurato dal configuration remoto. Esistono diversi modi per configurare il Git repository e puoi scegliere liberamente quello più adatto alla tua configurazione.

Ad esempio, la seguente configurazione consente all'agente host di recuperare le configurazioni dal main ramo del configuration remoto:

etc> git init
etc> git remote add -m main -t main configuration <git-repository-url>
etc> git fetch configuration
etc> git checkout -f -b main --track configuration/main

L'esempio seguente consente di estrarre le configurazioni dal my-configurations ramo nel configuration remoto:

etc> git init
etc> git remote add -m main -t my-configurations configuration <git-repository-url>
etc> git fetch configuration
etc> git checkout -f -b main --track configuration/my-configurations

I formati <git-repository-url> possibili sono descritti nella documentazione ufficiale sugli Git URL.

Git Gli hook sono programmi che è possibile inserire nella .git/hooks directory del repository e che si attivano in diversi momenti del ciclo di vita del Git repository. Git offre molti hook diversi, e post-update l'hook è il più adatto per l'integrazione con la gestione della Git configurazione basata su degli agenti host.

Il GitOps-Demo repository fornisce un hook di post-updateGit esempio che attiva l'aggiornamento degli agenti host ogni volta che viene aggiornato un ramo nel repository.

Vedi che l'output previsto dello script inviato al tuo Git client dopo aver attivato un push:

$ gitops-test# git push origin HEAD:main
[detached HEAD 9632c09] origin
 1 file changed, 1 insertion(+), 1 deletion(-)
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 12 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (4/4), 376 bytes | 376.00 KiB/s, done.
Total 4 (delta 1), reused 0 (delta 0)
remote: GitOps update: Triggering the configuration update of agents matching the following query: 'entity.zone:"test"' ... OK
   699ada9..9632c09  HEAD -> main

L 'azione GitHub Instana consente GitOps di attivare direttamente il controllo remoto degli agenti host utilizzando l'API Web di Instana.

Il GitOps-Demo repository mostra come configurare un repository su GitHub per gestire le configurazioni dell'agente host e come attivare automaticamente gli aggiornamenti utilizzando l'azione GitHub Instana per GitOps.

GitHub supporta HTTPS l'autenticazione tramite token, che può essere utilizzata dall'agente host come descritto in questa sezione.

Per utilizzare un GitHub repository, devi prima creare un token di accesso personale. I dettagli su come farlo sono documentati nella pagina Creazione di un token di accesso personaleGitHub della documentazione. Il token necessita solo dei permessi di lettura per accedere al repository.

GitHub si aspetta che il token venga fornito come nome utente di HTTPS autenticazione di base con una password vuota. Pertanto, l'agente host può essere configurato per utilizzare HTTPS l'autenticazione di base per GitHub i repository impostando le seguenti variabili di ambiente:

INSTANA_GIT_REMOTE_REPOSITORY='https://github.com/<user/organization>/<repository>.git
INSTANA_GIT_REMOTE_BRANCH='<branch>'
INSTANA_GIT_REMOTE_USERNAME='<token>'
INSTANA_GIT_REMOTE_PASSWORD=''

Si noti che lo stesso principio della password vuota e del token personale come nome utente funziona anche con gli altri metodi di configurazione dell'agente host per la gestione della Git configurazione basata su. Per una panoramica dei possibili approcci di configurazione, consultare la sezione Impostazione.

È possibile utilizzare diversi metodi per controllare gli aggiornamenti di versione dell'agente host distribuito negli ambienti di produzione. Se si utilizzano agenti statici, è necessario aggiornare manualmente l'agente host secondo necessità. Se si utilizzano agenti dinamici, è possibile configurare gli aggiornamenti per impostare intervalli di aggiornamento, versioni bloccate e così via. Per ulteriori informazioni, vedere Configurazione degli aggiornamenti degli agenti host dinamici. Se non viene specificata alcuna configurazione, gli aggiornamenti vengono applicati automaticamente all'agente dinamico ogni giorno. Inoltre, se è necessario un controllo più rigoroso sugli aggiornamenti di versione dell'agente host, è possibile utilizzare una combinazione di fissaggio dinamico della versione dell'agente con la gestione della Git configurazione basata su. Se disponi di un ambiente di test, puoi testare le distribuzioni dell'agente in uno scenario simile a quello di produzione prima di applicare l'aggiornamento in produzione.