index.html 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420
  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>Delinea Secret Server - 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="#delinea-secret-server" 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. Delinea Secret Server
  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="#creating-a-secretstore" class="md-nav__link">
  1050. <span class="md-ellipsis">
  1051. Creating a SecretStore
  1052. </span>
  1053. </a>
  1054. </li>
  1055. <li class="md-nav__item">
  1056. <a href="#referencing-secrets" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Referencing Secrets
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="#preparing-your-secret" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Preparing your secret
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="#examples" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Examples
  1073. </span>
  1074. </a>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </div>
  1079. </div>
  1080. </div>
  1081. <div class="md-content" data-md-component="content">
  1082. <article class="md-content__inner md-typeset">
  1083. <h1 id="delinea-secret-server">Delinea Secret Server</h1>
  1084. <p>External Secrets Operator integration with <a href="https://docs.delinea.com/online-help/secret-server/start.htm">Delinea Secret Server</a>.</p>
  1085. <h3 id="creating-a-secretstore">Creating a SecretStore</h3>
  1086. <p>You need a username, password and a fully qualified Secret Server tenant URL to authenticate
  1087. i.e. <code>https://yourTenantName.secretservercloud.com</code>.</p>
  1088. <p>Both username and password can be specified either directly in your <code>SecretStore</code> yaml config, or by referencing a kubernetes secret.</p>
  1089. <p>To acquire a username and password, refer to the Secret Server <a href="https://docs.delinea.com/online-help/secret-server/users/creating-users/index.htm">user management</a> documentation.</p>
  1090. <p>Both <code>username</code> and <code>password</code> can either be specified directly via the <code>value</code> field (example below)</p>
  1091. <blockquote>
  1092. <p>spec.provider.secretserver.username.value: "yourusername"<br />
  1093. spec.provider.secretserver.password.value: "yourpassword" <br /></p>
  1094. </blockquote>
  1095. <p>Or you can reference a kubernetes secret (password example below).</p>
  1096. <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>
  1097. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1098. <span class="nt">metadata</span><span class="p">:</span>
  1099. <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">secret-server-store</span>
  1100. <span class="nt">spec</span><span class="p">:</span>
  1101. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1102. <span class="w"> </span><span class="nt">secretserver</span><span class="p">:</span>
  1103. <span class="w"> </span><span class="nt">serverURL</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://yourtenantname.secretservercloud.com&quot;</span>
  1104. <span class="w"> </span><span class="nt">username</span><span class="p">:</span>
  1105. <span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;yourusername&quot;</span>
  1106. <span class="w"> </span><span class="nt">password</span><span class="p">:</span>
  1107. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1108. <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">&lt;NAME_OF_K8S_SECRET&gt;</span>
  1109. <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">&lt;KEY_IN_K8S_SECRET&gt;</span>
  1110. </code></pre></div>
  1111. <h3 id="referencing-secrets">Referencing Secrets</h3>
  1112. <p>Secrets may be referenced by secret ID or secret name.</p>
  1113. <blockquote>
  1114. <p>Please note if using the secret name
  1115. the name field must not contain spaces or control characters.<br />
  1116. If multiple secrets are found, <em><code>only the first found secret will be returned</code></em>.</p>
  1117. </blockquote>
  1118. <p>Please note: <code>Retrieving a specific version of a secret is not yet supported.</code></p>
  1119. <p>Note that because all Secret Server secrets are JSON objects, you must specify the <code>remoteRef.property</code>
  1120. in your ExternalSecret configuration.<br />
  1121. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>.</p>
  1122. <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>
  1123. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1124. <span class="nt">metadata</span><span class="p">:</span>
  1125. <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">secret-server-external-secret</span>
  1126. <span class="nt">spec</span><span class="p">:</span>
  1127. <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">15s</span>
  1128. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1129. <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>
  1130. <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">secret-server-store</span>
  1131. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1132. <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">SecretServerValue</span><span class="w"> </span><span class="c1">#&lt;SECRET_VALUE_RETURNED_HERE&gt;</span>
  1133. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1134. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;52622&quot;</span><span class="w"> </span><span class="c1">#&lt;SECRET_ID&gt;</span>
  1135. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;array.0.value&quot;</span><span class="w"> </span><span class="c1">#&lt;GJSON_PROPERTY&gt; * an empty property will return the entire secret</span>
  1136. </code></pre></div>
  1137. <h3 id="preparing-your-secret">Preparing your secret</h3>
  1138. <p>You can either retrieve your entire secret or you can use a JSON formatted string
  1139. stored in your secret located at Items[0].ItemValue to retrieve a specific value.<br />
  1140. See example JSON secret below.</p>
  1141. <h3 id="examples">Examples</h3>
  1142. <p>Using the json formatted secret below:</p>
  1143. <ul>
  1144. <li>Lookup a single top level property using secret ID.</li>
  1145. </ul>
  1146. <blockquote>
  1147. <p>spec.data.remoteRef.key = 52622 (id of the secret)<br />
  1148. spec.data.remoteRef.property = "user" (Items.0.ItemValue user attribute)<br />
  1149. returns: marktwain@hannibal.com</p>
  1150. </blockquote>
  1151. <ul>
  1152. <li>Lookup a nested property using secret name.</li>
  1153. </ul>
  1154. <blockquote>
  1155. <p>spec.data.remoteRef.key = "external-secret-testing" (name of the secret)<br />
  1156. spec.data.remoteRef.property = "books.1" (Items.0.ItemValue books.1 attribute)<br />
  1157. returns: huckleberryFinn</p>
  1158. </blockquote>
  1159. <ul>
  1160. <li>Lookup by secret ID (<em>secret name will work as well</em>) and return the entire secret.</li>
  1161. </ul>
  1162. <blockquote>
  1163. <p>spec.data.remoteRef.key = "52622" (id of the secret)<br />
  1164. spec.data.remoteRef.property = "" <br />
  1165. returns: The entire secret in JSON format as displayed below</p>
  1166. </blockquote>
  1167. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1168. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;external-secret-testing&quot;</span><span class="p">,</span>
  1169. <span class="w"> </span><span class="nt">&quot;FolderID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">73</span><span class="p">,</span>
  1170. <span class="w"> </span><span class="nt">&quot;ID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">52622</span><span class="p">,</span>
  1171. <span class="w"> </span><span class="nt">&quot;SiteID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
  1172. <span class="w"> </span><span class="nt">&quot;SecretTemplateID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">6098</span><span class="p">,</span>
  1173. <span class="w"> </span><span class="nt">&quot;SecretPolicyID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1174. <span class="w"> </span><span class="nt">&quot;PasswordTypeWebScriptID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1175. <span class="w"> </span><span class="nt">&quot;LauncherConnectAsSecretID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1176. <span class="w"> </span><span class="nt">&quot;CheckOutIntervalMinutes&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
  1177. <span class="w"> </span><span class="nt">&quot;Active&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1178. <span class="w"> </span><span class="nt">&quot;CheckedOut&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1179. <span class="w"> </span><span class="nt">&quot;CheckOutEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1180. <span class="w"> </span><span class="nt">&quot;AutoChangeEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1181. <span class="w"> </span><span class="nt">&quot;CheckOutChangePasswordEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1182. <span class="w"> </span><span class="nt">&quot;DelayIndexing&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1183. <span class="w"> </span><span class="nt">&quot;EnableInheritPermissions&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1184. <span class="w"> </span><span class="nt">&quot;EnableInheritSecretPolicy&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
  1185. <span class="w"> </span><span class="nt">&quot;ProxyEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1186. <span class="w"> </span><span class="nt">&quot;RequiresComment&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1187. <span class="w"> </span><span class="nt">&quot;SessionRecordingEnabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1188. <span class="w"> </span><span class="nt">&quot;WebLauncherRequiresIncognitoMode&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1189. <span class="w"> </span><span class="nt">&quot;Items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1190. <span class="w"> </span><span class="p">{</span>
  1191. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">280265</span><span class="p">,</span>
  1192. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">439</span><span class="p">,</span>
  1193. <span class="w"> </span><span class="nt">&quot;FileAttachmentID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1194. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Data&quot;</span><span class="p">,</span>
  1195. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;data&quot;</span><span class="p">,</span>
  1196. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;json text field&quot;</span><span class="p">,</span>
  1197. <span class="w"> </span><span class="nt">&quot;Filename&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1198. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{ \&quot;user\&quot;: \&quot;marktwain@hannibal.com\&quot;, \&quot;occupation\&quot;: \&quot;author\&quot;,\&quot;books\&quot;:[ \&quot;tomSawyer\&quot;,\&quot;huckleberryFinn\&quot;,\&quot;Pudd&#39;nhead Wilson\&quot;] }&quot;</span><span class="p">,</span>
  1199. <span class="w"> </span><span class="nt">&quot;IsFile&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1200. <span class="w"> </span><span class="nt">&quot;IsNotes&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1201. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1202. <span class="w"> </span><span class="p">}</span>
  1203. <span class="w"> </span><span class="p">]</span>
  1204. <span class="p">}</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>