index.html 82 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825
  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="prev" href="../delinea/">
  7. <link rel="next" href="../passbolt/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
  10. <title>Secret Server - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#delinea-secret-server" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Secret Server
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var 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(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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.52 6.52 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 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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.52 6.52 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 5"/></svg>
  85. <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 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/sts/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. AWS STS Session Token
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/cluster/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Cluster Generator
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/gcr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Google Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/quay/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Quay
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/vault/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Vault Dynamic Secret
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/password/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Password
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/fake/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Fake
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/webhook/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Webhook
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/github/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Github
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/uuid/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. UUID
  405. </span>
  406. </a>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  413. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  414. <span class="md-ellipsis">
  415. Reference Docs
  416. </span>
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  420. <label class="md-nav__title" for="__nav_2_4">
  421. <span class="md-nav__icon md-icon"></span>
  422. Reference Docs
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../../api/spec/" class="md-nav__link">
  427. <span class="md-ellipsis">
  428. API specification
  429. </span>
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../../api/controller-options/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Controller Options
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item">
  440. <a href="../../api/metrics/" class="md-nav__link">
  441. <span class="md-ellipsis">
  442. Metrics
  443. </span>
  444. </a>
  445. </li>
  446. </ul>
  447. </nav>
  448. </li>
  449. </ul>
  450. </nav>
  451. </li>
  452. <li class="md-nav__item md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  454. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  455. <span class="md-ellipsis">
  456. Guides
  457. </span>
  458. <span class="md-nav__icon md-icon"></span>
  459. </label>
  460. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  461. <label class="md-nav__title" for="__nav_3">
  462. <span class="md-nav__icon md-icon"></span>
  463. Guides
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../../guides/introduction/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Introduction
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item md-nav__item--nested">
  474. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  475. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  476. <span class="md-ellipsis">
  477. External Secrets
  478. </span>
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  482. <label class="md-nav__title" for="__nav_3_2">
  483. <span class="md-nav__icon md-icon"></span>
  484. External Secrets
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Extract structured data
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item">
  495. <a href="../../guides/getallsecrets/" class="md-nav__link">
  496. <span class="md-ellipsis">
  497. Find Secrets by Name or Metadata
  498. </span>
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. Rewriting Keys
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  510. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  511. <span class="md-ellipsis">
  512. Advanced Templating
  513. </span>
  514. <span class="md-nav__icon md-icon"></span>
  515. </label>
  516. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  517. <label class="md-nav__title" for="__nav_3_2_4">
  518. <span class="md-nav__icon md-icon"></span>
  519. Advanced Templating
  520. </label>
  521. <ul class="md-nav__list" data-md-scrollfix>
  522. <li class="md-nav__item">
  523. <a href="../../guides/templating/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. v2
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/templating-v1/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. v1
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Kubernetes Secret Types
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Lifecycle: ownership & deletion
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  555. <span class="md-ellipsis">
  556. Decoding Strategies
  557. </span>
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../guides/controller-class/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Controller Classes
  564. </span>
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../guides/generator/" class="md-nav__link">
  572. <span class="md-ellipsis">
  573. Generators
  574. </span>
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../../guides/pushsecrets/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Push Secrets
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item md-nav__item--nested">
  585. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  586. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  587. <span class="md-ellipsis">
  588. Operations
  589. </span>
  590. <span class="md-nav__icon md-icon"></span>
  591. </label>
  592. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  593. <label class="md-nav__title" for="__nav_3_5">
  594. <span class="md-nav__icon md-icon"></span>
  595. Operations
  596. </label>
  597. <ul class="md-nav__list" data-md-scrollfix>
  598. <li class="md-nav__item">
  599. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Multi Tenancy
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/security-best-practices/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Security Best Practices
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/threat-model/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Threat Model
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/v1beta1/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Upgrading to v1beta1
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/using-latest-image/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Using Latest Image
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Disable Cluster Features
  637. </span>
  638. </a>
  639. </li>
  640. </ul>
  641. </nav>
  642. </li>
  643. <li class="md-nav__item md-nav__item--nested">
  644. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  645. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  646. <span class="md-ellipsis">
  647. Tooling
  648. </span>
  649. <span class="md-nav__icon md-icon"></span>
  650. </label>
  651. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  652. <label class="md-nav__title" for="__nav_3_6">
  653. <span class="md-nav__icon md-icon"></span>
  654. Tooling
  655. </label>
  656. <ul class="md-nav__list" data-md-scrollfix>
  657. <li class="md-nav__item">
  658. <a href="../../guides/using-render-tool/" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. Using the Render tool
  661. </span>
  662. </a>
  663. </li>
  664. </ul>
  665. </nav>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  671. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  672. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  673. <span class="md-ellipsis">
  674. Provider
  675. </span>
  676. <span class="md-nav__icon md-icon"></span>
  677. </label>
  678. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  679. <label class="md-nav__title" for="__nav_4">
  680. <span class="md-nav__icon md-icon"></span>
  681. Provider
  682. </label>
  683. <ul class="md-nav__list" data-md-scrollfix>
  684. <li class="md-nav__item">
  685. <a href="../aws-secrets-manager/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. AWS Secrets Manager
  688. </span>
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../aws-parameter-store/" class="md-nav__link">
  693. <span class="md-ellipsis">
  694. AWS Parameter Store
  695. </span>
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../azure-key-vault/" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. Azure Key Vault
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../beyondtrust/" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. BeyondTrust
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. Bitwarden Secrets Manager
  716. </span>
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="../chef/" class="md-nav__link">
  721. <span class="md-ellipsis">
  722. Chef
  723. </span>
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../conjur/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. CyberArk Conjur
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../device42/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Device42
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../google-secrets-manager/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. Google Cloud Secret Manager
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../hashicorp-vault/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. HashiCorp Vault
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../kubernetes/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. Kubernetes
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../ibm-secrets-manager/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. IBM Secrets Manager
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../akeyless/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Akeyless
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../yandex-certificate-manager/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. Yandex Certificate Manager
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../yandex-lockbox/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. Yandex Lockbox
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../alibaba/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. Alibaba Cloud
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../gitlab-variables/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. GitLab Variables
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../oracle-vault/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. Oracle Vault
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../1password-automation/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. 1Password Secrets Automation
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../webhook/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. Webhook
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../fake/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. Fake
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../senhasegura-dsm/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. senhasegura DevOps Secrets Management (DSM)
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../doppler/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. Doppler
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../keeper-security/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. Keeper Security
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../cloak/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Cloak End 2 End Encrypted Secrets
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../scaleway/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Scaleway
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../delinea/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. Delinea
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item md-nav__item--active">
  874. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  875. <label class="md-nav__link md-nav__link--active" for="__toc">
  876. <span class="md-ellipsis">
  877. Secret Server
  878. </span>
  879. <span class="md-nav__icon md-icon"></span>
  880. </label>
  881. <a href="./" class="md-nav__link md-nav__link--active">
  882. <span class="md-ellipsis">
  883. Secret Server
  884. </span>
  885. </a>
  886. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  887. <label class="md-nav__title" for="__toc">
  888. <span class="md-nav__icon md-icon"></span>
  889. Table of contents
  890. </label>
  891. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  892. <li class="md-nav__item">
  893. <a href="#creating-a-secretstore" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Creating a SecretStore
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="#referencing-secrets" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Referencing Secrets
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="#preparing-your-secret" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Preparing your secret
  910. </span>
  911. </a>
  912. <nav class="md-nav" aria-label="Preparing your secret">
  913. <ul class="md-nav__list">
  914. <li class="md-nav__item">
  915. <a href="#examples" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Examples
  918. </span>
  919. </a>
  920. </li>
  921. </ul>
  922. </nav>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="#referencing-secrets-in-multiple-items-secrets" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Referencing Secrets in multiple Items secrets
  928. </span>
  929. </a>
  930. <nav class="md-nav" aria-label="Referencing Secrets in multiple Items secrets">
  931. <ul class="md-nav__list">
  932. <li class="md-nav__item">
  933. <a href="#examples_1" class="md-nav__link">
  934. <span class="md-ellipsis">
  935. Examples
  936. </span>
  937. </a>
  938. </li>
  939. </ul>
  940. </nav>
  941. </li>
  942. </ul>
  943. </nav>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../passbolt/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. Passbolt
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../pulumi/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. Pulumi ESC
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../onboardbase/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Onboardbase
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="../../provider-passworddepot/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Password Depot
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="../fortanix/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Fortanix
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../infisical/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Infisical
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../previder/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Previder
  991. </span>
  992. </a>
  993. </li>
  994. </ul>
  995. </nav>
  996. </li>
  997. <li class="md-nav__item md-nav__item--nested">
  998. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  999. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1000. <span class="md-ellipsis">
  1001. Examples
  1002. </span>
  1003. <span class="md-nav__icon md-icon"></span>
  1004. </label>
  1005. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1006. <label class="md-nav__title" for="__nav_5">
  1007. <span class="md-nav__icon md-icon"></span>
  1008. Examples
  1009. </label>
  1010. <ul class="md-nav__list" data-md-scrollfix>
  1011. <li class="md-nav__item">
  1012. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1013. <span class="md-ellipsis">
  1014. FluxCD
  1015. </span>
  1016. </a>
  1017. </li>
  1018. <li class="md-nav__item">
  1019. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Anchore Engine
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Jenkins
  1029. </span>
  1030. </a>
  1031. </li>
  1032. <li class="md-nav__item">
  1033. <a href="../../examples/bitwarden/" class="md-nav__link">
  1034. <span class="md-ellipsis">
  1035. BitWarden
  1036. </span>
  1037. </a>
  1038. </li>
  1039. </ul>
  1040. </nav>
  1041. </li>
  1042. <li class="md-nav__item md-nav__item--nested">
  1043. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1044. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1045. <span class="md-ellipsis">
  1046. Community
  1047. </span>
  1048. <span class="md-nav__icon md-icon"></span>
  1049. </label>
  1050. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1051. <label class="md-nav__title" for="__nav_6">
  1052. <span class="md-nav__icon md-icon"></span>
  1053. Community
  1054. </label>
  1055. <ul class="md-nav__list" data-md-scrollfix>
  1056. <li class="md-nav__item md-nav__item--nested">
  1057. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1058. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1059. <span class="md-ellipsis">
  1060. Contributing
  1061. </span>
  1062. <span class="md-nav__icon md-icon"></span>
  1063. </label>
  1064. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1065. <label class="md-nav__title" for="__nav_6_1">
  1066. <span class="md-nav__icon md-icon"></span>
  1067. Contributing
  1068. </label>
  1069. <ul class="md-nav__list" data-md-scrollfix>
  1070. <li class="md-nav__item">
  1071. <a href="../../contributing/devguide/" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. Developer guide
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="../../contributing/process/" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Contributing Process
  1081. </span>
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="../../contributing/release/" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Release Process
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="../../contributing/coc/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Code of Conduct
  1095. </span>
  1096. </a>
  1097. </li>
  1098. <li class="md-nav__item">
  1099. <a href="../../contributing/roadmap/" class="md-nav__link">
  1100. <span class="md-ellipsis">
  1101. Roadmap
  1102. </span>
  1103. </a>
  1104. </li>
  1105. </ul>
  1106. </nav>
  1107. </li>
  1108. <li class="md-nav__item md-nav__item--nested">
  1109. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1110. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1111. <span class="md-ellipsis">
  1112. External Resources
  1113. </span>
  1114. <span class="md-nav__icon md-icon"></span>
  1115. </label>
  1116. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1117. <label class="md-nav__title" for="__nav_6_2">
  1118. <span class="md-nav__icon md-icon"></span>
  1119. External Resources
  1120. </label>
  1121. <ul class="md-nav__list" data-md-scrollfix>
  1122. <li class="md-nav__item">
  1123. <a href="../../eso-talks/" class="md-nav__link">
  1124. <span class="md-ellipsis">
  1125. Talks
  1126. </span>
  1127. </a>
  1128. </li>
  1129. <li class="md-nav__item">
  1130. <a href="../../eso-demos/" class="md-nav__link">
  1131. <span class="md-ellipsis">
  1132. Demos
  1133. </span>
  1134. </a>
  1135. </li>
  1136. <li class="md-nav__item">
  1137. <a href="../../eso-blogs/" class="md-nav__link">
  1138. <span class="md-ellipsis">
  1139. Blogs
  1140. </span>
  1141. </a>
  1142. </li>
  1143. <li class="md-nav__item">
  1144. <a href="../../eso-tools/" class="md-nav__link">
  1145. <span class="md-ellipsis">
  1146. Tools
  1147. </span>
  1148. </a>
  1149. </li>
  1150. </ul>
  1151. </nav>
  1152. </li>
  1153. </ul>
  1154. </nav>
  1155. </li>
  1156. </ul>
  1157. </nav>
  1158. </div>
  1159. </div>
  1160. </div>
  1161. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1162. <div class="md-sidebar__scrollwrap">
  1163. <div class="md-sidebar__inner">
  1164. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1165. <label class="md-nav__title" for="__toc">
  1166. <span class="md-nav__icon md-icon"></span>
  1167. Table of contents
  1168. </label>
  1169. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1170. <li class="md-nav__item">
  1171. <a href="#creating-a-secretstore" class="md-nav__link">
  1172. <span class="md-ellipsis">
  1173. Creating a SecretStore
  1174. </span>
  1175. </a>
  1176. </li>
  1177. <li class="md-nav__item">
  1178. <a href="#referencing-secrets" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Referencing Secrets
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="#preparing-your-secret" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Preparing your secret
  1188. </span>
  1189. </a>
  1190. <nav class="md-nav" aria-label="Preparing your secret">
  1191. <ul class="md-nav__list">
  1192. <li class="md-nav__item">
  1193. <a href="#examples" class="md-nav__link">
  1194. <span class="md-ellipsis">
  1195. Examples
  1196. </span>
  1197. </a>
  1198. </li>
  1199. </ul>
  1200. </nav>
  1201. </li>
  1202. <li class="md-nav__item">
  1203. <a href="#referencing-secrets-in-multiple-items-secrets" class="md-nav__link">
  1204. <span class="md-ellipsis">
  1205. Referencing Secrets in multiple Items secrets
  1206. </span>
  1207. </a>
  1208. <nav class="md-nav" aria-label="Referencing Secrets in multiple Items secrets">
  1209. <ul class="md-nav__list">
  1210. <li class="md-nav__item">
  1211. <a href="#examples_1" class="md-nav__link">
  1212. <span class="md-ellipsis">
  1213. Examples
  1214. </span>
  1215. </a>
  1216. </li>
  1217. </ul>
  1218. </nav>
  1219. </li>
  1220. </ul>
  1221. </nav>
  1222. </div>
  1223. </div>
  1224. </div>
  1225. <div class="md-content" data-md-component="content">
  1226. <article class="md-content__inner md-typeset">
  1227. <h1 id="delinea-secret-server">Delinea Secret Server</h1>
  1228. <p>External Secrets Operator integration with <a href="https://docs.delinea.com/online-help/secret-server/start.htm">Delinea Secret Server</a>.</p>
  1229. <h3 id="creating-a-secretstore">Creating a SecretStore</h3>
  1230. <p>You need a username, password and a fully qualified Secret Server tenant URL to authenticate
  1231. i.e. <code>https://yourTenantName.secretservercloud.com</code>.</p>
  1232. <p>Both username and password can be specified either directly in your <code>SecretStore</code> yaml config, or by referencing a kubernetes secret.</p>
  1233. <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>
  1234. <p>Both <code>username</code> and <code>password</code> can either be specified directly via the <code>value</code> field (example below)</p>
  1235. <blockquote>
  1236. <p>spec.provider.secretserver.username.value: "yourusername"<br />
  1237. spec.provider.secretserver.password.value: "yourpassword" <br /></p>
  1238. </blockquote>
  1239. <p>Or you can reference a kubernetes secret (password example below).</p>
  1240. <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>
  1241. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1242. <span class="nt">metadata</span><span class="p">:</span>
  1243. <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>
  1244. <span class="nt">spec</span><span class="p">:</span>
  1245. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1246. <span class="w"> </span><span class="nt">secretserver</span><span class="p">:</span>
  1247. <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>
  1248. <span class="w"> </span><span class="nt">username</span><span class="p">:</span>
  1249. <span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;yourusername&quot;</span>
  1250. <span class="w"> </span><span class="nt">password</span><span class="p">:</span>
  1251. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1252. <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>
  1253. <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>
  1254. </code></pre></div>
  1255. <h3 id="referencing-secrets">Referencing Secrets</h3>
  1256. <p>Secrets may be referenced by secret ID or secret name.</p>
  1257. <blockquote>
  1258. <p>Please note if using the secret name
  1259. the name field must not contain spaces or control characters.<br />
  1260. If multiple secrets are found, <em><code>only the first found secret will be returned</code></em>.</p>
  1261. </blockquote>
  1262. <p>Please note: <code>Retrieving a specific version of a secret is not yet supported.</code></p>
  1263. <p>Note that because all Secret Server secrets are JSON objects, you must specify the <code>remoteRef.property</code>
  1264. in your ExternalSecret configuration.<br />
  1265. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>.</p>
  1266. <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>
  1267. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1268. <span class="nt">metadata</span><span class="p">:</span>
  1269. <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>
  1270. <span class="nt">spec</span><span class="p">:</span>
  1271. <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">1h</span>
  1272. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1273. <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>
  1274. <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>
  1275. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1276. <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>
  1277. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1278. <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>
  1279. <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>
  1280. </code></pre></div>
  1281. <h3 id="preparing-your-secret">Preparing your secret</h3>
  1282. <p>You can either retrieve your entire secret or you can use a JSON formatted string
  1283. stored in your secret located at Items[0].ItemValue to retrieve a specific value.<br />
  1284. See example JSON secret below.</p>
  1285. <h4 id="examples">Examples</h4>
  1286. <p>Using the json formatted secret below:</p>
  1287. <ul>
  1288. <li>Lookup a single top level property using secret ID.</li>
  1289. </ul>
  1290. <blockquote>
  1291. <p>spec.data.remoteRef.key = 52622 (id of the secret)<br />
  1292. spec.data.remoteRef.property = "user" (Items.0.ItemValue user attribute)<br />
  1293. returns: marktwain@hannibal.com</p>
  1294. </blockquote>
  1295. <ul>
  1296. <li>Lookup a nested property using secret name.</li>
  1297. </ul>
  1298. <blockquote>
  1299. <p>spec.data.remoteRef.key = "external-secret-testing" (name of the secret)<br />
  1300. spec.data.remoteRef.property = "books.1" (Items.0.ItemValue books.1 attribute)<br />
  1301. returns: huckleberryFinn</p>
  1302. </blockquote>
  1303. <ul>
  1304. <li>Lookup by secret ID (<em>secret name will work as well</em>) and return the entire secret.</li>
  1305. </ul>
  1306. <blockquote>
  1307. <p>spec.data.remoteRef.key = "52622" (id of the secret)<br />
  1308. spec.data.remoteRef.property = "" <br />
  1309. returns: The entire secret in JSON format as displayed below</p>
  1310. </blockquote>
  1311. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1312. <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>
  1313. <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>
  1314. <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>
  1315. <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>
  1316. <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>
  1317. <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>
  1318. <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>
  1319. <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>
  1320. <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>
  1321. <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>
  1322. <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>
  1323. <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>
  1324. <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>
  1325. <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>
  1326. <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>
  1327. <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>
  1328. <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>
  1329. <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>
  1330. <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>
  1331. <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>
  1332. <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>
  1333. <span class="w"> </span><span class="nt">&quot;Items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1334. <span class="w"> </span><span class="p">{</span>
  1335. <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>
  1336. <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>
  1337. <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>
  1338. <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>
  1339. <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>
  1340. <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>
  1341. <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>
  1342. <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>
  1343. <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>
  1344. <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>
  1345. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1346. <span class="w"> </span><span class="p">}</span>
  1347. <span class="w"> </span><span class="p">]</span>
  1348. <span class="p">}</span>
  1349. </code></pre></div>
  1350. <h3 id="referencing-secrets-in-multiple-items-secrets">Referencing Secrets in multiple Items secrets</h3>
  1351. <p>If there is more then one Item in the secret, it supports to retrieve them (all Item.*.ItemValue) looking up by Item.*.FieldName or Item.*.Slug, instead of the above behaviour to use gjson only on the first item Items.0.ItemValue only.</p>
  1352. <h4 id="examples_1">Examples</h4>
  1353. <p>Using the json formatted secret below:</p>
  1354. <ul>
  1355. <li>Lookup a single top level property using secret ID.</li>
  1356. </ul>
  1357. <blockquote>
  1358. <p>spec.data.remoteRef.key = 4000 (id of the secret)<br />
  1359. spec.data.remoteRef.property = "Username" (Items.0.FieldName)<br />
  1360. returns: usernamevalue</p>
  1361. </blockquote>
  1362. <ul>
  1363. <li>Lookup a nested property using secret name.</li>
  1364. </ul>
  1365. <blockquote>
  1366. <p>spec.data.remoteRef.key = "Secretname" (name of the secret)<br />
  1367. spec.data.remoteRef.property = "password" (Items.1.slug)<br />
  1368. returns: passwordvalue</p>
  1369. </blockquote>
  1370. <ul>
  1371. <li>Lookup by secret ID (<em>secret name will work as well</em>) and return the entire secret.</li>
  1372. </ul>
  1373. <blockquote>
  1374. <p>spec.data.remoteRef.key = "4000" (id of the secret)<br />
  1375. returns: The entire secret in JSON format as displayed below</p>
  1376. </blockquote>
  1377. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1378. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Secretname&quot;</span><span class="p">,</span>
  1379. <span class="w"> </span><span class="nt">&quot;FolderID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1380. <span class="w"> </span><span class="nt">&quot;ID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4000</span><span class="p">,</span>
  1381. <span class="w"> </span><span class="nt">&quot;SiteID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1382. <span class="w"> </span><span class="nt">&quot;SecretTemplateID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1383. <span class="w"> </span><span class="nt">&quot;LauncherConnectAsSecretID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1384. <span class="w"> </span><span class="nt">&quot;CheckOutIntervalMinutes&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1385. <span class="w"> </span><span class="nt">&quot;Active&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1386. <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>
  1387. <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>
  1388. <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>
  1389. <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>
  1390. <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>
  1391. <span class="w"> </span><span class="nt">&quot;EnableInheritPermissions&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1392. <span class="w"> </span><span class="nt">&quot;EnableInheritSecretPolicy&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
  1393. <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>
  1394. <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>
  1395. <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>
  1396. <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>
  1397. <span class="w"> </span><span class="nt">&quot;Items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1398. <span class="w"> </span><span class="p">{</span>
  1399. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1400. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1401. <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>
  1402. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Username&quot;</span><span class="p">,</span>
  1403. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;username&quot;</span><span class="p">,</span>
  1404. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1405. <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>
  1406. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;usernamevalue&quot;</span><span class="p">,</span>
  1407. <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>
  1408. <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>
  1409. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1410. <span class="w"> </span><span class="p">},</span>
  1411. <span class="w"> </span><span class="p">{</span>
  1412. <span class="w"> </span><span class="nt">&quot;ItemID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1413. <span class="w"> </span><span class="nt">&quot;FieldID&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
  1414. <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>
  1415. <span class="w"> </span><span class="nt">&quot;FieldName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Password&quot;</span><span class="p">,</span>
  1416. <span class="w"> </span><span class="nt">&quot;Slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;password&quot;</span><span class="p">,</span>
  1417. <span class="w"> </span><span class="nt">&quot;FieldDescription&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
  1418. <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>
  1419. <span class="w"> </span><span class="nt">&quot;ItemValue&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;passwordvalue&quot;</span><span class="p">,</span>
  1420. <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>
  1421. <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>
  1422. <span class="w"> </span><span class="nt">&quot;IsPassword&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
  1423. <span class="w"> </span><span class="p">}</span>
  1424. <span class="w"> </span><span class="p">]</span>
  1425. <span class="p">}</span>
  1426. </code></pre></div>
  1427. </article>
  1428. </div>
  1429. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1430. </div>
  1431. </main>
  1432. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1433. <footer class="md-footer">
  1434. <div class="md-footer-meta md-typeset">
  1435. <div class="md-footer-meta__inner md-grid">
  1436. <div class="md-copyright">
  1437. <div class="md-copyright__highlight">
  1438. &copy; 2024 The external-secrets Authors.<br/>
  1439. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1440. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1441. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1442. </div>
  1443. Made with
  1444. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1445. Material for MkDocs
  1446. </a>
  1447. </div>
  1448. </div>
  1449. </div>
  1450. </footer>
  1451. </div>
  1452. <div class="md-dialog" data-md-component="dialog">
  1453. <div class="md-dialog__inner md-typeset"></div>
  1454. </div>
  1455. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.f8cc74c7.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>
  1456. <script src="../../assets/javascripts/bundle.60a45f97.min.js"></script>
  1457. </body>
  1458. </html>