index.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148
  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/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item md-nav__item--active">
  411. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  412. <label class="md-nav__link md-nav__link--active" for="__toc">
  413. Decoding Strategies
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <a href="./" class="md-nav__link md-nav__link--active">
  417. Decoding Strategies
  418. </a>
  419. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  420. <label class="md-nav__title" for="__toc">
  421. <span class="md-nav__icon md-icon"></span>
  422. Table of contents
  423. </label>
  424. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="#none-default" class="md-nav__link">
  427. None (default)
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="#base64" class="md-nav__link">
  432. Base64
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="#base64url" class="md-nav__link">
  437. Base64URL
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="#auto" class="md-nav__link">
  442. Auto
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="#examples" class="md-nav__link">
  447. Examples
  448. </a>
  449. <nav class="md-nav" aria-label="Examples">
  450. <ul class="md-nav__list">
  451. <li class="md-nav__item">
  452. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  453. Setting Decoding strategy Auto in a DataFrom.Extract
  454. </a>
  455. </li>
  456. </ul>
  457. </nav>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="#limitations" class="md-nav__link">
  461. Limitations
  462. </a>
  463. </li>
  464. </ul>
  465. </nav>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../getallsecrets/" class="md-nav__link">
  469. Getting Multiple Secrets
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../multi-tenancy/" class="md-nav__link">
  474. Multi Tenancy
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../datafrom-rewrite/" class="md-nav__link">
  479. Rewriting Keys
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../v1beta1/" class="md-nav__link">
  484. Upgrading to v1beta1
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../using-latest-image/" class="md-nav__link">
  489. Using Latest Image
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../disable-cluster-features/" class="md-nav__link">
  494. Disable Cluster Features
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. <li class="md-nav__item md-nav__item--nested">
  501. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  502. <label class="md-nav__link" for="__nav_4">
  503. Provider
  504. <span class="md-nav__icon md-icon"></span>
  505. </label>
  506. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  507. <label class="md-nav__title" for="__nav_4">
  508. <span class="md-nav__icon md-icon"></span>
  509. Provider
  510. </label>
  511. <ul class="md-nav__list" data-md-scrollfix>
  512. <li class="md-nav__item">
  513. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  514. AWS Secrets Manager
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  519. AWS Parameter Store
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  524. Azure Key Vault
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  529. Google Secret Manager
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  534. IBM Secrets Manager
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../provider/akeyless/" class="md-nav__link">
  539. Akeyless
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  544. HashiCorp Vault
  545. </a>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  549. Yandex Certificate Manager
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  554. Yandex Lockbox
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  559. Gitlab Variables
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../provider/oracle-vault/" class="md-nav__link">
  564. Oracle Vault
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="../../provider/1password-automation/" class="md-nav__link">
  569. 1Password Secrets Automation
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../provider/webhook/" class="md-nav__link">
  574. Webhook
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../../provider/fake/" class="md-nav__link">
  579. Fake
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../provider/kubernetes/" class="md-nav__link">
  584. Kubernetes
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  589. senhasegura DevOps Secrets Management (DSM)
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../provider/doppler/" class="md-nav__link">
  594. Doppler
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../provider/keeper-security/" class="md-nav__link">
  599. Keeper Security
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../provider/scaleway/" class="md-nav__link">
  604. Scaleway
  605. </a>
  606. </li>
  607. </ul>
  608. </nav>
  609. </li>
  610. <li class="md-nav__item md-nav__item--nested">
  611. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  612. <label class="md-nav__link" for="__nav_5">
  613. Examples
  614. <span class="md-nav__icon md-icon"></span>
  615. </label>
  616. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  617. <label class="md-nav__title" for="__nav_5">
  618. <span class="md-nav__icon md-icon"></span>
  619. Examples
  620. </label>
  621. <ul class="md-nav__list" data-md-scrollfix>
  622. <li class="md-nav__item">
  623. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  624. FluxCD
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  629. Anchore Engine
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  634. Jenkins
  635. </a>
  636. </li>
  637. </ul>
  638. </nav>
  639. </li>
  640. <li class="md-nav__item md-nav__item--nested">
  641. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  642. <label class="md-nav__link" for="__nav_6">
  643. Community
  644. <span class="md-nav__icon md-icon"></span>
  645. </label>
  646. <nav class="md-nav" aria-label="Community" data-md-level="1">
  647. <label class="md-nav__title" for="__nav_6">
  648. <span class="md-nav__icon md-icon"></span>
  649. Community
  650. </label>
  651. <ul class="md-nav__list" data-md-scrollfix>
  652. <li class="md-nav__item md-nav__item--nested">
  653. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  654. <label class="md-nav__link" for="__nav_6_1">
  655. Contributing
  656. <span class="md-nav__icon md-icon"></span>
  657. </label>
  658. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  659. <label class="md-nav__title" for="__nav_6_1">
  660. <span class="md-nav__icon md-icon"></span>
  661. Contributing
  662. </label>
  663. <ul class="md-nav__list" data-md-scrollfix>
  664. <li class="md-nav__item">
  665. <a href="../../contributing/devguide/" class="md-nav__link">
  666. Developer guide
  667. </a>
  668. </li>
  669. <li class="md-nav__item">
  670. <a href="../../contributing/process/" class="md-nav__link">
  671. Contributing Process
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../contributing/release/" class="md-nav__link">
  676. Release Process
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../contributing/coc/" class="md-nav__link">
  681. Code of Conduct
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../contributing/roadmap/" class="md-nav__link">
  686. Roadmap
  687. </a>
  688. </li>
  689. </ul>
  690. </nav>
  691. </li>
  692. <li class="md-nav__item md-nav__item--nested">
  693. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  694. <label class="md-nav__link" for="__nav_6_2">
  695. External Resources
  696. <span class="md-nav__icon md-icon"></span>
  697. </label>
  698. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  699. <label class="md-nav__title" for="__nav_6_2">
  700. <span class="md-nav__icon md-icon"></span>
  701. External Resources
  702. </label>
  703. <ul class="md-nav__list" data-md-scrollfix>
  704. <li class="md-nav__item">
  705. <a href="../../eso-talks/" class="md-nav__link">
  706. Talks
  707. </a>
  708. </li>
  709. <li class="md-nav__item">
  710. <a href="../../eso-demos/" class="md-nav__link">
  711. Demos
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="../../eso-blogs/" class="md-nav__link">
  716. Blogs
  717. </a>
  718. </li>
  719. </ul>
  720. </nav>
  721. </li>
  722. </ul>
  723. </nav>
  724. </li>
  725. </ul>
  726. </nav>
  727. </div>
  728. </div>
  729. </div>
  730. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  731. <div class="md-sidebar__scrollwrap">
  732. <div class="md-sidebar__inner">
  733. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  734. <label class="md-nav__title" for="__toc">
  735. <span class="md-nav__icon md-icon"></span>
  736. Table of contents
  737. </label>
  738. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  739. <li class="md-nav__item">
  740. <a href="#none-default" class="md-nav__link">
  741. None (default)
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#base64" class="md-nav__link">
  746. Base64
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="#base64url" class="md-nav__link">
  751. Base64URL
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="#auto" class="md-nav__link">
  756. Auto
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="#examples" class="md-nav__link">
  761. Examples
  762. </a>
  763. <nav class="md-nav" aria-label="Examples">
  764. <ul class="md-nav__list">
  765. <li class="md-nav__item">
  766. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  767. Setting Decoding strategy Auto in a DataFrom.Extract
  768. </a>
  769. </li>
  770. </ul>
  771. </nav>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="#limitations" class="md-nav__link">
  775. Limitations
  776. </a>
  777. </li>
  778. </ul>
  779. </nav>
  780. </div>
  781. </div>
  782. </div>
  783. <div class="md-content" data-md-component="content">
  784. <article class="md-content__inner md-typeset">
  785. <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">
  786. <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>
  787. </a>
  788. <h1 id="decoding-strategies">Decoding Strategies</h1>
  789. <p>The External Secrets Operator has the feature to allow multiple decoding strategies during an object generation.</p>
  790. <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>
  791. <h3 id="none-default">None (default)</h3>
  792. <p>ESO will not try to decode the secret value.</p>
  793. <h3 id="base64">Base64</h3>
  794. <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>
  795. <h3 id="base64url">Base64URL</h3>
  796. <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>
  797. <h3 id="auto">Auto</h3>
  798. <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>
  799. <h2 id="examples">Examples</h2>
  800. <h3 id="setting-decoding-strategy-auto-in-a-datafromextract">Setting Decoding strategy Auto in a DataFrom.Extract</h3>
  801. <p>Given that we have the given secret information:
  802. <div class="highlight"><pre><span></span><code>{
  803. &quot;name&quot;: &quot;Gustavo&quot;,
  804. &quot;surname&quot;: &quot;Fring&quot;,
  805. &quot;address&quot;:&quot;aGFwcHkgc3RyZWV0&quot;,
  806. }
  807. </code></pre></div>
  808. if we apply the following dataFrom:
  809. <div class="highlight"><pre><span></span><code>spec:
  810. dataFrom:
  811. - extract:
  812. key: my-secret
  813. decodingStrategy: Auto
  814. </code></pre></div>
  815. It will render the following Kubernetes Secret:
  816. <div class="highlight"><pre><span></span><code>data:
  817. name: R3VzdGF2bw== #Gustavo
  818. surname: RnJpbmc= #Fring
  819. address: aGFwcHkgc3RyZWV0 #happy street
  820. </code></pre></div></p>
  821. <h2 id="limitations">Limitations</h2>
  822. <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>
  823. <div class="admonition note">
  824. <p class="admonition-title">Note</p>
  825. <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>
  826. </div>
  827. </article>
  828. </div>
  829. </div>
  830. </main>
  831. <footer class="md-footer">
  832. <nav class="md-footer__inner md-grid" aria-label="Footer">
  833. <a href="../ownership-deletion-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lifecycle: ownership &amp; deletion" rel="prev">
  834. <div class="md-footer__button md-icon">
  835. <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>
  836. </div>
  837. <div class="md-footer__title">
  838. <div class="md-ellipsis">
  839. <span class="md-footer__direction">
  840. Previous
  841. </span>
  842. Lifecycle: ownership & deletion
  843. </div>
  844. </div>
  845. </a>
  846. <a href="../getallsecrets/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Multiple Secrets" rel="next">
  847. <div class="md-footer__title">
  848. <div class="md-ellipsis">
  849. <span class="md-footer__direction">
  850. Next
  851. </span>
  852. Getting Multiple Secrets
  853. </div>
  854. </div>
  855. <div class="md-footer__button md-icon">
  856. <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>
  857. </div>
  858. </a>
  859. </nav>
  860. <div class="md-footer-meta md-typeset">
  861. <div class="md-footer-meta__inner md-grid">
  862. <div class="md-copyright">
  863. <div class="md-copyright__highlight">
  864. &copy; 2023 The external-secrets Authors.<br/>
  865. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  866. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  867. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  868. </div>
  869. Made with
  870. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  871. Material for MkDocs
  872. </a>
  873. </div>
  874. </div>
  875. </div>
  876. </footer>
  877. </div>
  878. <div class="md-dialog" data-md-component="dialog">
  879. <div class="md-dialog__inner md-typeset"></div>
  880. </div>
  881. <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>
  882. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  883. </body>
  884. </html>