index.html 40 KB

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