index.html 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187
  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.1, mkdocs-material-7.1.8">
  8. <title>Gitlab Project Variables - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.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-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  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. <header class="md-header" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="Header">
  31. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  32. <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>
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. External Secrets Operator
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. Gitlab Project Variables
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <label class="md-header__button md-icon" for="__search">
  52. <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>
  53. </label>
  54. <div class="md-search" data-md-component="search" role="dialog">
  55. <label class="md-search__overlay" for="__search"></label>
  56. <div class="md-search__inner" role="search">
  57. <form class="md-search__form" name="search">
  58. <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" data-md-state="active" required>
  59. <label class="md-search__icon md-icon" for="__search">
  60. <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>
  61. <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>
  62. </label>
  63. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  64. <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>
  65. </button>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <div class="md-header__source">
  80. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  81. <div class="md-source__icon md-icon">
  82. <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>
  83. </div>
  84. <div class="md-source__repository">
  85. External Secrets Operator
  86. </div>
  87. </a>
  88. </div>
  89. </nav>
  90. </header>
  91. <div class="md-container" data-md-component="container">
  92. <main class="md-main" data-md-component="main">
  93. <div class="md-main__inner md-grid">
  94. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  95. <div class="md-sidebar__scrollwrap">
  96. <div class="md-sidebar__inner">
  97. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  98. <label class="md-nav__title" for="__drawer">
  99. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  100. <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>
  101. </a>
  102. External Secrets Operator
  103. </label>
  104. <div class="md-nav__source">
  105. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <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>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. <ul class="md-nav__list" data-md-scrollfix>
  115. <li class="md-nav__item">
  116. <a href=".." class="md-nav__link">
  117. Introduction
  118. </a>
  119. </li>
  120. <li class="md-nav__item">
  121. <a href="../api-overview/" class="md-nav__link">
  122. Overview
  123. </a>
  124. </li>
  125. <li class="md-nav__item md-nav__item--nested">
  126. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  127. <label class="md-nav__link" for="__nav_3">
  128. API Types
  129. <span class="md-nav__icon md-icon"></span>
  130. </label>
  131. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  132. <label class="md-nav__title" for="__nav_3">
  133. <span class="md-nav__icon md-icon"></span>
  134. API Types
  135. </label>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../api-externalsecret/" class="md-nav__link">
  139. ExternalSecret
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="../api-secretstore/" class="md-nav__link">
  144. SecretStore
  145. </a>
  146. </li>
  147. <li class="md-nav__item">
  148. <a href="../api-clustersecretstore/" class="md-nav__link">
  149. ClusterSecretStore
  150. </a>
  151. </li>
  152. </ul>
  153. </nav>
  154. </li>
  155. <li class="md-nav__item md-nav__item--nested">
  156. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  157. <label class="md-nav__link" for="__nav_4">
  158. Guides
  159. <span class="md-nav__icon md-icon"></span>
  160. </label>
  161. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  162. <label class="md-nav__title" for="__nav_4">
  163. <span class="md-nav__icon md-icon"></span>
  164. Guides
  165. </label>
  166. <ul class="md-nav__list" data-md-scrollfix>
  167. <li class="md-nav__item">
  168. <a href="../guides-introduction/" class="md-nav__link">
  169. Introduction
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../guides-getting-started/" class="md-nav__link">
  174. Getting started
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-templating/" class="md-nav__link">
  179. Advanced Templating
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  184. All keys, One secret
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  189. Common K8S Secret Types
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="../guides-multi-tenancy/" class="md-nav__link">
  194. Multi Tenancy
  195. </a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../guides-metrics/" class="md-nav__link">
  199. Metrics
  200. </a>
  201. </li>
  202. </ul>
  203. </nav>
  204. </li>
  205. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  206. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  207. <label class="md-nav__link" for="__nav_5">
  208. Provider
  209. <span class="md-nav__icon md-icon"></span>
  210. </label>
  211. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  212. <label class="md-nav__title" for="__nav_5">
  213. <span class="md-nav__icon md-icon"></span>
  214. Provider
  215. </label>
  216. <ul class="md-nav__list" data-md-scrollfix>
  217. <li class="md-nav__item md-nav__item--nested">
  218. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  219. <label class="md-nav__link" for="__nav_5_1">
  220. AWS
  221. <span class="md-nav__icon md-icon"></span>
  222. </label>
  223. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  224. <label class="md-nav__title" for="__nav_5_1">
  225. <span class="md-nav__icon md-icon"></span>
  226. AWS
  227. </label>
  228. <ul class="md-nav__list" data-md-scrollfix>
  229. <li class="md-nav__item">
  230. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  231. Secrets Manager
  232. </a>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  236. Parameter Store
  237. </a>
  238. </li>
  239. </ul>
  240. </nav>
  241. </li>
  242. <li class="md-nav__item md-nav__item--nested">
  243. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  244. <label class="md-nav__link" for="__nav_5_2">
  245. Azure
  246. <span class="md-nav__icon md-icon"></span>
  247. </label>
  248. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  249. <label class="md-nav__title" for="__nav_5_2">
  250. <span class="md-nav__icon md-icon"></span>
  251. Azure
  252. </label>
  253. <ul class="md-nav__list" data-md-scrollfix>
  254. <li class="md-nav__item">
  255. <a href="../provider-azure-key-vault/" class="md-nav__link">
  256. Key Vault
  257. </a>
  258. </li>
  259. </ul>
  260. </nav>
  261. </li>
  262. <li class="md-nav__item md-nav__item--nested">
  263. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  264. <label class="md-nav__link" for="__nav_5_3">
  265. Google
  266. <span class="md-nav__icon md-icon"></span>
  267. </label>
  268. <nav class="md-nav" aria-label="Google" data-md-level="2">
  269. <label class="md-nav__title" for="__nav_5_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. Google
  272. </label>
  273. <ul class="md-nav__list" data-md-scrollfix>
  274. <li class="md-nav__item">
  275. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  276. Secrets Manager
  277. </a>
  278. </li>
  279. </ul>
  280. </nav>
  281. </li>
  282. <li class="md-nav__item md-nav__item--nested">
  283. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  284. <label class="md-nav__link" for="__nav_5_4">
  285. IBM
  286. <span class="md-nav__icon md-icon"></span>
  287. </label>
  288. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  289. <label class="md-nav__title" for="__nav_5_4">
  290. <span class="md-nav__icon md-icon"></span>
  291. IBM
  292. </label>
  293. <ul class="md-nav__list" data-md-scrollfix>
  294. <li class="md-nav__item">
  295. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  296. Secrets Manager
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  304. HashiCorp Vault
  305. </a>
  306. </li>
  307. <li class="md-nav__item md-nav__item--nested">
  308. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_6" type="checkbox" id="__nav_5_6" >
  309. <label class="md-nav__link" for="__nav_5_6">
  310. Yandex
  311. <span class="md-nav__icon md-icon"></span>
  312. </label>
  313. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  314. <label class="md-nav__title" for="__nav_5_6">
  315. <span class="md-nav__icon md-icon"></span>
  316. Yandex
  317. </label>
  318. <ul class="md-nav__list" data-md-scrollfix>
  319. <li class="md-nav__item">
  320. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  321. Lockbox
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" checked>
  329. <label class="md-nav__link" for="__nav_5_7">
  330. Gitlab
  331. <span class="md-nav__icon md-icon"></span>
  332. </label>
  333. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  334. <label class="md-nav__title" for="__nav_5_7">
  335. <span class="md-nav__icon md-icon"></span>
  336. Gitlab
  337. </label>
  338. <ul class="md-nav__list" data-md-scrollfix>
  339. <li class="md-nav__item md-nav__item--active">
  340. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  341. <label class="md-nav__link md-nav__link--active" for="__toc">
  342. Gitlab Project Variables
  343. <span class="md-nav__icon md-icon"></span>
  344. </label>
  345. <a href="./" class="md-nav__link md-nav__link--active">
  346. Gitlab Project Variables
  347. </a>
  348. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  349. <label class="md-nav__title" for="__toc">
  350. <span class="md-nav__icon md-icon"></span>
  351. Table of contents
  352. </label>
  353. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="#gitlab-project-variables" class="md-nav__link">
  356. Gitlab Project Variables
  357. </a>
  358. <nav class="md-nav" aria-label="Gitlab Project Variables">
  359. <ul class="md-nav__list">
  360. <li class="md-nav__item">
  361. <a href="#authentication" class="md-nav__link">
  362. Authentication
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="#access-token-secret" class="md-nav__link">
  367. Access Token secret
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="#update-secret-store" class="md-nav__link">
  372. Update secret store
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="#creating-external-secret" class="md-nav__link">
  377. Creating external secret
  378. </a>
  379. <nav class="md-nav" aria-label="Creating external secret">
  380. <ul class="md-nav__list">
  381. <li class="md-nav__item">
  382. <a href="#using-datafrom" class="md-nav__link">
  383. Using DataFrom
  384. </a>
  385. </li>
  386. </ul>
  387. </nav>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  391. Getting the Kubernetes secret
  392. </a>
  393. </li>
  394. </ul>
  395. </nav>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item md-nav__item--nested">
  407. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  408. <label class="md-nav__link" for="__nav_6">
  409. References
  410. <span class="md-nav__icon md-icon"></span>
  411. </label>
  412. <nav class="md-nav" aria-label="References" data-md-level="1">
  413. <label class="md-nav__title" for="__nav_6">
  414. <span class="md-nav__icon md-icon"></span>
  415. References
  416. </label>
  417. <ul class="md-nav__list" data-md-scrollfix>
  418. <li class="md-nav__item">
  419. <a href="../spec/" class="md-nav__link">
  420. API specification
  421. </a>
  422. </li>
  423. </ul>
  424. </nav>
  425. </li>
  426. <li class="md-nav__item md-nav__item--nested">
  427. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  428. <label class="md-nav__link" for="__nav_7">
  429. Contributing
  430. <span class="md-nav__icon md-icon"></span>
  431. </label>
  432. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  433. <label class="md-nav__title" for="__nav_7">
  434. <span class="md-nav__icon md-icon"></span>
  435. Contributing
  436. </label>
  437. <ul class="md-nav__list" data-md-scrollfix>
  438. <li class="md-nav__item">
  439. <a href="../contributing-devguide/" class="md-nav__link">
  440. Developer guide
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../contributing-process/" class="md-nav__link">
  445. Contributing Process
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../contributing-coc/" class="md-nav__link">
  450. Code of Conduct
  451. </a>
  452. </li>
  453. </ul>
  454. </nav>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../deprecation-policy/" class="md-nav__link">
  458. Deprecation Policy
  459. </a>
  460. </li>
  461. </ul>
  462. </nav>
  463. </div>
  464. </div>
  465. </div>
  466. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  467. <div class="md-sidebar__scrollwrap">
  468. <div class="md-sidebar__inner">
  469. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  470. <label class="md-nav__title" for="__toc">
  471. <span class="md-nav__icon md-icon"></span>
  472. Table of contents
  473. </label>
  474. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  475. <li class="md-nav__item">
  476. <a href="#gitlab-project-variables" class="md-nav__link">
  477. Gitlab Project Variables
  478. </a>
  479. <nav class="md-nav" aria-label="Gitlab Project Variables">
  480. <ul class="md-nav__list">
  481. <li class="md-nav__item">
  482. <a href="#authentication" class="md-nav__link">
  483. Authentication
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="#access-token-secret" class="md-nav__link">
  488. Access Token secret
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="#update-secret-store" class="md-nav__link">
  493. Update secret store
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="#creating-external-secret" class="md-nav__link">
  498. Creating external secret
  499. </a>
  500. <nav class="md-nav" aria-label="Creating external secret">
  501. <ul class="md-nav__list">
  502. <li class="md-nav__item">
  503. <a href="#using-datafrom" class="md-nav__link">
  504. Using DataFrom
  505. </a>
  506. </li>
  507. </ul>
  508. </nav>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  512. Getting the Kubernetes secret
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. </ul>
  519. </nav>
  520. </div>
  521. </div>
  522. </div>
  523. <div class="md-content" data-md-component="content">
  524. <article class="md-content__inner md-typeset">
  525. <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">
  526. <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>
  527. </a>
  528. <h1>Gitlab Project Variables</h1>
  529. <h2 id="gitlab-project-variables">Gitlab Project Variables</h2>
  530. <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>
  531. <h3 id="authentication">Authentication</h3>
  532. <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>
  533. <p><img alt="token-details" src="../pictures/screenshot_gitlab_token.png" /></p>
  534. <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.
  535. <img alt="token-created" src="../pictures/screenshot_gitlab_token_created.png" /></p>
  536. <h3 id="access-token-secret">Access Token secret</h3>
  537. <p>Create a secret containing your access token:</p>
  538. <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>
  539. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  540. <span class="nt">metadata</span><span class="p">:</span>
  541. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span>
  542. <span class="nt">labels</span><span class="p">:</span>
  543. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab</span>
  544. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Opaque</span>
  545. <span class="nt">stringData</span><span class="p">:</span>
  546. <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>
  547. </code></pre></div>
  548. <h3 id="update-secret-store">Update secret store</h3>
  549. <p>Be sure the <code>gitlab</code> provider is listed in the <code>Kind=SecretStore</code> and the ProjectID is set</p>
  550. <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>
  551. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  552. <span class="nt">metadata</span><span class="p">:</span>
  553. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span>
  554. <span class="nt">spec</span><span class="p">:</span>
  555. <span class="nt">provider</span><span class="p">:</span>
  556. <span class="c1"># provider type: gitlab</span>
  557. <span class="nt">gitlab</span><span class="p">:</span>
  558. <span class="nt">auth</span><span class="p">:</span>
  559. <span class="nt">SecretRef</span><span class="p">:</span>
  560. <span class="nt">accessToken</span><span class="p">:</span>
  561. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span>
  562. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">token</span>
  563. <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>
  564. </code></pre></div>
  565. <p>Your project ID can be found on your project's page.
  566. <img alt="projectID" src="../pictures/screenshot_gitlab_projectID.png" /></p>
  567. <h3 id="creating-external-secret">Creating external secret</h3>
  568. <p>To sync a Gitlab variable to a secret on the Kubernetes cluster, a <code>Kind=ExternalSecret</code> is needed.</p>
  569. <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>
  570. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  571. <span class="nt">metadata</span><span class="p">:</span>
  572. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span>
  573. <span class="nt">spec</span><span class="p">:</span>
  574. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  575. <span class="nt">secretStoreRef</span><span class="p">:</span>
  576. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  577. <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>
  578. <span class="nt">target</span><span class="p">:</span>
  579. <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>
  580. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  581. <span class="nt">data</span><span class="p">:</span>
  582. <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>
  583. <span class="nt">remoteRef</span><span class="p">:</span>
  584. <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>
  585. </code></pre></div>
  586. <h4 id="using-datafrom">Using DataFrom</h4>
  587. <p>DataFrom can be used to get a variable as a JSON string and attempt to parse it.</p>
  588. <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>
  589. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  590. <span class="nt">metadata</span><span class="p">:</span>
  591. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span>
  592. <span class="nt">spec</span><span class="p">:</span>
  593. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1h</span>
  594. <span class="nt">secretStoreRef</span><span class="p">:</span>
  595. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  596. <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>
  597. <span class="nt">target</span><span class="p">:</span>
  598. <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>
  599. <span class="nt">creationPolicy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Owner</span>
  600. <span class="c1"># each secret name in the KV will be used as the secret key in the SECRET k8s target object</span>
  601. <span class="nt">dataFrom</span><span class="p">:</span>
  602. <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>
  603. </code></pre></div>
  604. <h3 id="getting-the-kubernetes-secret">Getting the Kubernetes secret</h3>
  605. <p>The operator will fetch the project variable and inject it as a <code>Kind=Secret</code>.
  606. <div class="highlight"><pre><span></span><code>kubectl get secret gitlab-secret-to-create -o jsonpath=&#39;{.data.secretKey}&#39; | base64 -d
  607. </code></pre></div></p>
  608. </article>
  609. </div>
  610. </div>
  611. </main>
  612. <footer class="md-footer">
  613. <nav class="md-footer__inner md-grid" aria-label="Footer">
  614. <a href="../provider-yandex-lockbox/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lockbox" rel="prev">
  615. <div class="md-footer__button md-icon">
  616. <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>
  617. </div>
  618. <div class="md-footer__title">
  619. <div class="md-ellipsis">
  620. <span class="md-footer__direction">
  621. Previous
  622. </span>
  623. Lockbox
  624. </div>
  625. </div>
  626. </a>
  627. <a href="../spec/" class="md-footer__link md-footer__link--next" aria-label="Next: API specification" rel="next">
  628. <div class="md-footer__title">
  629. <div class="md-ellipsis">
  630. <span class="md-footer__direction">
  631. Next
  632. </span>
  633. API specification
  634. </div>
  635. </div>
  636. <div class="md-footer__button md-icon">
  637. <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>
  638. </div>
  639. </a>
  640. </nav>
  641. <div class="md-footer-meta md-typeset">
  642. <div class="md-footer-meta__inner md-grid">
  643. <div class="md-footer-copyright">
  644. Made with
  645. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  646. Material for MkDocs
  647. </a>
  648. </div>
  649. </div>
  650. </div>
  651. </footer>
  652. </div>
  653. <div class="md-dialog" data-md-component="dialog">
  654. <div class="md-dialog__inner md-typeset"></div>
  655. </div>
  656. <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.b0710199.min.js", "version": null}</script>
  657. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  658. </body>
  659. </html>