На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Проект Дженкинса
- Технический писатель:
- Зайкоды
- Название проекта:
- Дженкинс в Kubernetes
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Kubernetes — это независимый от платформы инструмент оркестрации контейнеров, созданный Google и широко поддерживаемый сообществом разработчиков ПО с открытым исходным кодом в рамках проекта Cloud Native Computing Foundation. Он позволяет использовать экземпляры контейнеров и управлять ими для масштабирования и отказоустойчивости. Он также выполняет широкий спектр действий по управлению, которые в противном случае потребовали бы отдельных решений или специального кода, включая маршрутизацию запросов, обнаружение контейнеров, проверки работоспособности и периодические обновления.
Kubernetes совместим с большинством инструментов CI/CD, которые позволяют разработчикам запускать тесты, развертывать сборки в Kubernetes и обновлять приложения без простоев. Одним из самых популярных инструментов CI/CD сейчас является Jenkins по следующим причинам: 1. Он имеет открытый исходный код и бесплатен. 2. Он удобен в использовании, прост в установке и не требует дополнительных установок или компонентов. 3. Jenkins также довольно легко настраивать, модифицировать и расширять. 4. Он мгновенно развертывает код, генерирует отчеты о тестировании. 5. Jenkins можно настроить в соответствии с требованиями непрерывной интеграции и непрерывной доставки. 6. Jenkins доступен для всех платформ и различных операционных систем, будь то OS X, Windows или Linux. 7. Он также может похвастаться богатой экосистемой плагинов. Обширный пул плагинов делает Jenkins гибким и позволяет создавать, развертывать и автоматизировать работу на различных платформах. 8. Большая часть работы по интеграции автоматизирована. Следовательно, меньше проблем с интеграцией. Это экономит время и деньги на протяжении всего срока реализации проекта.
Следующие причины сделали Jenkins on Kubernetes популярной темой для пользователей Jenkins, однако в настоящее время не существует центрального места для документации, описывающей Jenkins on Kubernetes, что затрудняет пользователям Jenkins on Kubernetes навигацию и поиск информации. В рамках этого проекта будет создана новая страница «Решения Kubernetes», на которой будут описаны концепции, методы и варианты выбора для пользователей Kubernetes, использующих Jenkins.
Текущее состояние
Существует множество презентаций и статей о запуске Jenkins в Kubernetes, однако нет центрального места для описания Jenkins в Kubernetes. Это затрудняет: 1. Пользователям Jenkins в Kubernetes навигацию и поиск информации. 2. Отслеживание, обновление и поддержание информации о Jenkins в Kubernetes.
Почему предлагаемая вами документация лучше существующей?
Чтобы решить существующую проблему с документацией Jenkins в Kubernetes, я собираюсь создать страницу Kubernetes Solutions на Jenkins.io, следуя созданной мной структуре. На этой странице «Решения» будут собраны существующие материалы и связанные проекты. Этот проект дает следующие преимущества:
- Улучшите взаимодействие с пользователями Jenkins в Kubernetes, предоставив им единый центр информации о Jenkins в Kubernetes.
- Упростите отслеживание, обновление и поддержку информации о Jenkins в Kubernetes с помощью страницы «Решения».
Как разработчик, я знаю, как это может быть неприятно, когда у вас возникают проблемы, и вам все равно приходится сталкиваться с камнем преткновения, когда вам приходится часами перемещаться по сайту, прежде чем вы сможете найти хоть один фрагмент информации, а это обычно занимало несколько часов. минут, чтобы проверить, хорошо ли структурирована информация. Я решил работать над этим проектом, потому что создание страницы решений для Jenkins в Kubernetes дало бы мне возможность улучшить опыт пользователей Jenkins.
Анализ
Я создал структуру для страницы «Решения Kubernetes», объединив некоторые существующие материалы о Jenkins в Kubernetes и ссылки на некоторые полезные ресурсы. Кроме того, принимая во внимание тот факт, что «вы не сможете создать по-настоящему хорошую пользовательскую документацию, пока не выслушаете людей за пределами вашей организации, которые на самом деле используют продукты, не изучите их болевые точки и не попытаетесь решить их как можно лучше» Я поделился новой структурой страницы Kubernetes Solutions с некоторыми пользователями Jenkins on Kubernetes в моей организации Interswitch, а также с сообществом Jenkins, чтобы узнать их мнения о том, что они хотели бы видеть в новой документации, и они оставили несколько комментариев, которые также могут можно найти в предлагаемой новой структуре . Однако эта структура должна быть принята и изменена Наставниками до начала реализации.
Цели проекта
Создайте новую страницу решений Kubernetes, следуя этой структуре на странице решения Jenkins или томе, в котором будут описаны концепции, методы и варианты выбора для пользователей Kubernetes, использующих Jenkins.