index.html 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430
  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="../../pictures/eso-round-logo.svg">
  7. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.33">
  8. <title>Beyondtrust - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.3cba04c6.min.css">
  10. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  11. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  12. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  13. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  14. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  15. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  16. </head>
  17. <body dir="ltr">
  18. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  19. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  20. <label class="md-overlay" for="__drawer"></label>
  21. <div data-md-component="skip">
  22. <a href="#beyondtrust-password-safe" class="md-skip">
  23. Skip to content
  24. </a>
  25. </div>
  26. <div data-md-component="announce">
  27. </div>
  28. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  29. <aside class="md-banner md-banner--warning">
  30. <div class="md-banner__inner md-grid md-typeset">
  31. You're not viewing the latest version.
  32. <a href="../../..">
  33. <strong>Click here to go to latest.</strong>
  34. </a>
  35. </div>
  36. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  37. </aside>
  38. </div>
  39. <header class="md-header" data-md-component="header">
  40. <nav class="md-header__inner md-grid" aria-label="Header">
  41. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  42. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  43. </a>
  44. <label class="md-header__button md-icon" for="__drawer">
  45. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  46. </label>
  47. <div class="md-header__title" data-md-component="header-title">
  48. <div class="md-header__ellipsis">
  49. <div class="md-header__topic">
  50. <span class="md-ellipsis">
  51. External Secrets Operator
  52. </span>
  53. </div>
  54. <div class="md-header__topic" data-md-component="header-topic">
  55. <span class="md-ellipsis">
  56. Beyondtrust
  57. </span>
  58. </div>
  59. </div>
  60. </div>
  61. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  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" title="Clear" 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" tabindex="0" 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" role="presentation"></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"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><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-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../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. <li class="md-tabs__item">
  139. <a href="../../spec/" class="md-tabs__link">
  140. References
  141. </a>
  142. </li>
  143. </ul>
  144. </div>
  145. </nav>
  146. <main class="md-main" data-md-component="main">
  147. <div class="md-main__inner md-grid">
  148. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  149. <div class="md-sidebar__scrollwrap">
  150. <div class="md-sidebar__inner">
  151. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  152. <label class="md-nav__title" for="__drawer">
  153. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  154. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  155. </a>
  156. External Secrets Operator
  157. </label>
  158. <div class="md-nav__source">
  159. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  160. <div class="md-source__icon md-icon">
  161. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><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>
  162. </div>
  163. <div class="md-source__repository">
  164. External Secrets Operator
  165. </div>
  166. </a>
  167. </div>
  168. <ul class="md-nav__list" data-md-scrollfix>
  169. <li class="md-nav__item md-nav__item--nested">
  170. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  171. <div class="md-nav__link md-nav__container">
  172. <a href="../.." class="md-nav__link ">
  173. <span class="md-ellipsis">
  174. Introduction
  175. </span>
  176. </a>
  177. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  178. <span class="md-nav__icon md-icon"></span>
  179. </label>
  180. </div>
  181. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  182. <label class="md-nav__title" for="__nav_1">
  183. <span class="md-nav__icon md-icon"></span>
  184. Introduction
  185. </label>
  186. <ul class="md-nav__list" data-md-scrollfix>
  187. <li class="md-nav__item">
  188. <a href="../../introduction/overview/" class="md-nav__link">
  189. <span class="md-ellipsis">
  190. Overview
  191. </span>
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../../introduction/getting-started/" class="md-nav__link">
  196. <span class="md-ellipsis">
  197. Getting started
  198. </span>
  199. </a>
  200. </li>
  201. <li class="md-nav__item">
  202. <a href="../../introduction/faq/" class="md-nav__link">
  203. <span class="md-ellipsis">
  204. FAQ
  205. </span>
  206. </a>
  207. </li>
  208. <li class="md-nav__item">
  209. <a href="../../introduction/stability-support/" class="md-nav__link">
  210. <span class="md-ellipsis">
  211. Stability and Support
  212. </span>
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  217. <span class="md-ellipsis">
  218. Deprecation Policy
  219. </span>
  220. </a>
  221. </li>
  222. </ul>
  223. </nav>
  224. </li>
  225. <li class="md-nav__item md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  227. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  228. <span class="md-ellipsis">
  229. API
  230. </span>
  231. <span class="md-nav__icon md-icon"></span>
  232. </label>
  233. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  234. <label class="md-nav__title" for="__nav_2">
  235. <span class="md-nav__icon md-icon"></span>
  236. API
  237. </label>
  238. <ul class="md-nav__list" data-md-scrollfix>
  239. <li class="md-nav__item">
  240. <a href="../../api/components/" class="md-nav__link">
  241. <span class="md-ellipsis">
  242. Components
  243. </span>
  244. </a>
  245. </li>
  246. <li class="md-nav__item md-nav__item--nested">
  247. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  248. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  249. <span class="md-ellipsis">
  250. Core Resources
  251. </span>
  252. <span class="md-nav__icon md-icon"></span>
  253. </label>
  254. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  255. <label class="md-nav__title" for="__nav_2_2">
  256. <span class="md-nav__icon md-icon"></span>
  257. Core Resources
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item">
  261. <a href="../../api/externalsecret/" class="md-nav__link">
  262. <span class="md-ellipsis">
  263. ExternalSecret
  264. </span>
  265. </a>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="../../api/secretstore/" class="md-nav__link">
  269. <span class="md-ellipsis">
  270. SecretStore
  271. </span>
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="../../api/clustersecretstore/" class="md-nav__link">
  276. <span class="md-ellipsis">
  277. ClusterSecretStore
  278. </span>
  279. </a>
  280. </li>
  281. <li class="md-nav__item">
  282. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. ClusterExternalSecret
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../../api/pushsecret/" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. PushSecret
  292. </span>
  293. </a>
  294. </li>
  295. </ul>
  296. </nav>
  297. </li>
  298. <li class="md-nav__item md-nav__item--nested">
  299. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  300. <div class="md-nav__link md-nav__container">
  301. <a href="../../api/generator/" class="md-nav__link ">
  302. <span class="md-ellipsis">
  303. Generators
  304. </span>
  305. </a>
  306. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  307. <span class="md-nav__icon md-icon"></span>
  308. </label>
  309. </div>
  310. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  311. <label class="md-nav__title" for="__nav_2_3">
  312. <span class="md-nav__icon md-icon"></span>
  313. Generators
  314. </label>
  315. <ul class="md-nav__list" data-md-scrollfix>
  316. <li class="md-nav__item">
  317. <a href="../../api/generator/acr/" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. Azure Container Registry
  320. </span>
  321. </a>
  322. </li>
  323. <li class="md-nav__item">
  324. <a href="../../api/generator/ecr/" class="md-nav__link">
  325. <span class="md-ellipsis">
  326. AWS Elastic Container Registry
  327. </span>
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../../api/generator/gcr/" class="md-nav__link">
  332. <span class="md-ellipsis">
  333. Google Container Registry
  334. </span>
  335. </a>
  336. </li>
  337. <li class="md-nav__item">
  338. <a href="../../api/generator/vault/" class="md-nav__link">
  339. <span class="md-ellipsis">
  340. Vault Dynamic Secret
  341. </span>
  342. </a>
  343. </li>
  344. <li class="md-nav__item">
  345. <a href="../../api/generator/password/" class="md-nav__link">
  346. <span class="md-ellipsis">
  347. Password
  348. </span>
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="../../api/generator/fake/" class="md-nav__link">
  353. <span class="md-ellipsis">
  354. Fake
  355. </span>
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="../../api/generator/webhook/" class="md-nav__link">
  360. <span class="md-ellipsis">
  361. Webhook
  362. </span>
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../../api/generator/github/" class="md-nav__link">
  367. <span class="md-ellipsis">
  368. Github
  369. </span>
  370. </a>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  377. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  378. <span class="md-ellipsis">
  379. Reference Docs
  380. </span>
  381. <span class="md-nav__icon md-icon"></span>
  382. </label>
  383. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  384. <label class="md-nav__title" for="__nav_2_4">
  385. <span class="md-nav__icon md-icon"></span>
  386. Reference Docs
  387. </label>
  388. <ul class="md-nav__list" data-md-scrollfix>
  389. <li class="md-nav__item">
  390. <a href="../../api/spec/" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. API specification
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../../api/controller-options/" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. Controller Options
  400. </span>
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../../api/metrics/" class="md-nav__link">
  405. <span class="md-ellipsis">
  406. Metrics
  407. </span>
  408. </a>
  409. </li>
  410. </ul>
  411. </nav>
  412. </li>
  413. </ul>
  414. </nav>
  415. </li>
  416. <li class="md-nav__item md-nav__item--nested">
  417. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  418. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  419. <span class="md-ellipsis">
  420. Guides
  421. </span>
  422. <span class="md-nav__icon md-icon"></span>
  423. </label>
  424. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  425. <label class="md-nav__title" for="__nav_3">
  426. <span class="md-nav__icon md-icon"></span>
  427. Guides
  428. </label>
  429. <ul class="md-nav__list" data-md-scrollfix>
  430. <li class="md-nav__item">
  431. <a href="../../guides/introduction/" class="md-nav__link">
  432. <span class="md-ellipsis">
  433. Introduction
  434. </span>
  435. </a>
  436. </li>
  437. <li class="md-nav__item md-nav__item--nested">
  438. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  439. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  440. <span class="md-ellipsis">
  441. External Secrets
  442. </span>
  443. <span class="md-nav__icon md-icon"></span>
  444. </label>
  445. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  446. <label class="md-nav__title" for="__nav_3_2">
  447. <span class="md-nav__icon md-icon"></span>
  448. External Secrets
  449. </label>
  450. <ul class="md-nav__list" data-md-scrollfix>
  451. <li class="md-nav__item">
  452. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  453. <span class="md-ellipsis">
  454. Extract structured data
  455. </span>
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../guides/getallsecrets/" class="md-nav__link">
  460. <span class="md-ellipsis">
  461. Find Secrets by Name or Metadata
  462. </span>
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  467. <span class="md-ellipsis">
  468. Rewriting Keys
  469. </span>
  470. </a>
  471. </li>
  472. <li class="md-nav__item md-nav__item--nested">
  473. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  474. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  475. <span class="md-ellipsis">
  476. Advanced Templating
  477. </span>
  478. <span class="md-nav__icon md-icon"></span>
  479. </label>
  480. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  481. <label class="md-nav__title" for="__nav_3_2_4">
  482. <span class="md-nav__icon md-icon"></span>
  483. Advanced Templating
  484. </label>
  485. <ul class="md-nav__list" data-md-scrollfix>
  486. <li class="md-nav__item">
  487. <a href="../../guides/templating/" class="md-nav__link">
  488. <span class="md-ellipsis">
  489. v2
  490. </span>
  491. </a>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../guides/templating-v1/" class="md-nav__link">
  495. <span class="md-ellipsis">
  496. v1
  497. </span>
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  505. <span class="md-ellipsis">
  506. Kubernetes Secret Types
  507. </span>
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  512. <span class="md-ellipsis">
  513. Lifecycle: ownership & deletion
  514. </span>
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  519. <span class="md-ellipsis">
  520. Decoding Strategies
  521. </span>
  522. </a>
  523. </li>
  524. <li class="md-nav__item">
  525. <a href="../../guides/controller-class/" class="md-nav__link">
  526. <span class="md-ellipsis">
  527. Controller Classes
  528. </span>
  529. </a>
  530. </li>
  531. </ul>
  532. </nav>
  533. </li>
  534. <li class="md-nav__item">
  535. <a href="../../guides/generator/" class="md-nav__link">
  536. <span class="md-ellipsis">
  537. Generators
  538. </span>
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../../guides/pushsecrets/" class="md-nav__link">
  543. <span class="md-ellipsis">
  544. Push Secrets
  545. </span>
  546. </a>
  547. </li>
  548. <li class="md-nav__item md-nav__item--nested">
  549. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  550. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  551. <span class="md-ellipsis">
  552. Operations
  553. </span>
  554. <span class="md-nav__icon md-icon"></span>
  555. </label>
  556. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  557. <label class="md-nav__title" for="__nav_3_5">
  558. <span class="md-nav__icon md-icon"></span>
  559. Operations
  560. </label>
  561. <ul class="md-nav__list" data-md-scrollfix>
  562. <li class="md-nav__item">
  563. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Multi Tenancy
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../../guides/security-best-practices/" class="md-nav__link">
  571. <span class="md-ellipsis">
  572. Security Best Practices
  573. </span>
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../guides/threat-model/" class="md-nav__link">
  578. <span class="md-ellipsis">
  579. Threat Model
  580. </span>
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../guides/v1beta1/" class="md-nav__link">
  585. <span class="md-ellipsis">
  586. Upgrading to v1beta1
  587. </span>
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../guides/using-latest-image/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Using Latest Image
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Disable Cluster Features
  601. </span>
  602. </a>
  603. </li>
  604. </ul>
  605. </nav>
  606. </li>
  607. </ul>
  608. </nav>
  609. </li>
  610. <li class="md-nav__item md-nav__item--nested">
  611. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  612. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  613. <span class="md-ellipsis">
  614. Provider
  615. </span>
  616. <span class="md-nav__icon md-icon"></span>
  617. </label>
  618. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  619. <label class="md-nav__title" for="__nav_4">
  620. <span class="md-nav__icon md-icon"></span>
  621. Provider
  622. </label>
  623. <ul class="md-nav__list" data-md-scrollfix>
  624. <li class="md-nav__item">
  625. <a href="../aws-secrets-manager/" class="md-nav__link">
  626. <span class="md-ellipsis">
  627. AWS Secrets Manager
  628. </span>
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../aws-parameter-store/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. AWS Parameter Store
  635. </span>
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../azure-key-vault/" class="md-nav__link">
  640. <span class="md-ellipsis">
  641. Azure Key Vault
  642. </span>
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  647. <span class="md-ellipsis">
  648. Bitwarden Secrets Manager
  649. </span>
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../chef/" class="md-nav__link">
  654. <span class="md-ellipsis">
  655. Chef
  656. </span>
  657. </a>
  658. </li>
  659. <li class="md-nav__item">
  660. <a href="../conjur/" class="md-nav__link">
  661. <span class="md-ellipsis">
  662. CyberArk Conjur
  663. </span>
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../device42/" class="md-nav__link">
  668. <span class="md-ellipsis">
  669. Device42
  670. </span>
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="../google-secrets-manager/" class="md-nav__link">
  675. <span class="md-ellipsis">
  676. Google Cloud Secret Manager
  677. </span>
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../hashicorp-vault/" class="md-nav__link">
  682. <span class="md-ellipsis">
  683. HashiCorp Vault
  684. </span>
  685. </a>
  686. </li>
  687. <li class="md-nav__item">
  688. <a href="../kubernetes/" class="md-nav__link">
  689. <span class="md-ellipsis">
  690. Kubernetes
  691. </span>
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../ibm-secrets-manager/" class="md-nav__link">
  696. <span class="md-ellipsis">
  697. IBM Secrets Manager
  698. </span>
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../akeyless/" class="md-nav__link">
  703. <span class="md-ellipsis">
  704. Akeyless
  705. </span>
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="../yandex-certificate-manager/" class="md-nav__link">
  710. <span class="md-ellipsis">
  711. Yandex Certificate Manager
  712. </span>
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="../yandex-lockbox/" class="md-nav__link">
  717. <span class="md-ellipsis">
  718. Yandex Lockbox
  719. </span>
  720. </a>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="../alibaba/" class="md-nav__link">
  724. <span class="md-ellipsis">
  725. Alibaba Cloud
  726. </span>
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="../gitlab-variables/" class="md-nav__link">
  731. <span class="md-ellipsis">
  732. GitLab Variables
  733. </span>
  734. </a>
  735. </li>
  736. <li class="md-nav__item">
  737. <a href="../oracle-vault/" class="md-nav__link">
  738. <span class="md-ellipsis">
  739. Oracle Vault
  740. </span>
  741. </a>
  742. </li>
  743. <li class="md-nav__item">
  744. <a href="../1password-automation/" class="md-nav__link">
  745. <span class="md-ellipsis">
  746. 1Password Secrets Automation
  747. </span>
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="../webhook/" class="md-nav__link">
  752. <span class="md-ellipsis">
  753. Webhook
  754. </span>
  755. </a>
  756. </li>
  757. <li class="md-nav__item">
  758. <a href="../fake/" class="md-nav__link">
  759. <span class="md-ellipsis">
  760. Fake
  761. </span>
  762. </a>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="../senhasegura-dsm/" class="md-nav__link">
  766. <span class="md-ellipsis">
  767. senhasegura DevOps Secrets Management (DSM)
  768. </span>
  769. </a>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="../doppler/" class="md-nav__link">
  773. <span class="md-ellipsis">
  774. Doppler
  775. </span>
  776. </a>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="../keeper-security/" class="md-nav__link">
  780. <span class="md-ellipsis">
  781. Keeper Security
  782. </span>
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="../cloak/" class="md-nav__link">
  787. <span class="md-ellipsis">
  788. Cloak End 2 End Encrypted Secrets
  789. </span>
  790. </a>
  791. </li>
  792. <li class="md-nav__item">
  793. <a href="../scaleway/" class="md-nav__link">
  794. <span class="md-ellipsis">
  795. Scaleway
  796. </span>
  797. </a>
  798. </li>
  799. <li class="md-nav__item">
  800. <a href="../delinea/" class="md-nav__link">
  801. <span class="md-ellipsis">
  802. Delinea
  803. </span>
  804. </a>
  805. </li>
  806. <li class="md-nav__item">
  807. <a href="../delinea/" class="md-nav__link">
  808. <span class="md-ellipsis">
  809. Delinea
  810. </span>
  811. </a>
  812. </li>
  813. <li class="md-nav__item">
  814. <a href="../passbolt/" class="md-nav__link">
  815. <span class="md-ellipsis">
  816. Passbolt
  817. </span>
  818. </a>
  819. </li>
  820. <li class="md-nav__item">
  821. <a href="../pulumi/" class="md-nav__link">
  822. <span class="md-ellipsis">
  823. Pulumi ESC
  824. </span>
  825. </a>
  826. </li>
  827. <li class="md-nav__item">
  828. <a href="../onboardbase/" class="md-nav__link">
  829. <span class="md-ellipsis">
  830. Onboardbase
  831. </span>
  832. </a>
  833. </li>
  834. <li class="md-nav__item">
  835. <a href="../../provider-passworddepot/" class="md-nav__link">
  836. <span class="md-ellipsis">
  837. Password Depot
  838. </span>
  839. </a>
  840. </li>
  841. <li class="md-nav__item">
  842. <a href="../fortanix/" class="md-nav__link">
  843. <span class="md-ellipsis">
  844. Fortanix
  845. </span>
  846. </a>
  847. </li>
  848. <li class="md-nav__item">
  849. <a href="../infisical/" class="md-nav__link">
  850. <span class="md-ellipsis">
  851. Infisical
  852. </span>
  853. </a>
  854. </li>
  855. </ul>
  856. </nav>
  857. </li>
  858. <li class="md-nav__item md-nav__item--nested">
  859. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  860. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  861. <span class="md-ellipsis">
  862. Examples
  863. </span>
  864. <span class="md-nav__icon md-icon"></span>
  865. </label>
  866. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  867. <label class="md-nav__title" for="__nav_5">
  868. <span class="md-nav__icon md-icon"></span>
  869. Examples
  870. </label>
  871. <ul class="md-nav__list" data-md-scrollfix>
  872. <li class="md-nav__item">
  873. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. FluxCD
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Anchore Engine
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Jenkins
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="../../examples/bitwarden/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. BitWarden
  897. </span>
  898. </a>
  899. </li>
  900. </ul>
  901. </nav>
  902. </li>
  903. <li class="md-nav__item md-nav__item--nested">
  904. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  905. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  906. <span class="md-ellipsis">
  907. Community
  908. </span>
  909. <span class="md-nav__icon md-icon"></span>
  910. </label>
  911. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  912. <label class="md-nav__title" for="__nav_6">
  913. <span class="md-nav__icon md-icon"></span>
  914. Community
  915. </label>
  916. <ul class="md-nav__list" data-md-scrollfix>
  917. <li class="md-nav__item md-nav__item--nested">
  918. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  919. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  920. <span class="md-ellipsis">
  921. Contributing
  922. </span>
  923. <span class="md-nav__icon md-icon"></span>
  924. </label>
  925. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  926. <label class="md-nav__title" for="__nav_6_1">
  927. <span class="md-nav__icon md-icon"></span>
  928. Contributing
  929. </label>
  930. <ul class="md-nav__list" data-md-scrollfix>
  931. <li class="md-nav__item">
  932. <a href="../../contributing/devguide/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. Developer guide
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="../../contributing/process/" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. Contributing Process
  942. </span>
  943. </a>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../../contributing/release/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. Release Process
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../../contributing/coc/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. Code of Conduct
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../../contributing/roadmap/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Roadmap
  963. </span>
  964. </a>
  965. </li>
  966. </ul>
  967. </nav>
  968. </li>
  969. <li class="md-nav__item md-nav__item--nested">
  970. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  971. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  972. <span class="md-ellipsis">
  973. External Resources
  974. </span>
  975. <span class="md-nav__icon md-icon"></span>
  976. </label>
  977. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  978. <label class="md-nav__title" for="__nav_6_2">
  979. <span class="md-nav__icon md-icon"></span>
  980. External Resources
  981. </label>
  982. <ul class="md-nav__list" data-md-scrollfix>
  983. <li class="md-nav__item">
  984. <a href="../../eso-talks/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Talks
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../eso-demos/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Demos
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../eso-blogs/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Blogs
  1001. </span>
  1002. </a>
  1003. </li>
  1004. </ul>
  1005. </nav>
  1006. </li>
  1007. </ul>
  1008. </nav>
  1009. </li>
  1010. <li class="md-nav__item md-nav__item--nested">
  1011. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1012. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1013. <span class="md-ellipsis">
  1014. References
  1015. </span>
  1016. <span class="md-nav__icon md-icon"></span>
  1017. </label>
  1018. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1019. <label class="md-nav__title" for="__nav_7">
  1020. <span class="md-nav__icon md-icon"></span>
  1021. References
  1022. </label>
  1023. <ul class="md-nav__list" data-md-scrollfix>
  1024. <li class="md-nav__item">
  1025. <a href="../../spec/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. API specification
  1028. </span>
  1029. </a>
  1030. </li>
  1031. </ul>
  1032. </nav>
  1033. </li>
  1034. </ul>
  1035. </nav>
  1036. </div>
  1037. </div>
  1038. </div>
  1039. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1040. <div class="md-sidebar__scrollwrap">
  1041. <div class="md-sidebar__inner">
  1042. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1043. <label class="md-nav__title" for="__toc">
  1044. <span class="md-nav__icon md-icon"></span>
  1045. Table of contents
  1046. </label>
  1047. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1048. <li class="md-nav__item">
  1049. <a href="#beyondtrust-password-safe" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. BeyondTrust Password Safe
  1052. </span>
  1053. </a>
  1054. <nav class="md-nav" aria-label="BeyondTrust Password Safe">
  1055. <ul class="md-nav__list">
  1056. <li class="md-nav__item">
  1057. <a href="#prerequisites" class="md-nav__link">
  1058. <span class="md-ellipsis">
  1059. Prerequisites
  1060. </span>
  1061. </a>
  1062. </li>
  1063. <li class="md-nav__item">
  1064. <a href="#authentication" class="md-nav__link">
  1065. <span class="md-ellipsis">
  1066. Authentication
  1067. </span>
  1068. </a>
  1069. </li>
  1070. <li class="md-nav__item">
  1071. <a href="#client-certificate" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. Client Certificate
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="#creating-a-secretstore" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Creating a SecretStore
  1081. </span>
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="#creating-a-externalsecret" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Creating a ExternalSecret
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="#get-the-k8s-secret" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Get the K8s secret
  1095. </span>
  1096. </a>
  1097. </li>
  1098. </ul>
  1099. </nav>
  1100. </li>
  1101. </ul>
  1102. </nav>
  1103. </div>
  1104. </div>
  1105. </div>
  1106. <div class="md-content" data-md-component="content">
  1107. <article class="md-content__inner md-typeset">
  1108. <h1>Beyondtrust</h1>
  1109. <h2 id="beyondtrust-password-safe">BeyondTrust Password Safe</h2>
  1110. <p>External Secrets Operator integrates with <a href="https://www.beyondtrust.com/docs/beyondinsight-password-safe/">BeyondTrust Password Safe</a>.</p>
  1111. <p>Warning: The External Secrets Operator secure usage involves taking several measures. Please see <a href="https://external-secrets.io/latest/guides/security-best-practices/">Security Best Practices</a> for more information.</p>
  1112. <p>Warning: If the BT provider secret is deleted it will still exist in the Kubernetes secrets.</p>
  1113. <h3 id="prerequisites">Prerequisites</h3>
  1114. <p>The BT provider supports retrieval of a secret from BeyondInsight/Password Safe versions 23.1 or greater.</p>
  1115. <p>For this provider to retrieve a secret the Password Safe/Secrets Safe instance must be preconfigured with the secret in question and authorized to read it.</p>
  1116. <h3 id="authentication">Authentication</h3>
  1117. <p>BeyondTrust <a href="https://www.beyondtrust.com/docs/beyondinsight-password-safe/ps/admin/configure-api-registration.htm">OAuth Authentication</a>.</p>
  1118. <ol>
  1119. <li>Create an API access registration in BeyondInsight</li>
  1120. <li>Create or use an existing Secrets Safe Group</li>
  1121. <li>Create or use an existing Application User</li>
  1122. <li>Add API registration to the Application user</li>
  1123. <li>Add the user to the group</li>
  1124. <li>Add the Secrets Safe Feature to the group</li>
  1125. </ol>
  1126. <blockquote>
  1127. <p>NOTE: The ClentID and ClientSecret must be stored in a Kubernetes secret in order for the SecretStore to read the configuration.</p>
  1128. </blockquote>
  1129. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>bt-secret<span class="w"> </span>--from-literal<span class="w"> </span><span class="nv">ClientSecret</span><span class="o">=</span><span class="s2">&quot;&lt;your secret&gt;&quot;</span>
  1130. kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>bt-id<span class="w"> </span>--from-literal<span class="w"> </span><span class="nv">ClientId</span><span class="o">=</span><span class="s2">&quot;&lt;your ID&gt;&quot;</span>
  1131. </code></pre></div>
  1132. <h3 id="client-certificate">Client Certificate</h3>
  1133. <p>Download the pfx certificate from Secrets Safe extract the certificate and create two Kubernetes secret.</p>
  1134. <div class="highlight"><pre><span></span><code>openssl<span class="w"> </span>pkcs12<span class="w"> </span>-in<span class="w"> </span>client_certificate.pfx<span class="w"> </span>-nocerts<span class="w"> </span>-out<span class="w"> </span>ps_key.pem<span class="w"> </span>-nodes
  1135. openssl<span class="w"> </span>pkcs12<span class="w"> </span>-in<span class="w"> </span>client_certificate.pfx<span class="w"> </span>-clcerts<span class="w"> </span>-nokeys<span class="w"> </span>-out<span class="w"> </span>ps_cert.pem
  1136. <span class="c1"># Copy the text from the ps_key.pem to a file.</span>
  1137. -----BEGIN<span class="w"> </span>PRIVATE<span class="w"> </span>KEY-----
  1138. ...
  1139. -----END<span class="w"> </span>PRIVATE<span class="w"> </span>KEY-----
  1140. <span class="c1"># Copy the text from the ps_cert.pem to a file.</span>
  1141. -----BEGIN<span class="w"> </span>CERTIFICATE-----
  1142. ...
  1143. -----END<span class="w"> </span>CERTIFICATE-----
  1144. kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>bt-certificate<span class="w"> </span>--from-file<span class="o">=</span><span class="nv">ClientCertificate</span><span class="o">=</span>./ps_cert.pem
  1145. kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>bt-certificatekey<span class="w"> </span>--from-file<span class="o">=</span><span class="nv">ClientCertificateKey</span><span class="o">=</span>./ps_key.pem
  1146. </code></pre></div>
  1147. <h3 id="creating-a-secretstore">Creating a SecretStore</h3>
  1148. <p>You can follow the below example to create a <code>SecretStore</code> resource.
  1149. You can also use a <code>ClusterSecretStore</code> allowing you to reference secrets from all namespaces. <a href="https://external-secrets.io/latest/api/clustersecretstore/">ClusterSecretStore</a></p>
  1150. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>secret-store.yml
  1151. </code></pre></div>
  1152. <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">external-secrets.io/v1beta1</span>
  1153. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1154. <span class="nt">metadata</span><span class="p">:</span>
  1155. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-beyondtrust</span>
  1156. <span class="nt">spec</span><span class="p">:</span>
  1157. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1158. <span class="w"> </span><span class="nt">beyondtrust</span><span class="p">:</span>
  1159. <span class="w"> </span><span class="nt">apiurl</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://example.com:443/BeyondTrust/api/public/v3/</span>
  1160. <span class="w"> </span><span class="nt">certificate</span><span class="p">:</span>
  1161. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1162. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt-certificate</span>
  1163. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClientCertificate</span>
  1164. <span class="w"> </span><span class="nt">certificatekey</span><span class="p">:</span>
  1165. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1166. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt-certificatekey</span>
  1167. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClientCertificateKey</span>
  1168. <span class="w"> </span><span class="nt">clientsecret</span><span class="p">:</span>
  1169. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1170. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt-secret</span>
  1171. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClientSecret</span>
  1172. <span class="w"> </span><span class="nt">clientid</span><span class="p">:</span>
  1173. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1174. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt-id</span>
  1175. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClientId</span>
  1176. <span class="w"> </span><span class="nt">retrievaltype</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MANAGED_ACCOUNT</span>
  1177. <span class="w"> </span><span class="nt">verifyca</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1178. <span class="w"> </span><span class="nt">clienttimeoutseconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</span>
  1179. </code></pre></div>
  1180. <h3 id="creating-a-externalsecret">Creating a ExternalSecret</h3>
  1181. <p>You can follow the below example to create a <code>ExternalSecret</code> resource. Secrets can be referenced by path.
  1182. You can also use a <code>ClusterExternalSecret</code> allowing you to reference secrets from all namespaces.</p>
  1183. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>external-secret.yml
  1184. </code></pre></div>
  1185. <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">external-secrets.io/v1beta1</span>
  1186. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1187. <span class="nt">metadata</span><span class="p">:</span>
  1188. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">beyondtrust-external-secret</span>
  1189. <span class="nt">spec</span><span class="p">:</span>
  1190. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">300s</span>
  1191. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1192. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1193. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-beyondtrust</span>
  1194. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1195. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-beyondtrust-secret</span><span class="w"> </span><span class="c1"># name of secret to create in k8s secrets (etcd)</span>
  1196. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span>
  1197. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1198. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretKey</span>
  1199. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1200. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system01/managed_account01</span>
  1201. </code></pre></div>
  1202. <h3 id="get-the-k8s-secret">Get the K8s secret</h3>
  1203. <div class="highlight"><pre><span></span><code><span class="c1"># WARNING: this command will reveal the stored secret in plain text</span>
  1204. kubectl<span class="w"> </span>get<span class="w"> </span>secret<span class="w"> </span>my-beyondtrust-secret<span class="w"> </span>-o<span class="w"> </span><span class="nv">jsonpath</span><span class="o">=</span><span class="s2">&quot;{.data.secretKey}&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>base64<span class="w"> </span>--decode<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nb">echo</span>
  1205. </code></pre></div>
  1206. </article>
  1207. </div>
  1208. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1209. </div>
  1210. </main>
  1211. <footer class="md-footer">
  1212. <div class="md-footer-meta md-typeset">
  1213. <div class="md-footer-meta__inner md-grid">
  1214. <div class="md-copyright">
  1215. <div class="md-copyright__highlight">
  1216. &copy; 2024 The external-secrets Authors.<br/>
  1217. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1218. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1219. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1220. </div>
  1221. Made with
  1222. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1223. Material for MkDocs
  1224. </a>
  1225. </div>
  1226. </div>
  1227. </div>
  1228. </footer>
  1229. </div>
  1230. <div class="md-dialog" data-md-component="dialog">
  1231. <div class="md-dialog__inner md-typeset"></div>
  1232. </div>
  1233. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1234. <script src="../../assets/javascripts/bundle.af256bd8.min.js"></script>
  1235. </body>
  1236. </html>