1866 lines
55 KiB
HTML
1866 lines
55 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="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>Installing the Operator | Jenkins Operator</title><meta property="og:title" content="Installing the Operator" />
|
|
<meta property="og:description" content="How to install Jenkins Operator
|
|
" />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.6.x/installing-the-operator/" />
|
|
<meta property="article:published_time" content="2021-12-08T00:00:00+00:00" />
|
|
<meta property="article:modified_time" content="2021-12-08T00:00:00+00:00" /><meta property="og:site_name" content="Jenkins Operator" />
|
|
<meta itemprop="name" content="Installing the Operator">
|
|
<meta itemprop="description" content="How to install Jenkins Operator
|
|
">
|
|
<meta itemprop="datePublished" content="2021-12-08T00:00:00+00:00" />
|
|
<meta itemprop="dateModified" content="2021-12-08T00:00:00+00:00" />
|
|
<meta itemprop="wordCount" content="1209">
|
|
|
|
|
|
|
|
<meta itemprop="keywords" content="" /><meta name="twitter:card" content="summary"/>
|
|
<meta name="twitter:title" content="Installing the Operator"/>
|
|
<meta name="twitter:description" content="How to install Jenkins Operator
|
|
"/>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preload" href="/kubernetes-operator/scss/main.min.6c58fba96b88d035ce071c346f084a9dc4dedee4e80eb3724fe530520541a4ec.css" as="style">
|
|
<link href="/kubernetes-operator/scss/main.min.6c58fba96b88d035ce071c346f084a9dc4dedee4e80eb3724fe530520541a4ec.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>Installing the Operator | Jenkins Operator</title>
|
|
</head>
|
|
<body class="td-page">
|
|
<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/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 td-sidebar-link td-sidebar-link__section">Getting Started</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" 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.7.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-installing-the-operator" href="/kubernetes-operator/docs/getting-started/latest/installing-the-operator/">Installing the Operator</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-deploying-jenkins" href="/kubernetes-operator/docs/getting-started/latest/deploying-jenkins/">Deploying Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-customizing-jenkins" href="/kubernetes-operator/docs/getting-started/latest/customizing-jenkins/">Customizing Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-configuring-seed-jobs-and-pipelines" href="/kubernetes-operator/docs/getting-started/latest/configuring-seed-jobs-and-pipelines/">Configuring Seed Jobs and Pipelines</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-configuring-backup-and-restore" href="/kubernetes-operator/docs/getting-started/latest/configuring-backup-and-restore/">Configuring backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-latest-separate-namespaces" href="/kubernetes-operator/docs/getting-started/latest/separate-namespaces/">Separate namespaces for Jenkins and Operator</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-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-ldap" href="/kubernetes-operator/docs/getting-started/latest/ldap/">LDAP</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-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.6.x/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">v0.6.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" id="kubernetes-operator-docs-getting-started-v0-6-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page active" id="m-kubernetes-operator-docs-getting-started-v0-6-x-installing-the-operator" href="/kubernetes-operator/docs/getting-started/v0.6.x/installing-the-operator/">Installing the Operator</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-deploying-jenkins" href="/kubernetes-operator/docs/getting-started/v0.6.x/deploying-jenkins/">Deploying Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-customizing-jenkins" href="/kubernetes-operator/docs/getting-started/v0.6.x/customizing-jenkins/">Customizing Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-configuring-seed-jobs-and-pipelines" href="/kubernetes-operator/docs/getting-started/v0.6.x/configuring-seed-jobs-and-pipelines/">Configuring Seed Jobs and Pipelines</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-configuring-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.6.x/configuring-backup-and-restore/">Configuring backup and restore</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-separate-namespaces" href="/kubernetes-operator/docs/getting-started/v0.6.x/separate-namespaces/">Separate namespaces for Jenkins and Operator</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.6.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-6-x-aks" href="/kubernetes-operator/docs/getting-started/v0.6.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-ldap" href="/kubernetes-operator/docs/getting-started/v0.6.x/ldap/">LDAP</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-openshift" href="/kubernetes-operator/docs/getting-started/v0.6.x/openshift/">OpenShift</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-6-x-schema" href="/kubernetes-operator/docs/getting-started/v0.6.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.5.x/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">v0.5.x</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-getting-started-v0-5-x">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-deploy-jenkins" href="/kubernetes-operator/docs/getting-started/v0.5.x/deploy-jenkins/">Deploy Jenkins</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-configuration" href="/kubernetes-operator/docs/getting-started/v0.5.x/configuration/">Configuration</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-customization" href="/kubernetes-operator/docs/getting-started/v0.5.x/customization/">Customization</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-configure-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.5.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-5-x-aks" href="/kubernetes-operator/docs/getting-started/v0.5.x/aks/">AKS</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-custom-backup-and-restore" href="/kubernetes-operator/docs/getting-started/v0.5.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-5-x-notifications" href="/kubernetes-operator/docs/getting-started/v0.5.x/notifications/">Notifications</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-openshift" href="/kubernetes-operator/docs/getting-started/v0.5.x/openshift/">OpenShift</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-diagnostics" href="/kubernetes-operator/docs/getting-started/v0.5.x/diagnostics/">Diagnostics</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-docs-getting-started-v0-5-x-schema" href="/kubernetes-operator/docs/getting-started/v0.5.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.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.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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
</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/troubleshooting/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Troubleshooting</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-troubleshooting">
|
|
|
|
|
|
|
|
</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 collapsed td-sidebar-link td-sidebar-link__section">Developer Guide</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-developer-guide">
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/docs/faq/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">FAQ</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-docs-faq">
|
|
|
|
|
|
|
|
</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/Getting%20Started/v0.6.x/installing-the-operator.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?labels=documentation&template=documentation.md&title=Installing%20the%20Operator" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
|
|
|
|
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/issues/new/choose" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li>
|
|
<ul>
|
|
<li><a href="#requirements">Requirements</a></li>
|
|
<li><a href="#deploy-jenkins-operator-using-yaml-s">Deploy Jenkins Operator using YAML’s</a></li>
|
|
<li><a href="#deploy-jenkins-operator-using-helm-chart">Deploy Jenkins Operator using Helm Chart</a>
|
|
<ul>
|
|
<li><a href="#configuring-operator-deployment">Configuring operator deployment</a></li>
|
|
</ul></li>
|
|
<li><a href="#note-on-operator-s-nightly-built-images">Note on Operator’s nightly built images</a></li>
|
|
<li><a href="#note-on-restricted-jenkins-controller-pod-volumemounts">Note on restricted Jenkins controller pod volumeMounts</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" >
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/">Getting Started</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="breadcrumb-item" >
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.6.x/">v0.6.x</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="breadcrumb-item active" aria-current="page">
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.6.x/installing-the-operator/">Installing the Operator</a>
|
|
</li>
|
|
|
|
</ol>
|
|
</nav >
|
|
|
|
|
|
<div class="td-content">
|
|
<h1>Installing the Operator</h1>
|
|
<div class="lead">How to install Jenkins Operator</div>
|
|
|
|
|
|
|
|
|
|
<div class="pageinfo pageinfo-primary">
|
|
<p>This document describes installation procedure for <strong>Jenkins Operator</strong>.
|
|
All container images can be found at <a href="https://hub.docker.com/r/virtuslab/jenkins-operator">virtuslab/jenkins-operator</a> Docker Hub repository.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id="requirements">Requirements</h2>
|
|
|
|
<p>To run <strong>Jenkins Operator</strong>, you will need:</p>
|
|
|
|
<ul>
|
|
<li>access to a Kubernetes cluster version <code>1.17+</code></li>
|
|
<li><code>kubectl</code> version <code>1.17+</code></li>
|
|
</ul>
|
|
|
|
<p>Listed below are the two ways to deploy Jenkins Operator.</p>
|
|
|
|
<h2 id="deploy-jenkins-operator-using-yaml-s">Deploy Jenkins Operator using YAML’s</h2>
|
|
|
|
<p>First, install Jenkins Custom Resource Definition:</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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.yaml </code></pre></div>
|
|
<p>Then, install the Operator and other required resources:</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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml</code></pre></div>
|
|
<p>Watch <strong>Jenkins Operator</strong> instance being created:</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 get pods -w</code></pre></div>
|
|
<p>Now <strong>Jenkins Operator</strong> should be up and running in the <code>default</code> namespace.
|
|
For deploying Jenkins, refer to <a href="/kubernetes-operator/docs/getting-started/latest/deploying-jenkins/">Deploy Jenkins section</a>.</p>
|
|
|
|
<h2 id="deploy-jenkins-operator-using-helm-chart">Deploy Jenkins Operator using Helm Chart</h2>
|
|
|
|
<p>Alternatively, you can also use Helm to install the Operator (and optionally, by default, Jenkins). It requires the Helm 3+ for deployment.</p>
|
|
|
|
<p>Create a namespace for the operator:</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 create namespace <your-namespace></code></pre></div>
|
|
<p>To install, you need only to type these commands:</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">$ helm repo add jenkins https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/chart
|
|
$ helm install <name> jenkins/jenkins-operator -n <your-namespace></code></pre></div>
|
|
<p>To add custom labels and annotations, you can use <code>values.yaml</code> file or pass them into <code>helm install</code> command, e.g.:</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">$ helm install <name> jenkins/jenkins-operator -n <your-namespace> --set jenkins.labels.LabelKey<span style="color:#ce5c00;font-weight:bold">=</span>LabelValue,jenkins.annotations.AnnotationKey<span style="color:#ce5c00;font-weight:bold">=</span>AnnotationValue</code></pre></div>
|
|
<p>You can further customize Jenkins using <code>values.yaml</code>:
|
|
<h3 id="JenkinsConfiguration">Jenkins instance configuration
|
|
</h3></p>
|
|
|
|
<table aria-colspan="4">
|
|
<thead aria-colspan="4">
|
|
<tr>
|
|
<th></th>
|
|
<th>Field</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody aria-colspan="4">
|
|
<tr></tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<code>jenkins</code>
|
|
</td>
|
|
<td colspan="3">
|
|
<p>operator is section for configuring operator deployment</p>
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<code>enabled</code>
|
|
</td>
|
|
<td>
|
|
true
|
|
</td>
|
|
<td>
|
|
Enabled can enable or disable the Jenkins instance.
|
|
Set to false if you have configured CR already and/or you want to deploy an operator only.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>apiVersion</code>
|
|
</td>
|
|
<td>jenkins.io/v1alpha2</td>
|
|
<td>
|
|
Version of the CR manifest. The recommended and default value is <code>jenkins.io/v1alpha2</code>.
|
|
<a href="#github.io/kubernetes-operator/docs/getting-started/v0.1.x/migration-guide-v1alpha1-to-v1alpha2/">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>name</code>
|
|
</td>
|
|
<td>
|
|
jenkins
|
|
</td>
|
|
<td>
|
|
Name of resource. The pod name will be <code>jenkins-<name></code> (name will be set as suffix).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>namespace</code>
|
|
</td>
|
|
<td>
|
|
default
|
|
</td>
|
|
<td>
|
|
Namespace the resources will be deployed to. It's not recommended to use default namespace.
|
|
Create new namespace for jenkins (e.g. <code>kubectl create -n jenkins</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>labels</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
Labels are injected into metadata labels field.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>annotations</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
Annotations are injected into metadata annotations field.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>image</code>
|
|
</td>
|
|
<td>
|
|
jenkins/jenkins:lts
|
|
</td>
|
|
<td>
|
|
Image is the name (and tag) of the Jenkins instance.
|
|
It's recommended to use LTS (tag: "lts") version.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>env</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Env contains jenkins container environment variables.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>imagePullPolicy</code>
|
|
</td>
|
|
<td>
|
|
Always
|
|
</td>
|
|
<td>
|
|
Defines policy for pulling images
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>priorityClassName</code>
|
|
</td>
|
|
<td>
|
|
""
|
|
</td>
|
|
<td>
|
|
PriorityClassName indicates the importance of a Pod relative to other Pods.
|
|
<a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>disableCSRFProtection</code>
|
|
</td>
|
|
<td>
|
|
false
|
|
</td>
|
|
<td>
|
|
disableCSRFProtection can enable or disable operator built-in CSRF protection.
|
|
Set it to true if you are using OpenShift Jenkins Plugin.
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/pull/193">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>imagePullSecrets</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Used if you want to pull images from private repository
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration/#pulling-docker-images-from-private-repositories">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>notifications</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Notifications is feature that notify user about Jenkins reconcilation status
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/notifications/">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>basePlugins</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
- name: kubernetes
|
|
version: "1.25.2"
|
|
- name: workflow-job
|
|
version: "2.39"
|
|
- name: workflow-aggregator
|
|
version: "2.6"
|
|
- name: git
|
|
version: "4.2.2"
|
|
- name: job-dsl
|
|
version: "1.77"
|
|
- name: configuration-as-code
|
|
version: "1.38"
|
|
- name: kubernetes-credentials
|
|
-provider
|
|
version: "0.13"
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
Plugins installed and required by the operator
|
|
shouldn't contain plugins defined by user
|
|
You can change their versions here
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/#install-plugins">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>plugins</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Plugins required by the user. You can define plugins here.
|
|
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/#install-plugins">More info</a>
|
|
Example:
|
|
<pre>
|
|
plugins:
|
|
- name: simple-theme-plugin
|
|
version: 0.5.1
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>seedJobs</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Placeholder for jenkins seed jobs
|
|
For seed job creation tutorial, check:<br /> <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuring-seed-jobs-and-pipelines/#prepare-job-definitions-and-pipelines">Prepare seed jobs</a>
|
|
<br /><a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuring-seed-jobs-and-pipelines/#configure-seed-jobs">Configure seed jobs</a>
|
|
<br />Example:
|
|
<code>
|
|
<pre>
|
|
seedJobs:
|
|
- id: jenkins-operator
|
|
targets: "cicd/jobs/*.jenkins"
|
|
description: "Jenkins Operator repository"
|
|
repositoryBranch: master
|
|
repositoryUrl:
|
|
- https://github.com/jenkinsci/kubernetes-operator.git
|
|
</pre>
|
|
</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>resources</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
limits:
|
|
cpu: 1500m
|
|
memory: 3Gi
|
|
requests:
|
|
cpu: 1
|
|
memory: 500M
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
Resource limit/request for Jenkins
|
|
<a href="https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container">More info</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>volumes</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
- name: backup
|
|
persistentVolumeClaim:
|
|
claimName: jenkins-backup
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
Volumes used by Jenkins
|
|
By default, we are only using PVC volume for storing backups.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>volumeMounts</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
volumeMounts are mounts for Jenkins pod.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>securityContext</code>
|
|
</td>
|
|
<td>
|
|
runAsUser: 1000
|
|
fsGroup: 1000
|
|
</td>
|
|
<td>
|
|
SecurityContext for pod.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>service</code></td>
|
|
<td>not implemented</td>
|
|
<td>Http Jenkins service. See https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service for details.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slaveService</code></td>
|
|
<td>not implemented</td>
|
|
<td>Slave Jenkins service. See https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service for details.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>livenessProbe</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
livenessProbe:
|
|
failureThreshold: 12
|
|
httpGet:
|
|
path: /login
|
|
port: http
|
|
scheme: HTTP
|
|
initialDelaySeconds: 80
|
|
periodSeconds: 10
|
|
successThreshold: 1
|
|
timeoutSeconds: 5
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
livenessProbe for Pod
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>readinessProbe</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
readinessProbe:
|
|
failureThreshold: 3
|
|
httpGet:
|
|
path: /login
|
|
port: http
|
|
scheme: HTTP
|
|
initialDelaySeconds: 30
|
|
periodSeconds: 10
|
|
successThreshold: 1
|
|
timeoutSeconds: 1
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
readinessProbe for Pod
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
backup
|
|
</code>
|
|
<p>
|
|
<em>
|
|
<a href="#Backup">
|
|
Backup
|
|
</a>
|
|
</em>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
Backup is section for configuring operator's backup feature
|
|
By default backup feature is enabled and pre-configured
|
|
This section simplifies the configuration described here: <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuring-backup-and-restore/">Configuring backup and restore</a>
|
|
For customization tips see <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/custom-backup-and-restore">Custom backup and restore</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>configuration</code>
|
|
<p>
|
|
<em>
|
|
<a href="#Configuration">
|
|
Configuration
|
|
</a>
|
|
</em>
|
|
</p>
|
|
</td>
|
|
<td></td>
|
|
<td>
|
|
Section where we can configure Jenkins instance.
|
|
See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customizing-jenkins/">Customizing Jenkins</a> for details
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3 id="configuring-operator-deployment">Configuring operator deployment</h3>
|
|
|
|
<table aria-colspan="4">
|
|
<thead aria-colspan="4">
|
|
<tr>
|
|
<th></th>
|
|
<th>Field</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody aria-colspan="4">
|
|
<tr></tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<code>operator</code>
|
|
</td>
|
|
<td colspan="3">
|
|
<p>operator is section for configuring operator deployment</p>
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<code>replicaCount</code></br>
|
|
</td>
|
|
<td>
|
|
1
|
|
</td>
|
|
<td>
|
|
Number of Replicas.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>image</code>
|
|
</td>
|
|
<td>
|
|
virtuslab/jenkins-operator:v0.4.0
|
|
</td>
|
|
<td>
|
|
Name (and tag) of the Jenkins Operator image.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>imagePullPolicy</code>
|
|
</td>
|
|
<td>
|
|
IfNotPresent
|
|
</td>
|
|
<td>
|
|
Defines policy for pulling images.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>imagePullSecrets</code>
|
|
</td>
|
|
<td>
|
|
[]
|
|
</td>
|
|
<td>
|
|
Used if you want to pull images from private repository.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>nameOverride</code>
|
|
</td>
|
|
<td>
|
|
""
|
|
</td>
|
|
<td>
|
|
nameOverride overrides the app name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>fullnameOverride</code>
|
|
</td>
|
|
<td>
|
|
""
|
|
</td>
|
|
<td>
|
|
fullnameOverride overrides the deployment name
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>resources</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>nodeSelector</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>tolerations</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>affinity</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p><h3 id="Backup">Backup
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#JenkinsConfiguration">JenkinsConfiguration</a>)
|
|
</p>
|
|
<p>
|
|
Backup defines configuration of Jenkins backup.
|
|
</p></p>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>enabled</code>
|
|
</td>
|
|
<td>
|
|
true
|
|
</td>
|
|
<td>
|
|
Enabled is enable/disable switch for backup feature.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>image</code>
|
|
</td>
|
|
<td>
|
|
virtuslab/jenkins-operator-backup-pvc:v0.0.8
|
|
</td>
|
|
<td>
|
|
Image used by backup feature.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>containerName</code>
|
|
</td>
|
|
<td>
|
|
backup
|
|
</td>
|
|
<td>
|
|
Backup container name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>interval</code>
|
|
</td>
|
|
<td>
|
|
30
|
|
</td>
|
|
<td>
|
|
Defines how often make backup in seconds.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>makeBackupBeforePodDeletion</code>
|
|
</td>
|
|
<td>
|
|
true
|
|
</td>
|
|
<td>
|
|
When enabled will make backup before pod deletion.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>backupCommand</code>
|
|
</td>
|
|
<td>
|
|
/home/user/bin/backup.sh
|
|
</td>
|
|
<td>
|
|
Backup container command.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>restoreCommand</code>
|
|
</td>
|
|
<td>
|
|
/home/user/bin/restore.sh
|
|
</td>
|
|
<td>
|
|
Backup restore command.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>pvc</code>
|
|
</td>
|
|
<td colspan="2">
|
|
<p>Persistent Volume Claim Kubernetes resource</p>
|
|
<br/>
|
|
<table colspan="2" style="width:100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>enabled</code>
|
|
</td>
|
|
<td>
|
|
true
|
|
</td>
|
|
<td>
|
|
Enable/disable switch for PVC
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>enabled</code>
|
|
</td>
|
|
<td>
|
|
true
|
|
</td>
|
|
<td>
|
|
Enable/disable switch for PVC
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>size</code>
|
|
</td>
|
|
<td>
|
|
5Gi
|
|
</td>
|
|
<td>
|
|
Size of PVC
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>className</code>
|
|
</td>
|
|
<td>
|
|
""
|
|
</td>
|
|
<td>
|
|
StorageClassName for PVC
|
|
<a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class-1">More info</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>env</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
- name: BACKUP_DIR
|
|
value: /backup
|
|
- name: JENKINS_HOME
|
|
value: /jenkins-home
|
|
- name: BACKUP_COUNT
|
|
value: "3"
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
Contains container environment variables.
|
|
PVC backup provider handles these variables:<br />
|
|
BACKUP_DIR - path for storing backup files (default: "/backup")<br />
|
|
JENKINS_HOME - path to jenkins home (default: "/jenkins-home")<br />
|
|
BACKUP_COUNT - define how much recent backups will be kept<br />
|
|
</td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>volumeMounts</code>
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
- name: jenkins-home
|
|
mountPath: /jenkins-home
|
|
- mountPath: /backup
|
|
name: backup
|
|
</pre>
|
|
</td>
|
|
<td>
|
|
Holds the mount points for volumes.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><h4 id="Configuration">Configuration
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#JenkinsConfiguration">Jenkins instance configuration</a>)
|
|
</p></p>
|
|
|
|
<p><table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>configurationAsCode</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin.
|
|
Example:<br />
|
|
<pre>
|
|
- configMapName: jenkins-casc
|
|
content: {}
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>groovyScripts</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
GroovyScripts defines configuration of Jenkins customization via groovy scripts.
|
|
Example:<br />
|
|
<pre>
|
|
- configMapName: jenkins-gs
|
|
content: {}
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>secretRefName</code>
|
|
</td>
|
|
<td>
|
|
“”
|
|
</td>
|
|
<td>
|
|
secretRefName of existing secret (previously created).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>secretData</code>
|
|
</td>
|
|
<td>
|
|
{}
|
|
</td>
|
|
<td>
|
|
If secretRefName is empty, secretData creates new secret and fills with data provided in secretData.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></p>
|
|
|
|
<h2 id="note-on-operator-s-nightly-built-images">Note on Operator’s nightly built images</h2>
|
|
|
|
<p>If you wish to use the newest, not yet released version of the Operator, you can use one of nightly built snapshot images, however the maintainers of this project cannot guarantee their stability.</p>
|
|
|
|
<p>You can find nightly built images by heading to <a href="https://hub.docker.com/r/virtuslab/jenkins-operator">virtuslab/jenkins-operator</a> Docker Hub repository and looking for images with tag in the form of <code>{git-hash}</code>, {git-hash} being the hash of master branch commit that you want to use snapshot of.</p>
|
|
|
|
<h2 id="note-on-restricted-jenkins-controller-pod-volumemounts">Note on restricted Jenkins controller pod volumeMounts</h2>
|
|
|
|
<p>Current design of the Operator puts an emphasis on creating a full GitOps flow of work for Jenkins users.
|
|
One of the key points of this design is maintaining an immutable state of Jenkins.</p>
|
|
|
|
<p>One of the prerequisites of this is an ephemeral Jenkins home directory. To achieve that, Operator mounts emptyDir Volume
|
|
(jenkins-home) as Jenkins home directory.
|
|
It is not possible to overwrite volumeMount and specify any other Volume for Jenkins home directory,
|
|
as attempting to do so will result in Operator error.</p>
|
|
|
|
<p>jenkins-home is not the only Jenkins controller pod volumeMount that is non-configurable and managed by Operator,
|
|
below is the full list of those volumeMounts:</p>
|
|
|
|
<ul>
|
|
<li>jenkins-home</li>
|
|
<li>scripts</li>
|
|
<li>init-configuration</li>
|
|
<li>operator-credentials</li>
|
|
</ul>
|
|
|
|
|
|
|
|
<div class="text-muted mt-5 pt-3 border-top">Last modified December 8, 2021
|
|
</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> |