index.html 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../1password-automation/">
  7. <link rel="next" href="../fake/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.9">
  10. <title>Webhook - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#generic-webhook" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Webhook
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item md-tabs__item--active">
  126. <a href="../aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../../introduction/overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../introduction/getting-started/" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. Getting started
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/faq/" class="md-nav__link">
  200. <span class="md-ellipsis">
  201. FAQ
  202. </span>
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../../introduction/stability-support/" class="md-nav__link">
  207. <span class="md-ellipsis">
  208. Stability and Support
  209. </span>
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  214. <span class="md-ellipsis">
  215. Deprecation Policy
  216. </span>
  217. </a>
  218. </li>
  219. </ul>
  220. </nav>
  221. </li>
  222. <li class="md-nav__item md-nav__item--nested">
  223. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  224. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  225. <span class="md-ellipsis">
  226. API
  227. </span>
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  231. <label class="md-nav__title" for="__nav_2">
  232. <span class="md-nav__icon md-icon"></span>
  233. API
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item">
  237. <a href="../../api/components/" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Components
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  245. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  246. <span class="md-ellipsis">
  247. Core Resources
  248. </span>
  249. <span class="md-nav__icon md-icon"></span>
  250. </label>
  251. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  252. <label class="md-nav__title" for="__nav_2_2">
  253. <span class="md-nav__icon md-icon"></span>
  254. Core Resources
  255. </label>
  256. <ul class="md-nav__list" data-md-scrollfix>
  257. <li class="md-nav__item">
  258. <a href="../../api/externalsecret/" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. ExternalSecret
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="../../api/secretstore/" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. SecretStore
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="../../api/clustersecretstore/" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. ClusterSecretStore
  275. </span>
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  280. <span class="md-ellipsis">
  281. ClusterExternalSecret
  282. </span>
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../../api/pushsecret/" class="md-nav__link">
  287. <span class="md-ellipsis">
  288. PushSecret
  289. </span>
  290. </a>
  291. </li>
  292. </ul>
  293. </nav>
  294. </li>
  295. <li class="md-nav__item md-nav__item--nested">
  296. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  297. <div class="md-nav__link md-nav__container">
  298. <a href="../../api/generator/" class="md-nav__link ">
  299. <span class="md-ellipsis">
  300. Generators
  301. </span>
  302. </a>
  303. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  304. <span class="md-nav__icon md-icon"></span>
  305. </label>
  306. </div>
  307. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  308. <label class="md-nav__title" for="__nav_2_3">
  309. <span class="md-nav__icon md-icon"></span>
  310. Generators
  311. </label>
  312. <ul class="md-nav__list" data-md-scrollfix>
  313. <li class="md-nav__item">
  314. <a href="../../api/generator/acr/" class="md-nav__link">
  315. <span class="md-ellipsis">
  316. Azure Container Registry
  317. </span>
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../../api/generator/ecr/" class="md-nav__link">
  322. <span class="md-ellipsis">
  323. AWS Elastic Container Registry
  324. </span>
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/generator/gcr/" class="md-nav__link">
  329. <span class="md-ellipsis">
  330. Google Container Registry
  331. </span>
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../../api/generator/vault/" class="md-nav__link">
  336. <span class="md-ellipsis">
  337. Vault Dynamic Secret
  338. </span>
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../../api/generator/password/" class="md-nav__link">
  343. <span class="md-ellipsis">
  344. Password
  345. </span>
  346. </a>
  347. </li>
  348. <li class="md-nav__item">
  349. <a href="../../api/generator/fake/" class="md-nav__link">
  350. <span class="md-ellipsis">
  351. Fake
  352. </span>
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../../api/generator/webhook/" class="md-nav__link">
  357. <span class="md-ellipsis">
  358. Webhook
  359. </span>
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item md-nav__item--nested">
  366. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  367. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  368. <span class="md-ellipsis">
  369. Reference Docs
  370. </span>
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  374. <label class="md-nav__title" for="__nav_2_4">
  375. <span class="md-nav__icon md-icon"></span>
  376. Reference Docs
  377. </label>
  378. <ul class="md-nav__list" data-md-scrollfix>
  379. <li class="md-nav__item">
  380. <a href="../../api/spec/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. API specification
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../../api/controller-options/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. Controller Options
  390. </span>
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="../../api/metrics/" class="md-nav__link">
  395. <span class="md-ellipsis">
  396. Metrics
  397. </span>
  398. </a>
  399. </li>
  400. </ul>
  401. </nav>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item md-nav__item--nested">
  407. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  408. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  409. <span class="md-ellipsis">
  410. Guides
  411. </span>
  412. <span class="md-nav__icon md-icon"></span>
  413. </label>
  414. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  415. <label class="md-nav__title" for="__nav_3">
  416. <span class="md-nav__icon md-icon"></span>
  417. Guides
  418. </label>
  419. <ul class="md-nav__list" data-md-scrollfix>
  420. <li class="md-nav__item">
  421. <a href="../../guides/introduction/" class="md-nav__link">
  422. <span class="md-ellipsis">
  423. Introduction
  424. </span>
  425. </a>
  426. </li>
  427. <li class="md-nav__item md-nav__item--nested">
  428. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  429. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  430. <span class="md-ellipsis">
  431. External Secrets
  432. </span>
  433. <span class="md-nav__icon md-icon"></span>
  434. </label>
  435. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  436. <label class="md-nav__title" for="__nav_3_2">
  437. <span class="md-nav__icon md-icon"></span>
  438. External Secrets
  439. </label>
  440. <ul class="md-nav__list" data-md-scrollfix>
  441. <li class="md-nav__item">
  442. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Extract structured data
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/getallsecrets/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Find Secrets by Name or Metadata
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  457. <span class="md-ellipsis">
  458. Rewriting Keys
  459. </span>
  460. </a>
  461. </li>
  462. <li class="md-nav__item md-nav__item--nested">
  463. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  464. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  465. <span class="md-ellipsis">
  466. Advanced Templating
  467. </span>
  468. <span class="md-nav__icon md-icon"></span>
  469. </label>
  470. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  471. <label class="md-nav__title" for="__nav_3_2_4">
  472. <span class="md-nav__icon md-icon"></span>
  473. Advanced Templating
  474. </label>
  475. <ul class="md-nav__list" data-md-scrollfix>
  476. <li class="md-nav__item">
  477. <a href="../../guides/templating/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. v2
  480. </span>
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../guides/templating-v1/" class="md-nav__link">
  485. <span class="md-ellipsis">
  486. v1
  487. </span>
  488. </a>
  489. </li>
  490. </ul>
  491. </nav>
  492. </li>
  493. <li class="md-nav__item">
  494. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  495. <span class="md-ellipsis">
  496. Kubernetes Secret Types
  497. </span>
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Lifecycle: ownership & deletion
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Decoding Strategies
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="../../guides/controller-class/" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Controller Classes
  518. </span>
  519. </a>
  520. </li>
  521. </ul>
  522. </nav>
  523. </li>
  524. <li class="md-nav__item">
  525. <a href="../../guides/generator/" class="md-nav__link">
  526. <span class="md-ellipsis">
  527. Generators
  528. </span>
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../../guides/pushsecrets/" class="md-nav__link">
  533. <span class="md-ellipsis">
  534. Push Secrets
  535. </span>
  536. </a>
  537. </li>
  538. <li class="md-nav__item md-nav__item--nested">
  539. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  540. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  541. <span class="md-ellipsis">
  542. Operations
  543. </span>
  544. <span class="md-nav__icon md-icon"></span>
  545. </label>
  546. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  547. <label class="md-nav__title" for="__nav_3_5">
  548. <span class="md-nav__icon md-icon"></span>
  549. Operations
  550. </label>
  551. <ul class="md-nav__list" data-md-scrollfix>
  552. <li class="md-nav__item">
  553. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  554. <span class="md-ellipsis">
  555. Multi Tenancy
  556. </span>
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="../../guides/security-best-practices/" class="md-nav__link">
  561. <span class="md-ellipsis">
  562. Security Best Practices
  563. </span>
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../../guides/threat-model/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Threat Model
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../guides/v1beta1/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Upgrading to v1beta1
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../guides/using-latest-image/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Using Latest Image
  584. </span>
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  589. <span class="md-ellipsis">
  590. Disable Cluster Features
  591. </span>
  592. </a>
  593. </li>
  594. </ul>
  595. </nav>
  596. </li>
  597. </ul>
  598. </nav>
  599. </li>
  600. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  601. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  602. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  603. <span class="md-ellipsis">
  604. Provider
  605. </span>
  606. <span class="md-nav__icon md-icon"></span>
  607. </label>
  608. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  609. <label class="md-nav__title" for="__nav_4">
  610. <span class="md-nav__icon md-icon"></span>
  611. Provider
  612. </label>
  613. <ul class="md-nav__list" data-md-scrollfix>
  614. <li class="md-nav__item">
  615. <a href="../aws-secrets-manager/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. AWS Secrets Manager
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../aws-parameter-store/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. AWS Parameter Store
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../azure-key-vault/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Azure Key Vault
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../chef/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Chef
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../conjur/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. CyberArk Conjur
  646. </span>
  647. </a>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../google-secrets-manager/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Google Cloud Secret Manager
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../hashicorp-vault/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. HashiCorp Vault
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../kubernetes/" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. Kubernetes
  667. </span>
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../ibm-secrets-manager/" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. IBM Secrets Manager
  674. </span>
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../akeyless/" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Akeyless
  681. </span>
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../yandex-certificate-manager/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Yandex Certificate Manager
  688. </span>
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../yandex-lockbox/" class="md-nav__link">
  693. <span class="md-ellipsis">
  694. Yandex Lockbox
  695. </span>
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../alibaba/" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. Alibaba Cloud
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../gitlab-variables/" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. GitLab Variables
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../oracle-vault/" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. Oracle Vault
  716. </span>
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="../1password-automation/" class="md-nav__link">
  721. <span class="md-ellipsis">
  722. 1Password Secrets Automation
  723. </span>
  724. </a>
  725. </li>
  726. <li class="md-nav__item md-nav__item--active">
  727. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  728. <label class="md-nav__link md-nav__link--active" for="__toc">
  729. <span class="md-ellipsis">
  730. Webhook
  731. </span>
  732. <span class="md-nav__icon md-icon"></span>
  733. </label>
  734. <a href="./" class="md-nav__link md-nav__link--active">
  735. <span class="md-ellipsis">
  736. Webhook
  737. </span>
  738. </a>
  739. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  740. <label class="md-nav__title" for="__toc">
  741. <span class="md-nav__icon md-icon"></span>
  742. Table of contents
  743. </label>
  744. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  745. <li class="md-nav__item">
  746. <a href="#generic-webhook" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Generic Webhook
  749. </span>
  750. </a>
  751. <nav class="md-nav" aria-label="Generic Webhook">
  752. <ul class="md-nav__list">
  753. <li class="md-nav__item">
  754. <a href="#example" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Example
  757. </span>
  758. </a>
  759. <nav class="md-nav" aria-label="Example">
  760. <ul class="md-nav__list">
  761. <li class="md-nav__item">
  762. <a href="#limitations" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Limitations
  765. </span>
  766. </a>
  767. </li>
  768. </ul>
  769. </nav>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="#templating" class="md-nav__link">
  773. <span class="md-ellipsis">
  774. Templating
  775. </span>
  776. </a>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#all-parameters" class="md-nav__link">
  780. <span class="md-ellipsis">
  781. All Parameters
  782. </span>
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="#webhook-as-generators" class="md-nav__link">
  787. <span class="md-ellipsis">
  788. Webhook as generators
  789. </span>
  790. </a>
  791. </li>
  792. </ul>
  793. </nav>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../fake/" class="md-nav__link">
  800. <span class="md-ellipsis">
  801. Fake
  802. </span>
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="../senhasegura-dsm/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. senhasegura DevOps Secrets Management (DSM)
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../doppler/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. Doppler
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../keeper-security/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Keeper Security
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../cloak/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. Cloak End 2 End Encrypted Secrets
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../scaleway/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Scaleway
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../delinea/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Delinea
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../pulumi/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Pulumi ESC
  851. </span>
  852. </a>
  853. </li>
  854. </ul>
  855. </nav>
  856. </li>
  857. <li class="md-nav__item md-nav__item--nested">
  858. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  859. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  860. <span class="md-ellipsis">
  861. Examples
  862. </span>
  863. <span class="md-nav__icon md-icon"></span>
  864. </label>
  865. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  866. <label class="md-nav__title" for="__nav_5">
  867. <span class="md-nav__icon md-icon"></span>
  868. Examples
  869. </label>
  870. <ul class="md-nav__list" data-md-scrollfix>
  871. <li class="md-nav__item">
  872. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. FluxCD
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Anchore Engine
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Jenkins
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../examples/bitwarden/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. BitWarden
  896. </span>
  897. </a>
  898. </li>
  899. </ul>
  900. </nav>
  901. </li>
  902. <li class="md-nav__item md-nav__item--nested">
  903. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  904. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  905. <span class="md-ellipsis">
  906. Community
  907. </span>
  908. <span class="md-nav__icon md-icon"></span>
  909. </label>
  910. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  911. <label class="md-nav__title" for="__nav_6">
  912. <span class="md-nav__icon md-icon"></span>
  913. Community
  914. </label>
  915. <ul class="md-nav__list" data-md-scrollfix>
  916. <li class="md-nav__item md-nav__item--nested">
  917. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  918. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  919. <span class="md-ellipsis">
  920. Contributing
  921. </span>
  922. <span class="md-nav__icon md-icon"></span>
  923. </label>
  924. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  925. <label class="md-nav__title" for="__nav_6_1">
  926. <span class="md-nav__icon md-icon"></span>
  927. Contributing
  928. </label>
  929. <ul class="md-nav__list" data-md-scrollfix>
  930. <li class="md-nav__item">
  931. <a href="../../contributing/devguide/" class="md-nav__link">
  932. <span class="md-ellipsis">
  933. Developer guide
  934. </span>
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../../contributing/process/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Contributing Process
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../contributing/release/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Release Process
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../contributing/coc/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Code of Conduct
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../contributing/roadmap/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Roadmap
  962. </span>
  963. </a>
  964. </li>
  965. </ul>
  966. </nav>
  967. </li>
  968. <li class="md-nav__item md-nav__item--nested">
  969. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  970. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  971. <span class="md-ellipsis">
  972. External Resources
  973. </span>
  974. <span class="md-nav__icon md-icon"></span>
  975. </label>
  976. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  977. <label class="md-nav__title" for="__nav_6_2">
  978. <span class="md-nav__icon md-icon"></span>
  979. External Resources
  980. </label>
  981. <ul class="md-nav__list" data-md-scrollfix>
  982. <li class="md-nav__item">
  983. <a href="../../eso-talks/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Talks
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../../eso-demos/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Demos
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../eso-blogs/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Blogs
  1000. </span>
  1001. </a>
  1002. </li>
  1003. </ul>
  1004. </nav>
  1005. </li>
  1006. </ul>
  1007. </nav>
  1008. </li>
  1009. </ul>
  1010. </nav>
  1011. </div>
  1012. </div>
  1013. </div>
  1014. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1015. <div class="md-sidebar__scrollwrap">
  1016. <div class="md-sidebar__inner">
  1017. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1018. <label class="md-nav__title" for="__toc">
  1019. <span class="md-nav__icon md-icon"></span>
  1020. Table of contents
  1021. </label>
  1022. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1023. <li class="md-nav__item">
  1024. <a href="#generic-webhook" class="md-nav__link">
  1025. <span class="md-ellipsis">
  1026. Generic Webhook
  1027. </span>
  1028. </a>
  1029. <nav class="md-nav" aria-label="Generic Webhook">
  1030. <ul class="md-nav__list">
  1031. <li class="md-nav__item">
  1032. <a href="#example" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Example
  1035. </span>
  1036. </a>
  1037. <nav class="md-nav" aria-label="Example">
  1038. <ul class="md-nav__list">
  1039. <li class="md-nav__item">
  1040. <a href="#limitations" class="md-nav__link">
  1041. <span class="md-ellipsis">
  1042. Limitations
  1043. </span>
  1044. </a>
  1045. </li>
  1046. </ul>
  1047. </nav>
  1048. </li>
  1049. <li class="md-nav__item">
  1050. <a href="#templating" class="md-nav__link">
  1051. <span class="md-ellipsis">
  1052. Templating
  1053. </span>
  1054. </a>
  1055. </li>
  1056. <li class="md-nav__item">
  1057. <a href="#all-parameters" class="md-nav__link">
  1058. <span class="md-ellipsis">
  1059. All Parameters
  1060. </span>
  1061. </a>
  1062. </li>
  1063. <li class="md-nav__item">
  1064. <a href="#webhook-as-generators" class="md-nav__link">
  1065. <span class="md-ellipsis">
  1066. Webhook as generators
  1067. </span>
  1068. </a>
  1069. </li>
  1070. </ul>
  1071. </nav>
  1072. </li>
  1073. </ul>
  1074. </nav>
  1075. </div>
  1076. </div>
  1077. </div>
  1078. <div class="md-content" data-md-component="content">
  1079. <article class="md-content__inner md-typeset">
  1080. <h1>Webhook</h1>
  1081. <h2 id="generic-webhook">Generic Webhook</h2>
  1082. <p>External Secrets Operator can integrate with simple web apis by specifying the endpoint</p>
  1083. <h3 id="example">Example</h3>
  1084. <p>First, create a SecretStore with a webhook backend. We'll use a static user/password <code>root</code>:</p>
  1085. <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>
  1086. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1087. <span class="nt">metadata</span><span class="p">:</span>
  1088. <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>
  1089. <span class="nt">spec</span><span class="p">:</span>
  1090. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1091. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1092. <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>
  1093. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1094. <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>
  1095. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1096. <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>
  1097. <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>
  1098. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1099. <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>
  1100. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1101. <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>
  1102. <span class="nn">---</span>
  1103. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1104. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1105. <span class="nt">metadata</span><span class="p">:</span>
  1106. <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>
  1107. <span class="nt">data</span><span class="p">:</span>
  1108. <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>
  1109. <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>
  1110. </code></pre></div>
  1111. <p>NB: This is obviously not practical because it just returns the key as the result, but it shows how it works</p>
  1112. <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>
  1113. <p>Now create an ExternalSecret that uses the above SecretStore:</p>
  1114. <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>
  1115. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1116. <span class="nt">metadata</span><span class="p">:</span>
  1117. <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>
  1118. <span class="nt">spec</span><span class="p">:</span>
  1119. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;15s&quot;</span>
  1120. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1121. <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>
  1122. <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>
  1123. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1124. <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>
  1125. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1126. <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>
  1127. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1128. <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>
  1129. <span class="nn">---</span>
  1130. <span class="c1"># will create a secret with:</span>
  1131. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1132. <span class="nt">metadata</span><span class="p">:</span>
  1133. <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>
  1134. <span class="nt">data</span><span class="p">:</span>
  1135. <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>
  1136. </code></pre></div>
  1137. <h4 id="limitations">Limitations</h4>
  1138. <p>Webhook does not support authorization, other than what can be sent by generating http headers</p>
  1139. <div class="admonition note">
  1140. <p class="admonition-title">Note</p>
  1141. <p>If a webhook endpoint for a given <code>ExternalSecret</code> returns a 404 status code, the secret is considered to have been deleted. This will trigger the <code>deletionPolicy</code> set on the <code>ExternalSecret</code>.</p>
  1142. </div>
  1143. <h3 id="templating">Templating</h3>
  1144. <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>
  1145. <p>The provider inserts the secret to be retrieved in the object named <code>remoteRef</code>.</p>
  1146. <p>In addition, secrets can be added as named objects, for example to use in authorization headers.
  1147. Each secret has a <code>name</code> property which determines the name of the object in the templating engine.</p>
  1148. <h3 id="all-parameters">All Parameters</h3>
  1149. <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>
  1150. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1151. <span class="nt">metadata</span><span class="p">:</span>
  1152. <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>
  1153. <span class="nt">spec</span><span class="p">:</span>
  1154. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1155. <span class="w"> </span><span class="nt">webhook</span><span class="p">:</span>
  1156. <span class="w"> </span><span class="c1"># Url to call. Use templating engine to fill in the request parameters</span>
  1157. <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>
  1158. <span class="w"> </span><span class="c1"># http method, defaults to GET</span>
  1159. <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>
  1160. <span class="w"> </span><span class="c1"># Timeout in duration (1s, 1m, etc)</span>
  1161. <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>
  1162. <span class="w"> </span><span class="nt">result</span><span class="p">:</span>
  1163. <span class="w"> </span><span class="c1"># [jsonPath](https://jsonpath.com) syntax, which also can be templated</span>
  1164. <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>
  1165. <span class="w"> </span><span class="c1"># Map of headers, can be templated</span>
  1166. <span class="w"> </span><span class="nt">headers</span><span class="p">:</span>
  1167. <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>
  1168. <span class="w"> </span><span class="c1"># Body to sent as request, can be templated (optional)</span>
  1169. <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>
  1170. <span class="w"> </span><span class="c1"># List of secrets to expose to the templating engine</span>
  1171. <span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
  1172. <span class="w"> </span><span class="c1"># Use this name to refer to this secret in templating, above</span>
  1173. <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>
  1174. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1175. <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>
  1176. <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>
  1177. <span class="w"> </span><span class="c1"># Add CAs here for the TLS handshake</span>
  1178. <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>
  1179. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1180. <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>
  1181. <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>
  1182. <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>
  1183. <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>
  1184. </code></pre></div>
  1185. <h3 id="webhook-as-generators">Webhook as generators</h3>
  1186. <p>You can also leverage webhooks as generators, following the same syntax. The only difference is that the webhook generator needs its source secrets to be labeled, as opposed to webhook secretstores. Please see the <a href="../../api/generator/webhook/">generator-webhook</a> documentation for more information. </p>
  1187. </article>
  1188. </div>
  1189. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1190. </div>
  1191. </main>
  1192. <footer class="md-footer">
  1193. <div class="md-footer-meta md-typeset">
  1194. <div class="md-footer-meta__inner md-grid">
  1195. <div class="md-copyright">
  1196. <div class="md-copyright__highlight">
  1197. &copy; 2023 The external-secrets Authors.<br/>
  1198. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1199. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1200. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1201. </div>
  1202. Made with
  1203. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1204. Material for MkDocs
  1205. </a>
  1206. </div>
  1207. </div>
  1208. </div>
  1209. </footer>
  1210. </div>
  1211. <div class="md-dialog" data-md-component="dialog">
  1212. <div class="md-dialog__inner md-typeset"></div>
  1213. </div>
  1214. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1215. <script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
  1216. </body>
  1217. </html>