Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Jenkins-Projekt
- Technischer Redakteur:
- Zaycodes
- Projektname:
- Jenkins in Kubernetes
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Kubernetes ist ein plattformunabhängiges Container-Orchestrierungstool, das von Google entwickelt und als Projekt der Cloud Native Computing Foundation von der Open-Source-Community stark unterstützt wird. Sie können Containerinstanzen verwenden und für Skalierung und Ausfallsicherheit verwalten. Außerdem werden damit eine Vielzahl von Verwaltungsaktivitäten ausgeführt, für die sonst separate Lösungen oder benutzerdefinierter Code erforderlich wären, z. B. das Routing von Anfragen, die Containererkennung, Systemdiagnosen und schrittweise Updates.
Kubernetes ist mit den meisten CI/CD-Tools kompatibel, mit denen Entwickler ohne Ausfallzeiten Tests ausführen, Builds in Kubernetes bereitstellen und Anwendungen aktualisieren können. Jenkins ist eines der beliebtesten CI/CD-Tools aus folgenden Gründen: Es ist Open Source und kostenlos. 2. Sie ist nutzerfreundlich, einfach zu installieren und erfordert keine zusätzlichen Installationen oder Komponenten. 3. Jenkins lässt sich außerdem ganz einfach konfigurieren, ändern und erweitern. 4. Es wird Code sofort bereitgestellt und Testberichte werden generiert. 5. Jenkins kann gemäß den Anforderungen für kontinuierliche Integrationen und Continuous Delivery konfiguriert werden. 6. Jenkins ist für alle Plattformen und verschiedene Betriebssysteme verfügbar, z. B. OS X, Windows oder Linux. 7. Außerdem gibt es eine große Auswahl an Plug-ins. Durch die große Auswahl an Plug-ins ist Jenkins flexibel und ermöglicht das Erstellen, Bereitstellen und Automatisieren auf verschiedenen Plattformen. 8. Der Großteil der Integrationsarbeit ist automatisiert. So treten weniger Integrationsprobleme auf. Dies spart während der gesamten Lebensdauer eines Projekts Zeit und Geld.
Aus den folgenden Gründen ist Jenkins on Kubernetes ein beliebtes Thema für Jenkins-Nutzer. Derzeit gibt es jedoch keinen zentralen Ort für die Dokumentation von Jenkins on Kubernetes. Das erschwert es Nutzern von Jenkins on Kubernetes, sich zurechtzufinden und Informationen zu finden. Im Rahmen dieses Projekts wird eine neue Seite zu Kubernetes-Lösungen erstellt, auf der die Konzepte, Techniken und Optionen für Kubernetes-Nutzer beschrieben werden, die Jenkins verwenden.
Aktueller Status
Es gibt viele Präsentationen und Artikel zum Ausführen von Jenkins unter Kubernetes. Es gibt jedoch keinen zentralen Ort, um Jenkins in Kubernetes zu beschreiben. Das erschwert Folgendes: 1. Jenkins für Kubernetes-Nutzer zum Navigieren und Suchen von Informationen 2. Informationen zu Jenkins in Kubernetes erfassen, aktualisieren und verwalten
Warum ist Ihre vorgeschlagene Dokumentation eine Verbesserung gegenüber der aktuellen?
Um das bestehende Problem mit der Jenkins on Kubernetes-Dokumentation zu lösen, werde ich auf Jenkins.io eine Seite mit Kubernetes-Lösungen erstellen, die dieser von mir erstellten Struktur folgt. Auf dieser Seite werden vorhandene Materialien und zugehörige Projekte zusammengefasst. Dieses Projekt bietet folgende Vorteile:
- Verbessern Sie die Nutzerfreundlichkeit von Jenkins on Kubernetes, indem Sie Nutzern eine zentrale Anlaufstelle für Informationen zu Jenkins on Kubernetes bieten.
- Auf der Seite „Lösungen“ können Sie Informationen zu Jenkins on Kubernetes ganz einfach verfolgen, aktualisieren und verwalten.
Als Entwickler weiß ich, wie frustrierend es sein kann, wenn Sie Probleme haben und trotzdem stundenlang suchen müssen, bevor Sie eine einzige Information finden, die normalerweise in wenigen Minuten gefunden werden sollte, wenn die Informationen gut strukturiert wären. Ich habe mich für dieses Projekt entschieden, weil ich mit der Erstellung einer Solutions-Seite für Jenkins on Kubernetes die Möglichkeit hatte, die Nutzerfreundlichkeit von Jenkins zu verbessern.
Analyse
Ich habe eine Struktur für die Seite „Kubernetes-Lösungen“ erstellt, in der einige der vorhandenen Materialien zu Jenkins in Kubernetes und Links zu nützlichen Ressourcen zusammengefasst sind. Außerdem habe ich die neue Struktur der Seite „Kubernetes-Lösungen“ mit einigen Jenkins on Kubernetes-Nutzern in meiner Organisation Interswitch und auch mit der Jenkins-Community geteilt, um deren Meinung dazu einzuholen, was sie sich in der neuen Dokumentation wünschen. Sie haben einige Kommentare hinterlassen, die auch in der vorgeschlagenen neuen Struktur zu finden sind. Diese Struktur muss jedoch von den Mentoren genehmigt und vor Beginn der Implementierung geändert werden.
Projektziele
Erstellen Sie eine neue Seite mit Kubernetes-Lösungen, die dieser Struktur auf der Jenkins-Lösungsseite folgt, oder ein Volume, in dem die Konzepte, Techniken und Optionen für Kubernetes-Nutzer beschrieben werden, die Jenkins ausführen.