index.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010
  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>FluxCD - 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="#gitops-using-fluxcd-v2" 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. FluxCD
  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. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-getallsecrets/" class="md-nav__link">
  242. Getting Multiple Secrets
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-multi-tenancy/" class="md-nav__link">
  247. Multi Tenancy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-metrics/" class="md-nav__link">
  252. Metrics
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-v1beta1/" class="md-nav__link">
  257. Upgrading to v1beta1
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-using-latest-image/" class="md-nav__link">
  262. Using Latest Image
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  270. <label class="md-nav__link" for="__nav_5">
  271. Provider
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  275. <label class="md-nav__title" for="__nav_5">
  276. <span class="md-nav__icon md-icon"></span>
  277. Provider
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  282. <label class="md-nav__link" for="__nav_5_1">
  283. AWS
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_1">
  288. <span class="md-nav__icon md-icon"></span>
  289. AWS
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  299. Parameter Store
  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_2" type="checkbox" id="__nav_5_2" >
  307. <label class="md-nav__link" for="__nav_5_2">
  308. Azure
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_2">
  313. <span class="md-nav__icon md-icon"></span>
  314. Azure
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-azure-key-vault/" class="md-nav__link">
  319. Key Vault
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  327. <label class="md-nav__link" for="__nav_5_3">
  328. Google
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Google" data-md-level="2">
  332. <label class="md-nav__title" for="__nav_5_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Google
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  339. Secret Manager
  340. </a>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  347. <label class="md-nav__link" for="__nav_5_4">
  348. IBM
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  352. <label class="md-nav__title" for="__nav_5_4">
  353. <span class="md-nav__icon md-icon"></span>
  354. IBM
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  359. Secrets Manager
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../provider-akeyless/" class="md-nav__link">
  367. Akeyless
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  372. HashiCorp Vault
  373. </a>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  377. <label class="md-nav__link" for="__nav_5_7">
  378. Yandex
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_7">
  383. <span class="md-nav__icon md-icon"></span>
  384. Yandex
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  389. Certificate Manager
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  394. Lockbox
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  402. <label class="md-nav__link" for="__nav_5_8">
  403. Gitlab
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  407. <label class="md-nav__title" for="__nav_5_8">
  408. <span class="md-nav__icon md-icon"></span>
  409. Gitlab
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  414. Gitlab Project Variables
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  422. <label class="md-nav__link" for="__nav_5_9">
  423. Oracle
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  427. <label class="md-nav__title" for="__nav_5_9">
  428. <span class="md-nav__icon md-icon"></span>
  429. Oracle
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../provider-oracle-vault/" class="md-nav__link">
  434. Oracle Vault
  435. </a>
  436. </li>
  437. </ul>
  438. </nav>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  442. <label class="md-nav__link" for="__nav_5_10">
  443. 1Password
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  447. <label class="md-nav__title" for="__nav_5_10">
  448. <span class="md-nav__icon md-icon"></span>
  449. 1Password
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../provider-1password-automation/" class="md-nav__link">
  454. Secrets Automation
  455. </a>
  456. </li>
  457. </ul>
  458. </nav>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../provider-webhook/" class="md-nav__link">
  462. Webhook
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../provider-fake/" class="md-nav__link">
  467. Fake
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-kubernetes/" class="md-nav__link">
  472. Kubernetes
  473. </a>
  474. </li>
  475. <li class="md-nav__item md-nav__item--nested">
  476. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  477. <label class="md-nav__link" for="__nav_5_14">
  478. senhasegura
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  482. <label class="md-nav__title" for="__nav_5_14">
  483. <span class="md-nav__icon md-icon"></span>
  484. senhasegura
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  489. DevOps Secrets Management (DSM)
  490. </a>
  491. </li>
  492. </ul>
  493. </nav>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  499. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  500. <label class="md-nav__link" for="__nav_6">
  501. Examples
  502. <span class="md-nav__icon md-icon"></span>
  503. </label>
  504. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  505. <label class="md-nav__title" for="__nav_6">
  506. <span class="md-nav__icon md-icon"></span>
  507. Examples
  508. </label>
  509. <ul class="md-nav__list" data-md-scrollfix>
  510. <li class="md-nav__item md-nav__item--active">
  511. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  512. <label class="md-nav__link md-nav__link--active" for="__toc">
  513. FluxCD
  514. <span class="md-nav__icon md-icon"></span>
  515. </label>
  516. <a href="./" class="md-nav__link md-nav__link--active">
  517. FluxCD
  518. </a>
  519. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  520. <label class="md-nav__title" for="__toc">
  521. <span class="md-nav__icon md-icon"></span>
  522. Table of contents
  523. </label>
  524. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  525. <li class="md-nav__item">
  526. <a href="#advantages" class="md-nav__link">
  527. Advantages
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="#the-approach" class="md-nav__link">
  532. The approach
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="#the-problem" class="md-nav__link">
  537. The problem
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="#the-solution" class="md-nav__link">
  542. The solution
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="#create-the-main-kustomization" class="md-nav__link">
  547. Create the main kustomization
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="#create-the-secret" class="md-nav__link">
  552. Create the secret
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  557. Creating the references to repositories
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="#deploy-the-crds" class="md-nav__link">
  562. Deploy the CRDs
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="#deploy-the-operator" class="md-nav__link">
  567. Deploy the operator
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#deploy-the-crs" class="md-nav__link">
  572. Deploy the CRs
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="#results" class="md-nav__link">
  577. Results
  578. </a>
  579. </li>
  580. </ul>
  581. </nav>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  585. Anchore Engine
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  590. Jenkins
  591. </a>
  592. </li>
  593. </ul>
  594. </nav>
  595. </li>
  596. <li class="md-nav__item md-nav__item--nested">
  597. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  598. <label class="md-nav__link" for="__nav_7">
  599. External Resources
  600. <span class="md-nav__icon md-icon"></span>
  601. </label>
  602. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  603. <label class="md-nav__title" for="__nav_7">
  604. <span class="md-nav__icon md-icon"></span>
  605. External Resources
  606. </label>
  607. <ul class="md-nav__list" data-md-scrollfix>
  608. <li class="md-nav__item">
  609. <a href="../eso-talks/" class="md-nav__link">
  610. Talks
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../eso-demos/" class="md-nav__link">
  615. Demos
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../eso-blogs/" class="md-nav__link">
  620. Blogs
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item md-nav__item--nested">
  627. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  628. <label class="md-nav__link" for="__nav_8">
  629. References
  630. <span class="md-nav__icon md-icon"></span>
  631. </label>
  632. <nav class="md-nav" aria-label="References" data-md-level="1">
  633. <label class="md-nav__title" for="__nav_8">
  634. <span class="md-nav__icon md-icon"></span>
  635. References
  636. </label>
  637. <ul class="md-nav__list" data-md-scrollfix>
  638. <li class="md-nav__item">
  639. <a href="../spec/" class="md-nav__link">
  640. API specification
  641. </a>
  642. </li>
  643. </ul>
  644. </nav>
  645. </li>
  646. <li class="md-nav__item md-nav__item--nested">
  647. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  648. <label class="md-nav__link" for="__nav_9">
  649. Contributing
  650. <span class="md-nav__icon md-icon"></span>
  651. </label>
  652. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  653. <label class="md-nav__title" for="__nav_9">
  654. <span class="md-nav__icon md-icon"></span>
  655. Contributing
  656. </label>
  657. <ul class="md-nav__list" data-md-scrollfix>
  658. <li class="md-nav__item">
  659. <a href="../contributing-devguide/" class="md-nav__link">
  660. Developer guide
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../contributing-process/" class="md-nav__link">
  665. Contributing Process
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../contributing-release/" class="md-nav__link">
  670. Release Process
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../contributing-coc/" class="md-nav__link">
  675. Code of Conduct
  676. </a>
  677. </li>
  678. </ul>
  679. </nav>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../roadmap/" class="md-nav__link">
  683. Roadmap
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../faq/" class="md-nav__link">
  688. FAQ
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../stability-support/" class="md-nav__link">
  693. Stability and Support
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../deprecation-policy/" class="md-nav__link">
  698. Deprecation Policy
  699. </a>
  700. </li>
  701. </ul>
  702. </nav>
  703. </div>
  704. </div>
  705. </div>
  706. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  707. <div class="md-sidebar__scrollwrap">
  708. <div class="md-sidebar__inner">
  709. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  710. <label class="md-nav__title" for="__toc">
  711. <span class="md-nav__icon md-icon"></span>
  712. Table of contents
  713. </label>
  714. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  715. <li class="md-nav__item">
  716. <a href="#advantages" class="md-nav__link">
  717. Advantages
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="#the-approach" class="md-nav__link">
  722. The approach
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#the-problem" class="md-nav__link">
  727. The problem
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#the-solution" class="md-nav__link">
  732. The solution
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="#create-the-main-kustomization" class="md-nav__link">
  737. Create the main kustomization
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="#create-the-secret" class="md-nav__link">
  742. Create the secret
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  747. Creating the references to repositories
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="#deploy-the-crds" class="md-nav__link">
  752. Deploy the CRDs
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="#deploy-the-operator" class="md-nav__link">
  757. Deploy the operator
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="#deploy-the-crs" class="md-nav__link">
  762. Deploy the CRs
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="#results" class="md-nav__link">
  767. Results
  768. </a>
  769. </li>
  770. </ul>
  771. </nav>
  772. </div>
  773. </div>
  774. </div>
  775. <div class="md-content" data-md-component="content">
  776. <article class="md-content__inner md-typeset">
  777. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/examples-gitops-using-fluxcd.md" title="Edit this page" class="md-content__button md-icon">
  778. <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>
  779. </a>
  780. <h1 id="gitops-using-fluxcd-v2">GitOps using FluxCD (v2)</h1>
  781. <p>FluxCD is a GitOps operator for Kubernetes. It synchronizes the status of the cluster from manifests allocated in
  782. different repositories (Git or Helm). This approach fits perfectly with External Secrets on clusters which are dynamically
  783. created, to get credentials with no manual intervention from the beginning.</p>
  784. <h2 id="advantages">Advantages</h2>
  785. <p>This approach has several advantages as follows:</p>
  786. <ul>
  787. <li><strong>Homogenize environments</strong> allowing developers to use the same toolset in Kind in the same way they do in the cloud
  788. provider distributions such as EKS or GKE. This accelerates the development</li>
  789. <li><strong>Reduce security risks</strong>, because credentials can be easily obtained, so temptation to store them locally is reduced.</li>
  790. <li><strong>Application compatibility increase</strong>: Applications are deployed in different ways, and sometimes they need to share
  791. credentials. This can be done using External Secrets as a wire for them at real time.</li>
  792. <li><strong>Automation by default</strong> oh, come on!</li>
  793. </ul>
  794. <h2 id="the-approach">The approach</h2>
  795. <p>FluxCD is composed by several controllers dedicated to manage different custom resources. The most important
  796. ones are <strong>Kustomization</strong> (to clarify, Flux one, not Kubernetes' one) and <strong>HelmRelease</strong> to deploy using the approaches
  797. of the same names.</p>
  798. <p>External Secrets can be deployed using Helm <a href="../guides-getting-started/">as explained here</a>. The deployment includes the
  799. CRDs if enabled on the <code>values.yaml</code>, but after this, you need to deploy some <code>SecretStore</code> to start
  800. getting credentials from your secrets manager with External Secrets.</p>
  801. <blockquote>
  802. <p>The idea of this guide is to deploy the whole stack, using flux, needed by developers not to worry about the credentials,
  803. but only about the application and its code.</p>
  804. </blockquote>
  805. <h2 id="the-problem">The problem</h2>
  806. <p>This can sound easy, but External Secrets is deployed using Helm, which is managed by the HelmController,
  807. and your custom resources, for example a <code>ClusterSecretStore</code> and the related <code>Secret</code>, are often deployed using a
  808. <code>kustomization.yaml</code>, which is deployed by the KustomizeController.</p>
  809. <p>Both controllers manage the resources independently, at different moments, with no possibility to wait each other.
  810. This means that we have a wonderful race condition where sometimes the CRs (<code>SecretStore</code>,<code>ClusterSecretStore</code>...) tries
  811. to be deployed before than the CRDs needed to recognize them.</p>
  812. <h2 id="the-solution">The solution</h2>
  813. <p>Let's see the conditions to start working on a solution:</p>
  814. <ul>
  815. <li>The External Secrets operator is deployed with Helm, and admits disabling the CRDs deployment</li>
  816. <li>The race condition only affects the deployment of <code>CustomResourceDefinition</code> and the CRs needed later</li>
  817. <li>CRDs can be deployed directly from the Git repository of the project using a Flux <code>Kustomization</code></li>
  818. <li>Required CRs can be deployed using a Flux <code>Kustomization</code> too, allowing dependency between CRDs and CRs</li>
  819. <li>All previous manifests can be applied with a Kubernetes <code>kustomization</code></li>
  820. </ul>
  821. <h2 id="create-the-main-kustomization">Create the main kustomization</h2>
  822. <p>To have a better view of things needed later, the first manifest to be created is the <code>kustomization.yaml</code></p>
  823. <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">kustomize.config.k8s.io/v1beta1</span><span class="w"></span>
  824. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  825. <span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  826. <span class="c1"># Deploy the Vault access secret</span><span class="w"></span>
  827. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">namespace.yaml</span><span class="w"></span>
  828. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-token.yaml</span><span class="w"></span>
  829. <span class="c1"># Deploy the repositories</span><span class="w"></span>
  830. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">repositories.yaml</span><span class="w"></span>
  831. <span class="c1"># Deploy the CRDs</span><span class="w"></span>
  832. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crds.yaml</span><span class="w"></span>
  833. <span class="c1"># Deploy the operator</span><span class="w"></span>
  834. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment.yaml</span><span class="w"></span>
  835. <span class="c1"># Deploy default Custom Resources from &#39;crs&#39; directory</span><span class="w"></span>
  836. <span class="c1"># INFO: This depends on the CRDs deployment. Will happen after it</span><span class="w"></span>
  837. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crs.yaml</span><span class="w"></span>
  838. </code></pre></div>
  839. <h2 id="create-the-secret">Create the secret</h2>
  840. <p>To access your secret manager, External Secrets needs some credentials. They are stored inside a Secret, which is intended
  841. to be deployed by automation as a good practise. This time, a placeholder called <code>secret-token.yaml</code> is show as an example:</p>
  842. <div class="highlight"><pre><span></span><code><span class="c1"># The namespace.yaml first</span><span class="w"></span>
  843. <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>
  844. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Namespace</span><span class="w"></span>
  845. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  846. <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">external-secrets</span><span class="w"></span>
  847. </code></pre></div>
  848. <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>
  849. <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>
  850. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  851. <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">vault-token-global</span><span class="w"></span>
  852. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  853. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  854. <span class="w"> </span><span class="c1"># This token must be patched by overlays. Not here for security reasons</span><span class="w"></span>
  855. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">change-me-placeholder</span><span class="w"></span>
  856. </code></pre></div>
  857. <h2 id="creating-the-references-to-repositories">Creating the references to repositories</h2>
  858. <p>Create a manifest called <code>repositories.yaml</code> to store the references to external repositories for Flux</p>
  859. <div class="highlight"><pre><span></span><code><span class="c1"># Reference to Helm repository</span><span class="w"></span>
  860. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span><span class="w"></span>
  861. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRepository</span><span class="w"></span>
  862. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  863. <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">external-secrets</span><span class="w"></span>
  864. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  865. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  866. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  867. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://charts.external-secrets.io</span><span class="w"></span>
  868. <span class="nn">---</span><span class="w"></span>
  869. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span><span class="w"></span>
  870. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span><span class="w"></span>
  871. <span class="nt">metadata</span><span class="p">:</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">external-secrets</span><span class="w"></span>
  873. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  874. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  875. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  876. <span class="w"> </span><span class="nt">ref</span><span class="p">:</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">branch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span><span class="w"></span>
  878. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://github.com/external-secrets/external-secrets</span><span class="w"></span>
  879. </code></pre></div>
  880. <h2 id="deploy-the-crds">Deploy the CRDs</h2>
  881. <p>As mentioned, CRDs can be deployed using the official Helm package, but to solve the race condition, they will be deployed
  882. from our git repository using a Kustomization manifest called <code>deployment-crds.yaml</code> as follows:</p>
  883. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  884. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span><span class="w"></span>
  885. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  886. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  887. <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">external-secrets-crds</span><span class="w"></span>
  888. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  889. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  891. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./deploy/crds</span><span class="w"></span>
  892. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  894. <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">GitRepository</span><span class="w"></span>
  895. <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">external-secrets</span><span class="w"></span>
  896. </code></pre></div>
  897. <h2 id="deploy-the-operator">Deploy the operator</h2>
  898. <p>The operator is deployed using a HelmRelease manifest to deploy the Helm package, but due to the special race condition,
  899. the deployment must be disabled in the <code>values</code> of the manifest called <code>deployment.yaml</code>, as follows:</p>
  900. <div class="highlight"><pre><span></span><code><span class="c1"># How to manage values files. Ref: https://fluxcd.io/docs/guides/helmreleases/#refer-to-values-inside-the-chart</span><span class="w"></span>
  901. <span class="c1"># How to inject values: https://fluxcd.io/docs/guides/helmreleases/#cloud-storage</span><span class="w"></span>
  902. <span class="nn">---</span><span class="w"></span>
  903. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">helm.toolkit.fluxcd.io/v2beta1</span><span class="w"></span>
  904. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRelease</span><span class="w"></span>
  905. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  906. <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">external-secrets</span><span class="w"></span>
  907. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  908. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  909. <span class="w"> </span><span class="c1"># Override Release name to avoid the pattern Namespace-Release</span><span class="w"></span>
  910. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmRelease</span><span class="w"></span>
  911. <span class="w"> </span><span class="nt">releaseName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  912. <span class="w"> </span><span class="nt">targetNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  913. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  914. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"></span>
  915. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  916. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  917. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.3.9</span><span class="w"></span>
  918. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  919. <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">HelmRepository</span><span class="w"></span>
  920. <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">external-secrets</span><span class="w"></span>
  921. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  922. <span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
  923. <span class="w"> </span><span class="nt">installCRDs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
  924. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Install</span><span class="w"></span>
  925. <span class="w"> </span><span class="nt">install</span><span class="p">:</span><span class="w"></span>
  926. <span class="w"> </span><span class="nt">createNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  927. </code></pre></div>
  928. <h2 id="deploy-the-crs">Deploy the CRs</h2>
  929. <p>Now, be ready for the arcane magic. Create a Kustomization manifest called <code>deployment-crs.yaml</code> with the following content:</p>
  930. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  931. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span><span class="w"></span>
  932. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span><span class="w"></span>
  933. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  934. <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">external-secrets-crs</span><span class="w"></span>
  935. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span><span class="w"></span>
  936. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  937. <span class="w"> </span><span class="nt">dependsOn</span><span class="p">:</span><span class="w"></span>
  938. <span class="w"> </span><span class="p p-Indicator">-</span><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">external-secrets-crds</span><span class="w"></span>
  939. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span><span class="w"></span>
  940. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./infrastructure/external-secrets/crs</span><span class="w"></span>
  941. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  942. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  943. <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">GitRepository</span><span class="w"></span>
  944. <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">flux-system</span><span class="w"></span>
  945. </code></pre></div>
  946. <p>There are several interesting details to see here, that finally solves the race condition:</p>
  947. <ol>
  948. <li>First one is the field <code>dependsOn</code>, which points to a previous Kustomization called <code>external-secrets-crds</code>. This
  949. dependency forces this deployment to wait for the other to be ready, before start being deployed.</li>
  950. <li>The reference to the place where to find the CRs
  951. <div class="highlight"><pre><span></span><code><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./infrastructure/external-secrets/crs</span><span class="w"></span>
  952. <span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  953. <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">GitRepository</span><span class="w"></span>
  954. <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">flux-system</span><span class="w"></span>
  955. </code></pre></div>
  956. Custom Resources will be searched in the relative path <code>./infrastructure/external-secrets/crs</code> of the GitRepository
  957. called <code>flux-system</code>, which is a reference to the same repository that FluxCD watches to synchronize the cluster.
  958. With fewer words, a reference to itself, but going to another directory called <code>crs</code></li>
  959. </ol>
  960. <p>Of course, allocate inside the mentioned path <code>./infrastructure/external-secrets/crs</code>, all the desired CRs to be deployed,
  961. for example, a manifest <code>clusterSecretStore.yaml</code> to reach your Hashicorp Vault as follows:</p>
  962. <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>
  963. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span><span class="w"></span>
  964. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  965. <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">vault-backend-global</span><span class="w"></span>
  966. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  967. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  968. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  969. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.your-domain.com&quot;</span><span class="w"></span>
  970. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret</span><span class="w"></span>
  971. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span><span class="w"></span>
  972. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  973. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span><span class="w"></span>
  974. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  975. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span><span class="w"></span>
  976. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token-global&quot;</span><span class="w"></span>
  977. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span><span class="w"></span>
  978. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span><span class="w"></span>
  979. </code></pre></div>
  980. <h2 id="results">Results</h2>
  981. <p>At the end, the required files tree is shown in the following picture:</p>
  982. <p><img alt="FluxCD files tree" src="../pictures/screenshot_gitops_final_directory_tree.png" /></p>
  983. </article>
  984. </div>
  985. </div>
  986. </main>
  987. <footer class="md-footer">
  988. <nav class="md-footer__inner md-grid" aria-label="Footer">
  989. <a href="../provider-senhasegura-dsm/" class="md-footer__link md-footer__link--prev" aria-label="Previous: DevOps Secrets Management (DSM)" rel="prev">
  990. <div class="md-footer__button md-icon">
  991. <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>
  992. </div>
  993. <div class="md-footer__title">
  994. <div class="md-ellipsis">
  995. <span class="md-footer__direction">
  996. Previous
  997. </span>
  998. DevOps Secrets Management (DSM)
  999. </div>
  1000. </div>
  1001. </a>
  1002. <a href="../examples-anchore-engine-credentials/" class="md-footer__link md-footer__link--next" aria-label="Next: Anchore Engine" rel="next">
  1003. <div class="md-footer__title">
  1004. <div class="md-ellipsis">
  1005. <span class="md-footer__direction">
  1006. Next
  1007. </span>
  1008. Anchore Engine
  1009. </div>
  1010. </div>
  1011. <div class="md-footer__button md-icon">
  1012. <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>
  1013. </div>
  1014. </a>
  1015. </nav>
  1016. <div class="md-footer-meta md-typeset">
  1017. <div class="md-footer-meta__inner md-grid">
  1018. <div class="md-copyright">
  1019. Made with
  1020. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1021. Material for MkDocs
  1022. </a>
  1023. </div>
  1024. </div>
  1025. </div>
  1026. </footer>
  1027. </div>
  1028. <div class="md-dialog" data-md-component="dialog">
  1029. <div class="md-dialog__inner md-typeset"></div>
  1030. </div>
  1031. <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.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1032. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1033. </body>
  1034. </html>