index.html 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Keeper Security - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#keeper-security" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Keeper Security
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../../guides/introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  427. Rewriting Keys
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/v1beta1/" class="md-nav__link">
  432. Upgrading to v1beta1
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/using-latest-image/" class="md-nav__link">
  437. Using Latest Image
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  442. Disable Cluster Features
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  450. <label class="md-nav__link" for="__nav_4">
  451. Provider
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  455. <label class="md-nav__title" for="__nav_4">
  456. <span class="md-nav__icon md-icon"></span>
  457. Provider
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../aws-secrets-manager/" class="md-nav__link">
  462. AWS Secrets Manager
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../aws-parameter-store/" class="md-nav__link">
  467. AWS Parameter Store
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../azure-key-vault/" class="md-nav__link">
  472. Azure Key Vault
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../google-secrets-manager/" class="md-nav__link">
  477. Google Secret Manager
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../ibm-secrets-manager/" class="md-nav__link">
  482. IBM Secrets Manager
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../akeyless/" class="md-nav__link">
  487. Akeyless
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../hashicorp-vault/" class="md-nav__link">
  492. HashiCorp Vault
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../yandex-certificate-manager/" class="md-nav__link">
  497. Yandex Certificate Manager
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../yandex-lockbox/" class="md-nav__link">
  502. Yandex Lockbox
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../gitlab-variables/" class="md-nav__link">
  507. Gitlab Variables
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../oracle-vault/" class="md-nav__link">
  512. Oracle Vault
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../1password-automation/" class="md-nav__link">
  517. 1Password Secrets Automation
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../webhook/" class="md-nav__link">
  522. Webhook
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../fake/" class="md-nav__link">
  527. Fake
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../kubernetes/" class="md-nav__link">
  532. Kubernetes
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../senhasegura-dsm/" class="md-nav__link">
  537. senhasegura DevOps Secrets Management (DSM)
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../doppler/" class="md-nav__link">
  542. Doppler
  543. </a>
  544. </li>
  545. <li class="md-nav__item md-nav__item--active">
  546. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  547. <label class="md-nav__link md-nav__link--active" for="__toc">
  548. Keeper Security
  549. <span class="md-nav__icon md-icon"></span>
  550. </label>
  551. <a href="./" class="md-nav__link md-nav__link--active">
  552. Keeper Security
  553. </a>
  554. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  555. <label class="md-nav__title" for="__toc">
  556. <span class="md-nav__icon md-icon"></span>
  557. Table of contents
  558. </label>
  559. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  560. <li class="md-nav__item">
  561. <a href="#keeper-security" class="md-nav__link">
  562. Keeper Security
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="#authentication" class="md-nav__link">
  567. Authentication
  568. </a>
  569. <nav class="md-nav" aria-label="Authentication">
  570. <ul class="md-nav__list">
  571. <li class="md-nav__item">
  572. <a href="#secrets-manager-configuration-smc" class="md-nav__link">
  573. Secrets Manager Configuration (SMC)
  574. </a>
  575. <nav class="md-nav" aria-label="Secrets Manager Configuration (SMC)">
  576. <ul class="md-nav__list">
  577. <li class="md-nav__item">
  578. <a href="#creating-secrets-manager-configuration" class="md-nav__link">
  579. Creating Secrets Manager Configuration
  580. </a>
  581. </li>
  582. </ul>
  583. </nav>
  584. </li>
  585. </ul>
  586. </nav>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="#important-note-about-this-documentation" class="md-nav__link">
  590. Important note about this documentation
  591. </a>
  592. <nav class="md-nav" aria-label="Important note about this documentation">
  593. <ul class="md-nav__list">
  594. <li class="md-nav__item">
  595. <a href="#update-secret-store" class="md-nav__link">
  596. Update secret store
  597. </a>
  598. </li>
  599. </ul>
  600. </nav>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="#external-secrets" class="md-nav__link">
  604. External Secrets
  605. </a>
  606. <nav class="md-nav" aria-label="External Secrets">
  607. <ul class="md-nav__list">
  608. <li class="md-nav__item">
  609. <a href="#behavior" class="md-nav__link">
  610. Behavior
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="#creating-external-secret" class="md-nav__link">
  615. Creating external secret
  616. </a>
  617. </li>
  618. </ul>
  619. </nav>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="#limitations" class="md-nav__link">
  623. Limitations
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="#push-secrets" class="md-nav__link">
  628. Push Secrets
  629. </a>
  630. <nav class="md-nav" aria-label="Push Secrets">
  631. <ul class="md-nav__list">
  632. <li class="md-nav__item">
  633. <a href="#behavior_1" class="md-nav__link">
  634. Behavior
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="#creating-push-secret" class="md-nav__link">
  639. Creating push secret
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="#limitations_1" class="md-nav__link">
  644. Limitations
  645. </a>
  646. </li>
  647. </ul>
  648. </nav>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../scaleway/" class="md-nav__link">
  655. Scaleway
  656. </a>
  657. </li>
  658. </ul>
  659. </nav>
  660. </li>
  661. <li class="md-nav__item md-nav__item--nested">
  662. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  663. <label class="md-nav__link" for="__nav_5">
  664. Examples
  665. <span class="md-nav__icon md-icon"></span>
  666. </label>
  667. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  668. <label class="md-nav__title" for="__nav_5">
  669. <span class="md-nav__icon md-icon"></span>
  670. Examples
  671. </label>
  672. <ul class="md-nav__list" data-md-scrollfix>
  673. <li class="md-nav__item">
  674. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  675. FluxCD
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  680. Anchore Engine
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  685. Jenkins
  686. </a>
  687. </li>
  688. </ul>
  689. </nav>
  690. </li>
  691. <li class="md-nav__item md-nav__item--nested">
  692. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  693. <label class="md-nav__link" for="__nav_6">
  694. Community
  695. <span class="md-nav__icon md-icon"></span>
  696. </label>
  697. <nav class="md-nav" aria-label="Community" data-md-level="1">
  698. <label class="md-nav__title" for="__nav_6">
  699. <span class="md-nav__icon md-icon"></span>
  700. Community
  701. </label>
  702. <ul class="md-nav__list" data-md-scrollfix>
  703. <li class="md-nav__item md-nav__item--nested">
  704. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  705. <label class="md-nav__link" for="__nav_6_1">
  706. Contributing
  707. <span class="md-nav__icon md-icon"></span>
  708. </label>
  709. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  710. <label class="md-nav__title" for="__nav_6_1">
  711. <span class="md-nav__icon md-icon"></span>
  712. Contributing
  713. </label>
  714. <ul class="md-nav__list" data-md-scrollfix>
  715. <li class="md-nav__item">
  716. <a href="../../contributing/devguide/" class="md-nav__link">
  717. Developer guide
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../contributing/process/" class="md-nav__link">
  722. Contributing Process
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../contributing/release/" class="md-nav__link">
  727. Release Process
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="../../contributing/coc/" class="md-nav__link">
  732. Code of Conduct
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../contributing/roadmap/" class="md-nav__link">
  737. Roadmap
  738. </a>
  739. </li>
  740. </ul>
  741. </nav>
  742. </li>
  743. <li class="md-nav__item md-nav__item--nested">
  744. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  745. <label class="md-nav__link" for="__nav_6_2">
  746. External Resources
  747. <span class="md-nav__icon md-icon"></span>
  748. </label>
  749. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  750. <label class="md-nav__title" for="__nav_6_2">
  751. <span class="md-nav__icon md-icon"></span>
  752. External Resources
  753. </label>
  754. <ul class="md-nav__list" data-md-scrollfix>
  755. <li class="md-nav__item">
  756. <a href="../../eso-talks/" class="md-nav__link">
  757. Talks
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../eso-demos/" class="md-nav__link">
  762. Demos
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="../../eso-blogs/" class="md-nav__link">
  767. Blogs
  768. </a>
  769. </li>
  770. </ul>
  771. </nav>
  772. </li>
  773. </ul>
  774. </nav>
  775. </li>
  776. </ul>
  777. </nav>
  778. </div>
  779. </div>
  780. </div>
  781. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  782. <div class="md-sidebar__scrollwrap">
  783. <div class="md-sidebar__inner">
  784. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  785. <label class="md-nav__title" for="__toc">
  786. <span class="md-nav__icon md-icon"></span>
  787. Table of contents
  788. </label>
  789. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  790. <li class="md-nav__item">
  791. <a href="#keeper-security" class="md-nav__link">
  792. Keeper Security
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="#authentication" class="md-nav__link">
  797. Authentication
  798. </a>
  799. <nav class="md-nav" aria-label="Authentication">
  800. <ul class="md-nav__list">
  801. <li class="md-nav__item">
  802. <a href="#secrets-manager-configuration-smc" class="md-nav__link">
  803. Secrets Manager Configuration (SMC)
  804. </a>
  805. <nav class="md-nav" aria-label="Secrets Manager Configuration (SMC)">
  806. <ul class="md-nav__list">
  807. <li class="md-nav__item">
  808. <a href="#creating-secrets-manager-configuration" class="md-nav__link">
  809. Creating Secrets Manager Configuration
  810. </a>
  811. </li>
  812. </ul>
  813. </nav>
  814. </li>
  815. </ul>
  816. </nav>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="#important-note-about-this-documentation" class="md-nav__link">
  820. Important note about this documentation
  821. </a>
  822. <nav class="md-nav" aria-label="Important note about this documentation">
  823. <ul class="md-nav__list">
  824. <li class="md-nav__item">
  825. <a href="#update-secret-store" class="md-nav__link">
  826. Update secret store
  827. </a>
  828. </li>
  829. </ul>
  830. </nav>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="#external-secrets" class="md-nav__link">
  834. External Secrets
  835. </a>
  836. <nav class="md-nav" aria-label="External Secrets">
  837. <ul class="md-nav__list">
  838. <li class="md-nav__item">
  839. <a href="#behavior" class="md-nav__link">
  840. Behavior
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="#creating-external-secret" class="md-nav__link">
  845. Creating external secret
  846. </a>
  847. </li>
  848. </ul>
  849. </nav>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="#limitations" class="md-nav__link">
  853. Limitations
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="#push-secrets" class="md-nav__link">
  858. Push Secrets
  859. </a>
  860. <nav class="md-nav" aria-label="Push Secrets">
  861. <ul class="md-nav__list">
  862. <li class="md-nav__item">
  863. <a href="#behavior_1" class="md-nav__link">
  864. Behavior
  865. </a>
  866. </li>
  867. <li class="md-nav__item">
  868. <a href="#creating-push-secret" class="md-nav__link">
  869. Creating push secret
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="#limitations_1" class="md-nav__link">
  874. Limitations
  875. </a>
  876. </li>
  877. </ul>
  878. </nav>
  879. </li>
  880. </ul>
  881. </nav>
  882. </div>
  883. </div>
  884. </div>
  885. <div class="md-content" data-md-component="content">
  886. <article class="md-content__inner md-typeset">
  887. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/keeper-security.md" title="Edit this page" class="md-content__button md-icon">
  888. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  889. </a>
  890. <h1>Keeper Security</h1>
  891. <h2 id="keeper-security">Keeper Security</h2>
  892. <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>
  893. <h2 id="authentication">Authentication</h2>
  894. <h3 id="secrets-manager-configuration-smc">Secrets Manager Configuration (SMC)</h3>
  895. <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>
  896. <h4 id="creating-secrets-manager-configuration">Creating Secrets Manager Configuration</h4>
  897. <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>
  898. <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>
  899. <ul>
  900. <li><code>hostname</code></li>
  901. <li><code>clientId</code></li>
  902. <li><code>privateKey</code></li>
  903. <li><code>serverPublicKeyId</code></li>
  904. <li><code>appKey</code></li>
  905. <li><code>appOwnerPublicKey</code></li>
  906. </ul>
  907. <p>This base64 encoded jsong string will be required to create your secretStores</p>
  908. <h2 id="important-note-about-this-documentation">Important note about this documentation</h2>
  909. <p><em><strong>The KepeerSecurity calls the entries in vaults 'Records'. These docs use the same term.</strong></em></p>
  910. <h3 id="update-secret-store">Update secret store</h3>
  911. <p>Be sure the <code>keepersecurity</code> provider is listed in the <code>Kind=SecretStore</code></p>
  912. <div class="highlight"><pre><span></span><code><span class="nn">---</span><span class="w"></span>
  913. <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><span class="w"></span>
  914. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"></span>
  915. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  916. <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><span class="w"></span>
  917. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  918. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  919. <span class="w"> </span><span class="nt">keepersecurity</span><span class="p">:</span><span class="w"></span>
  920. <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><span class="w"></span>
  921. <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><span class="w"></span>
  922. <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><span class="w"></span>
  923. <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><span class="w"></span>
  924. </code></pre></div>
  925. <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>
  926. <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>
  927. <h2 id="external-secrets">External Secrets</h2>
  928. <h3 id="behavior">Behavior</h3>
  929. <ul>
  930. <li>How a Record is equated to an ExternalSecret:<ul>
  931. <li><code>remoteRef.key</code> is equated to a Record's ID</li>
  932. <li><code>remoteRef.property</code> is equated to one of the following options:<ul>
  933. <li>Fields: <a href="https://docs.keeper.io/secrets-manager/secrets-manager/about/field-record-types">Record's field's Type</a></li>
  934. <li>CustomFields: Record's field's Label</li>
  935. <li>Files: Record's file's Name</li>
  936. <li>If empty, defaults to the complete Record in JSON format</li>
  937. </ul>
  938. </li>
  939. <li><code>remoteRef.version</code> is currently not supported.</li>
  940. </ul>
  941. </li>
  942. <li><code>dataFrom</code>:<ul>
  943. <li><code>find.path</code> is currently not supported.</li>
  944. <li><code>find.name.regexp</code> is equated to one of the following options:<ul>
  945. <li>Fields: Record's field's Type</li>
  946. <li>CustomFields: Record's field's Label</li>
  947. <li>Files: Record's file's Name</li>
  948. </ul>
  949. </li>
  950. <li><code>find.tags</code> are not supported at this time.</li>
  951. </ul>
  952. </li>
  953. </ul>
  954. <h3 id="creating-external-secret">Creating external secret</h3>
  955. <p>To create a kubernetes secret from the GCP Secret Manager secret a <code>Kind=ExternalSecret</code> is needed.</p>
  956. <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><span class="w"></span>
  957. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  958. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  959. <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>
  960. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  961. <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><span class="w"></span>
  962. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  963. <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><span class="w"></span>
  964. <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><span class="w"></span>
  965. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  966. <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><span class="w"></span>
  967. <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><span class="w"></span>
  968. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  969. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  970. <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><span class="w"></span>
  971. <span class="nn">---</span><span class="w"></span>
  972. <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><span class="w"></span>
  973. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  974. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  975. <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><span class="w"></span>
  976. <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><span class="w"></span>
  977. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  978. <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><span class="w"></span>
  979. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  980. <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><span class="w"></span>
  981. <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><span class="w"></span>
  982. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  983. <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><span class="w"></span>
  984. <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><span class="w"></span>
  985. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  986. <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><span class="w"></span>
  987. <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><span class="w"></span>
  988. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  989. <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><span class="w"></span>
  990. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  991. <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><span class="w"></span>
  992. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  993. <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>
  994. <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><span class="w"></span>
  995. <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><span class="w"></span>
  996. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  997. <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>
  998. <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><span class="w"></span>
  999. <span class="nn">---</span><span class="w"></span>
  1000. <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><span class="w"></span>
  1001. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  1002. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1003. <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><span class="w"></span>
  1004. <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><span class="w"></span>
  1005. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1006. <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><span class="w"></span>
  1007. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  1008. <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><span class="w"></span>
  1009. <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><span class="w"></span>
  1010. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  1011. <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><span class="w"></span>
  1012. <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><span class="w"></span>
  1013. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  1014. <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><span class="w"></span>
  1015. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  1016. <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><span class="w"></span>
  1017. <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><span class="w"></span>
  1018. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  1019. <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><span class="w"></span>
  1020. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  1021. <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>
  1022. <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><span class="w"></span>
  1023. <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><span class="w"></span>
  1024. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  1025. <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>
  1026. <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><span class="w"></span>
  1027. </code></pre></div>
  1028. <p>The operator will fetch the Keeper Secret Manager secret and inject it as a <code>Kind=Secret</code>
  1029. <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
  1030. </code></pre></div></p>
  1031. <h2 id="limitations">Limitations</h2>
  1032. <p>There are some limitations using this provider.</p>
  1033. <ul>
  1034. <li>Keeper Secret Manager does not work with <code>General</code> Records types nor legacy non-typed records</li>
  1035. <li>Using tags <code>find.tags</code> is not supported by KSM</li>
  1036. <li>Using path <code>find.path</code> is not supported at the moment</li>
  1037. </ul>
  1038. <h2 id="push-secrets">Push Secrets</h2>
  1039. <p>Push Secret will only work with a custom KeeperSecurity Record type <code>ExternalSecret</code></p>
  1040. <h3 id="behavior_1">Behavior</h3>
  1041. <ul>
  1042. <li><code>selector</code>:</li>
  1043. <li><code>secret.name</code>: name of the kubernetes secret to be pushed</li>
  1044. <li><code>data.match</code>:</li>
  1045. <li><code>secretKey</code>: key on the selected secret to be pushed</li>
  1046. <li><code>remoteRef.remoteKey</code>: Secret and key to be created on the remote provider<ul>
  1047. <li>Format: SecretName/SecretKey</li>
  1048. </ul>
  1049. </li>
  1050. </ul>
  1051. <h3 id="creating-push-secret">Creating push secret</h3>
  1052. <p>To create a Keeper Security record from kubernetes a <code>Kind=PushSecret</code> is needed.</p>
  1053. <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><span class="w"></span>
  1054. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span><span class="w"></span>
  1055. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1056. <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>
  1057. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1058. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"></span>
  1059. <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><span class="w"></span>
  1060. <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><span class="w"></span>
  1061. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span><span class="w"></span>
  1062. <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><span class="w"></span>
  1063. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span><span class="w"></span>
  1064. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span><span class="w"></span>
  1065. <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><span class="w"></span>
  1066. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  1067. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span><span class="w"></span>
  1068. <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><span class="w"></span>
  1069. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  1070. <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><span class="w"></span>
  1071. </code></pre></div>
  1072. <h3 id="limitations_1">Limitations</h3>
  1073. <ul>
  1074. <li>Only possible to push one key per secret at the moment</li>
  1075. <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>
  1076. </ul>
  1077. </article>
  1078. </div>
  1079. </div>
  1080. </main>
  1081. <footer class="md-footer">
  1082. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1083. <a href="../doppler/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Doppler" rel="prev">
  1084. <div class="md-footer__button md-icon">
  1085. <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>
  1086. </div>
  1087. <div class="md-footer__title">
  1088. <div class="md-ellipsis">
  1089. <span class="md-footer__direction">
  1090. Previous
  1091. </span>
  1092. Doppler
  1093. </div>
  1094. </div>
  1095. </a>
  1096. <a href="../scaleway/" class="md-footer__link md-footer__link--next" aria-label="Next: Scaleway" rel="next">
  1097. <div class="md-footer__title">
  1098. <div class="md-ellipsis">
  1099. <span class="md-footer__direction">
  1100. Next
  1101. </span>
  1102. Scaleway
  1103. </div>
  1104. </div>
  1105. <div class="md-footer__button md-icon">
  1106. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  1107. </div>
  1108. </a>
  1109. </nav>
  1110. <div class="md-footer-meta md-typeset">
  1111. <div class="md-footer-meta__inner md-grid">
  1112. <div class="md-copyright">
  1113. <div class="md-copyright__highlight">
  1114. &copy; 2023 The external-secrets Authors.<br/>
  1115. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1116. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1117. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1118. </div>
  1119. Made with
  1120. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1121. Material for MkDocs
  1122. </a>
  1123. </div>
  1124. </div>
  1125. </div>
  1126. </footer>
  1127. </div>
  1128. <div class="md-dialog" data-md-component="dialog">
  1129. <div class="md-dialog__inner md-typeset"></div>
  1130. </div>
  1131. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1132. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1133. </body>
  1134. </html>