index.html 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060
  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>Password - 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="#output-keys-and-values" 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. Password
  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="../../components/" class="md-tabs__link md-tabs__link--active">
  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="../../../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--active md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" 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="../../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="../../externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../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--active md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../">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="../acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item md-nav__item--active">
  293. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  294. <label class="md-nav__link md-nav__link--active" for="__toc">
  295. Password
  296. <span class="md-nav__icon md-icon"></span>
  297. </label>
  298. <a href="./" class="md-nav__link md-nav__link--active">
  299. Password
  300. </a>
  301. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  302. <label class="md-nav__title" for="__toc">
  303. <span class="md-nav__icon md-icon"></span>
  304. Table of contents
  305. </label>
  306. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  307. <li class="md-nav__item">
  308. <a href="#output-keys-and-values" class="md-nav__link">
  309. Output Keys and Values
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="#parameters" class="md-nav__link">
  314. Parameters
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="#example-manifest" class="md-nav__link">
  319. Example Manifest
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../fake/" class="md-nav__link">
  327. Fake
  328. </a>
  329. </li>
  330. </ul>
  331. </nav>
  332. </li>
  333. <li class="md-nav__item md-nav__item--nested">
  334. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  335. <label class="md-nav__link" for="__nav_2_4">
  336. Reference Docs
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  340. <label class="md-nav__title" for="__nav_2_4">
  341. <span class="md-nav__icon md-icon"></span>
  342. Reference Docs
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../spec/" class="md-nav__link">
  347. API specification
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="../../controller-options/" class="md-nav__link">
  352. Controller Options
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../../metrics/" class="md-nav__link">
  357. Metrics
  358. </a>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. </ul>
  364. </nav>
  365. </li>
  366. <li class="md-nav__item md-nav__item--nested">
  367. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  368. <label class="md-nav__link" for="__nav_3">
  369. Guides
  370. <span class="md-nav__icon md-icon"></span>
  371. </label>
  372. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  373. <label class="md-nav__title" for="__nav_3">
  374. <span class="md-nav__icon md-icon"></span>
  375. Guides
  376. </label>
  377. <ul class="md-nav__list" data-md-scrollfix>
  378. <li class="md-nav__item">
  379. <a href="../../../guides/introduction/" class="md-nav__link">
  380. Introduction
  381. </a>
  382. </li>
  383. <li class="md-nav__item md-nav__item--nested">
  384. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  385. <label class="md-nav__link" for="__nav_3_2">
  386. Advanced Templating
  387. <span class="md-nav__icon md-icon"></span>
  388. </label>
  389. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  390. <label class="md-nav__title" for="__nav_3_2">
  391. <span class="md-nav__icon md-icon"></span>
  392. Advanced Templating
  393. </label>
  394. <ul class="md-nav__list" data-md-scrollfix>
  395. <li class="md-nav__item">
  396. <a href="../../../guides/templating/" class="md-nav__link">
  397. v2
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../../guides/templating-v1/" class="md-nav__link">
  402. v1
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../../guides/generator/" class="md-nav__link">
  410. Generators
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../../guides/all-keys-one-secret/" class="md-nav__link">
  415. All keys, One secret
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../../guides/common-k8s-secret-types/" class="md-nav__link">
  420. Common K8S Secret Types
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../../guides/controller-class/" class="md-nav__link">
  425. Controller Classes
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../../guides/ownership-deletion-policy/" class="md-nav__link">
  430. Lifecycle: ownership & deletion
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../../guides/decoding-strategy/" class="md-nav__link">
  435. Decoding Strategies
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../../guides/getallsecrets/" class="md-nav__link">
  440. Getting Multiple Secrets
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../../guides/multi-tenancy/" class="md-nav__link">
  445. Multi Tenancy
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../../guides/datafrom-rewrite/" class="md-nav__link">
  450. Rewriting Keys
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../../guides/v1beta1/" class="md-nav__link">
  455. Upgrading to v1beta1
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../../guides/using-latest-image/" class="md-nav__link">
  460. Using Latest Image
  461. </a>
  462. </li>
  463. </ul>
  464. </nav>
  465. </li>
  466. <li class="md-nav__item md-nav__item--nested">
  467. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  468. <label class="md-nav__link" for="__nav_4">
  469. Provider
  470. <span class="md-nav__icon md-icon"></span>
  471. </label>
  472. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  473. <label class="md-nav__title" for="__nav_4">
  474. <span class="md-nav__icon md-icon"></span>
  475. Provider
  476. </label>
  477. <ul class="md-nav__list" data-md-scrollfix>
  478. <li class="md-nav__item">
  479. <a href="../../../provider/aws-secrets-manager/" class="md-nav__link">
  480. AWS Secrets Manager
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../../provider/aws-parameter-store/" class="md-nav__link">
  485. AWS Parameter Store
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../../provider/azure-key-vault/" class="md-nav__link">
  490. Azure Key Vault
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../../provider/google-secrets-manager/" class="md-nav__link">
  495. Google Secret Manager
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../../provider/ibm-secrets-manager/" class="md-nav__link">
  500. IBM Secrets Manager
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../../provider/akeyless/" class="md-nav__link">
  505. Akeyless
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../../provider/hashicorp-vault/" class="md-nav__link">
  510. HashiCorp Vault
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../../provider/yandex-certificate-manager/" class="md-nav__link">
  515. Yandex Certificate Manager
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../../provider/yandex-lockbox/" class="md-nav__link">
  520. Yandex Lockbox
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../../provider/gitlab-variables/" class="md-nav__link">
  525. Gitlab Variables
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../../provider/oracle-vault/" class="md-nav__link">
  530. Oracle Vault
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../../provider/1password-automation/" class="md-nav__link">
  535. 1Password Secrets Automation
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../../provider/webhook/" class="md-nav__link">
  540. Webhook
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../../provider/fake/" class="md-nav__link">
  545. Fake
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../../provider/kubernetes/" class="md-nav__link">
  550. Kubernetes
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../../provider/senhasegura-dsm/" class="md-nav__link">
  555. senhasegura DevOps Secrets Management (DSM)
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../../provider/doppler/" class="md-nav__link">
  560. Doppler
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item md-nav__item--nested">
  567. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  568. <label class="md-nav__link" for="__nav_5">
  569. Examples
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  573. <label class="md-nav__title" for="__nav_5">
  574. <span class="md-nav__icon md-icon"></span>
  575. Examples
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../../../examples/gitops-using-fluxcd/" class="md-nav__link">
  580. FluxCD
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../../examples/anchore-engine-credentials/" class="md-nav__link">
  585. Anchore Engine
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  590. Jenkins
  591. </a>
  592. </li>
  593. </ul>
  594. </nav>
  595. </li>
  596. <li class="md-nav__item md-nav__item--nested">
  597. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  598. <label class="md-nav__link" for="__nav_6">
  599. Community
  600. <span class="md-nav__icon md-icon"></span>
  601. </label>
  602. <nav class="md-nav" aria-label="Community" data-md-level="1">
  603. <label class="md-nav__title" for="__nav_6">
  604. <span class="md-nav__icon md-icon"></span>
  605. Community
  606. </label>
  607. <ul class="md-nav__list" data-md-scrollfix>
  608. <li class="md-nav__item md-nav__item--nested">
  609. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  610. <label class="md-nav__link" for="__nav_6_1">
  611. Contributing
  612. <span class="md-nav__icon md-icon"></span>
  613. </label>
  614. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  615. <label class="md-nav__title" for="__nav_6_1">
  616. <span class="md-nav__icon md-icon"></span>
  617. Contributing
  618. </label>
  619. <ul class="md-nav__list" data-md-scrollfix>
  620. <li class="md-nav__item">
  621. <a href="../../../contributing/devguide/" class="md-nav__link">
  622. Developer guide
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../../contributing/process/" class="md-nav__link">
  627. Contributing Process
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../../contributing/release/" class="md-nav__link">
  632. Release Process
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../../contributing/coc/" class="md-nav__link">
  637. Code of Conduct
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../../contributing/roadmap/" class="md-nav__link">
  642. Roadmap
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </li>
  648. <li class="md-nav__item md-nav__item--nested">
  649. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  650. <label class="md-nav__link" for="__nav_6_2">
  651. External Resources
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  655. <label class="md-nav__title" for="__nav_6_2">
  656. <span class="md-nav__icon md-icon"></span>
  657. External Resources
  658. </label>
  659. <ul class="md-nav__list" data-md-scrollfix>
  660. <li class="md-nav__item">
  661. <a href="../../../eso-talks/" class="md-nav__link">
  662. Talks
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../../eso-demos/" class="md-nav__link">
  667. Demos
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../../eso-blogs/" class="md-nav__link">
  672. Blogs
  673. </a>
  674. </li>
  675. </ul>
  676. </nav>
  677. </li>
  678. </ul>
  679. </nav>
  680. </li>
  681. </ul>
  682. </nav>
  683. </div>
  684. </div>
  685. </div>
  686. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  687. <div class="md-sidebar__scrollwrap">
  688. <div class="md-sidebar__inner">
  689. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  690. <label class="md-nav__title" for="__toc">
  691. <span class="md-nav__icon md-icon"></span>
  692. Table of contents
  693. </label>
  694. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  695. <li class="md-nav__item">
  696. <a href="#output-keys-and-values" class="md-nav__link">
  697. Output Keys and Values
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="#parameters" class="md-nav__link">
  702. Parameters
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#example-manifest" class="md-nav__link">
  707. Example Manifest
  708. </a>
  709. </li>
  710. </ul>
  711. </nav>
  712. </div>
  713. </div>
  714. </div>
  715. <div class="md-content" data-md-component="content">
  716. <article class="md-content__inner md-typeset">
  717. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/generator/password.md" title="Edit this page" class="md-content__button md-icon">
  718. <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>
  719. </a>
  720. <h1>Password</h1>
  721. <p>The Password generator provides random passwords that you can feed into your applications. It uses lower and uppercase alphanumeric characters as well as symbols. Please see below for the symbols in use.</p>
  722. <div class="admonition warning">
  723. <p class="admonition-title">Passwords are completely randomized</p>
  724. <p>It is possible that we may generate passwords that don't match the expected character set from your application.</p>
  725. </div>
  726. <h2 id="output-keys-and-values">Output Keys and Values</h2>
  727. <table>
  728. <thead>
  729. <tr>
  730. <th>Key</th>
  731. <th>Description</th>
  732. </tr>
  733. </thead>
  734. <tbody>
  735. <tr>
  736. <td>password</td>
  737. <td>the generated password</td>
  738. </tr>
  739. </tbody>
  740. </table>
  741. <h2 id="parameters">Parameters</h2>
  742. <p>You can influence the behavior of the generator by providing the following args</p>
  743. <table>
  744. <thead>
  745. <tr>
  746. <th>Key</th>
  747. <th>Default</th>
  748. <th>Description</th>
  749. </tr>
  750. </thead>
  751. <tbody>
  752. <tr>
  753. <td>length</td>
  754. <td>24</td>
  755. <td>Length of the password to be generated.</td>
  756. </tr>
  757. <tr>
  758. <td>digits</td>
  759. <td>25% of the length</td>
  760. <td>Specify the number of digits in the generated password.</td>
  761. </tr>
  762. <tr>
  763. <td>symbols</td>
  764. <td>25% of the length</td>
  765. <td>Specify the number of symbol characters in the generated.</td>
  766. </tr>
  767. <tr>
  768. <td>symbolCharacters</td>
  769. <td>~!@#$%^&amp;*()_+`-={}|[]\:"&lt;&gt;?,./</td>
  770. <td>Specify the character set that should be used when generating the password.</td>
  771. </tr>
  772. <tr>
  773. <td>noUpper</td>
  774. <td>false</td>
  775. <td>disable uppercase characters.</td>
  776. </tr>
  777. <tr>
  778. <td>allowRepeat</td>
  779. <td>false</td>
  780. <td>allow repeating characters.</td>
  781. </tr>
  782. </tbody>
  783. </table>
  784. <h2 id="example-manifest">Example Manifest</h2>
  785. <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">generators.external-secrets.io/v1alpha1</span><span class="w"></span>
  786. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Password</span><span class="w"></span>
  787. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  788. <span class="w"> </span><span class="nt">length</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">42</span><span class="w"></span>
  789. <span class="w"> </span><span class="nt">digits</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span><span class="w"></span>
  790. <span class="w"> </span><span class="nt">symbols</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">symbolCharacters</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;-_$@&quot;</span><span class="w"></span>
  792. <span class="w"> </span><span class="nt">noUpper</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class="w"></span>
  793. <span class="w"> </span><span class="nt">allowRepeat</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
  794. </code></pre></div>
  795. <p>May produce values such as:</p>
  796. <div class="highlight"><pre><span></span><code>RMngCHKtZ@@h@3aja$WZDuDVhkCkN48JBa9OF8jH$R
  797. VB$pX8SSUMIlk9K8g@XxJAhGz$0$ktbJ1ArMukg-bD
  798. Hi$-aK_3Rrrw1Pj9-sIpPZuk5abvEDJlabUYUcS$9L
  799. </code></pre></div>
  800. <p>With default values you would get something like:</p>
  801. <div class="highlight"><pre><span></span><code>2Cp=O*&amp;8x6sdwM!&lt;74G_gUz5
  802. -MS`e#n24K|h5A&lt;&amp;6q9Yv7Cj
  803. ZRv-k!y6x/V&quot;29:43aErSf$1
  804. Vk9*mwXE30Q+&gt;H?lY$5I64_q
  805. </code></pre></div>
  806. </article>
  807. </div>
  808. </div>
  809. </main>
  810. <footer class="md-footer">
  811. <nav class="md-footer__inner md-grid" aria-label="Footer">
  812. <a href="../gcr/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Google Container Registry" rel="prev">
  813. <div class="md-footer__button md-icon">
  814. <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>
  815. </div>
  816. <div class="md-footer__title">
  817. <div class="md-ellipsis">
  818. <span class="md-footer__direction">
  819. Previous
  820. </span>
  821. Google Container Registry
  822. </div>
  823. </div>
  824. </a>
  825. <a href="../fake/" class="md-footer__link md-footer__link--next" aria-label="Next: Fake" rel="next">
  826. <div class="md-footer__title">
  827. <div class="md-ellipsis">
  828. <span class="md-footer__direction">
  829. Next
  830. </span>
  831. Fake
  832. </div>
  833. </div>
  834. <div class="md-footer__button md-icon">
  835. <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>
  836. </div>
  837. </a>
  838. </nav>
  839. <div class="md-footer-meta md-typeset">
  840. <div class="md-footer-meta__inner md-grid">
  841. <div class="md-copyright">
  842. <div class="md-copyright__highlight">
  843. &copy; 2022 The external-secrets Authors.<br/>
  844. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  845. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  846. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  847. </div>
  848. Made with
  849. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  850. Material for MkDocs
  851. </a>
  852. </div>
  853. </div>
  854. </div>
  855. </footer>
  856. </div>
  857. <div class="md-dialog" data-md-component="dialog">
  858. <div class="md-dialog__inner md-typeset"></div>
  859. </div>
  860. <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>
  861. <script src="../../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  862. </body>
  863. </html>