index.html 83 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805
  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="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
  10. <title>Keeper Security - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.35f28582.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 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>
  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. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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 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>
  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.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>
  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.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>
  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 11z"/></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 12z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" tabindex="0" 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.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></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. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  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.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></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. <li class="md-nav__item">
  363. <a href="../../api/generator/github/" class="md-nav__link">
  364. <span class="md-ellipsis">
  365. Github
  366. </span>
  367. </a>
  368. </li>
  369. <li class="md-nav__item">
  370. <a href="../../api/generator/uuid/" class="md-nav__link">
  371. <span class="md-ellipsis">
  372. UUID
  373. </span>
  374. </a>
  375. </li>
  376. </ul>
  377. </nav>
  378. </li>
  379. <li class="md-nav__item md-nav__item--nested">
  380. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  381. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  382. <span class="md-ellipsis">
  383. Reference Docs
  384. </span>
  385. <span class="md-nav__icon md-icon"></span>
  386. </label>
  387. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  388. <label class="md-nav__title" for="__nav_2_4">
  389. <span class="md-nav__icon md-icon"></span>
  390. Reference Docs
  391. </label>
  392. <ul class="md-nav__list" data-md-scrollfix>
  393. <li class="md-nav__item">
  394. <a href="../../api/spec/" class="md-nav__link">
  395. <span class="md-ellipsis">
  396. API specification
  397. </span>
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../api/controller-options/" class="md-nav__link">
  402. <span class="md-ellipsis">
  403. Controller Options
  404. </span>
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="../../api/metrics/" class="md-nav__link">
  409. <span class="md-ellipsis">
  410. Metrics
  411. </span>
  412. </a>
  413. </li>
  414. </ul>
  415. </nav>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  422. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  423. <span class="md-ellipsis">
  424. Guides
  425. </span>
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  429. <label class="md-nav__title" for="__nav_3">
  430. <span class="md-nav__icon md-icon"></span>
  431. Guides
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../../guides/introduction/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. Introduction
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item md-nav__item--nested">
  442. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  443. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  444. <span class="md-ellipsis">
  445. External Secrets
  446. </span>
  447. <span class="md-nav__icon md-icon"></span>
  448. </label>
  449. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  450. <label class="md-nav__title" for="__nav_3_2">
  451. <span class="md-nav__icon md-icon"></span>
  452. External Secrets
  453. </label>
  454. <ul class="md-nav__list" data-md-scrollfix>
  455. <li class="md-nav__item">
  456. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  457. <span class="md-ellipsis">
  458. Extract structured data
  459. </span>
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../../guides/getallsecrets/" class="md-nav__link">
  464. <span class="md-ellipsis">
  465. Find Secrets by Name or Metadata
  466. </span>
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. Rewriting Keys
  473. </span>
  474. </a>
  475. </li>
  476. <li class="md-nav__item md-nav__item--nested">
  477. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  478. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  479. <span class="md-ellipsis">
  480. Advanced Templating
  481. </span>
  482. <span class="md-nav__icon md-icon"></span>
  483. </label>
  484. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  485. <label class="md-nav__title" for="__nav_3_2_4">
  486. <span class="md-nav__icon md-icon"></span>
  487. Advanced Templating
  488. </label>
  489. <ul class="md-nav__list" data-md-scrollfix>
  490. <li class="md-nav__item">
  491. <a href="../../guides/templating/" class="md-nav__link">
  492. <span class="md-ellipsis">
  493. v2
  494. </span>
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../../guides/templating-v1/" class="md-nav__link">
  499. <span class="md-ellipsis">
  500. v1
  501. </span>
  502. </a>
  503. </li>
  504. </ul>
  505. </nav>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Kubernetes Secret Types
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Lifecycle: ownership & deletion
  518. </span>
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  523. <span class="md-ellipsis">
  524. Decoding Strategies
  525. </span>
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../guides/controller-class/" class="md-nav__link">
  530. <span class="md-ellipsis">
  531. Controller Classes
  532. </span>
  533. </a>
  534. </li>
  535. </ul>
  536. </nav>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../guides/generator/" class="md-nav__link">
  540. <span class="md-ellipsis">
  541. Generators
  542. </span>
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../guides/pushsecrets/" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. Push Secrets
  549. </span>
  550. </a>
  551. </li>
  552. <li class="md-nav__item md-nav__item--nested">
  553. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  554. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  555. <span class="md-ellipsis">
  556. Operations
  557. </span>
  558. <span class="md-nav__icon md-icon"></span>
  559. </label>
  560. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  561. <label class="md-nav__title" for="__nav_3_5">
  562. <span class="md-nav__icon md-icon"></span>
  563. Operations
  564. </label>
  565. <ul class="md-nav__list" data-md-scrollfix>
  566. <li class="md-nav__item">
  567. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Multi Tenancy
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../guides/security-best-practices/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Security Best Practices
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../guides/threat-model/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Threat Model
  584. </span>
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../../guides/v1beta1/" class="md-nav__link">
  589. <span class="md-ellipsis">
  590. Upgrading to v1beta1
  591. </span>
  592. </a>
  593. </li>
  594. <li class="md-nav__item">
  595. <a href="../../guides/using-latest-image/" class="md-nav__link">
  596. <span class="md-ellipsis">
  597. Using Latest Image
  598. </span>
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  603. <span class="md-ellipsis">
  604. Disable Cluster Features
  605. </span>
  606. </a>
  607. </li>
  608. </ul>
  609. </nav>
  610. </li>
  611. </ul>
  612. </nav>
  613. </li>
  614. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  615. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  616. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  617. <span class="md-ellipsis">
  618. Provider
  619. </span>
  620. <span class="md-nav__icon md-icon"></span>
  621. </label>
  622. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  623. <label class="md-nav__title" for="__nav_4">
  624. <span class="md-nav__icon md-icon"></span>
  625. Provider
  626. </label>
  627. <ul class="md-nav__list" data-md-scrollfix>
  628. <li class="md-nav__item">
  629. <a href="../aws-secrets-manager/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. AWS Secrets Manager
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../aws-parameter-store/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. AWS Parameter Store
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../azure-key-vault/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Azure Key Vault
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../beyondtrust/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. BeyoundTrust
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Bitwarden Secrets Manager
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../chef/" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. Chef
  667. </span>
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../conjur/" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. CyberArk Conjur
  674. </span>
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../device42/" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Device42
  681. </span>
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../google-secrets-manager/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Google Cloud Secret Manager
  688. </span>
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../hashicorp-vault/" class="md-nav__link">
  693. <span class="md-ellipsis">
  694. HashiCorp Vault
  695. </span>
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../kubernetes/" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. Kubernetes
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../ibm-secrets-manager/" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. IBM Secrets Manager
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../akeyless/" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. Akeyless
  716. </span>
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="../yandex-certificate-manager/" class="md-nav__link">
  721. <span class="md-ellipsis">
  722. Yandex Certificate Manager
  723. </span>
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../yandex-lockbox/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. Yandex Lockbox
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../alibaba/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Alibaba Cloud
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../gitlab-variables/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. GitLab Variables
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../oracle-vault/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Oracle Vault
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../1password-automation/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. 1Password Secrets Automation
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../webhook/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Webhook
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../fake/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Fake
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../senhasegura-dsm/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. senhasegura DevOps Secrets Management (DSM)
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../doppler/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. Doppler
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item md-nav__item--active">
  790. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  791. <label class="md-nav__link md-nav__link--active" for="__toc">
  792. <span class="md-ellipsis">
  793. Keeper Security
  794. </span>
  795. <span class="md-nav__icon md-icon"></span>
  796. </label>
  797. <a href="./" class="md-nav__link md-nav__link--active">
  798. <span class="md-ellipsis">
  799. Keeper Security
  800. </span>
  801. </a>
  802. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  803. <label class="md-nav__title" for="__toc">
  804. <span class="md-nav__icon md-icon"></span>
  805. Table of contents
  806. </label>
  807. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  808. <li class="md-nav__item">
  809. <a href="#keeper-security" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Keeper Security
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="#authentication" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Authentication
  819. </span>
  820. </a>
  821. <nav class="md-nav" aria-label="Authentication">
  822. <ul class="md-nav__list">
  823. <li class="md-nav__item">
  824. <a href="#secrets-manager-configuration-smc" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Secrets Manager Configuration (SMC)
  827. </span>
  828. </a>
  829. <nav class="md-nav" aria-label="Secrets Manager Configuration (SMC)">
  830. <ul class="md-nav__list">
  831. <li class="md-nav__item">
  832. <a href="#creating-secrets-manager-configuration" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. Creating Secrets Manager Configuration
  835. </span>
  836. </a>
  837. </li>
  838. </ul>
  839. </nav>
  840. </li>
  841. </ul>
  842. </nav>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="#important-note-about-this-documentation" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Important note about this documentation
  848. </span>
  849. </a>
  850. <nav class="md-nav" aria-label="Important note about this documentation">
  851. <ul class="md-nav__list">
  852. <li class="md-nav__item">
  853. <a href="#update-secret-store" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. Update secret store
  856. </span>
  857. </a>
  858. </li>
  859. </ul>
  860. </nav>
  861. </li>
  862. <li class="md-nav__item">
  863. <a href="#external-secrets" class="md-nav__link">
  864. <span class="md-ellipsis">
  865. External Secrets
  866. </span>
  867. </a>
  868. <nav class="md-nav" aria-label="External Secrets">
  869. <ul class="md-nav__list">
  870. <li class="md-nav__item">
  871. <a href="#behavior" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Behavior
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="#creating-external-secret" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Creating external secret
  881. </span>
  882. </a>
  883. </li>
  884. </ul>
  885. </nav>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="#limitations" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Limitations
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="#push-secrets" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Push Secrets
  898. </span>
  899. </a>
  900. <nav class="md-nav" aria-label="Push Secrets">
  901. <ul class="md-nav__list">
  902. <li class="md-nav__item">
  903. <a href="#behavior_1" class="md-nav__link">
  904. <span class="md-ellipsis">
  905. Behavior
  906. </span>
  907. </a>
  908. </li>
  909. <li class="md-nav__item">
  910. <a href="#creating-push-secret" class="md-nav__link">
  911. <span class="md-ellipsis">
  912. Creating push secret
  913. </span>
  914. </a>
  915. </li>
  916. <li class="md-nav__item">
  917. <a href="#limitations_1" class="md-nav__link">
  918. <span class="md-ellipsis">
  919. Limitations
  920. </span>
  921. </a>
  922. </li>
  923. </ul>
  924. </nav>
  925. </li>
  926. </ul>
  927. </nav>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../cloak/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Cloak End 2 End Encrypted Secrets
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../scaleway/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Scaleway
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../delinea/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Delinea
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../secretserver/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Secret Server
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../passbolt/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Passbolt
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item">
  965. <a href="../pulumi/" class="md-nav__link">
  966. <span class="md-ellipsis">
  967. Pulumi ESC
  968. </span>
  969. </a>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="../onboardbase/" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. Onboardbase
  975. </span>
  976. </a>
  977. </li>
  978. <li class="md-nav__item">
  979. <a href="../../provider-passworddepot/" class="md-nav__link">
  980. <span class="md-ellipsis">
  981. Password Depot
  982. </span>
  983. </a>
  984. </li>
  985. <li class="md-nav__item">
  986. <a href="../fortanix/" class="md-nav__link">
  987. <span class="md-ellipsis">
  988. Fortanix
  989. </span>
  990. </a>
  991. </li>
  992. <li class="md-nav__item">
  993. <a href="../infisical/" class="md-nav__link">
  994. <span class="md-ellipsis">
  995. Infisical
  996. </span>
  997. </a>
  998. </li>
  999. </ul>
  1000. </nav>
  1001. </li>
  1002. <li class="md-nav__item md-nav__item--nested">
  1003. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1004. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1005. <span class="md-ellipsis">
  1006. Examples
  1007. </span>
  1008. <span class="md-nav__icon md-icon"></span>
  1009. </label>
  1010. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1011. <label class="md-nav__title" for="__nav_5">
  1012. <span class="md-nav__icon md-icon"></span>
  1013. Examples
  1014. </label>
  1015. <ul class="md-nav__list" data-md-scrollfix>
  1016. <li class="md-nav__item">
  1017. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1018. <span class="md-ellipsis">
  1019. FluxCD
  1020. </span>
  1021. </a>
  1022. </li>
  1023. <li class="md-nav__item">
  1024. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1025. <span class="md-ellipsis">
  1026. Anchore Engine
  1027. </span>
  1028. </a>
  1029. </li>
  1030. <li class="md-nav__item">
  1031. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1032. <span class="md-ellipsis">
  1033. Jenkins
  1034. </span>
  1035. </a>
  1036. </li>
  1037. <li class="md-nav__item">
  1038. <a href="../../examples/bitwarden/" class="md-nav__link">
  1039. <span class="md-ellipsis">
  1040. BitWarden
  1041. </span>
  1042. </a>
  1043. </li>
  1044. </ul>
  1045. </nav>
  1046. </li>
  1047. <li class="md-nav__item md-nav__item--nested">
  1048. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1049. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1050. <span class="md-ellipsis">
  1051. Community
  1052. </span>
  1053. <span class="md-nav__icon md-icon"></span>
  1054. </label>
  1055. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1056. <label class="md-nav__title" for="__nav_6">
  1057. <span class="md-nav__icon md-icon"></span>
  1058. Community
  1059. </label>
  1060. <ul class="md-nav__list" data-md-scrollfix>
  1061. <li class="md-nav__item md-nav__item--nested">
  1062. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1063. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1064. <span class="md-ellipsis">
  1065. Contributing
  1066. </span>
  1067. <span class="md-nav__icon md-icon"></span>
  1068. </label>
  1069. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1070. <label class="md-nav__title" for="__nav_6_1">
  1071. <span class="md-nav__icon md-icon"></span>
  1072. Contributing
  1073. </label>
  1074. <ul class="md-nav__list" data-md-scrollfix>
  1075. <li class="md-nav__item">
  1076. <a href="../../contributing/devguide/" class="md-nav__link">
  1077. <span class="md-ellipsis">
  1078. Developer guide
  1079. </span>
  1080. </a>
  1081. </li>
  1082. <li class="md-nav__item">
  1083. <a href="../../contributing/process/" class="md-nav__link">
  1084. <span class="md-ellipsis">
  1085. Contributing Process
  1086. </span>
  1087. </a>
  1088. </li>
  1089. <li class="md-nav__item">
  1090. <a href="../../contributing/release/" class="md-nav__link">
  1091. <span class="md-ellipsis">
  1092. Release Process
  1093. </span>
  1094. </a>
  1095. </li>
  1096. <li class="md-nav__item">
  1097. <a href="../../contributing/coc/" class="md-nav__link">
  1098. <span class="md-ellipsis">
  1099. Code of Conduct
  1100. </span>
  1101. </a>
  1102. </li>
  1103. <li class="md-nav__item">
  1104. <a href="../../contributing/roadmap/" class="md-nav__link">
  1105. <span class="md-ellipsis">
  1106. Roadmap
  1107. </span>
  1108. </a>
  1109. </li>
  1110. </ul>
  1111. </nav>
  1112. </li>
  1113. <li class="md-nav__item md-nav__item--nested">
  1114. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1115. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1116. <span class="md-ellipsis">
  1117. External Resources
  1118. </span>
  1119. <span class="md-nav__icon md-icon"></span>
  1120. </label>
  1121. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1122. <label class="md-nav__title" for="__nav_6_2">
  1123. <span class="md-nav__icon md-icon"></span>
  1124. External Resources
  1125. </label>
  1126. <ul class="md-nav__list" data-md-scrollfix>
  1127. <li class="md-nav__item">
  1128. <a href="../../eso-talks/" class="md-nav__link">
  1129. <span class="md-ellipsis">
  1130. Talks
  1131. </span>
  1132. </a>
  1133. </li>
  1134. <li class="md-nav__item">
  1135. <a href="../../eso-demos/" class="md-nav__link">
  1136. <span class="md-ellipsis">
  1137. Demos
  1138. </span>
  1139. </a>
  1140. </li>
  1141. <li class="md-nav__item">
  1142. <a href="../../eso-blogs/" class="md-nav__link">
  1143. <span class="md-ellipsis">
  1144. Blogs
  1145. </span>
  1146. </a>
  1147. </li>
  1148. <li class="md-nav__item">
  1149. <a href="../../eso-tools/" class="md-nav__link">
  1150. <span class="md-ellipsis">
  1151. Tools
  1152. </span>
  1153. </a>
  1154. </li>
  1155. </ul>
  1156. </nav>
  1157. </li>
  1158. </ul>
  1159. </nav>
  1160. </li>
  1161. </ul>
  1162. </nav>
  1163. </div>
  1164. </div>
  1165. </div>
  1166. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1167. <div class="md-sidebar__scrollwrap">
  1168. <div class="md-sidebar__inner">
  1169. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1170. <label class="md-nav__title" for="__toc">
  1171. <span class="md-nav__icon md-icon"></span>
  1172. Table of contents
  1173. </label>
  1174. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1175. <li class="md-nav__item">
  1176. <a href="#keeper-security" class="md-nav__link">
  1177. <span class="md-ellipsis">
  1178. Keeper Security
  1179. </span>
  1180. </a>
  1181. </li>
  1182. <li class="md-nav__item">
  1183. <a href="#authentication" class="md-nav__link">
  1184. <span class="md-ellipsis">
  1185. Authentication
  1186. </span>
  1187. </a>
  1188. <nav class="md-nav" aria-label="Authentication">
  1189. <ul class="md-nav__list">
  1190. <li class="md-nav__item">
  1191. <a href="#secrets-manager-configuration-smc" class="md-nav__link">
  1192. <span class="md-ellipsis">
  1193. Secrets Manager Configuration (SMC)
  1194. </span>
  1195. </a>
  1196. <nav class="md-nav" aria-label="Secrets Manager Configuration (SMC)">
  1197. <ul class="md-nav__list">
  1198. <li class="md-nav__item">
  1199. <a href="#creating-secrets-manager-configuration" class="md-nav__link">
  1200. <span class="md-ellipsis">
  1201. Creating Secrets Manager Configuration
  1202. </span>
  1203. </a>
  1204. </li>
  1205. </ul>
  1206. </nav>
  1207. </li>
  1208. </ul>
  1209. </nav>
  1210. </li>
  1211. <li class="md-nav__item">
  1212. <a href="#important-note-about-this-documentation" class="md-nav__link">
  1213. <span class="md-ellipsis">
  1214. Important note about this documentation
  1215. </span>
  1216. </a>
  1217. <nav class="md-nav" aria-label="Important note about this documentation">
  1218. <ul class="md-nav__list">
  1219. <li class="md-nav__item">
  1220. <a href="#update-secret-store" class="md-nav__link">
  1221. <span class="md-ellipsis">
  1222. Update secret store
  1223. </span>
  1224. </a>
  1225. </li>
  1226. </ul>
  1227. </nav>
  1228. </li>
  1229. <li class="md-nav__item">
  1230. <a href="#external-secrets" class="md-nav__link">
  1231. <span class="md-ellipsis">
  1232. External Secrets
  1233. </span>
  1234. </a>
  1235. <nav class="md-nav" aria-label="External Secrets">
  1236. <ul class="md-nav__list">
  1237. <li class="md-nav__item">
  1238. <a href="#behavior" class="md-nav__link">
  1239. <span class="md-ellipsis">
  1240. Behavior
  1241. </span>
  1242. </a>
  1243. </li>
  1244. <li class="md-nav__item">
  1245. <a href="#creating-external-secret" class="md-nav__link">
  1246. <span class="md-ellipsis">
  1247. Creating external secret
  1248. </span>
  1249. </a>
  1250. </li>
  1251. </ul>
  1252. </nav>
  1253. </li>
  1254. <li class="md-nav__item">
  1255. <a href="#limitations" class="md-nav__link">
  1256. <span class="md-ellipsis">
  1257. Limitations
  1258. </span>
  1259. </a>
  1260. </li>
  1261. <li class="md-nav__item">
  1262. <a href="#push-secrets" class="md-nav__link">
  1263. <span class="md-ellipsis">
  1264. Push Secrets
  1265. </span>
  1266. </a>
  1267. <nav class="md-nav" aria-label="Push Secrets">
  1268. <ul class="md-nav__list">
  1269. <li class="md-nav__item">
  1270. <a href="#behavior_1" class="md-nav__link">
  1271. <span class="md-ellipsis">
  1272. Behavior
  1273. </span>
  1274. </a>
  1275. </li>
  1276. <li class="md-nav__item">
  1277. <a href="#creating-push-secret" class="md-nav__link">
  1278. <span class="md-ellipsis">
  1279. Creating push secret
  1280. </span>
  1281. </a>
  1282. </li>
  1283. <li class="md-nav__item">
  1284. <a href="#limitations_1" class="md-nav__link">
  1285. <span class="md-ellipsis">
  1286. Limitations
  1287. </span>
  1288. </a>
  1289. </li>
  1290. </ul>
  1291. </nav>
  1292. </li>
  1293. </ul>
  1294. </nav>
  1295. </div>
  1296. </div>
  1297. </div>
  1298. <div class="md-content" data-md-component="content">
  1299. <article class="md-content__inner md-typeset">
  1300. <h1>Keeper Security</h1>
  1301. <h2 id="keeper-security">Keeper Security</h2>
  1302. <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>
  1303. <h2 id="authentication">Authentication</h2>
  1304. <h3 id="secrets-manager-configuration-smc">Secrets Manager Configuration (SMC)</h3>
  1305. <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>
  1306. <h4 id="creating-secrets-manager-configuration">Creating Secrets Manager Configuration</h4>
  1307. <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>
  1308. <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>
  1309. <ul>
  1310. <li><code>hostname</code></li>
  1311. <li><code>clientId</code></li>
  1312. <li><code>privateKey</code></li>
  1313. <li><code>serverPublicKeyId</code></li>
  1314. <li><code>appKey</code></li>
  1315. <li><code>appOwnerPublicKey</code></li>
  1316. </ul>
  1317. <p>This base64 encoded jsong string will be required to create your secretStores</p>
  1318. <h2 id="important-note-about-this-documentation">Important note about this documentation</h2>
  1319. <p><em><strong>The KepeerSecurity calls the entries in vaults 'Records'. These docs use the same term.</strong></em></p>
  1320. <h3 id="update-secret-store">Update secret store</h3>
  1321. <p>Be sure the <code>keepersecurity</code> provider is listed in the <code>Kind=SecretStore</code></p>
  1322. <div class="highlight"><pre><span></span><code><span class="nn">---</span>
  1323. <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>
  1324. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1325. <span class="nt">metadata</span><span class="p">:</span>
  1326. <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>
  1327. <span class="nt">spec</span><span class="p">:</span>
  1328. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1329. <span class="w"> </span><span class="nt">keepersecurity</span><span class="p">:</span>
  1330. <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>
  1331. <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>
  1332. <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>
  1333. <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>
  1334. </code></pre></div>
  1335. <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>
  1336. <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>
  1337. <h2 id="external-secrets">External Secrets</h2>
  1338. <h3 id="behavior">Behavior</h3>
  1339. <ul>
  1340. <li>How a Record is equated to an ExternalSecret:<ul>
  1341. <li><code>remoteRef.key</code> is equated to a Record's ID</li>
  1342. <li><code>remoteRef.property</code> is equated to one of the following options:<ul>
  1343. <li>Fields: <a href="https://docs.keeper.io/secrets-manager/secrets-manager/about/field-record-types">Record's field's Type</a></li>
  1344. <li>CustomFields: Record's field's Label</li>
  1345. <li>Files: Record's file's Name</li>
  1346. <li>If empty, defaults to the complete Record in JSON format</li>
  1347. </ul>
  1348. </li>
  1349. <li><code>remoteRef.version</code> is currently not supported.</li>
  1350. </ul>
  1351. </li>
  1352. <li><code>dataFrom</code>:<ul>
  1353. <li><code>find.path</code> is currently not supported.</li>
  1354. <li><code>find.name.regexp</code> is equated to one of the following options:<ul>
  1355. <li>Fields: Record's field's Type</li>
  1356. <li>CustomFields: Record's field's Label</li>
  1357. <li>Files: Record's file's Name</li>
  1358. </ul>
  1359. </li>
  1360. <li><code>find.tags</code> are not supported at this time.</li>
  1361. </ul>
  1362. </li>
  1363. </ul>
  1364. <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>
  1365. <h3 id="creating-external-secret">Creating external secret</h3>
  1366. <p>To create a kubernetes secret from Keeper Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  1367. <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>
  1368. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1369. <span class="nt">metadata</span><span class="p">:</span>
  1370. <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>
  1371. <span class="nt">spec</span><span class="p">:</span>
  1372. <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>
  1373. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1374. <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>
  1375. <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>
  1376. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1377. <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>
  1378. <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>
  1379. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1380. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1381. <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>
  1382. <span class="nn">---</span>
  1383. <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>
  1384. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1385. <span class="nt">metadata</span><span class="p">:</span>
  1386. <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>
  1387. <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>
  1388. <span class="nt">spec</span><span class="p">:</span>
  1389. <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>
  1390. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1391. <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>
  1392. <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>
  1393. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1394. <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>
  1395. <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>
  1396. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1397. <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>
  1398. <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>
  1399. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1400. <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>
  1401. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1402. <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>
  1403. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1404. <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>
  1405. <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>
  1406. <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>
  1407. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1408. <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>
  1409. <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>
  1410. <span class="nn">---</span>
  1411. <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>
  1412. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1413. <span class="nt">metadata</span><span class="p">:</span>
  1414. <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>
  1415. <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>
  1416. <span class="nt">spec</span><span class="p">:</span>
  1417. <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>
  1418. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1419. <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>
  1420. <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>
  1421. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1422. <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>
  1423. <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>
  1424. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1425. <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>
  1426. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1427. <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>
  1428. <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>
  1429. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1430. <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>
  1431. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1432. <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>
  1433. <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>
  1434. <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>
  1435. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1436. <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>
  1437. <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>
  1438. <span class="nn">---</span>
  1439. <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>
  1440. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1441. <span class="nt">metadata</span><span class="p">:</span>
  1442. <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>
  1443. <span class="nt">spec</span><span class="p">:</span>
  1444. <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>
  1445. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1446. <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>
  1447. <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>
  1448. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1449. <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>
  1450. <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>
  1451. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1452. <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>
  1453. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1454. <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>
  1455. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1456. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1457. <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>
  1458. </code></pre></div>
  1459. <p>The operator will fetch the Keeper Secret Manager secret and inject it as a <code>Kind=Secret</code>
  1460. <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
  1461. </code></pre></div></p>
  1462. <h2 id="limitations">Limitations</h2>
  1463. <p>There are some limitations using this provider.</p>
  1464. <ul>
  1465. <li>Keeper Secret Manager does not work with <code>General</code> Records types nor legacy non-typed records</li>
  1466. <li>Using tags <code>find.tags</code> is not supported by KSM</li>
  1467. <li>Using path <code>find.path</code> is not supported at the moment</li>
  1468. </ul>
  1469. <h2 id="push-secrets">Push Secrets</h2>
  1470. <p>Push Secret will only work with a custom KeeperSecurity Record type <code>ExternalSecret</code></p>
  1471. <h3 id="behavior_1">Behavior</h3>
  1472. <ul>
  1473. <li><code>selector</code>:</li>
  1474. <li><code>secret.name</code>: name of the kubernetes secret to be pushed</li>
  1475. <li><code>data.match</code>:</li>
  1476. <li><code>secretKey</code>: key on the selected secret to be pushed</li>
  1477. <li><code>remoteRef.remoteKey</code>: Secret and key to be created on the remote provider<ul>
  1478. <li>Format: SecretName/SecretKey</li>
  1479. </ul>
  1480. </li>
  1481. </ul>
  1482. <h3 id="creating-push-secret">Creating push secret</h3>
  1483. <p>To create a Keeper Security record from kubernetes a <code>Kind=PushSecret</code> is needed.</p>
  1484. <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>
  1485. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1486. <span class="nt">metadata</span><span class="p">:</span>
  1487. <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>
  1488. <span class="nt">spec</span><span class="p">:</span>
  1489. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span>
  1490. <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>
  1491. <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>
  1492. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span>
  1493. <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>
  1494. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1495. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1496. <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>
  1497. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1498. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1499. <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>
  1500. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1501. <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>
  1502. </code></pre></div>
  1503. <h3 id="limitations_1">Limitations</h3>
  1504. <ul>
  1505. <li>Only possible to push one key per secret at the moment</li>
  1506. <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>
  1507. </ul>
  1508. </article>
  1509. </div>
  1510. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1511. </div>
  1512. </main>
  1513. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1514. <footer class="md-footer">
  1515. <div class="md-footer-meta md-typeset">
  1516. <div class="md-footer-meta__inner md-grid">
  1517. <div class="md-copyright">
  1518. <div class="md-copyright__highlight">
  1519. &copy; 2024 The external-secrets Authors.<br/>
  1520. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1521. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1522. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1523. </div>
  1524. Made with
  1525. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1526. Material for MkDocs
  1527. </a>
  1528. </div>
  1529. </div>
  1530. </div>
  1531. </footer>
  1532. </div>
  1533. <div class="md-dialog" data-md-component="dialog">
  1534. <div class="md-dialog__inner md-typeset"></div>
  1535. </div>
  1536. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.07f07601.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>
  1537. <script src="../../assets/javascripts/bundle.56dfad97.min.js"></script>
  1538. </body>
  1539. </html>