index.html 80 KB

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