index.html 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372
  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>Doppler - 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="#doppler-secretops-platform" 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. Doppler
  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 Cloud 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="../alibaba/" class="md-nav__link">
  507. Alibaba Cloud
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../gitlab-variables/" class="md-nav__link">
  512. Gitlab Variables
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../oracle-vault/" class="md-nav__link">
  517. Oracle Vault
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../1password-automation/" class="md-nav__link">
  522. 1Password Secrets Automation
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../webhook/" class="md-nav__link">
  527. Webhook
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../fake/" class="md-nav__link">
  532. Fake
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../kubernetes/" class="md-nav__link">
  537. Kubernetes
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../senhasegura-dsm/" class="md-nav__link">
  542. senhasegura DevOps Secrets Management (DSM)
  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. Doppler
  549. <span class="md-nav__icon md-icon"></span>
  550. </label>
  551. <a href="./" class="md-nav__link md-nav__link--active">
  552. Doppler
  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="#doppler-secretops-platform" class="md-nav__link">
  562. Doppler SecretOps Platform
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="#authentication" class="md-nav__link">
  567. Authentication
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#use-cases" class="md-nav__link">
  572. Use Cases
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="#1-fetch" class="md-nav__link">
  577. 1. Fetch
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#2-fetch-all" class="md-nav__link">
  582. 2. Fetch all
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="#3-filter" class="md-nav__link">
  587. 3. Filter
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="#4-json-secret" class="md-nav__link">
  592. 4. JSON secret
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="#5-name-transformer" class="md-nav__link">
  597. 5. Name transformer
  598. </a>
  599. <nav class="md-nav" aria-label="5. Name transformer">
  600. <ul class="md-nav__list">
  601. <li class="md-nav__item">
  602. <a href="#6-download" class="md-nav__link">
  603. 6. Download
  604. </a>
  605. </li>
  606. </ul>
  607. </nav>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../keeper-security/" class="md-nav__link">
  614. Keeper Security
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../scaleway/" class="md-nav__link">
  619. Scaleway
  620. </a>
  621. </li>
  622. </ul>
  623. </nav>
  624. </li>
  625. <li class="md-nav__item md-nav__item--nested">
  626. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  627. <label class="md-nav__link" for="__nav_5">
  628. Examples
  629. <span class="md-nav__icon md-icon"></span>
  630. </label>
  631. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  632. <label class="md-nav__title" for="__nav_5">
  633. <span class="md-nav__icon md-icon"></span>
  634. Examples
  635. </label>
  636. <ul class="md-nav__list" data-md-scrollfix>
  637. <li class="md-nav__item">
  638. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  639. FluxCD
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  644. Anchore Engine
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  649. Jenkins
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../../examples/bitwarden/" class="md-nav__link">
  654. BitWarden
  655. </a>
  656. </li>
  657. </ul>
  658. </nav>
  659. </li>
  660. <li class="md-nav__item md-nav__item--nested">
  661. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  662. <label class="md-nav__link" for="__nav_6">
  663. Community
  664. <span class="md-nav__icon md-icon"></span>
  665. </label>
  666. <nav class="md-nav" aria-label="Community" data-md-level="1">
  667. <label class="md-nav__title" for="__nav_6">
  668. <span class="md-nav__icon md-icon"></span>
  669. Community
  670. </label>
  671. <ul class="md-nav__list" data-md-scrollfix>
  672. <li class="md-nav__item md-nav__item--nested">
  673. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  674. <label class="md-nav__link" for="__nav_6_1">
  675. Contributing
  676. <span class="md-nav__icon md-icon"></span>
  677. </label>
  678. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  679. <label class="md-nav__title" for="__nav_6_1">
  680. <span class="md-nav__icon md-icon"></span>
  681. Contributing
  682. </label>
  683. <ul class="md-nav__list" data-md-scrollfix>
  684. <li class="md-nav__item">
  685. <a href="../../contributing/devguide/" class="md-nav__link">
  686. Developer guide
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../contributing/process/" class="md-nav__link">
  691. Contributing Process
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../../contributing/release/" class="md-nav__link">
  696. Release Process
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../contributing/coc/" class="md-nav__link">
  701. Code of Conduct
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../contributing/roadmap/" class="md-nav__link">
  706. Roadmap
  707. </a>
  708. </li>
  709. </ul>
  710. </nav>
  711. </li>
  712. <li class="md-nav__item md-nav__item--nested">
  713. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  714. <label class="md-nav__link" for="__nav_6_2">
  715. External Resources
  716. <span class="md-nav__icon md-icon"></span>
  717. </label>
  718. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  719. <label class="md-nav__title" for="__nav_6_2">
  720. <span class="md-nav__icon md-icon"></span>
  721. External Resources
  722. </label>
  723. <ul class="md-nav__list" data-md-scrollfix>
  724. <li class="md-nav__item">
  725. <a href="../../eso-talks/" class="md-nav__link">
  726. Talks
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="../../eso-demos/" class="md-nav__link">
  731. Demos
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../eso-blogs/" class="md-nav__link">
  736. Blogs
  737. </a>
  738. </li>
  739. </ul>
  740. </nav>
  741. </li>
  742. </ul>
  743. </nav>
  744. </li>
  745. </ul>
  746. </nav>
  747. </div>
  748. </div>
  749. </div>
  750. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  751. <div class="md-sidebar__scrollwrap">
  752. <div class="md-sidebar__inner">
  753. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  754. <label class="md-nav__title" for="__toc">
  755. <span class="md-nav__icon md-icon"></span>
  756. Table of contents
  757. </label>
  758. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  759. <li class="md-nav__item">
  760. <a href="#doppler-secretops-platform" class="md-nav__link">
  761. Doppler SecretOps Platform
  762. </a>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="#authentication" class="md-nav__link">
  766. Authentication
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="#use-cases" class="md-nav__link">
  771. Use Cases
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="#1-fetch" class="md-nav__link">
  776. 1. Fetch
  777. </a>
  778. </li>
  779. <li class="md-nav__item">
  780. <a href="#2-fetch-all" class="md-nav__link">
  781. 2. Fetch all
  782. </a>
  783. </li>
  784. <li class="md-nav__item">
  785. <a href="#3-filter" class="md-nav__link">
  786. 3. Filter
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="#4-json-secret" class="md-nav__link">
  791. 4. JSON secret
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="#5-name-transformer" class="md-nav__link">
  796. 5. Name transformer
  797. </a>
  798. <nav class="md-nav" aria-label="5. Name transformer">
  799. <ul class="md-nav__list">
  800. <li class="md-nav__item">
  801. <a href="#6-download" class="md-nav__link">
  802. 6. Download
  803. </a>
  804. </li>
  805. </ul>
  806. </nav>
  807. </li>
  808. </ul>
  809. </nav>
  810. </div>
  811. </div>
  812. </div>
  813. <div class="md-content" data-md-component="content">
  814. <article class="md-content__inner md-typeset">
  815. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/doppler.md" title="Edit this page" class="md-content__button md-icon">
  816. <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>
  817. </a>
  818. <h1>Doppler</h1>
  819. <p><img alt="Doppler External Secrets Provider" src="../../pictures/doppler-provider-header.jpg" /></p>
  820. <h2 id="doppler-secretops-platform">Doppler SecretOps Platform</h2>
  821. <p>Sync secrets from the <a href="https://www.doppler.com/">Doppler SecretOps Platform</a> to Kubernetes using the External Secrets Operator.</p>
  822. <h2 id="authentication">Authentication</h2>
  823. <p>Doppler <a href="https://docs.doppler.com/docs/service-tokens">Service Tokens</a> are recommended as they restrict access to a single config.</p>
  824. <p><img alt="Doppler Service Token" src="../../pictures/doppler-service-tokens.png" /></p>
  825. <blockquote>
  826. <p>NOTE: Doppler Personal Tokens are also supported but require <code>project</code> and <code>config</code> to be set on the <code>SecretStore</code> or <code>ClusterSecretStore</code>.</p>
  827. </blockquote>
  828. <p>Create the Doppler Token secret by opening the Doppler dashboard and navigating to the desired Project and Config, then create a new Service Token from the <strong>Access</strong> tab:</p>
  829. <p><img alt="Create Doppler Service Token" src="../../pictures/doppler-create-service-token.jpg" /></p>
  830. <p>Create the Doppler Token Kubernetes secret with your Service Token value:</p>
  831. <div class="highlight"><pre><span></span><code><span class="nv">HISTIGNORE</span><span class="o">=</span><span class="s1">&#39;*kubectl*&#39;</span> kubectl create secret generic <span class="se">\</span>
  832. doppler-token-auth-api <span class="se">\</span>
  833. --from-literal <span class="nv">dopplerToken</span><span class="o">=</span><span class="s2">&quot;dp.st.xxxx&quot;</span>
  834. </code></pre></div>
  835. <p>Then to create a generic <code>SecretStore</code>:</p>
  836. <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>
  837. <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>
  838. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  839. <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">doppler-auth-api</span><span class="w"></span>
  840. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  841. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">doppler</span><span class="p">:</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  844. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  845. <span class="w"> </span><span class="nt">dopplerToken</span><span class="p">:</span><span class="w"></span>
  846. <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">doppler-token-auth-api</span><span class="w"></span>
  847. <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">dopplerToken</span><span class="w"></span>
  848. </code></pre></div>
  849. <blockquote>
  850. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, be sure to set <code>namespace</code> in <code>secretRef.dopplerToken</code>.</p>
  851. </blockquote>
  852. <h2 id="use-cases">Use Cases</h2>
  853. <p>The Doppler provider allows for a wide range of use cases:</p>
  854. <ol>
  855. <li><a href="#1-fetch">Fetch</a></li>
  856. <li><a href="#2-fetch-all">Fetch all</a></li>
  857. <li><a href="#3-filter">Filter</a></li>
  858. <li><a href="#4-json-secret">JSON secret</a></li>
  859. <li><a href="#5-name-transformer">Name transformer</a></li>
  860. <li><a href="#6-download">Download</a></li>
  861. </ol>
  862. <p>Let's explore each use case using a fictional <code>auth-api</code> Doppler project.</p>
  863. <h2 id="1-fetch">1. Fetch</h2>
  864. <p>To sync one or more individual secrets:</p>
  865. <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>
  866. <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>
  867. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  868. <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">auth-api-db-url</span><span class="w"></span>
  869. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  870. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  871. <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>
  872. <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">doppler-auth-api</span><span class="w"></span>
  873. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  874. <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">auth-api-db-url</span><span class="w"></span>
  875. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  876. <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">DB_URL</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  878. <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">DB_URL</span><span class="w"></span>
  879. </code></pre></div>
  880. <p><img alt="Doppler fetch" src="../../pictures/doppler-fetch.png" /></p>
  881. <h2 id="2-fetch-all">2. Fetch all</h2>
  882. <p>To sync every secret from a config:</p>
  883. <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>
  884. <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>
  885. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  886. <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">auth-api-all</span><span class="w"></span>
  887. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  888. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  889. <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>
  890. <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">doppler-auth-api</span><span class="w"></span>
  891. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  892. <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">auth-api-all</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  894. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  895. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  896. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.*</span><span class="w"></span>
  897. </code></pre></div>
  898. <p><img alt="Doppler fetch all" src="../../pictures/doppler-fetch-all.png" /></p>
  899. <h2 id="3-filter">3. Filter</h2>
  900. <p>To filter secrets by <code>path</code> (path prefix), <code>name</code> (regular expression) or a combination of both:</p>
  901. <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>
  902. <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>
  903. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  904. <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">auth-api-db</span><span class="w"></span>
  905. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  906. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  907. <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>
  908. <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">doppler-auth-api</span><span class="w"></span>
  909. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  910. <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">auth-api-db</span><span class="w"></span>
  911. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  912. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  913. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DB_</span><span class="w"></span>
  914. </code></pre></div>
  915. <p><img alt="Doppler filter" src="../../pictures/doppler-filter.png" /></p>
  916. <h2 id="4-json-secret">4. JSON secret</h2>
  917. <p>To parse a JSON secret to its key-value pairs:</p>
  918. <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>
  919. <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>
  920. <span class="nt">metadata</span><span class="p">:</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">auth-api-sa-json</span><span class="w"></span>
  922. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  923. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  924. <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>
  925. <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">doppler-auth-api</span><span class="w"></span>
  926. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  927. <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">auth-api-sa-json</span><span class="w"></span>
  928. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  929. <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>
  930. <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">SA_JSON</span><span class="w"></span>
  931. </code></pre></div>
  932. <p><img alt="Doppler JSON Secret" src="../../pictures/doppler-json.png" /></p>
  933. <h2 id="5-name-transformer">5. Name transformer</h2>
  934. <p>Name transformers format keys from Doppler's UPPER_SNAKE_CASE to one of the following alternatives:</p>
  935. <ul>
  936. <li>upper-camel</li>
  937. <li>camel</li>
  938. <li>lower-snake</li>
  939. <li>tf-var</li>
  940. <li>dotnet-env</li>
  941. </ul>
  942. <p>Name transformers require a specifically configured <code>SecretStore</code>:</p>
  943. <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>
  944. <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>
  945. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  946. <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">doppler-auth-api-dotnet-env</span><span class="w"></span>
  947. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  948. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  949. <span class="w"> </span><span class="nt">doppler</span><span class="p">:</span><span class="w"></span>
  950. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  951. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  952. <span class="w"> </span><span class="nt">dopplerToken</span><span class="p">:</span><span class="w"></span>
  953. <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">doppler-token-auth-api</span><span class="w"></span>
  954. <span class="w"> </span><span class="nt">nameTransformer</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dotnet-env</span><span class="w"></span>
  955. </code></pre></div>
  956. <p>Then an <code>ExternalSecret</code> referencing the <code>SecretStore</code>:</p>
  957. <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>
  958. <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>
  959. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  960. <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">doppler-auth-api-dotnet-env</span><span class="w"></span>
  961. <span class="nt">spec</span><span class="p">:</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">doppler-auth-api-dotnet-env</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">doppler-auth-api-dotnet-env</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">find</span><span class="p">:</span><span class="w"></span>
  970. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  971. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.*</span><span class="w"></span>
  972. </code></pre></div>
  973. <p><img alt="Doppler name transformer" src="../../pictures/doppler-name-transformer.png" /></p>
  974. <h3 id="6-download">6. Download</h3>
  975. <p>A single <code>DOPPLER_SECRETS_FILE</code> key is set where the value is the secrets downloaded in one of the following formats:</p>
  976. <ul>
  977. <li>json</li>
  978. <li>dotnet-json</li>
  979. <li>env</li>
  980. <li>env-no-quotes</li>
  981. <li>yaml</li>
  982. </ul>
  983. <p>Downloading secrets requires a specifically configured <code>SecretStore</code>:</p>
  984. <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>
  985. <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>
  986. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  987. <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">doppler-auth-api-json-file</span><span class="w"></span>
  988. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  989. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  990. <span class="w"> </span><span class="nt">doppler</span><span class="p">:</span><span class="w"></span>
  991. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  992. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  993. <span class="w"> </span><span class="nt">dopplerToken</span><span class="p">:</span><span class="w"></span>
  994. <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">doppler-token-auth-api</span><span class="w"></span>
  995. <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">dopplerToken</span><span class="w"></span>
  996. <span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">json</span><span class="w"></span>
  997. </code></pre></div>
  998. <p>Then an <code>ExternalSecret</code> referencing the <code>SecretStore</code>:</p>
  999. <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>
  1000. <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>
  1001. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  1002. <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">auth-api-json-file</span><span class="w"></span>
  1003. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  1004. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  1005. <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>
  1006. <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">doppler-auth-api-json-file</span><span class="w"></span>
  1007. <span class="w"> </span><span class="nt">target</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">auth-api-json-file</span><span class="w"></span>
  1009. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  1010. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  1011. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DOPPLER_SECRETS_FILE</span><span class="w"></span>
  1012. </code></pre></div>
  1013. <p><img alt="Doppler download" src="../../pictures/doppler-download.png" /></p>
  1014. </article>
  1015. </div>
  1016. </div>
  1017. </main>
  1018. <footer class="md-footer">
  1019. <nav class="md-footer__inner md-grid" aria-label="Footer">
  1020. <a href="../senhasegura-dsm/" class="md-footer__link md-footer__link--prev" aria-label="Previous: senhasegura DevOps Secrets Management (DSM)" rel="prev">
  1021. <div class="md-footer__button md-icon">
  1022. <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>
  1023. </div>
  1024. <div class="md-footer__title">
  1025. <div class="md-ellipsis">
  1026. <span class="md-footer__direction">
  1027. Previous
  1028. </span>
  1029. senhasegura DevOps Secrets Management (DSM)
  1030. </div>
  1031. </div>
  1032. </a>
  1033. <a href="../keeper-security/" class="md-footer__link md-footer__link--next" aria-label="Next: Keeper Security" rel="next">
  1034. <div class="md-footer__title">
  1035. <div class="md-ellipsis">
  1036. <span class="md-footer__direction">
  1037. Next
  1038. </span>
  1039. Keeper Security
  1040. </div>
  1041. </div>
  1042. <div class="md-footer__button md-icon">
  1043. <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>
  1044. </div>
  1045. </a>
  1046. </nav>
  1047. <div class="md-footer-meta md-typeset">
  1048. <div class="md-footer-meta__inner md-grid">
  1049. <div class="md-copyright">
  1050. <div class="md-copyright__highlight">
  1051. &copy; 2023 The external-secrets Authors.<br/>
  1052. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1053. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1054. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1055. </div>
  1056. Made with
  1057. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1058. Material for MkDocs
  1059. </a>
  1060. </div>
  1061. </div>
  1062. </div>
  1063. </footer>
  1064. </div>
  1065. <div class="md-dialog" data-md-component="dialog">
  1066. <div class="md-dialog__inner md-typeset"></div>
  1067. </div>
  1068. <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>
  1069. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1070. </body>
  1071. </html>