index.html 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298
  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. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="./" class="md-tabs__link md-tabs__link--active">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  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_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../../guides/introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../../guides/templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating-v1/" class="md-nav__link">
  374. v1
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../guides/generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  387. All keys, One secret
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  392. Common K8S Secret Types
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  407. Decoding Strategies
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/getallsecrets/" class="md-nav__link">
  412. Getting Multiple Secrets
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  417. Multi Tenancy
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  422. Rewriting Keys
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/v1beta1/" class="md-nav__link">
  427. Upgrading to v1beta1
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/using-latest-image/" class="md-nav__link">
  432. Using Latest Image
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  440. <label class="md-nav__link" for="__nav_4">
  441. Provider
  442. <span class="md-nav__icon md-icon"></span>
  443. </label>
  444. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  445. <label class="md-nav__title" for="__nav_4">
  446. <span class="md-nav__icon md-icon"></span>
  447. Provider
  448. </label>
  449. <ul class="md-nav__list" data-md-scrollfix>
  450. <li class="md-nav__item">
  451. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  452. AWS Secrets Manager
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  457. AWS Parameter Store
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  462. Azure Key Vault
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  467. Google Secret Manager
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  472. IBM Secrets Manager
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../../provider/akeyless/" class="md-nav__link">
  477. Akeyless
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  482. HashiCorp Vault
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  487. Yandex Certificate Manager
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  492. Yandex Lockbox
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  497. Gitlab Variables
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../provider/oracle-vault/" class="md-nav__link">
  502. Oracle Vault
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../provider/1password-automation/" class="md-nav__link">
  507. 1Password Secrets Automation
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../provider/webhook/" class="md-nav__link">
  512. Webhook
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../provider/fake/" class="md-nav__link">
  517. Fake
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/kubernetes/" class="md-nav__link">
  522. Kubernetes
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  527. senhasegura DevOps Secrets Management (DSM)
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/doppler/" class="md-nav__link">
  532. Doppler
  533. </a>
  534. </li>
  535. </ul>
  536. </nav>
  537. </li>
  538. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  539. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  540. <label class="md-nav__link" for="__nav_5">
  541. Examples
  542. <span class="md-nav__icon md-icon"></span>
  543. </label>
  544. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  545. <label class="md-nav__title" for="__nav_5">
  546. <span class="md-nav__icon md-icon"></span>
  547. Examples
  548. </label>
  549. <ul class="md-nav__list" data-md-scrollfix>
  550. <li class="md-nav__item md-nav__item--active">
  551. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  552. <label class="md-nav__link md-nav__link--active" for="__toc">
  553. FluxCD
  554. <span class="md-nav__icon md-icon"></span>
  555. </label>
  556. <a href="./" class="md-nav__link md-nav__link--active">
  557. FluxCD
  558. </a>
  559. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  560. <label class="md-nav__title" for="__toc">
  561. <span class="md-nav__icon md-icon"></span>
  562. Table of contents
  563. </label>
  564. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  565. <li class="md-nav__item">
  566. <a href="#advantages" class="md-nav__link">
  567. Advantages
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#the-approach" class="md-nav__link">
  572. The approach
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="#the-problem" class="md-nav__link">
  577. The problem
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#the-solution" class="md-nav__link">
  582. The solution
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="#create-the-main-kustomization" class="md-nav__link">
  587. Create the main kustomization
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="#create-the-secret" class="md-nav__link">
  592. Create the secret
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  597. Creating the references to repositories
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="#deploy-the-crds" class="md-nav__link">
  602. Deploy the CRDs
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="#deploy-the-operator" class="md-nav__link">
  607. Deploy the operator
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="#deploy-the-crs" class="md-nav__link">
  612. Deploy the CRs
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="#results" class="md-nav__link">
  617. Results
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../anchore-engine-credentials/" class="md-nav__link">
  625. Anchore Engine
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../jenkins-kubernetes-credentials/" class="md-nav__link">
  630. Jenkins
  631. </a>
  632. </li>
  633. </ul>
  634. </nav>
  635. </li>
  636. <li class="md-nav__item md-nav__item--nested">
  637. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  638. <label class="md-nav__link" for="__nav_6">
  639. Community
  640. <span class="md-nav__icon md-icon"></span>
  641. </label>
  642. <nav class="md-nav" aria-label="Community" data-md-level="1">
  643. <label class="md-nav__title" for="__nav_6">
  644. <span class="md-nav__icon md-icon"></span>
  645. Community
  646. </label>
  647. <ul class="md-nav__list" data-md-scrollfix>
  648. <li class="md-nav__item md-nav__item--nested">
  649. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  650. <label class="md-nav__link" for="__nav_6_1">
  651. Contributing
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  655. <label class="md-nav__title" for="__nav_6_1">
  656. <span class="md-nav__icon md-icon"></span>
  657. Contributing
  658. </label>
  659. <ul class="md-nav__list" data-md-scrollfix>
  660. <li class="md-nav__item">
  661. <a href="../../contributing/devguide/" class="md-nav__link">
  662. Developer guide
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../contributing/process/" class="md-nav__link">
  667. Contributing Process
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../contributing/release/" class="md-nav__link">
  672. Release Process
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../contributing/coc/" class="md-nav__link">
  677. Code of Conduct
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../../contributing/roadmap/" class="md-nav__link">
  682. Roadmap
  683. </a>
  684. </li>
  685. </ul>
  686. </nav>
  687. </li>
  688. <li class="md-nav__item md-nav__item--nested">
  689. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  690. <label class="md-nav__link" for="__nav_6_2">
  691. External Resources
  692. <span class="md-nav__icon md-icon"></span>
  693. </label>
  694. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  695. <label class="md-nav__title" for="__nav_6_2">
  696. <span class="md-nav__icon md-icon"></span>
  697. External Resources
  698. </label>
  699. <ul class="md-nav__list" data-md-scrollfix>
  700. <li class="md-nav__item">
  701. <a href="../../eso-talks/" class="md-nav__link">
  702. Talks
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../../eso-demos/" class="md-nav__link">
  707. Demos
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../eso-blogs/" class="md-nav__link">
  712. Blogs
  713. </a>
  714. </li>
  715. </ul>
  716. </nav>
  717. </li>
  718. </ul>
  719. </nav>
  720. </li>
  721. </ul>
  722. </nav>
  723. </div>
  724. </div>
  725. </div>
  726. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  727. <div class="md-sidebar__scrollwrap">
  728. <div class="md-sidebar__inner">
  729. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  730. <label class="md-nav__title" for="__toc">
  731. <span class="md-nav__icon md-icon"></span>
  732. Table of contents
  733. </label>
  734. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  735. <li class="md-nav__item">
  736. <a href="#advantages" class="md-nav__link">
  737. Advantages
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="#the-approach" class="md-nav__link">
  742. The approach
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#the-problem" class="md-nav__link">
  747. The problem
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="#the-solution" class="md-nav__link">
  752. The solution
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="#create-the-main-kustomization" class="md-nav__link">
  757. Create the main kustomization
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="#create-the-secret" class="md-nav__link">
  762. Create the secret
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  767. Creating the references to repositories
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="#deploy-the-crds" class="md-nav__link">
  772. Deploy the CRDs
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="#deploy-the-operator" class="md-nav__link">
  777. Deploy the operator
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="#deploy-the-crs" class="md-nav__link">
  782. Deploy the CRs
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="#results" class="md-nav__link">
  787. Results
  788. </a>
  789. </li>
  790. </ul>
  791. </nav>
  792. </div>
  793. </div>
  794. </div>
  795. <div class="md-content" data-md-component="content">
  796. <article class="md-content__inner md-typeset">
  797. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/examples/gitops-using-fluxcd.md" title="Edit this page" class="md-content__button md-icon">
  798. <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>
  799. </a>
  800. <h1 id="gitops-using-fluxcd-v2">GitOps using FluxCD (v2)</h1>
  801. <p>FluxCD is a GitOps operator for Kubernetes. It synchronizes the status of the cluster from manifests allocated in
  802. different repositories (Git or Helm). This approach fits perfectly with External Secrets on clusters which are dynamically
  803. created, to get credentials with no manual intervention from the beginning.</p>
  804. <h2 id="advantages">Advantages</h2>
  805. <p>This approach has several advantages as follows:</p>
  806. <ul>
  807. <li><strong>Homogenize environments</strong> allowing developers to use the same toolset in Kind in the same way they do in the cloud
  808. provider distributions such as EKS or GKE. This accelerates the development</li>
  809. <li><strong>Reduce security risks</strong>, because credentials can be easily obtained, so temptation to store them locally is reduced.</li>
  810. <li><strong>Application compatibility increase</strong>: Applications are deployed in different ways, and sometimes they need to share
  811. credentials. This can be done using External Secrets as a wire for them at real time.</li>
  812. <li><strong>Automation by default</strong> oh, come on!</li>
  813. </ul>
  814. <h2 id="the-approach">The approach</h2>
  815. <p>FluxCD is composed by several controllers dedicated to manage different custom resources. The most important
  816. ones are <strong>Kustomization</strong> (to clarify, Flux one, not Kubernetes' one) and <strong>HelmRelease</strong> to deploy using the approaches
  817. of the same names.</p>
  818. <p>External Secrets can be deployed using Helm <a href="../../introduction/getting-started/">as explained here</a>. The deployment includes the
  819. CRDs if enabled on the <code>values.yaml</code>, but after this, you need to deploy some <code>SecretStore</code> to start
  820. getting credentials from your secrets manager with External Secrets.</p>
  821. <blockquote>
  822. <p>The idea of this guide is to deploy the whole stack, using flux, needed by developers not to worry about the credentials,
  823. but only about the application and its code.</p>
  824. </blockquote>
  825. <h2 id="the-problem">The problem</h2>
  826. <p>This can sound easy, but External Secrets is deployed using Helm, which is managed by the HelmController,
  827. and your custom resources, for example a <code>ClusterSecretStore</code> and the related <code>Secret</code>, are often deployed using a
  828. <code>kustomization.yaml</code>, which is deployed by the KustomizeController.</p>
  829. <p>Both controllers manage the resources independently, at different moments, with no possibility to wait each other.
  830. This means that we have a wonderful race condition where sometimes the CRs (<code>SecretStore</code>,<code>ClusterSecretStore</code>...) tries
  831. to be deployed before than the CRDs needed to recognize them.</p>
  832. <h2 id="the-solution">The solution</h2>
  833. <p>Let's see the conditions to start working on a solution:</p>
  834. <ul>
  835. <li>The External Secrets operator is deployed with Helm, and admits disabling the CRDs deployment</li>
  836. <li>The race condition only affects the deployment of <code>CustomResourceDefinition</code> and the CRs needed later</li>
  837. <li>CRDs can be deployed directly from the Git repository of the project using a Flux <code>Kustomization</code></li>
  838. <li>Required CRs can be deployed using a Flux <code>Kustomization</code> too, allowing dependency between CRDs and CRs</li>
  839. <li>All previous manifests can be applied with a Kubernetes <code>kustomization</code></li>
  840. </ul>
  841. <h2 id="create-the-main-kustomization">Create the main kustomization</h2>
  842. <p>To have a better view of things needed later, the first manifest to be created is the <code>kustomization.yaml</code></p>
  843. <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>
  844. <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>
  845. <span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  846. <span class="c1"># Deploy the Vault access secret</span><span class="w"></span>
  847. <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>
  848. <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>
  849. <span class="c1"># Deploy the repositories</span><span class="w"></span>
  850. <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>
  851. <span class="c1"># Deploy the CRDs</span><span class="w"></span>
  852. <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>
  853. <span class="c1"># Deploy the operator</span><span class="w"></span>
  854. <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>
  855. <span class="c1"># Deploy default Custom Resources from &#39;crs&#39; directory</span><span class="w"></span>
  856. <span class="c1"># INFO: This depends on the CRDs deployment. Will happen after it</span><span class="w"></span>
  857. <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>
  858. </code></pre></div>
  859. <h2 id="create-the-secret">Create the secret</h2>
  860. <p>To access your secret manager, External Secrets needs some credentials. They are stored inside a Secret, which is intended
  861. 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>
  862. <div class="highlight"><pre><span></span><code><span class="c1"># The namespace.yaml first</span><span class="w"></span>
  863. <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>
  864. <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>
  865. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  866. <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>
  867. </code></pre></div>
  868. <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>
  869. <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>
  870. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  871. <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>
  872. <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>
  873. <span class="nt">stringData</span><span class="p">:</span><span class="w"></span>
  874. <span class="w"> </span><span class="c1"># This token must be patched by overlays. Not here for security reasons</span><span class="w"></span>
  875. <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>
  876. </code></pre></div>
  877. <h2 id="creating-the-references-to-repositories">Creating the references to repositories</h2>
  878. <p>Create a manifest called <code>repositories.yaml</code> to store the references to external repositories for Flux</p>
  879. <div class="highlight"><pre><span></span><code><span class="c1"># Reference to Helm repository</span><span class="w"></span>
  880. <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>
  881. <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>
  882. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  883. <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>
  884. <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>
  885. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  886. <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>
  887. <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>
  888. <span class="nn">---</span><span class="w"></span>
  889. <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>
  890. <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>
  891. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  892. <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>
  893. <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>
  894. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  895. <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>
  896. <span class="w"> </span><span class="nt">ref</span><span class="p">:</span><span class="w"></span>
  897. <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>
  898. <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>
  899. </code></pre></div>
  900. <h2 id="deploy-the-crds">Deploy the CRDs</h2>
  901. <p>As mentioned, CRDs can be deployed using the official Helm package, but to solve the race condition, they will be deployed
  902. from our git repository using a Kustomization manifest called <code>deployment-crds.yaml</code> as follows:</p>
  903. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  904. <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>
  905. <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>
  906. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  907. <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>
  908. <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>
  909. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  910. <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>
  911. <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>
  912. <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>
  913. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  914. <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>
  915. <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>
  916. </code></pre></div>
  917. <h2 id="deploy-the-operator">Deploy the operator</h2>
  918. <p>The operator is deployed using a HelmRelease manifest to deploy the Helm package, but due to the special race condition,
  919. the deployment must be disabled in the <code>values</code> of the manifest called <code>deployment.yaml</code>, as follows:</p>
  920. <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>
  921. <span class="c1"># How to inject values: https://fluxcd.io/docs/guides/helmreleases/#cloud-storage</span><span class="w"></span>
  922. <span class="nn">---</span><span class="w"></span>
  923. <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>
  924. <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>
  925. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  926. <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>
  927. <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>
  928. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  929. <span class="w"> </span><span class="c1"># Override Release name to avoid the pattern Namespace-Release</span><span class="w"></span>
  930. <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>
  931. <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>
  932. <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>
  933. <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>
  934. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"></span>
  935. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  936. <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>
  937. <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>
  938. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  939. <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>
  940. <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>
  941. <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>
  942. <span class="w"> </span><span class="nt">values</span><span class="p">:</span><span class="w"></span>
  943. <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>
  944. <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>
  945. <span class="w"> </span><span class="nt">install</span><span class="p">:</span><span class="w"></span>
  946. <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>
  947. </code></pre></div>
  948. <h2 id="deploy-the-crs">Deploy the CRs</h2>
  949. <p>Now, be ready for the arcane magic. Create a Kustomization manifest called <code>deployment-crs.yaml</code> with the following content:</p>
  950. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  951. <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>
  952. <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>
  953. <span class="nt">metadata</span><span class="p">:</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">external-secrets-crs</span><span class="w"></span>
  955. <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>
  956. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  957. <span class="w"> </span><span class="nt">dependsOn</span><span class="p">:</span><span class="w"></span>
  958. <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>
  959. <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>
  960. <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>
  961. <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>
  962. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  963. <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>
  964. <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>
  965. </code></pre></div>
  966. <p>There are several interesting details to see here, that finally solves the race condition:</p>
  967. <ol>
  968. <li>First one is the field <code>dependsOn</code>, which points to a previous Kustomization called <code>external-secrets-crds</code>. This
  969. dependency forces this deployment to wait for the other to be ready, before start being deployed.</li>
  970. <li>The reference to the place where to find the CRs
  971. <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>
  972. <span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  973. <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>
  974. <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>
  975. </code></pre></div>
  976. Custom Resources will be searched in the relative path <code>./infrastructure/external-secrets/crs</code> of the GitRepository
  977. called <code>flux-system</code>, which is a reference to the same repository that FluxCD watches to synchronize the cluster.
  978. With fewer words, a reference to itself, but going to another directory called <code>crs</code></li>
  979. </ol>
  980. <p>Of course, allocate inside the mentioned path <code>./infrastructure/external-secrets/crs</code>, all the desired CRs to be deployed,
  981. for example, a manifest <code>clusterSecretStore.yaml</code> to reach your Hashicorp Vault as follows:</p>
  982. <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>
  983. <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>
  984. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  985. <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>
  986. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  987. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  988. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"></span>
  989. <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>
  990. <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>
  991. <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>
  992. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  993. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span><span class="w"></span>
  994. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span><span class="w"></span>
  995. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span><span class="w"></span>
  996. <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>
  997. <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>
  998. <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>
  999. </code></pre></div>
  1000. <h2 id="results">Results</h2>
  1001. <p>At the end, the required files tree is shown in the following picture:</p>
  1002. <p><img alt="FluxCD files tree" src="../../pictures/screenshot_gitops_final_directory_tree.png" /></p>
  1003. </article>
  1004. </div>
  1005. </div>
  1006. </main>
  1007. <footer class="md-footer">
  1008. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1009. <a href="../../provider/doppler/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Doppler" rel="prev">
  1010. <div class="md-footer__button md-icon">
  1011. <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>
  1012. </div>
  1013. <div class="md-footer__title">
  1014. <div class="md-ellipsis">
  1015. <span class="md-footer__direction">
  1016. Previous
  1017. </span>
  1018. Doppler
  1019. </div>
  1020. </div>
  1021. </a>
  1022. <a href="../anchore-engine-credentials/" class="md-footer__link md-footer__link--next" aria-label="Next: Anchore Engine" rel="next">
  1023. <div class="md-footer__title">
  1024. <div class="md-ellipsis">
  1025. <span class="md-footer__direction">
  1026. Next
  1027. </span>
  1028. Anchore Engine
  1029. </div>
  1030. </div>
  1031. <div class="md-footer__button md-icon">
  1032. <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>
  1033. </div>
  1034. </a>
  1035. </nav>
  1036. <div class="md-footer-meta md-typeset">
  1037. <div class="md-footer-meta__inner md-grid">
  1038. <div class="md-copyright">
  1039. <div class="md-copyright__highlight">
  1040. &copy; 2022 The external-secrets Authors.<br/>
  1041. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  1042. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1043. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1044. </div>
  1045. Made with
  1046. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1047. Material for MkDocs
  1048. </a>
  1049. </div>
  1050. </div>
  1051. </div>
  1052. </footer>
  1053. </div>
  1054. <div class="md-dialog" data-md-component="dialog">
  1055. <div class="md-dialog__inner md-typeset"></div>
  1056. </div>
  1057. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1058. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1059. </body>
  1060. </html>