1152 lines
53 KiB
HTML
1152 lines
53 KiB
HTML
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
<meta name="generator" content="Hugo 0.62.2" />
|
|
|
|
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
|
|
|
|
<link rel="alternate" type="application/rss+xml" href="https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/index.xml">
|
|
|
|
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico" >
|
|
<link rel="apple-touch-icon" href="/kubernetes-operator/favicons/apple-touch-icon-180x180.png" sizes="180x180">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/favicon-16x16.png" sizes="16x16">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/favicon-32x32.png" sizes="32x32">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-36x36.png" sizes="36x36">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-48x48.png" sizes="48x48">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-72x72.png" sizes="72x72">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-96x196.png" sizes="96x196">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-144x144.png" sizes="144x144">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-192x192.png"sizes="192x192">
|
|
|
|
<title>Developer Guide | Jenkins Operator</title><meta property="og:title" content="Developer Guide" />
|
|
<meta property="og:description" content="Jenkins Operator for developers
|
|
" />
|
|
<meta property="og:type" content="website" />
|
|
<meta property="og:url" content="https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/" />
|
|
<meta property="og:updated_time" content="2019-08-05T00:00:00+00:00" /><meta property="og:site_name" content="Jenkins Operator" />
|
|
<meta itemprop="name" content="Developer Guide">
|
|
<meta itemprop="description" content="Jenkins Operator for developers
|
|
"><meta name="twitter:card" content="summary"/>
|
|
<meta name="twitter:title" content="Developer Guide"/>
|
|
<meta name="twitter:description" content="Jenkins Operator for developers
|
|
"/>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preload" href="/kubernetes-operator/scss/main.min.fd69987024ae657af26227407273d5b4d1046115af0e0182839a91bb3e30e830.css" as="style">
|
|
<link href="/kubernetes-operator/scss/main.min.fd69987024ae657af26227407273d5b4d1046115af0e0182839a91bb3e30e830.css" rel="stylesheet" integrity="">
|
|
|
|
<script
|
|
src="https://code.jquery.com/jquery-3.3.1.min.js"
|
|
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
|
|
crossorigin="anonymous"></script>
|
|
|
|
|
|
<title>Developer Guide | Jenkins Operator</title>
|
|
</head>
|
|
<body class="td-section">
|
|
<header>
|
|
|
|
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
|
|
<a class="navbar-brand" href="/kubernetes-operator/">
|
|
<img style="width: 32px; height: 32px; margin-right: 7.5px;" src="/kubernetes-operator/img/logo.svg"></img><span class="text-uppercase font-weight-bold">Jenkins Operator</span>
|
|
</a>
|
|
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
|
|
<ul class="navbar-nav mt-2 mt-lg-0">
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|
<a class="nav-link" href="/kubernetes-operator/about"><span>What's the Jenkins Operator?</span></a>
|
|
</li>
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|
<a class="nav-link" href="/kubernetes-operator/docs"><span>Documentation</span></a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="navbar-nav d-none d-lg-block">
|
|
<input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off">
|
|
</div>
|
|
</nav>
|
|
|
|
</header>
|
|
<div class="container-fluid td-outer">
|
|
<div class="td-main">
|
|
<div class="row flex-xl-nowrap">
|
|
<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
|
|
|
|
|
|
|
|
|
|
|
|
<div id="td-sidebar-menu" class="td-sidebar__inner">
|
|
|
|
<form class="td-sidebar__search d-flex align-items-center">
|
|
|
|
<input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off">
|
|
|
|
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
|
|
</button>
|
|
</form>
|
|
|
|
<nav class="collapse td-sidebar-nav pt-2 pl-4" id="td-section-nav">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Documentation</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" id="kubernetes-operator-docs">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/installation/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Installation</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-installation">
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/how-it-works/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">How it works</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-how-it-works">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-how-it-works-architecture-and-design" href="/kubernetes-operator/docs/how-it-works/architecture-and-design/">Architecture and design</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-how-it-works-jenkins-docker-images" href="/kubernetes-operator/docs/how-it-works/jenkins-docker-images/">Jenkins Docker Images</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Getting Started</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/latest/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Latest (v0.5.x)</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-latest">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/latest/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-configuration" href="/kubernetes-operator/docs/getting-started/latest/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-customization" href="/kubernetes-operator/docs/getting-started/latest/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-aks" href="/kubernetes-operator/docs/getting-started/latest/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/latest/configure-backup-and-restore/">Configure backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/latest/custom-backup-and-restore/">Custom Backup and Restore Providers</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-notifications" href="/kubernetes-operator/docs/getting-started/latest/notifications/">Notifications</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-openshift" href="/kubernetes-operator/docs/getting-started/latest/openshift/">OpenShift</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-diagnostics" href="/kubernetes-operator/docs/getting-started/latest/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-schema" href="/kubernetes-operator/docs/getting-started/latest/schema/">Schema</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/v0.4.x/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">v0.4.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-v0-4-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/v0.4.x/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-configuration" href="/kubernetes-operator/docs/getting-started/v0.4.x/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-customization" href="/kubernetes-operator/docs/getting-started/v0.4.x/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-aks" href="/kubernetes-operator/docs/getting-started/v0.4.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.4.x/configure-backup-and-restore/">Configure backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.4.x/custom-backup-and-restore/">Custom Backup and Restore Providers</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-notifications" href="/kubernetes-operator/docs/getting-started/v0.4.x/notifications/">Notifications</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-openshift" href="/kubernetes-operator/docs/getting-started/v0.4.x/openshift/">OpenShift</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-diagnostics" href="/kubernetes-operator/docs/getting-started/v0.4.x/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-4-x-schema" href="/kubernetes-operator/docs/getting-started/v0.4.x/schema/">Schema</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/v0.3.x/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">v0.3.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-v0-3-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/v0.3.x/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-configuration" href="/kubernetes-operator/docs/getting-started/v0.3.x/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-customization" href="/kubernetes-operator/docs/getting-started/v0.3.x/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-migration" href="/kubernetes-operator/docs/getting-started/v0.3.x/migration/">Migration from v0.2.x</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-aks" href="/kubernetes-operator/docs/getting-started/v0.3.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.3.x/configure-backup-and-restore/">Configure backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.3.x/custom-backup-and-restore/">Custom Backup and Restore Providers</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-notifications" href="/kubernetes-operator/docs/getting-started/v0.3.x/notifications/">Notifications</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-diagnostics" href="/kubernetes-operator/docs/getting-started/v0.3.x/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-3-x-schema" href="/kubernetes-operator/docs/getting-started/v0.3.x/schema/">Schema</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/v0.1.x/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">v0.1.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-v0-1-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/v0.1.x/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-configuration" href="/kubernetes-operator/docs/getting-started/v0.1.x/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-customization" href="/kubernetes-operator/docs/getting-started/v0.1.x/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-aks" href="/kubernetes-operator/docs/getting-started/v0.1.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.1.x/configure-backup-and-restore/">Configure backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-diagnostics" href="/kubernetes-operator/docs/getting-started/v0.1.x/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-scheme" href="/kubernetes-operator/docs/getting-started/v0.1.x/scheme/">Scheme</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-1-x-migration-guide-v1alpha1-to-v1alpha2" href="/kubernetes-operator/docs/getting-started/v0.1.x/migration-guide-v1alpha1-to-v1alpha2/">Migration guide from v1alpha1 to v1alpha2</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/getting-started/v0.2.x/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">v0.2.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-v0-2-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/v0.2.x/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-configuration" href="/kubernetes-operator/docs/getting-started/v0.2.x/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-customization" href="/kubernetes-operator/docs/getting-started/v0.2.x/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-aks" href="/kubernetes-operator/docs/getting-started/v0.2.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.2.x/configure-backup-and-restore/">Configure backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.2.x/custom-backup-and-restore/">Custom Backup and Restore Providers</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-migration" href="/kubernetes-operator/docs/getting-started/v0.2.x/migration/">Migration from v0.1.x</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-diagnostics" href="/kubernetes-operator/docs/getting-started/v0.2.x/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-2-x-schema" href="/kubernetes-operator/docs/getting-started/v0.2.x/schema/">Schema</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/security/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Security</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-security">
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/developer-guide/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">Developer Guide</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" id="kubernetes-operator-docs-developer-guide">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-developer-guide-tools" href="/kubernetes-operator/docs/developer-guide/tools/">Tools</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
|
|
|
|
|
|
|
|
|
|
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
|
|
|
|
|
|
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/edit/master/website/content/en/docs/Developer%20Guide/_index.md" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a>
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/issues/new?title=Developer%20Guide" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
|
|
|
|
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/issues/new" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li>
|
|
<ul>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#clone-repository-and-download-dependencies">Clone repository and download dependencies</a></li>
|
|
<li><a href="#build-and-run-with-a-minikube">Build and run with a minikube</a>
|
|
<ul>
|
|
<li><a href="#debug-jenkins-operator">Debug Jenkins Operator</a></li>
|
|
</ul></li>
|
|
<li><a href="#build-and-run-with-a-remote-kubernetes-cluster">Build and run with a remote Kubernetes cluster</a></li>
|
|
<li><a href="#testing">Testing</a>
|
|
<ul>
|
|
<li><a href="#running-e2e-tests">Running E2E tests</a></li>
|
|
</ul></li>
|
|
<li><a href="#tips-tricks">Tips & Tricks</a>
|
|
<ul>
|
|
<li><a href="#building-docker-image-on-minikube-for-e2e-tests">Building docker image on minikube (for e2e tests)</a></li>
|
|
<li><a href="#when-pkg-apis-jenkinsio-jenkins-types-go-has-changed">When <code>pkg/apis/jenkinsio/*/jenkins_types.go</code> has changed</a></li>
|
|
<li><a href="#getting-the-jenkins-url-and-basic-credentials">Getting the Jenkins URL and basic credentials</a></li>
|
|
</ul></li>
|
|
<li><a href="#self-learning">Self-learning</a></li>
|
|
</ul></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
|
|
</div>
|
|
<main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
|
|
<nav aria-label="breadcrumb" class="d-none d-md-block d-print-none">
|
|
<ol class="breadcrumb spb-1">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="breadcrumb-item" >
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/">Documentation</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="breadcrumb-item active" aria-current="page">
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/">Developer Guide</a>
|
|
</li>
|
|
|
|
</ol>
|
|
</nav >
|
|
|
|
|
|
<div class="td-content">
|
|
<h1>Developer Guide</h1>
|
|
<div class="lead">Jenkins Operator for developers</div>
|
|
|
|
|
|
|
|
|
|
<div class="pageinfo pageinfo-primary">
|
|
<p>This document explains how to setup your development environment.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id="prerequisites">Prerequisites</h2>
|
|
|
|
<ul>
|
|
<li><a href="https://github.com/operator-framework/operator-sdk">operator_sdk</a> version v0.17.0</li>
|
|
<li><a href="https://git-scm.com/downloads">git</a></li>
|
|
<li><a href="https://golang.org/dl/">go</a> version v1.14+</li>
|
|
<li><a href="https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/tools/">goimports, golint, checkmake and staticcheck</a></li>
|
|
<li><a href="https://kubernetes.io/docs/tasks/tools/install-minikube/">minikube</a> version v1.1.0+ (preferred Hypervisor - <a href="https://www.virtualbox.org/wiki/Downloads">virtualbox</a>)</li>
|
|
<li><a href="https://docs.docker.com/install/">docker</a> version 17.03+</li>
|
|
</ul>
|
|
|
|
<h2 id="clone-repository-and-download-dependencies">Clone repository and download dependencies</h2>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">git clone git@github.com:jenkinsci/kubernetes-operator.git
|
|
<span style="color:#204a87">cd</span> kubernetes-operator
|
|
make go-dependencies</code></pre></div>
|
|
<h2 id="build-and-run-with-a-minikube">Build and run with a minikube</h2>
|
|
|
|
<p>Build and run <strong>Jenkins Operator</strong> locally:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make build minikube-run
|
|
|
|
INFO<span style="color:#ce5c00;font-weight:bold">[</span>0000<span style="color:#ce5c00;font-weight:bold">]</span> Running deepcopy code-generation <span style="color:#204a87;font-weight:bold">for</span> Custom Resource group versions: <span style="color:#ce5c00;font-weight:bold">[</span>jenkins:<span style="color:#ce5c00;font-weight:bold">[</span>v1alpha2<span style="color:#ce5c00;font-weight:bold">]</span>, <span style="color:#ce5c00;font-weight:bold">]</span>
|
|
INFO<span style="color:#ce5c00;font-weight:bold">[</span>0005<span style="color:#ce5c00;font-weight:bold">]</span> Code-generation complete.
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:51 Version: v0.4.0
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:52 Git commit: 4ffc58e-dirty
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:53 Go Version: go1.13.1
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:54 Go OS/Arch: linux/amd64
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:55 operator-sdk Version: v0.15.1
|
|
2020-04-27T09:52:26.520+0200 INFO controller-jenkins manager/main.go:80 Watch namespace: default
|
|
2020-04-27T09:52:26.527+0200 INFO leader leader/leader.go:46 Trying to become the leader.
|
|
2020-04-27T09:52:26.527+0200 INFO leader leader/leader.go:51 Skipping leader election<span style="color:#000;font-weight:bold">;</span> not running in a cluster.
|
|
2020-04-27T09:52:26.887+0200 INFO controller-runtime.metrics metrics/listener.go:40 metrics server is starting to listen <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"addr"</span>: <span style="color:#4e9a06">"0.0.0.0:8383"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:26.887+0200 INFO controller-jenkins manager/main.go:105 Registering Components.
|
|
2020-04-27T09:52:26.897+0200 WARN controller-jenkins manager/main.go:138 Could not generate and serve custom resource metrics <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"error"</span>: <span style="color:#4e9a06">"namespace not found for current environment"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.250+0200 INFO metrics metrics/metrics.go:55 Skipping metrics Service creation<span style="color:#000;font-weight:bold">;</span> not running in a cluster.
|
|
2020-04-27T09:52:27.601+0200 WARN controller-jenkins manager/main.go:157 Could not create ServiceMonitor object <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"error"</span>: <span style="color:#4e9a06">"no ServiceMonitor registered with the API"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.601+0200 WARN controller-jenkins manager/main.go:161 Install prometheus-operator in your cluster to create ServiceMonitor objects <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"error"</span>: <span style="color:#4e9a06">"no ServiceMonitor registered with the API"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.601+0200 INFO controller-jenkins manager/main.go:165 Starting the Cmd.
|
|
2020-04-27T09:52:27.601+0200 INFO controller-runtime.manager manager/internal.go:356 starting metrics server <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"path"</span>: <span style="color:#4e9a06">"/metrics"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.601+0200 INFO controller-runtime.controller controller/controller.go:164 Starting EventSource <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"source"</span>: <span style="color:#4e9a06">"kind source: jenkins.io/v1alpha2, Kind=Jenkins"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.702+0200 INFO controller-runtime.controller controller/controller.go:164 Starting EventSource <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"source"</span>: <span style="color:#4e9a06">"kind source: core/v1, Kind=Pod"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.803+0200 INFO controller-runtime.controller controller/controller.go:164 Starting EventSource <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"source"</span>: <span style="color:#4e9a06">"kind source: core/v1, Kind=Secret"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.903+0200 INFO controller-runtime.controller controller/controller.go:164 Starting EventSource <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"source"</span>: <span style="color:#4e9a06">"kind source: core/v1, Kind=Secret"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:27.903+0200 INFO controller-runtime.controller controller/controller.go:164 Starting EventSource <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"source"</span>: <span style="color:#4e9a06">"kind source: core/v1, Kind=ConfigMap"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:28.005+0200 INFO controller-runtime.controller controller/controller.go:171 Starting Controller <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:52:28.005+0200 INFO controller-runtime.controller controller/controller.go:190 Starting workers <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"controller"</span>: <span style="color:#4e9a06">"jenkins-controller"</span>, <span style="color:#4e9a06">"worker count"</span>: 1<span style="color:#ce5c00;font-weight:bold">}</span></code></pre></div><div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml
|
|
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:404 Setting default Jenkins container <span style="color:#204a87">command</span> <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:409 Setting default Jenkins container JAVA_OPTS environment variable <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:417 Setting default operator plugins <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:436 Setting default Jenkins master service <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:449 Setting default Jenkins slave service <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.153+0200 INFO controller-jenkins jenkins/jenkins_controller.go:479 Setting default Jenkins API settings <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.158+0200 INFO controller-jenkins jenkins/handler.go:89 *v1alpha2.Jenkins/example has been updated <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.562+0200 INFO controller-jenkins base/pod.go:161 Creating a new Jenkins Master Pod default/jenkins-example <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.575+0200 INFO controller-jenkins base/reconcile.go:528 The Admission controller has changed the Jenkins master pod spec.securityContext, changing the Jenkinc CR spec.master.securityContext to <span style="color:#4e9a06">'&PodSecurityContext{SELinuxOptions:nil,RunAsUser:nil,RunAsNonRoot:nil,SupplementalGroups:[],FSGroup:nil,RunAsGroup:nil,Sysctls:[]Sysctl{},WindowsOptions:nil,}'</span> <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:56:40.584+0200 INFO controller-jenkins jenkins/handler.go:89 *v1alpha2.Jenkins/example has been updated <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:59:40.409+0200 INFO controller-jenkins base/reconcile.go:466 Generating Jenkins API token <span style="color:#204a87;font-weight:bold">for</span> operator <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:59:40.410+0200 WARN controller-jenkins jenkins/jenkins_controller.go:171 Reconcile loop failed: couldn<span style="color:#4e9a06">'t init Jenkins API client: Get http://192.168.99.100:32380/api/json: dial tcp 192.168.99.100:32380: connect: connection refused {"cr": "example"}
|
|
</span><span style="color:#4e9a06">2020-04-27T09:59:40.455+0200 INFO controller-jenkins base/reconcile.go:466 Generating Jenkins API token for operator {"cr": "example"}
|
|
</span><span style="color:#4e9a06">2020-04-27T09:59:41.415+0200 INFO controller-jenkins groovy/groovy.go:145 base-groovy ConfigMap '</span>jenkins-operator-base-configuration-example<span style="color:#4e9a06">' name '</span>1-basic-settings.groovy<span style="color:#4e9a06">' running groovy script {"cr": "example"}
|
|
</span><span style="color:#4e9a06">...
|
|
</span><span style="color:#4e9a06">2020-04-27T09:59:49.030+0200 INFO controller-jenkins groovy/groovy.go:145 base-groovy ConfigMap '</span>jenkins-operator-base-configuration-example<span style="color:#4e9a06">' name '</span>8-disable-job-dsl-script-approval.groovy<span style="color:#a40000">'</span> running groovy script <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
|
|
2020-04-27T09:59:49.257+0200 INFO controller-jenkins jenkins/jenkins_controller.go:289 Base configuration phase is complete, took 3m9s <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T09:59:51.165+0200 INFO controller-jenkins seedjobs/seedjobs.go:232 Waiting <span style="color:#204a87;font-weight:bold">for</span> Seed Job Agent <span style="color:#4e9a06">`</span>seed-job-agent<span style="color:#4e9a06">`</span>... <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
...
|
|
2020-04-27T10:00:03.886+0200 INFO controller-jenkins seedjobs/seedjobs.go:232 Waiting <span style="color:#204a87;font-weight:bold">for</span> Seed Job Agent <span style="color:#4e9a06">`</span>seed-job-agent<span style="color:#4e9a06">`</span>... <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
2020-04-27T10:00:06.140+0200 INFO controller-jenkins jenkins/jenkins_controller.go:338 User configuration phase is complete, took 3m26s <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">"cr"</span>: <span style="color:#4e9a06">"example"</span><span style="color:#ce5c00;font-weight:bold">}</span></code></pre></div>
|
|
<p>Two log lines says that Jenkins Operator works correctly:</p>
|
|
|
|
<ul>
|
|
<li><code>Base configuration phase is complete</code> - ensures manifests, Jenkins pod, Jenkins configuration and Jenkins API token<br /></li>
|
|
<li><code>User configuration phase is complete</code> - ensures Jenkins restore, backup and seed jobs along with user configuration</li>
|
|
</ul>
|
|
|
|
<blockquote>
|
|
<p>Details about base and user phase can be found <a href="https://jenkinsci.github.io/kubernetes-operator/docs/how-it-works/architecture-and-design/">here</a>.</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl get jenkins -o yaml
|
|
|
|
apiVersion: v1
|
|
items:
|
|
- apiVersion: jenkins.io/v1alpha2
|
|
kind: Jenkins
|
|
metadata:
|
|
...
|
|
spec:
|
|
backup:
|
|
action: <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
containerName: <span style="color:#4e9a06">""</span>
|
|
interval: <span style="color:#0000cf;font-weight:bold">0</span>
|
|
makeBackupBeforePodDeletion: <span style="color:#204a87">false</span>
|
|
configurationAsCode:
|
|
configurations: null
|
|
secret:
|
|
name: <span style="color:#4e9a06">""</span>
|
|
groovyScripts:
|
|
configurations: null
|
|
secret:
|
|
name: <span style="color:#4e9a06">""</span>
|
|
jenkinsAPISettings:
|
|
authorizationStrategy: createUser
|
|
master:
|
|
basePlugins:
|
|
...
|
|
- command:
|
|
- bash
|
|
- -c
|
|
- /var/jenkins/scripts/init.sh <span style="color:#ce5c00;font-weight:bold">&&</span> <span style="color:#204a87">exec</span> /sbin/tini -s -- /usr/local/bin/jenkins.sh
|
|
env:
|
|
- name: JAVA_OPTS
|
|
value: -XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap
|
|
-XX:MaxRAMFraction<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">1</span> -Djenkins.install.runSetupWizard<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">false</span> -Djava.awt.headless<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">true</span>
|
|
image: jenkins/jenkins:lts
|
|
imagePullPolicy: Always
|
|
livenessProbe:
|
|
...
|
|
name: jenkins-master
|
|
readinessProbe:
|
|
...
|
|
resources:
|
|
limits:
|
|
cpu: 1500m
|
|
memory: 3Gi
|
|
requests:
|
|
cpu: <span style="color:#4e9a06">"1"</span>
|
|
memory: 500Mi
|
|
disableCSRFProtection: <span style="color:#204a87">false</span>
|
|
securityContext: <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
restore:
|
|
action: <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
containerName: <span style="color:#4e9a06">""</span>
|
|
seedJobs:
|
|
- additionalClasspath: <span style="color:#4e9a06">""</span>
|
|
bitbucketPushTrigger: <span style="color:#204a87">false</span>
|
|
buildPeriodically: <span style="color:#4e9a06">""</span>
|
|
description: Jenkins Operator repository
|
|
failOnMissingPlugin: <span style="color:#204a87">false</span>
|
|
githubPushTrigger: <span style="color:#204a87">false</span>
|
|
id: jenkins-operator
|
|
ignoreMissingFiles: <span style="color:#204a87">false</span>
|
|
pollSCM: <span style="color:#4e9a06">""</span>
|
|
repositoryBranch: master
|
|
repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
|
|
targets: cicd/jobs/*.jenkins
|
|
unstableOnDeprecation: <span style="color:#204a87">false</span>
|
|
service:
|
|
port: <span style="color:#0000cf;font-weight:bold">8080</span>
|
|
type: NodePort
|
|
serviceAccount: <span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
|
slaveService:
|
|
port: <span style="color:#0000cf;font-weight:bold">50000</span>
|
|
type: ClusterIP
|
|
status:
|
|
appliedGroovyScripts:
|
|
- configurationType: base-groovy
|
|
hash: <span style="color:#000">2ownqpRyBjQYmzTRttUx7axok3CKe2E45frI5iRwH0w</span><span style="color:#ce5c00;font-weight:bold">=</span>
|
|
name: 1-basic-settings.groovy
|
|
source: jenkins-operator-base-configuration-example
|
|
...
|
|
baseConfigurationCompletedTime: <span style="color:#4e9a06">"2020-04-27T07:59:49Z"</span>
|
|
createdSeedJobs:
|
|
- jenkins-operator
|
|
operatorVersion: v0.4.0
|
|
provisionStartTime: <span style="color:#4e9a06">"2020-04-27T07:56:40Z"</span>
|
|
userAndPasswordHash: kAeBnhHKU3LZuw+uo9oHILB59kAFSGDUbHwCSDgtMnE<span style="color:#ce5c00;font-weight:bold">=</span>
|
|
userConfigurationCompletedTime: <span style="color:#4e9a06">"2020-04-27T08:00:06Z"</span>
|
|
kind: List
|
|
metadata:
|
|
resourceVersion: <span style="color:#4e9a06">""</span>
|
|
selfLink: <span style="color:#4e9a06">""</span></code></pre></div><div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl get po
|
|
|
|
NAME READY STATUS RESTARTS AGE
|
|
jenkins-example 1/1 Running <span style="color:#0000cf;font-weight:bold">0</span> 15m
|
|
seed-job-agent-example-56569459c9-l69qf 1/1 Running <span style="color:#0000cf;font-weight:bold">0</span> 12m</code></pre></div>
|
|
<p>Upon every next start of local <strong>Jenkins Operator</strong> switch first command with:</p>
|
|
<pre><code>make minikube-start
|
|
make minikube-run</code></pre>
|
|
<h3 id="debug-jenkins-operator">Debug Jenkins Operator</h3>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make build minikube-run <span style="color:#000">OPERATOR_EXTRA_ARGS</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">"--debug"</span></code></pre></div>
|
|
<h2 id="build-and-run-with-a-remote-kubernetes-cluster">Build and run with a remote Kubernetes cluster</h2>
|
|
|
|
<p>You can also run the controller locally and make it listen to a remote Kubernetes server.</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make run <span style="color:#000">NAMESPACE</span><span style="color:#ce5c00;font-weight:bold">=</span>default <span style="color:#000">KUBECTL_CONTEXT</span><span style="color:#ce5c00;font-weight:bold">=</span>remote-k8s <span style="color:#000">EXTRA_ARGS</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">'--kubeconfig ~/.kube/config'</span></code></pre></div>
|
|
<p>Once <strong>Jenkins Operator</strong> are up and running, apply Jenkins custom resource:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl --context remote-k8s --namespace default apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml
|
|
kubectl --context remote-k8s --namespace default get jenkins -o yaml
|
|
kubectl --context remote-k8s --namespace default get po</code></pre></div>
|
|
<h2 id="testing">Testing</h2>
|
|
|
|
<p>Run unit tests:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make test</code></pre></div>
|
|
<h3 id="running-e2e-tests">Running E2E tests</h3>
|
|
|
|
<p>Run e2e tests with minikube:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make minikube-start
|
|
<span style="color:#204a87">eval</span> <span style="color:#204a87;font-weight:bold">$(</span>minikube docker-env<span style="color:#204a87;font-weight:bold">)</span>
|
|
make e2e</code></pre></div>
|
|
<p>Run the specific e2e test:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make build e2e <span style="color:#000">E2E_TEST_SELECTOR</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">'^TestConfiguration$'</span></code></pre></div>
|
|
<h2 id="tips-tricks">Tips & Tricks</h2>
|
|
|
|
<h3 id="building-docker-image-on-minikube-for-e2e-tests">Building docker image on minikube (for e2e tests)</h3>
|
|
|
|
<p>To be able to work with the docker daemon on <code>minikube</code> machine run the following command before building an image:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#204a87">eval</span> <span style="color:#204a87;font-weight:bold">$(</span>minikube docker-env<span style="color:#204a87;font-weight:bold">)</span></code></pre></div>
|
|
<h3 id="when-pkg-apis-jenkinsio-jenkins-types-go-has-changed">When <code>pkg/apis/jenkinsio/*/jenkins_types.go</code> has changed</h3>
|
|
|
|
<p>Run:</p>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">make deepcopy-gen</code></pre></div>
|
|
<h3 id="getting-the-jenkins-url-and-basic-credentials">Getting the Jenkins URL and basic credentials</h3>
|
|
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">minikube service jenkins-operator-http-<cr_name> --url
|
|
kubectl get secret jenkins-operator-credentials-<cr_name> -o <span style="color:#4e9a06">'jsonpath={.data.user}'</span> <span style="color:#000;font-weight:bold">|</span> base64 -d
|
|
kubectl get secret jenkins-operator-credentials-<cr_name> -o <span style="color:#4e9a06">'jsonpath={.data.password}'</span> <span style="color:#000;font-weight:bold">|</span> base64 -d</code></pre></div>
|
|
<h2 id="self-learning">Self-learning</h2>
|
|
|
|
<ul>
|
|
<li><p><a href="https://www.youtube.com/watch?v=8_DaCcRMp5I">Tutorial: Deep Dive into the Operator Framework for… Melvin Hillsman, Michael Hrivnak, & Matt Dorn
|
|
</a></p></li>
|
|
|
|
<li><p><a href="https://www.katacoda.com/openshift/courses/operatorframework">Operator Framework Training By OpenShift</a></p></li>
|
|
</ul>
|
|
|
|
<div class="section-index">
|
|
|
|
|
|
|
|
|
|
<hr class="panel-line">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="entry">
|
|
<h5>
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/tools/">Tools</a>
|
|
</h5>
|
|
<p>Required tools for building and running Jenkins Operator
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="text-muted mt-5 pt-3 border-top">Last modified August 5, 2019
|
|
</div>
|
|
</div>
|
|
|
|
</main>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="bg-dark py-5 row d-print-none">
|
|
<div class="bg-dark container-fluid trademark-bigger">
|
|
<div class="row">
|
|
<div class="col-6 col-sm-4 text-xs-center order-sm-2">
|
|
|
|
</div>
|
|
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
|
|
|
|
</div>
|
|
<div class="col-12 col-sm-12 text-center py-4 order-sm-2">
|
|
<small class="text-white">© 2021 Jenkins Operator is created by VirtusLab. Source is available under Apache License Version 2 and website content under Creative Commons Attribution-ShareAlike 4.0.</small><br>
|
|
<small class="text-white">Jenkins® is a registered trademark of Software in the Public Interest, Inc.</small>
|
|
|
|
<p class="mt-2"><a href="/kubernetes-operator/about/">What's the Jenkins Operator?</a></p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
</div>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
|
|
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script src="/kubernetes-operator/js/main.min.b0e99aac17991fa76812dd47914049168ac469a1faa0939560f0b370565becab.js" integrity="sha256-sOmarBeZH6doEt1HkUBJForEaaH6oJOVYPCzcFZb7Ks="></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html> |