index.html 43 KB

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