index.html 44 KB

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