index.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211
  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.10">
  8. <title>Gitlab Variables - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.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-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 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. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  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_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../../guides/introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  427. Rewriting Keys
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/v1beta1/" class="md-nav__link">
  432. Upgrading to v1beta1
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/using-latest-image/" class="md-nav__link">
  437. Using Latest Image
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  442. Disable Cluster Features
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  450. <label class="md-nav__link" for="__nav_4">
  451. Provider
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  455. <label class="md-nav__title" for="__nav_4">
  456. <span class="md-nav__icon md-icon"></span>
  457. Provider
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../aws-secrets-manager/" class="md-nav__link">
  462. AWS Secrets Manager
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../aws-parameter-store/" class="md-nav__link">
  467. AWS Parameter Store
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../azure-key-vault/" class="md-nav__link">
  472. Azure Key Vault
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../google-secrets-manager/" class="md-nav__link">
  477. Google Secret Manager
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../ibm-secrets-manager/" class="md-nav__link">
  482. IBM Secrets Manager
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../akeyless/" class="md-nav__link">
  487. Akeyless
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../hashicorp-vault/" class="md-nav__link">
  492. HashiCorp Vault
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../yandex-certificate-manager/" class="md-nav__link">
  497. Yandex Certificate Manager
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../yandex-lockbox/" class="md-nav__link">
  502. Yandex Lockbox
  503. </a>
  504. </li>
  505. <li class="md-nav__item md-nav__item--active">
  506. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  507. <label class="md-nav__link md-nav__link--active" for="__toc">
  508. Gitlab Variables
  509. <span class="md-nav__icon md-icon"></span>
  510. </label>
  511. <a href="./" class="md-nav__link md-nav__link--active">
  512. Gitlab Variables
  513. </a>
  514. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  515. <label class="md-nav__title" for="__toc">
  516. <span class="md-nav__icon md-icon"></span>
  517. Table of contents
  518. </label>
  519. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="#gitlab-variables" class="md-nav__link">
  522. Gitlab Variables
  523. </a>
  524. <nav class="md-nav" aria-label="Gitlab Variables">
  525. <ul class="md-nav__list">
  526. <li class="md-nav__item">
  527. <a href="#configuring-gitlab" class="md-nav__link">
  528. Configuring Gitlab
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="#access-token-secret" class="md-nav__link">
  533. Access Token secret
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="#configuring-the-secret-store" class="md-nav__link">
  538. Configuring the secret store
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="#creating-external-secret" class="md-nav__link">
  543. Creating external secret
  544. </a>
  545. <nav class="md-nav" aria-label="Creating external secret">
  546. <ul class="md-nav__list">
  547. <li class="md-nav__item">
  548. <a href="#using-datafrom" class="md-nav__link">
  549. Using DataFrom
  550. </a>
  551. </li>
  552. </ul>
  553. </nav>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  557. Getting the Kubernetes secret
  558. </a>
  559. </li>
  560. </ul>
  561. </nav>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../oracle-vault/" class="md-nav__link">
  568. Oracle Vault
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../1password-automation/" class="md-nav__link">
  573. 1Password Secrets Automation
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../webhook/" class="md-nav__link">
  578. Webhook
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../fake/" class="md-nav__link">
  583. Fake
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../kubernetes/" class="md-nav__link">
  588. Kubernetes
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../senhasegura-dsm/" class="md-nav__link">
  593. senhasegura DevOps Secrets Management (DSM)
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../doppler/" class="md-nav__link">
  598. Doppler
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../keeper-security/" class="md-nav__link">
  603. Keeper Security
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../scaleway/" class="md-nav__link">
  608. Scaleway
  609. </a>
  610. </li>
  611. </ul>
  612. </nav>
  613. </li>
  614. <li class="md-nav__item md-nav__item--nested">
  615. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  616. <label class="md-nav__link" for="__nav_5">
  617. Examples
  618. <span class="md-nav__icon md-icon"></span>
  619. </label>
  620. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  621. <label class="md-nav__title" for="__nav_5">
  622. <span class="md-nav__icon md-icon"></span>
  623. Examples
  624. </label>
  625. <ul class="md-nav__list" data-md-scrollfix>
  626. <li class="md-nav__item">
  627. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  628. FluxCD
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  633. Anchore Engine
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  638. Jenkins
  639. </a>
  640. </li>
  641. </ul>
  642. </nav>
  643. </li>
  644. <li class="md-nav__item md-nav__item--nested">
  645. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  646. <label class="md-nav__link" for="__nav_6">
  647. Community
  648. <span class="md-nav__icon md-icon"></span>
  649. </label>
  650. <nav class="md-nav" aria-label="Community" data-md-level="1">
  651. <label class="md-nav__title" for="__nav_6">
  652. <span class="md-nav__icon md-icon"></span>
  653. Community
  654. </label>
  655. <ul class="md-nav__list" data-md-scrollfix>
  656. <li class="md-nav__item md-nav__item--nested">
  657. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  658. <label class="md-nav__link" for="__nav_6_1">
  659. Contributing
  660. <span class="md-nav__icon md-icon"></span>
  661. </label>
  662. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  663. <label class="md-nav__title" for="__nav_6_1">
  664. <span class="md-nav__icon md-icon"></span>
  665. Contributing
  666. </label>
  667. <ul class="md-nav__list" data-md-scrollfix>
  668. <li class="md-nav__item">
  669. <a href="../../contributing/devguide/" class="md-nav__link">
  670. Developer guide
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../../contributing/process/" class="md-nav__link">
  675. Contributing Process
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../contributing/release/" class="md-nav__link">
  680. Release Process
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../contributing/coc/" class="md-nav__link">
  685. Code of Conduct
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../../contributing/roadmap/" class="md-nav__link">
  690. Roadmap
  691. </a>
  692. </li>
  693. </ul>
  694. </nav>
  695. </li>
  696. <li class="md-nav__item md-nav__item--nested">
  697. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  698. <label class="md-nav__link" for="__nav_6_2">
  699. External Resources
  700. <span class="md-nav__icon md-icon"></span>
  701. </label>
  702. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  703. <label class="md-nav__title" for="__nav_6_2">
  704. <span class="md-nav__icon md-icon"></span>
  705. External Resources
  706. </label>
  707. <ul class="md-nav__list" data-md-scrollfix>
  708. <li class="md-nav__item">
  709. <a href="../../eso-talks/" class="md-nav__link">
  710. Talks
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../eso-demos/" class="md-nav__link">
  715. Demos
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../eso-blogs/" class="md-nav__link">
  720. Blogs
  721. </a>
  722. </li>
  723. </ul>
  724. </nav>
  725. </li>
  726. </ul>
  727. </nav>
  728. </li>
  729. </ul>
  730. </nav>
  731. </div>
  732. </div>
  733. </div>
  734. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  735. <div class="md-sidebar__scrollwrap">
  736. <div class="md-sidebar__inner">
  737. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  738. <label class="md-nav__title" for="__toc">
  739. <span class="md-nav__icon md-icon"></span>
  740. Table of contents
  741. </label>
  742. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  743. <li class="md-nav__item">
  744. <a href="#gitlab-variables" class="md-nav__link">
  745. Gitlab Variables
  746. </a>
  747. <nav class="md-nav" aria-label="Gitlab Variables">
  748. <ul class="md-nav__list">
  749. <li class="md-nav__item">
  750. <a href="#configuring-gitlab" class="md-nav__link">
  751. Configuring Gitlab
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="#access-token-secret" class="md-nav__link">
  756. Access Token secret
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="#configuring-the-secret-store" class="md-nav__link">
  761. Configuring the secret store
  762. </a>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="#creating-external-secret" class="md-nav__link">
  766. Creating external secret
  767. </a>
  768. <nav class="md-nav" aria-label="Creating external secret">
  769. <ul class="md-nav__list">
  770. <li class="md-nav__item">
  771. <a href="#using-datafrom" class="md-nav__link">
  772. Using DataFrom
  773. </a>
  774. </li>
  775. </ul>
  776. </nav>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#getting-the-kubernetes-secret" class="md-nav__link">
  780. Getting the Kubernetes secret
  781. </a>
  782. </li>
  783. </ul>
  784. </nav>
  785. </li>
  786. </ul>
  787. </nav>
  788. </div>
  789. </div>
  790. </div>
  791. <div class="md-content" data-md-component="content">
  792. <article class="md-content__inner md-typeset">
  793. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/gitlab-variables.md" title="Edit this page" class="md-content__button md-icon">
  794. <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>
  795. </a>
  796. <h1>Gitlab Variables</h1>
  797. <h2 id="gitlab-variables">Gitlab Variables</h2>
  798. <p>External Secrets Operator integrates with Gitlab to sync <a href="https://docs.gitlab.com/ee/api/project_level_variables.html">Gitlab Project Variables API</a> and/or <a href="https://docs.gitlab.com/ee/api/group_level_variables.html">Gitlab Group Variables API</a> to secrets held on the Kubernetes cluster.</p>
  799. <h3 id="configuring-gitlab">Configuring Gitlab</h3>
  800. <p>The Gitlab API requires an access token, project ID and/or groupIDs.</p>
  801. <p>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>
  802. <p><img alt="token-details" src="../../pictures/screenshot_gitlab_token.png" /></p>
  803. <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.
  804. <img alt="token-created" src="../../pictures/screenshot_gitlab_token_created.png" /></p>
  805. <h3 id="access-token-secret">Access Token secret</h3>
  806. <p>Create a secret containing your access token:</p>
  807. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  808. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  809. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  810. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span><span class="w"></span>
  811. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span>
  812. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab</span><span class="w"></span>
  813. <span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Opaque</span><span class="w"> </span>
  814. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  815. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </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><span class="w"></span>
  816. </code></pre></div>
  817. <h3 id="configuring-the-secret-store">Configuring the secret store</h3>
  818. <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>
  819. <p>In order to sync group variables <code>inheritFromGroups</code> must be true or <code>groupIDs</code> have to be defined.</p>
  820. <p>In case you have defined multiple environments in Gitlab, the secret store should be constrained to a specific <code>environment_scope</code>.</p>
  821. <p><div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  822. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  823. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  824. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span><span class="w"></span>
  825. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  827. <span class="w"> </span><span class="c1"># provider type: gitlab</span><span class="w"></span>
  828. <span class="w"> </span><span class="nt">gitlab</span><span class="p">:</span><span class="w"></span>
  829. <span class="w"> </span><span class="c1"># url: https://gitlab.mydomain.com/</span><span class="w"></span>
  830. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">SecretRef</span><span class="p">:</span><span class="w"></span>
  832. <span class="w"> </span><span class="nt">accessToken</span><span class="p">:</span><span class="w"></span>
  833. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret</span><span class="w"></span>
  834. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">token</span><span class="w"></span>
  835. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </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><span class="w"></span>
  836. <span class="w"> </span><span class="nt">groupIDs</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;**groupID(s)</span><span class="nv"> </span><span class="s">go</span><span class="nv"> </span><span class="s">here**&quot;</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">inheritFromGroups</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;**automatically</span><span class="nv"> </span><span class="s">looks</span><span class="nv"> </span><span class="s">for</span><span class="nv"> </span><span class="s">variables</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">parent</span><span class="nv"> </span><span class="s">groups**&quot;</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;**environment</span><span class="nv"> </span><span class="s">scope</span><span class="nv"> </span><span class="s">goes</span><span class="nv"> </span><span class="s">here**&quot;</span><span class="w"></span>
  839. </code></pre></div>
  840. <strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessToken</code> with the namespace where the secret resides.</p>
  841. <p>Your project ID can be found on your project's page.
  842. <img alt="projectID" src="../../pictures/screenshot_gitlab_projectID.png" /></p>
  843. <h3 id="creating-external-secret">Creating external secret</h3>
  844. <p>To sync a Gitlab variable to a secret on the Kubernetes cluster, a <code>Kind=ExternalSecret</code> is needed.</p>
  845. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  846. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  847. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  848. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span><span class="w"></span>
  849. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  850. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  851. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  852. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  853. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span><span class="w"> </span><span class="c1"># Must match SecretStore on the cluster</span><span class="w"></span>
  854. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  855. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret-to-create</span><span class="w"> </span><span class="c1"># Name for the secret to be created on the cluster</span><span class="w"></span>
  856. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  858. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretKey</span><span class="w"> </span><span class="c1"># Key given to the secret to be created on the cluster</span><span class="w"></span>
  859. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"> </span>
  860. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myGitlabVariable</span><span class="w"> </span><span class="c1"># Key of the variable on Gitlab</span><span class="w"></span>
  861. </code></pre></div>
  862. <h4 id="using-datafrom">Using DataFrom</h4>
  863. <p>DataFrom can be used to get a variable as a JSON string and attempt to parse it.</p>
  864. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  865. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  866. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  867. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-external-secret-example</span><span class="w"></span>
  868. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  869. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  872. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret-store</span><span class="w"> </span><span class="c1"># Must match SecretStore on the cluster</span><span class="w"></span>
  873. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  874. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab-secret-to-create</span><span class="w"> </span><span class="c1"># Name for the secret to be created on the cluster</span><span class="w"></span>
  875. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span><span class="w"></span>
  876. <span class="w"> </span><span class="c1"># each secret name in the KV will be used as the secret key in the SECRET k8s target object</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  878. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  879. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;myJsonVariable&quot;</span><span class="w"> </span><span class="c1"># Key of the variable on Gitlab</span><span class="w"></span>
  880. </code></pre></div>
  881. <h3 id="getting-the-kubernetes-secret">Getting the Kubernetes secret</h3>
  882. <p>The operator will fetch the project variable and inject it as a <code>Kind=Secret</code>.
  883. <div class="highlight"><pre><span></span><code>kubectl get secret gitlab-secret-to-create -o jsonpath=&#39;{.data.secretKey}&#39; | base64 -d
  884. </code></pre></div></p>
  885. </article>
  886. </div>
  887. </div>
  888. </main>
  889. <footer class="md-footer">
  890. <nav class="md-footer__inner md-grid" aria-label="Footer">
  891. <a href="../yandex-lockbox/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Yandex Lockbox" rel="prev">
  892. <div class="md-footer__button md-icon">
  893. <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>
  894. </div>
  895. <div class="md-footer__title">
  896. <div class="md-ellipsis">
  897. <span class="md-footer__direction">
  898. Previous
  899. </span>
  900. Yandex Lockbox
  901. </div>
  902. </div>
  903. </a>
  904. <a href="../oracle-vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Oracle Vault" rel="next">
  905. <div class="md-footer__title">
  906. <div class="md-ellipsis">
  907. <span class="md-footer__direction">
  908. Next
  909. </span>
  910. Oracle Vault
  911. </div>
  912. </div>
  913. <div class="md-footer__button md-icon">
  914. <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>
  915. </div>
  916. </a>
  917. </nav>
  918. <div class="md-footer-meta md-typeset">
  919. <div class="md-footer-meta__inner md-grid">
  920. <div class="md-copyright">
  921. <div class="md-copyright__highlight">
  922. &copy; 2023 The external-secrets Authors.<br/>
  923. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  924. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  925. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  926. </div>
  927. Made with
  928. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  929. Material for MkDocs
  930. </a>
  931. </div>
  932. </div>
  933. </div>
  934. </footer>
  935. </div>
  936. <div class="md-dialog" data-md-component="dialog">
  937. <div class="md-dialog__inner md-typeset"></div>
  938. </div>
  939. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  940. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  941. </body>
  942. </html>