index.html 37 KB

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