index.html 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084
  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>Decoding Strategies - 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="#decoding-strategies" 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. Decoding Strategies
  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="../introduction/" class="md-tabs__link md-tabs__link--active">
  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="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/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--active md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" 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="../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="../templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../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="../generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../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="../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="../controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item md-nav__item--active">
  406. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  407. <label class="md-nav__link md-nav__link--active" for="__toc">
  408. Decoding Strategies
  409. <span class="md-nav__icon md-icon"></span>
  410. </label>
  411. <a href="./" class="md-nav__link md-nav__link--active">
  412. Decoding Strategies
  413. </a>
  414. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  415. <label class="md-nav__title" for="__toc">
  416. <span class="md-nav__icon md-icon"></span>
  417. Table of contents
  418. </label>
  419. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="#none-default" class="md-nav__link">
  422. None (default)
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="#base64" class="md-nav__link">
  427. Base64
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="#base64url" class="md-nav__link">
  432. Base64URL
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="#auto" class="md-nav__link">
  437. Auto
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="#examples" class="md-nav__link">
  442. Examples
  443. </a>
  444. <nav class="md-nav" aria-label="Examples">
  445. <ul class="md-nav__list">
  446. <li class="md-nav__item">
  447. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  448. Setting Decoding strategy Auto in a DataFrom.Extract
  449. </a>
  450. </li>
  451. </ul>
  452. </nav>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="#limitations" class="md-nav__link">
  456. Limitations
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../getallsecrets/" class="md-nav__link">
  464. Getting Multiple Secrets
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../multi-tenancy/" class="md-nav__link">
  469. Multi Tenancy
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../datafrom-rewrite/" class="md-nav__link">
  474. Rewriting Keys
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../v1beta1/" class="md-nav__link">
  479. Upgrading to v1beta1
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../using-latest-image/" class="md-nav__link">
  484. Using Latest Image
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </li>
  490. <li class="md-nav__item md-nav__item--nested">
  491. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  492. <label class="md-nav__link" for="__nav_4">
  493. Provider
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  497. <label class="md-nav__title" for="__nav_4">
  498. <span class="md-nav__icon md-icon"></span>
  499. Provider
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  504. AWS Secrets Manager
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  509. AWS Parameter Store
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  514. Azure Key Vault
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  519. Google Secret Manager
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  524. IBM Secrets Manager
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../provider/akeyless/" class="md-nav__link">
  529. Akeyless
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  534. HashiCorp Vault
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  539. Yandex Certificate Manager
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  544. Yandex Lockbox
  545. </a>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  549. Gitlab Variables
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../provider/oracle-vault/" class="md-nav__link">
  554. Oracle Vault
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../provider/1password-automation/" class="md-nav__link">
  559. 1Password Secrets Automation
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../provider/webhook/" class="md-nav__link">
  564. Webhook
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="../../provider/fake/" class="md-nav__link">
  569. Fake
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../provider/kubernetes/" class="md-nav__link">
  574. Kubernetes
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  579. senhasegura DevOps Secrets Management (DSM)
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../provider/doppler/" class="md-nav__link">
  584. Doppler
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. <li class="md-nav__item md-nav__item--nested">
  591. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  592. <label class="md-nav__link" for="__nav_5">
  593. Examples
  594. <span class="md-nav__icon md-icon"></span>
  595. </label>
  596. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  597. <label class="md-nav__title" for="__nav_5">
  598. <span class="md-nav__icon md-icon"></span>
  599. Examples
  600. </label>
  601. <ul class="md-nav__list" data-md-scrollfix>
  602. <li class="md-nav__item">
  603. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  604. FluxCD
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  609. Anchore Engine
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  614. Jenkins
  615. </a>
  616. </li>
  617. </ul>
  618. </nav>
  619. </li>
  620. <li class="md-nav__item md-nav__item--nested">
  621. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  622. <label class="md-nav__link" for="__nav_6">
  623. Community
  624. <span class="md-nav__icon md-icon"></span>
  625. </label>
  626. <nav class="md-nav" aria-label="Community" data-md-level="1">
  627. <label class="md-nav__title" for="__nav_6">
  628. <span class="md-nav__icon md-icon"></span>
  629. Community
  630. </label>
  631. <ul class="md-nav__list" data-md-scrollfix>
  632. <li class="md-nav__item md-nav__item--nested">
  633. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  634. <label class="md-nav__link" for="__nav_6_1">
  635. Contributing
  636. <span class="md-nav__icon md-icon"></span>
  637. </label>
  638. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  639. <label class="md-nav__title" for="__nav_6_1">
  640. <span class="md-nav__icon md-icon"></span>
  641. Contributing
  642. </label>
  643. <ul class="md-nav__list" data-md-scrollfix>
  644. <li class="md-nav__item">
  645. <a href="../../contributing/devguide/" class="md-nav__link">
  646. Developer guide
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../../contributing/process/" class="md-nav__link">
  651. Contributing Process
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../contributing/release/" class="md-nav__link">
  656. Release Process
  657. </a>
  658. </li>
  659. <li class="md-nav__item">
  660. <a href="../../contributing/coc/" class="md-nav__link">
  661. Code of Conduct
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../contributing/roadmap/" class="md-nav__link">
  666. Roadmap
  667. </a>
  668. </li>
  669. </ul>
  670. </nav>
  671. </li>
  672. <li class="md-nav__item md-nav__item--nested">
  673. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  674. <label class="md-nav__link" for="__nav_6_2">
  675. External Resources
  676. <span class="md-nav__icon md-icon"></span>
  677. </label>
  678. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  679. <label class="md-nav__title" for="__nav_6_2">
  680. <span class="md-nav__icon md-icon"></span>
  681. External Resources
  682. </label>
  683. <ul class="md-nav__list" data-md-scrollfix>
  684. <li class="md-nav__item">
  685. <a href="../../eso-talks/" class="md-nav__link">
  686. Talks
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../eso-demos/" class="md-nav__link">
  691. Demos
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../../eso-blogs/" class="md-nav__link">
  696. Blogs
  697. </a>
  698. </li>
  699. </ul>
  700. </nav>
  701. </li>
  702. </ul>
  703. </nav>
  704. </li>
  705. </ul>
  706. </nav>
  707. </div>
  708. </div>
  709. </div>
  710. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  711. <div class="md-sidebar__scrollwrap">
  712. <div class="md-sidebar__inner">
  713. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  714. <label class="md-nav__title" for="__toc">
  715. <span class="md-nav__icon md-icon"></span>
  716. Table of contents
  717. </label>
  718. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  719. <li class="md-nav__item">
  720. <a href="#none-default" class="md-nav__link">
  721. None (default)
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="#base64" class="md-nav__link">
  726. Base64
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="#base64url" class="md-nav__link">
  731. Base64URL
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="#auto" class="md-nav__link">
  736. Auto
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#examples" class="md-nav__link">
  741. Examples
  742. </a>
  743. <nav class="md-nav" aria-label="Examples">
  744. <ul class="md-nav__list">
  745. <li class="md-nav__item">
  746. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  747. Setting Decoding strategy Auto in a DataFrom.Extract
  748. </a>
  749. </li>
  750. </ul>
  751. </nav>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#limitations" class="md-nav__link">
  755. Limitations
  756. </a>
  757. </li>
  758. </ul>
  759. </nav>
  760. </div>
  761. </div>
  762. </div>
  763. <div class="md-content" data-md-component="content">
  764. <article class="md-content__inner md-typeset">
  765. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/guides/decoding-strategy.md" title="Edit this page" class="md-content__button md-icon">
  766. <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>
  767. </a>
  768. <h1 id="decoding-strategies">Decoding Strategies</h1>
  769. <p>The External Secrets Operator has the feature to allow multiple decoding strategies during an object generation.</p>
  770. <p>The <code>decodingStrategy</code> field allows the user to set the following Decoding Strategies based on their needs. <code>decodingStrategy</code> can be placed under <code>spec.data.remoteRef</code>, <code>spec.dataFrom.extract</code> or <code>spec.dataFrom.find</code>. It will configure the decoding strategy for that specific operation, leaving others with the default behavior if not set.</p>
  771. <h3 id="none-default">None (default)</h3>
  772. <p>ESO will not try to decode the secret value.</p>
  773. <h3 id="base64">Base64</h3>
  774. <p>ESO will try to decode the secret value using <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-4">base64</a> method. If the decoding fails, an error is produced.</p>
  775. <h3 id="base64url">Base64URL</h3>
  776. <p>ESO will try to decode the secret value using <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-5">base64url</a> method. If the decoding fails, an error is produced.</p>
  777. <h3 id="auto">Auto</h3>
  778. <p>ESO will try to decode using Base64/Base64URL strategies. If the decoding fails, ESO will apply decoding strategy None. No error is produced to the user.</p>
  779. <h2 id="examples">Examples</h2>
  780. <h3 id="setting-decoding-strategy-auto-in-a-datafromextract">Setting Decoding strategy Auto in a DataFrom.Extract</h3>
  781. <p>Given that we have the given secret information:
  782. <div class="highlight"><pre><span></span><code>{
  783. &quot;name&quot;: &quot;Gustavo&quot;,
  784. &quot;surname&quot;: &quot;Fring&quot;,
  785. &quot;address&quot;:&quot;aGFwcHkgc3RyZWV0&quot;,
  786. }
  787. </code></pre></div>
  788. if we apply the following dataFrom:
  789. <div class="highlight"><pre><span></span><code>spec:
  790. dataFrom:
  791. - extract:
  792. key: my-secret
  793. decodingStrategy: Auto
  794. </code></pre></div>
  795. It will render the following Kubernetes Secret:
  796. <div class="highlight"><pre><span></span><code>data:
  797. name: R3VzdGF2bw== #Gustavo
  798. surname: RnJpbmc= #Fring
  799. address: aGFwcHkgc3RyZWV0 #happy street
  800. </code></pre></div></p>
  801. <h2 id="limitations">Limitations</h2>
  802. <p>At this time, decoding Strategy Auto is only trying to check if the original input is valid to perform Base64 operations. This means that some non-encoded secret values might end up being decoded, producing gibberish. This is the case for numbered values like <code>123456</code> or some specially crafted string values such as <code>happy/street</code>. </p>
  803. <div class="admonition note">
  804. <p class="admonition-title">Note</p>
  805. <p>If you are using <code>decodeStrategy: Auto</code> and start to see ESO pulling completely wrong secret values into your kubernetes secret, consider changing it to <code>None</code> to investigate it.</p>
  806. </div>
  807. </article>
  808. </div>
  809. </div>
  810. </main>
  811. <footer class="md-footer">
  812. <nav class="md-footer__inner md-grid" aria-label="Footer">
  813. <a href="../ownership-deletion-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lifecycle: ownership &amp; deletion" rel="prev">
  814. <div class="md-footer__button md-icon">
  815. <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>
  816. </div>
  817. <div class="md-footer__title">
  818. <div class="md-ellipsis">
  819. <span class="md-footer__direction">
  820. Previous
  821. </span>
  822. Lifecycle: ownership & deletion
  823. </div>
  824. </div>
  825. </a>
  826. <a href="../getallsecrets/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Multiple Secrets" rel="next">
  827. <div class="md-footer__title">
  828. <div class="md-ellipsis">
  829. <span class="md-footer__direction">
  830. Next
  831. </span>
  832. Getting Multiple Secrets
  833. </div>
  834. </div>
  835. <div class="md-footer__button md-icon">
  836. <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>
  837. </div>
  838. </a>
  839. </nav>
  840. <div class="md-footer-meta md-typeset">
  841. <div class="md-footer-meta__inner md-grid">
  842. <div class="md-copyright">
  843. <div class="md-copyright__highlight">
  844. &copy; 2022 The external-secrets Authors.<br/>
  845. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  846. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  847. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  848. </div>
  849. Made with
  850. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  851. Material for MkDocs
  852. </a>
  853. </div>
  854. </div>
  855. </div>
  856. </footer>
  857. </div>
  858. <div class="md-dialog" data-md-component="dialog">
  859. <div class="md-dialog__inner md-typeset"></div>
  860. </div>
  861. <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>
  862. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  863. </body>
  864. </html>