index.html 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886
  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>Webhook - 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="#generic-webhook" 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. Webhook
  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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href="../.." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../../overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../../api/externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../../api/secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../../api/clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../../guides/introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../guides/getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../../guides/templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../guides/templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../guides/controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  242. Decoding Strategies
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../guides/getallsecrets/" class="md-nav__link">
  247. Getting Multiple Secrets
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  252. Multi Tenancy
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../guides/metrics/" class="md-nav__link">
  257. Metrics
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  262. Rewriting Keys
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="../../guides/v1beta1/" class="md-nav__link">
  267. Upgrading to v1beta1
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../../guides/using-latest-image/" class="md-nav__link">
  272. Using Latest Image
  273. </a>
  274. </li>
  275. </ul>
  276. </nav>
  277. </li>
  278. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  279. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  280. <label class="md-nav__link" for="__nav_5">
  281. Provider
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  285. <label class="md-nav__title" for="__nav_5">
  286. <span class="md-nav__icon md-icon"></span>
  287. Provider
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  292. <label class="md-nav__link" for="__nav_5_1">
  293. AWS
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_1">
  298. <span class="md-nav__icon md-icon"></span>
  299. AWS
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../aws-secrets-manager/" class="md-nav__link">
  304. Secrets Manager
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../aws-parameter-store/" class="md-nav__link">
  309. Parameter Store
  310. </a>
  311. </li>
  312. </ul>
  313. </nav>
  314. </li>
  315. <li class="md-nav__item md-nav__item--nested">
  316. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  317. <label class="md-nav__link" for="__nav_5_2">
  318. Azure
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  322. <label class="md-nav__title" for="__nav_5_2">
  323. <span class="md-nav__icon md-icon"></span>
  324. Azure
  325. </label>
  326. <ul class="md-nav__list" data-md-scrollfix>
  327. <li class="md-nav__item">
  328. <a href="../azure-key-vault/" class="md-nav__link">
  329. Key Vault
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. <li class="md-nav__item md-nav__item--nested">
  336. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  337. <label class="md-nav__link" for="__nav_5_3">
  338. Google
  339. <span class="md-nav__icon md-icon"></span>
  340. </label>
  341. <nav class="md-nav" aria-label="Google" data-md-level="2">
  342. <label class="md-nav__title" for="__nav_5_3">
  343. <span class="md-nav__icon md-icon"></span>
  344. Google
  345. </label>
  346. <ul class="md-nav__list" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="../google-secrets-manager/" class="md-nav__link">
  349. Secret Manager
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  357. <label class="md-nav__link" for="__nav_5_4">
  358. IBM
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_5_4">
  363. <span class="md-nav__icon md-icon"></span>
  364. IBM
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../ibm-secrets-manager/" class="md-nav__link">
  369. Secrets Manager
  370. </a>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../akeyless/" class="md-nav__link">
  377. Akeyless
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../hashicorp-vault/" class="md-nav__link">
  382. HashiCorp Vault
  383. </a>
  384. </li>
  385. <li class="md-nav__item md-nav__item--nested">
  386. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  387. <label class="md-nav__link" for="__nav_5_7">
  388. Yandex
  389. <span class="md-nav__icon md-icon"></span>
  390. </label>
  391. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  392. <label class="md-nav__title" for="__nav_5_7">
  393. <span class="md-nav__icon md-icon"></span>
  394. Yandex
  395. </label>
  396. <ul class="md-nav__list" data-md-scrollfix>
  397. <li class="md-nav__item">
  398. <a href="../yandex-certificate-manager/" class="md-nav__link">
  399. Certificate Manager
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../yandex-lockbox/" class="md-nav__link">
  404. Lockbox
  405. </a>
  406. </li>
  407. </ul>
  408. </nav>
  409. </li>
  410. <li class="md-nav__item md-nav__item--nested">
  411. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  412. <label class="md-nav__link" for="__nav_5_8">
  413. Gitlab
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  417. <label class="md-nav__title" for="__nav_5_8">
  418. <span class="md-nav__icon md-icon"></span>
  419. Gitlab
  420. </label>
  421. <ul class="md-nav__list" data-md-scrollfix>
  422. <li class="md-nav__item">
  423. <a href="../gitlab-project-variables/" class="md-nav__link">
  424. Gitlab Project Variables
  425. </a>
  426. </li>
  427. </ul>
  428. </nav>
  429. </li>
  430. <li class="md-nav__item md-nav__item--nested">
  431. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  432. <label class="md-nav__link" for="__nav_5_9">
  433. Oracle
  434. <span class="md-nav__icon md-icon"></span>
  435. </label>
  436. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  437. <label class="md-nav__title" for="__nav_5_9">
  438. <span class="md-nav__icon md-icon"></span>
  439. Oracle
  440. </label>
  441. <ul class="md-nav__list" data-md-scrollfix>
  442. <li class="md-nav__item">
  443. <a href="../oracle-vault/" class="md-nav__link">
  444. Oracle Vault
  445. </a>
  446. </li>
  447. </ul>
  448. </nav>
  449. </li>
  450. <li class="md-nav__item md-nav__item--nested">
  451. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  452. <label class="md-nav__link" for="__nav_5_10">
  453. 1Password
  454. <span class="md-nav__icon md-icon"></span>
  455. </label>
  456. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  457. <label class="md-nav__title" for="__nav_5_10">
  458. <span class="md-nav__icon md-icon"></span>
  459. 1Password
  460. </label>
  461. <ul class="md-nav__list" data-md-scrollfix>
  462. <li class="md-nav__item">
  463. <a href="../1password-automation/" class="md-nav__link">
  464. Secrets Automation
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. <li class="md-nav__item md-nav__item--active">
  471. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  472. <label class="md-nav__link md-nav__link--active" for="__toc">
  473. Webhook
  474. <span class="md-nav__icon md-icon"></span>
  475. </label>
  476. <a href="./" class="md-nav__link md-nav__link--active">
  477. Webhook
  478. </a>
  479. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  480. <label class="md-nav__title" for="__toc">
  481. <span class="md-nav__icon md-icon"></span>
  482. Table of contents
  483. </label>
  484. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  485. <li class="md-nav__item">
  486. <a href="#generic-webhook" class="md-nav__link">
  487. Generic Webhook
  488. </a>
  489. <nav class="md-nav" aria-label="Generic Webhook">
  490. <ul class="md-nav__list">
  491. <li class="md-nav__item">
  492. <a href="#example" class="md-nav__link">
  493. Example
  494. </a>
  495. <nav class="md-nav" aria-label="Example">
  496. <ul class="md-nav__list">
  497. <li class="md-nav__item">
  498. <a href="#limitations" class="md-nav__link">
  499. Limitations
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="#templating" class="md-nav__link">
  507. Templating
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="#all-parameters" class="md-nav__link">
  512. All Parameters
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. </ul>
  519. </nav>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../fake/" class="md-nav__link">
  523. Fake
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../kubernetes/" class="md-nav__link">
  528. Kubernetes
  529. </a>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  533. <label class="md-nav__link" for="__nav_5_14">
  534. senhasegura
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  538. <label class="md-nav__title" for="__nav_5_14">
  539. <span class="md-nav__icon md-icon"></span>
  540. senhasegura
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../senhasegura-dsm/" class="md-nav__link">
  545. DevOps Secrets Management (DSM)
  546. </a>
  547. </li>
  548. </ul>
  549. </nav>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../doppler/" class="md-nav__link">
  553. Doppler
  554. </a>
  555. </li>
  556. </ul>
  557. </nav>
  558. </li>
  559. <li class="md-nav__item md-nav__item--nested">
  560. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  561. <label class="md-nav__link" for="__nav_6">
  562. Examples
  563. <span class="md-nav__icon md-icon"></span>
  564. </label>
  565. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  566. <label class="md-nav__title" for="__nav_6">
  567. <span class="md-nav__icon md-icon"></span>
  568. Examples
  569. </label>
  570. <ul class="md-nav__list" data-md-scrollfix>
  571. <li class="md-nav__item">
  572. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  573. FluxCD
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  578. Anchore Engine
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  583. Jenkins
  584. </a>
  585. </li>
  586. </ul>
  587. </nav>
  588. </li>
  589. <li class="md-nav__item md-nav__item--nested">
  590. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  591. <label class="md-nav__link" for="__nav_7">
  592. External Resources
  593. <span class="md-nav__icon md-icon"></span>
  594. </label>
  595. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  596. <label class="md-nav__title" for="__nav_7">
  597. <span class="md-nav__icon md-icon"></span>
  598. External Resources
  599. </label>
  600. <ul class="md-nav__list" data-md-scrollfix>
  601. <li class="md-nav__item">
  602. <a href="../../eso-talks/" class="md-nav__link">
  603. Talks
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../../eso-demos/" class="md-nav__link">
  608. Demos
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../../eso-blogs/" class="md-nav__link">
  613. Blogs
  614. </a>
  615. </li>
  616. </ul>
  617. </nav>
  618. </li>
  619. <li class="md-nav__item md-nav__item--nested">
  620. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  621. <label class="md-nav__link" for="__nav_8">
  622. References
  623. <span class="md-nav__icon md-icon"></span>
  624. </label>
  625. <nav class="md-nav" aria-label="References" data-md-level="1">
  626. <label class="md-nav__title" for="__nav_8">
  627. <span class="md-nav__icon md-icon"></span>
  628. References
  629. </label>
  630. <ul class="md-nav__list" data-md-scrollfix>
  631. <li class="md-nav__item">
  632. <a href="../../spec/" class="md-nav__link">
  633. API specification
  634. </a>
  635. </li>
  636. </ul>
  637. </nav>
  638. </li>
  639. <li class="md-nav__item md-nav__item--nested">
  640. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  641. <label class="md-nav__link" for="__nav_9">
  642. Contributing
  643. <span class="md-nav__icon md-icon"></span>
  644. </label>
  645. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  646. <label class="md-nav__title" for="__nav_9">
  647. <span class="md-nav__icon md-icon"></span>
  648. Contributing
  649. </label>
  650. <ul class="md-nav__list" data-md-scrollfix>
  651. <li class="md-nav__item">
  652. <a href="../../contributing/devguide/" class="md-nav__link">
  653. Developer guide
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../contributing/process/" class="md-nav__link">
  658. Contributing Process
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../contributing/release/" class="md-nav__link">
  663. Release Process
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../../contributing/coc/" class="md-nav__link">
  668. Code of Conduct
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../contributing/roadmap/" class="md-nav__link">
  673. Roadmap
  674. </a>
  675. </li>
  676. </ul>
  677. </nav>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="../../faq/" class="md-nav__link">
  681. FAQ
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../stability-support/" class="md-nav__link">
  686. Stability and Support
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../deprecation-policy/" class="md-nav__link">
  691. Deprecation Policy
  692. </a>
  693. </li>
  694. </ul>
  695. </nav>
  696. </div>
  697. </div>
  698. </div>
  699. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  700. <div class="md-sidebar__scrollwrap">
  701. <div class="md-sidebar__inner">
  702. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  703. <label class="md-nav__title" for="__toc">
  704. <span class="md-nav__icon md-icon"></span>
  705. Table of contents
  706. </label>
  707. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  708. <li class="md-nav__item">
  709. <a href="#generic-webhook" class="md-nav__link">
  710. Generic Webhook
  711. </a>
  712. <nav class="md-nav" aria-label="Generic Webhook">
  713. <ul class="md-nav__list">
  714. <li class="md-nav__item">
  715. <a href="#example" class="md-nav__link">
  716. Example
  717. </a>
  718. <nav class="md-nav" aria-label="Example">
  719. <ul class="md-nav__list">
  720. <li class="md-nav__item">
  721. <a href="#limitations" class="md-nav__link">
  722. Limitations
  723. </a>
  724. </li>
  725. </ul>
  726. </nav>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="#templating" class="md-nav__link">
  730. Templating
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="#all-parameters" class="md-nav__link">
  735. All Parameters
  736. </a>
  737. </li>
  738. </ul>
  739. </nav>
  740. </li>
  741. </ul>
  742. </nav>
  743. </div>
  744. </div>
  745. </div>
  746. <div class="md-content" data-md-component="content">
  747. <article class="md-content__inner md-typeset">
  748. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/webhook.md" title="Edit this page" class="md-content__button md-icon">
  749. <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>
  750. </a>
  751. <h1>Webhook</h1>
  752. <h2 id="generic-webhook">Generic Webhook</h2>
  753. <p>External Secrets Operator can integrate with simple web apis by specifying the endpoint</p>
  754. <h3 id="example">Example</h3>
  755. <p>First, create a SecretStore with a webhook backend. We'll use a static user/password <code>root</code>:</p>
  756. <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>
  757. <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>
  758. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  759. <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">webhook-backend</span><span class="w"></span>
  760. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  761. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  762. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span><span class="w"></span>
  763. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://httpbin.org/get?parameter={{</span><span class="nv"> </span><span class="s">.remoteRef.key</span><span class="nv"> </span><span class="s">}}&quot;</span><span class="w"></span>
  764. <span class="w"> </span><span class="nt">result</span><span class="p">:</span><span class="w"></span>
  765. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$.args.parameter&quot;</span><span class="w"></span>
  766. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"></span>
  767. <span class="w"> </span><span class="nt">Content-Type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application/json</span><span class="w"></span>
  768. <span class="w"> </span><span class="nt">Authorization</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Basic {{ print .auth.username &quot;:&quot; .auth.password | b64enc }}</span><span class="w"></span>
  769. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span><span class="w"></span>
  770. <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">auth</span><span class="w"></span>
  771. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  772. <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">webhook-credentials</span><span class="w"></span>
  773. <span class="nn">---</span><span class="w"></span>
  774. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  775. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  776. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  777. <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">webhook-credentials</span><span class="w"></span>
  778. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  779. <span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span><span class="w"></span>
  780. <span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span><span class="w"> </span><span class="c1"># &quot;test&quot;</span><span class="w"></span>
  781. </code></pre></div>
  782. <p>NB: This is obviously not practical because it just returns the key as the result, but it shows how it works</p>
  783. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in all <code>secrets</code> references with the namespaces where the secrets reside.</p>
  784. <p>Now create an ExternalSecret that uses the above SecretStore:</p>
  785. <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>
  786. <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>
  787. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  788. <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">webhook-example</span><span class="w"></span>
  789. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  790. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15s&quot;</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  792. <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">webhook-backend</span><span class="w"></span>
  793. <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>
  794. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  795. <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-sync</span><span class="w"></span>
  796. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  797. <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">foobar</span><span class="w"></span>
  798. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  799. <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">secret</span><span class="w"></span>
  800. <span class="nn">---</span><span class="w"></span>
  801. <span class="c1"># will create a secret with:</span><span class="w"></span>
  802. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  803. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  804. <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-sync</span><span class="w"></span>
  805. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  806. <span class="w"> </span><span class="nt">foobar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">c2VjcmV0</span><span class="w"></span>
  807. </code></pre></div>
  808. <h4 id="limitations">Limitations</h4>
  809. <p>Webhook does not support authorization, other than what can be sent by generating http headers</p>
  810. <h3 id="templating">Templating</h3>
  811. <p>Generic WebHook provider uses the templating engine to generate the API call. It can be used in the url, headers, body and result.jsonPath fields.</p>
  812. <p>The provider inserts the secret to be retrieved in the object named <code>remoteRef</code>.</p>
  813. <p>In addition, secrets can be added as named objects, for example to use in authorization headers.
  814. Each secret has a <code>name</code> property which determines the name of the object in the templating engine.</p>
  815. <h3 id="all-parameters">All Parameters</h3>
  816. <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>
  817. <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>
  818. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  819. <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">statervault</span><span class="w"></span>
  820. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  821. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  822. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span><span class="w"></span>
  823. <span class="w"> </span><span class="c1"># Url to call. Use templating engine to fill in the request parameters</span><span class="w"></span>
  824. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;url&gt;</span><span class="w"></span>
  825. <span class="w"> </span><span class="c1"># http method, defaults to GET</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;method&gt;</span><span class="w"></span>
  827. <span class="w"> </span><span class="c1"># Timeout in duration (1s, 1m, etc)</span><span class="w"></span>
  828. <span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1s</span><span class="w"></span>
  829. <span class="w"> </span><span class="nt">result</span><span class="p">:</span><span class="w"></span>
  830. <span class="w"> </span><span class="c1"># [jsonPath](https://jsonpath.com) syntax, which also can be templated</span><span class="w"></span>
  831. <span class="w"> </span><span class="nt">jsonPath</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;jsonPath&gt;</span><span class="w"></span>
  832. <span class="w"> </span><span class="c1"># Map of headers, can be templated</span><span class="w"></span>
  833. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"></span>
  834. <span class="w"> </span><span class="nt">&lt;Header-Name&gt;</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;header contents&gt;</span><span class="w"></span>
  835. <span class="w"> </span><span class="c1"># Body to sent as request, can be templated (optional)</span><span class="w"></span>
  836. <span class="w"> </span><span class="nt">body</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;body&gt;</span><span class="w"></span>
  837. <span class="w"> </span><span class="c1"># List of secrets to expose to the templating engine</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span><span class="w"></span>
  839. <span class="w"> </span><span class="c1"># Use this name to refer to this secret in templating, above</span><span class="w"></span>
  840. <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">&lt;name&gt;</span><span class="w"></span>
  841. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span><span class="w"></span>
  842. <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">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;name&gt;</span><span class="w"></span>
  844. <span class="w"> </span><span class="c1"># Add CAs here for the TLS handshake</span><span class="w"></span>
  845. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;base64 encoded cabundle&gt;</span><span class="w"></span>
  846. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"></span>
  847. <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">Secret or COnfigMap</span><span class="w"></span>
  848. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;name of secret or configmap&gt;</span><span class="w"></span>
  849. <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">&lt;namespace&gt;</span><span class="w"> </span><span class="c1"># Only used in ClusterSecretStores</span><span class="w"></span>
  850. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;key inside secret&gt;</span><span class="w"></span>
  851. </code></pre></div>
  852. </article>
  853. </div>
  854. </div>
  855. </main>
  856. <footer class="md-footer">
  857. <nav class="md-footer__inner md-grid" aria-label="Footer">
  858. <a href="../1password-automation/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Secrets Automation" rel="prev">
  859. <div class="md-footer__button md-icon">
  860. <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>
  861. </div>
  862. <div class="md-footer__title">
  863. <div class="md-ellipsis">
  864. <span class="md-footer__direction">
  865. Previous
  866. </span>
  867. Secrets Automation
  868. </div>
  869. </div>
  870. </a>
  871. <a href="../fake/" class="md-footer__link md-footer__link--next" aria-label="Next: Fake" rel="next">
  872. <div class="md-footer__title">
  873. <div class="md-ellipsis">
  874. <span class="md-footer__direction">
  875. Next
  876. </span>
  877. Fake
  878. </div>
  879. </div>
  880. <div class="md-footer__button md-icon">
  881. <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>
  882. </div>
  883. </a>
  884. </nav>
  885. <div class="md-footer-meta md-typeset">
  886. <div class="md-footer-meta__inner md-grid">
  887. <div class="md-copyright">
  888. <div class="md-copyright__highlight">
  889. &copy; 2022 The external-secrets Authors.<br/>
  890. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  891. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  892. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  893. </div>
  894. Made with
  895. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  896. Material for MkDocs
  897. </a>
  898. </div>
  899. </div>
  900. </div>
  901. </footer>
  902. </div>
  903. <div class="md-dialog" data-md-component="dialog">
  904. <div class="md-dialog__inner md-typeset"></div>
  905. </div>
  906. <script id="__config" type="application/json">{"base": "../..", "features": [], "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>
  907. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  908. </body>
  909. </html>