index.html 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.9">
  8. <title>Gitlab Project Variables - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#gitlab-project-variables" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Gitlab Project Variables
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-multi-tenancy/" class="md-nav__link">
  212. Multi Tenancy
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-metrics/" class="md-nav__link">
  217. Metrics
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-using-latest-image/" class="md-nav__link">
  222. Using Latest Image
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  227. GitOps using FluxCD
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  235. <label class="md-nav__link" for="__nav_5">
  236. Provider
  237. <span class="md-nav__icon md-icon"></span>
  238. </label>
  239. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  240. <label class="md-nav__title" for="__nav_5">
  241. <span class="md-nav__icon md-icon"></span>
  242. Provider
  243. </label>
  244. <ul class="md-nav__list" data-md-scrollfix>
  245. <li class="md-nav__item md-nav__item--nested">
  246. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  247. <label class="md-nav__link" for="__nav_5_1">
  248. AWS
  249. <span class="md-nav__icon md-icon"></span>
  250. </label>
  251. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  252. <label class="md-nav__title" for="__nav_5_1">
  253. <span class="md-nav__icon md-icon"></span>
  254. AWS
  255. </label>
  256. <ul class="md-nav__list" data-md-scrollfix>
  257. <li class="md-nav__item">
  258. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  259. Secrets Manager
  260. </a>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  264. Parameter Store
  265. </a>
  266. </li>
  267. </ul>
  268. </nav>
  269. </li>
  270. <li class="md-nav__item md-nav__item--nested">
  271. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  272. <label class="md-nav__link" for="__nav_5_2">
  273. Azure
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  277. <label class="md-nav__title" for="__nav_5_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Azure
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item">
  283. <a href="../provider-azure-key-vault/" class="md-nav__link">
  284. Key Vault
  285. </a>
  286. </li>
  287. </ul>
  288. </nav>
  289. </li>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  292. <label class="md-nav__link" for="__nav_5_3">
  293. Google
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="Google" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_3">
  298. <span class="md-nav__icon md-icon"></span>
  299. Google
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  304. Secrets Manager
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  312. <label class="md-nav__link" for="__nav_5_4">
  313. IBM
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. IBM
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  324. Secrets Manager
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../provider-akeyless/" class="md-nav__link">
  332. Akeyless
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  337. HashiCorp Vault
  338. </a>
  339. </li>
  340. <li class="md-nav__item md-nav__item--nested">
  341. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  342. <label class="md-nav__link" for="__nav_5_7">
  343. Yandex
  344. <span class="md-nav__icon md-icon"></span>
  345. </label>
  346. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  347. <label class="md-nav__title" for="__nav_5_7">
  348. <span class="md-nav__icon md-icon"></span>
  349. Yandex
  350. </label>
  351. <ul class="md-nav__list" data-md-scrollfix>
  352. <li class="md-nav__item">
  353. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  354. Lockbox
  355. </a>
  356. </li>
  357. </ul>
  358. </nav>
  359. </li>
  360. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" checked>
  362. <label class="md-nav__link" for="__nav_5_8">
  363. Gitlab
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_5_8">
  368. <span class="md-nav__icon md-icon"></span>
  369. Gitlab
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item md-nav__item--active">
  373. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  374. <label class="md-nav__link md-nav__link--active" for="__toc">
  375. Gitlab Project Variables
  376. <span class="md-nav__icon md-icon"></span>
  377. </label>
  378. <a href="./" class="md-nav__link md-nav__link--active">
  379. Gitlab Project Variables
  380. </a>
  381. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  382. <label class="md-nav__title" for="__toc">
  383. <span class="md-nav__icon md-icon"></span>
  384. Table of contents
  385. </label>
  386. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="#gitlab-project-variables" class="md-nav__link">
  389. Gitlab Project Variables
  390. </a>
  391. <nav class="md-nav" aria-label="Gitlab Project Variables">
  392. <ul class="md-nav__list">
  393. <li class="md-nav__item">
  394. <a href="#authentication" class="md-nav__link">
  395. Authentication
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="#access-token-secret" class="md-nav__link">
  400. Access Token secret
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="#update-secret-store" class="md-nav__link">
  405. Update secret store
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="#creating-external-secret" class="md-nav__link">
  410. Creating external secret
  411. </a>
  412. <nav class="md-nav" aria-label="Creating external secret">
  413. <ul class="md-nav__list">
  414. <li class="md-nav__item">
  415. <a href="#using-datafrom" class="md-nav__link">
  416. Using DataFrom
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  424. Getting the Kubernetes secret
  425. </a>
  426. </li>
  427. </ul>
  428. </nav>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. </ul>
  434. </nav>
  435. </li>
  436. <li class="md-nav__item md-nav__item--nested">
  437. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  438. <label class="md-nav__link" for="__nav_5_9">
  439. Oracle
  440. <span class="md-nav__icon md-icon"></span>
  441. </label>
  442. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  443. <label class="md-nav__title" for="__nav_5_9">
  444. <span class="md-nav__icon md-icon"></span>
  445. Oracle
  446. </label>
  447. <ul class="md-nav__list" data-md-scrollfix>
  448. <li class="md-nav__item">
  449. <a href="../provider-oracle-vault/" class="md-nav__link">
  450. Oracle Vault
  451. </a>
  452. </li>
  453. </ul>
  454. </nav>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../provider-webhook/" class="md-nav__link">
  458. Webhook
  459. </a>
  460. </li>
  461. </ul>
  462. </nav>
  463. </li>
  464. <li class="md-nav__item md-nav__item--nested">
  465. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  466. <label class="md-nav__link" for="__nav_6">
  467. References
  468. <span class="md-nav__icon md-icon"></span>
  469. </label>
  470. <nav class="md-nav" aria-label="References" data-md-level="1">
  471. <label class="md-nav__title" for="__nav_6">
  472. <span class="md-nav__icon md-icon"></span>
  473. References
  474. </label>
  475. <ul class="md-nav__list" data-md-scrollfix>
  476. <li class="md-nav__item">
  477. <a href="../spec/" class="md-nav__link">
  478. API specification
  479. </a>
  480. </li>
  481. </ul>
  482. </nav>
  483. </li>
  484. <li class="md-nav__item md-nav__item--nested">
  485. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  486. <label class="md-nav__link" for="__nav_7">
  487. Contributing
  488. <span class="md-nav__icon md-icon"></span>
  489. </label>
  490. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  491. <label class="md-nav__title" for="__nav_7">
  492. <span class="md-nav__icon md-icon"></span>
  493. Contributing
  494. </label>
  495. <ul class="md-nav__list" data-md-scrollfix>
  496. <li class="md-nav__item">
  497. <a href="../contributing-devguide/" class="md-nav__link">
  498. Developer guide
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../contributing-process/" class="md-nav__link">
  503. Contributing Process
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../contributing-coc/" class="md-nav__link">
  508. Code of Conduct
  509. </a>
  510. </li>
  511. </ul>
  512. </nav>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="../deprecation-policy/" class="md-nav__link">
  516. Deprecation Policy
  517. </a>
  518. </li>
  519. </ul>
  520. </nav>
  521. </div>
  522. </div>
  523. </div>
  524. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  525. <div class="md-sidebar__scrollwrap">
  526. <div class="md-sidebar__inner">
  527. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  528. <label class="md-nav__title" for="__toc">
  529. <span class="md-nav__icon md-icon"></span>
  530. Table of contents
  531. </label>
  532. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  533. <li class="md-nav__item">
  534. <a href="#gitlab-project-variables" class="md-nav__link">
  535. Gitlab Project Variables
  536. </a>
  537. <nav class="md-nav" aria-label="Gitlab Project Variables">
  538. <ul class="md-nav__list">
  539. <li class="md-nav__item">
  540. <a href="#authentication" class="md-nav__link">
  541. Authentication
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="#access-token-secret" class="md-nav__link">
  546. Access Token secret
  547. </a>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="#update-secret-store" class="md-nav__link">
  551. Update secret store
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="#creating-external-secret" class="md-nav__link">
  556. Creating external secret
  557. </a>
  558. <nav class="md-nav" aria-label="Creating external secret">
  559. <ul class="md-nav__list">
  560. <li class="md-nav__item">
  561. <a href="#using-datafrom" class="md-nav__link">
  562. Using DataFrom
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  570. Getting the Kubernetes secret
  571. </a>
  572. </li>
  573. </ul>
  574. </nav>
  575. </li>
  576. </ul>
  577. </nav>
  578. </div>
  579. </div>
  580. </div>
  581. <div class="md-content" data-md-component="content">
  582. <article class="md-content__inner md-typeset">
  583. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-gitlab-project-variables.md" title="Edit this page" class="md-content__button md-icon">
  584. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  585. </a>
  586. <h1>Gitlab Project Variables</h1>
  587. <h2 id="gitlab-project-variables">Gitlab Project Variables</h2>
  588. <p>External Secrets Operator integrates with <a href="https://docs.gitlab.com/ee/api/project_level_variables.html">Gitlab API</a> to sync Gitlab project variables to secrets held on the Kubernetes cluster.</p>
  589. <h3 id="authentication">Authentication</h3>
  590. <p>The API requires an access token and project ID. To create a new access token, go to your user settings and select 'access tokens'. Give your token a name, expiration date, and select the permissions required (Note 'api' is required).</p>
  591. <p><img alt="token-details" src="../pictures/screenshot_gitlab_token.png" /></p>
  592. <p>Click 'Create personal access token', and your token will be generated and displayed on screen. Copy or save this token since you can't access it again.
  593. <img alt="token-created" src="../pictures/screenshot_gitlab_token_created.png" /></p>
  594. <h3 id="access-token-secret">Access Token secret</h3>
  595. <p>Create a secret containing your access token:</p>
  596. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  597. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  598. <span class="nt">metadata</span><span class="p">:</span>
  599. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span>
  600. <span class="nt">labels</span><span class="p">:</span>
  601. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab</span>
  602. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  603. <span class="nt">stringData</span><span class="p">:</span>
  604. <span class="nt">token</span><span class="p">:</span> <span class="s">&quot;**access</span><span class="nv"> </span><span class="s">token</span><span class="nv"> </span><span class="s">goes</span><span class="nv"> </span><span class="s">here**&quot;</span>
  605. </code></pre></div>
  606. <h3 id="update-secret-store">Update secret store</h3>
  607. <p>Be sure the <code>gitlab</code> provider is listed in the <code>Kind=SecretStore</code> and the ProjectID is set. If you are not using <code>https://gitlab.com</code>, you must set the <code>url</code> field as well.</p>
  608. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  609. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  610. <span class="nt">metadata</span><span class="p">:</span>
  611. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span>
  612. <span class="nt">spec</span><span class="p">:</span>
  613. <span class="nt">provider</span><span class="p">:</span>
  614. <span class="c1"># provider type: gitlab</span>
  615. <span class="nt">gitlab</span><span class="p">:</span>
  616. <span class="c1"># url: https://gitlab.mydomain.com/</span>
  617. <span class="nt">auth</span><span class="p">:</span>
  618. <span class="nt">SecretRef</span><span class="p">:</span>
  619. <span class="nt">accessToken</span><span class="p">:</span>
  620. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span>
  621. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">token</span>
  622. <span class="nt">projectID</span><span class="p">:</span> <span class="s">&quot;**project</span><span class="nv"> </span><span class="s">ID</span><span class="nv"> </span><span class="s">goes</span><span class="nv"> </span><span class="s">here**&quot;</span>
  623. </code></pre></div>
  624. <p>Your project ID can be found on your project's page.
  625. <img alt="projectID" src="../pictures/screenshot_gitlab_projectID.png" /></p>
  626. <h3 id="creating-external-secret">Creating external secret</h3>
  627. <p>To sync a Gitlab variable to a secret on the Kubernetes cluster, a <code>Kind=ExternalSecret</code> is needed.</p>
  628. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  629. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  630. <span class="nt">metadata</span><span class="p">:</span>
  631. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span>
  632. <span class="nt">spec</span><span class="p">:</span>
  633. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  634. <span class="nt">secretStoreRef</span><span class="p">:</span>
  635. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  636. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span> <span class="c1"># Must match SecretStore on the cluster</span>
  637. <span class="nt">target</span><span class="p">:</span>
  638. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-to-create</span> <span class="c1"># Name for the secret to be created on the cluster</span>
  639. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  640. <span class="nt">data</span><span class="p">:</span>
  641. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secretKey</span> <span class="c1"># Key given to the secret to be created on the cluster</span>
  642. <span class="nt">remoteRef</span><span class="p">:</span>
  643. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myGitlabVariable</span> <span class="c1"># Key of the variable on Gitlab</span>
  644. </code></pre></div>
  645. <h4 id="using-datafrom">Using DataFrom</h4>
  646. <p>DataFrom can be used to get a variable as a JSON string and attempt to parse it.</p>
  647. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  648. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  649. <span class="nt">metadata</span><span class="p">:</span>
  650. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span>
  651. <span class="nt">spec</span><span class="p">:</span>
  652. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  653. <span class="nt">secretStoreRef</span><span class="p">:</span>
  654. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  655. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span> <span class="c1"># Must match SecretStore on the cluster</span>
  656. <span class="nt">target</span><span class="p">:</span>
  657. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-to-create</span> <span class="c1"># Name for the secret to be created on the cluster</span>
  658. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  659. <span class="c1"># each secret name in the KV will be used as the secret key in the SECRET k8s target object</span>
  660. <span class="nt">dataFrom</span><span class="p">:</span>
  661. <span class="p p-Indicator">-</span> <span class="nt">key</span><span class="p">:</span> <span class="s">&quot;myJsonVariable&quot;</span> <span class="c1"># Key of the variable on Gitlab</span>
  662. </code></pre></div>
  663. <h3 id="getting-the-kubernetes-secret">Getting the Kubernetes secret</h3>
  664. <p>The operator will fetch the project variable and inject it as a <code>Kind=Secret</code>.
  665. <div class="highlight"><pre><span></span><code>kubectl get secret gitlab-secret-to-create -o jsonpath=&#39;{.data.secretKey}&#39; | base64 -d
  666. </code></pre></div></p>
  667. </article>
  668. </div>
  669. </div>
  670. </main>
  671. <footer class="md-footer">
  672. <nav class="md-footer__inner md-grid" aria-label="Footer">
  673. <a href="../provider-yandex-lockbox/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lockbox" rel="prev">
  674. <div class="md-footer__button md-icon">
  675. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  676. </div>
  677. <div class="md-footer__title">
  678. <div class="md-ellipsis">
  679. <span class="md-footer__direction">
  680. Previous
  681. </span>
  682. Lockbox
  683. </div>
  684. </div>
  685. </a>
  686. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Oracle Vault" rel="next">
  687. <div class="md-footer__title">
  688. <div class="md-ellipsis">
  689. <span class="md-footer__direction">
  690. Next
  691. </span>
  692. Oracle Vault
  693. </div>
  694. </div>
  695. <div class="md-footer__button md-icon">
  696. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  697. </div>
  698. </a>
  699. </nav>
  700. <div class="md-footer-meta md-typeset">
  701. <div class="md-footer-meta__inner md-grid">
  702. <div class="md-copyright">
  703. Made with
  704. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  705. Material for MkDocs
  706. </a>
  707. </div>
  708. </div>
  709. </div>
  710. </footer>
  711. </div>
  712. <div class="md-dialog" data-md-component="dialog">
  713. <div class="md-dialog__inner md-typeset"></div>
  714. </div>
  715. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  716. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  717. </body>
  718. </html>