Progetto progetto Jenkins

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
Progetto Jenkins
Technical writer:
Zaycode
Nome progetto:
Jenkins su Kubernetes
Durata del progetto:
Durata standard (3 mesi)

Project description

Kubernetes è uno strumento di orchestrazione dei container indipendente dalla piattaforma, creato da Google e fortemente supportato dalla community open source come progetto della Cloud Native Computing Foundation. Consente di utilizzare le istanze di container e gestirle per la scalabilità e la tolleranza di errore. Gestisce inoltre un'ampia gamma di attività di gestione che altrimenti richiederebbero soluzioni separate o codice personalizzato, tra cui routing delle richieste, rilevamento dei container, controlli di integrità e aggiornamenti in sequenza.

Kubernetes è compatibile con la maggior parte degli strumenti CI/CD che consentono agli sviluppatori di eseguire test, distribuire build in Kubernetes e aggiornare le applicazioni senza tempi di inattività. Uno degli strumenti di CI/CD più popolari oggi è Jenkins per i seguenti motivi: 1. È open source e senza costi. 2. è facile da usare, facile da installare e non richiede installazioni o componenti aggiuntivi. 3. Jenkins è anche abbastanza facile da configurare, modificare ed estendere. 4. Esegue il deployment del codice istantaneamente e genera report di test. 5. Jenkins può essere configurato in base ai requisiti per le integrazioni e la distribuzione continua. 6. Jenkins è disponibile per tutte le piattaforme e per diversi sistemi operativi, che si tratti di OS X, Windows o Linux. 7. Vanta inoltre un ricco ecosistema di plug-in. L'ampio pool di plug-in rende Jenkins flessibile e consente la creazione, il deployment e l'automazione su varie piattaforme. 8. La maggior parte del lavoro di integrazione è automatizzata. Di conseguenza, meno problemi di integrazione. Ciò consente di risparmiare tempo e denaro nel corso della durata di un progetto.

I seguenti motivi hanno reso Jenkins su Kubernetes un tema popolare per gli utenti di Jenkins. Tuttavia, al momento non esiste una posizione centrale per la documentazione che descrive Jenkins su Kubernetes, rendendo così difficile per gli utenti di Jenkins su Kubernetes navigare e trovare informazioni. Questo progetto creerebbe una nuova pagina Soluzioni Kubernetes in cui sarebbero descritti i concetti, le tecniche e le scelte per gli utenti Kubernetes che eseguono Jenkins.

Stato attuale

Esistono molte presentazioni e articoli sull'esecuzione di Jenkins su Kubernetes. Tuttavia, non esiste una posizione centralizzata per descrivere Jenkins su Kubernetes. Ciò rende difficile per: 1. Jenkins su Kubernetes per navigare e trovare informazioni. 2. Monitorare, aggiornare e gestire le informazioni relative a Jenkins su Kubernetes

Perché la documentazione proposta rappresenta un miglioramento rispetto a quella attuale?

Per risolvere il problema esistente di Jenkins sulla documentazione di Kubernetes, creerò una pagina Soluzioni Kubernetes su Jenkins.io seguendo questa struttura che ho creato. Questa pagina Soluzioni aggregherà i materiali esistenti e i progetti correlati. Questo progetto offre i seguenti vantaggi:

  1. Migliora l'esperienza utente di Jenkins sugli utenti Kubernetes offrendo loro un punto di riferimento unico per trovare informazioni su Jenkins su Kubernetes.
  2. Semplifica il monitoraggio, l'aggiornamento e la gestione delle informazioni su Jenkins su Kubernetes utilizzando la pagina Soluzioni.

In qualità di sviluppatore, so quanto possa essere frustrante avere problemi e dover affrontare l'incertezza di dover navigare per ore prima di riuscire a trovare un'informazione, cosa che in genere avrebbe dovuto richiedere qualche minuto per scoprire se le informazioni erano ben strutturate. Ho scelto di lavorare a questo progetto perché la creazione di una pagina Soluzioni per Jenkins su Kubernetes mi avrebbe dato l'opportunità di migliorare l'esperienza degli utenti di Jenkins.

Analisi

Ho creato una struttura per la pagina Soluzioni Kubernetes, aggregando alcuni materiali esistenti su Jenkins su Kubernetes e link ad alcune risorse utili. Inoltre, tenendo presente che "non puoi creare una documentazione utente davvero eccellente finché non hai ascoltato le persone esterne alla tua organizzazione che usano effettivamente i prodotti, appreso i loro punti deboli e cercando di affrontarle nel miglior modo possibile", ho condiviso la nuova struttura della pagina Soluzioni Kubernetes con alcuni utenti di Jenkins su Kubernetes nella mia organizzazione, Interswitch, e con la community di Jenkins per ricevere feedback su cosa vorrebbero vedere nella nuova documentazione. Tuttavia, questa struttura deve essere accettata e modificata dai Mentori prima che inizi l'implementazione.

Obiettivi del progetto

Crea una nuova pagina delle soluzioni Kubernetes seguendo questa struttura nella pagina delle soluzioni Jenkins o un volume che descriva i concetti, le tecniche e le scelte per gli utenti Kubernetes che eseguono Jenkins.