index.html 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417
  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.9">
  8. <title>Webhook - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.2b4465f4.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="../api-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. </ul>
  166. </nav>
  167. </li>
  168. <li class="md-nav__item md-nav__item--nested">
  169. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  170. <label class="md-nav__link" for="__nav_4">
  171. Guides
  172. <span class="md-nav__icon md-icon"></span>
  173. </label>
  174. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  175. <label class="md-nav__title" for="__nav_4">
  176. <span class="md-nav__icon md-icon"></span>
  177. Guides
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../guides-introduction/" class="md-nav__link">
  182. Introduction
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-templating/" class="md-nav__link">
  192. Advanced Templating
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-controller-class/" class="md-nav__link">
  197. Controller Classes
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  202. All keys, One secret
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  207. Common K8S Secret Types
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../guides-multi-tenancy/" class="md-nav__link">
  212. Multi Tenancy
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="../guides-metrics/" class="md-nav__link">
  217. Metrics
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-using-latest-image/" class="md-nav__link">
  222. Using Latest Image
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  227. GitOps using FluxCD
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  235. <label class="md-nav__link" for="__nav_5">
  236. Provider
  237. <span class="md-nav__icon md-icon"></span>
  238. </label>
  239. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  240. <label class="md-nav__title" for="__nav_5">
  241. <span class="md-nav__icon md-icon"></span>
  242. Provider
  243. </label>
  244. <ul class="md-nav__list" data-md-scrollfix>
  245. <li class="md-nav__item md-nav__item--nested">
  246. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  247. <label class="md-nav__link" for="__nav_5_1">
  248. AWS
  249. <span class="md-nav__icon md-icon"></span>
  250. </label>
  251. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  252. <label class="md-nav__title" for="__nav_5_1">
  253. <span class="md-nav__icon md-icon"></span>
  254. AWS
  255. </label>
  256. <ul class="md-nav__list" data-md-scrollfix>
  257. <li class="md-nav__item">
  258. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  259. Secrets Manager
  260. </a>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  264. Parameter Store
  265. </a>
  266. </li>
  267. </ul>
  268. </nav>
  269. </li>
  270. <li class="md-nav__item md-nav__item--nested">
  271. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  272. <label class="md-nav__link" for="__nav_5_2">
  273. Azure
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  277. <label class="md-nav__title" for="__nav_5_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Azure
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item">
  283. <a href="../provider-azure-key-vault/" class="md-nav__link">
  284. Key Vault
  285. </a>
  286. </li>
  287. </ul>
  288. </nav>
  289. </li>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  292. <label class="md-nav__link" for="__nav_5_3">
  293. Google
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="Google" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_3">
  298. <span class="md-nav__icon md-icon"></span>
  299. Google
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  304. Secrets Manager
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  312. <label class="md-nav__link" for="__nav_5_4">
  313. IBM
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_5_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. IBM
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  324. Secrets Manager
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../provider-akeyless/" class="md-nav__link">
  332. Akeyless
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  337. HashiCorp Vault
  338. </a>
  339. </li>
  340. <li class="md-nav__item md-nav__item--nested">
  341. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  342. <label class="md-nav__link" for="__nav_5_7">
  343. Yandex
  344. <span class="md-nav__icon md-icon"></span>
  345. </label>
  346. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  347. <label class="md-nav__title" for="__nav_5_7">
  348. <span class="md-nav__icon md-icon"></span>
  349. Yandex
  350. </label>
  351. <ul class="md-nav__list" data-md-scrollfix>
  352. <li class="md-nav__item">
  353. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  354. Lockbox
  355. </a>
  356. </li>
  357. </ul>
  358. </nav>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  362. <label class="md-nav__link" for="__nav_5_8">
  363. Gitlab
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_5_8">
  368. <span class="md-nav__icon md-icon"></span>
  369. Gitlab
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  374. Gitlab Project Variables
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  382. <label class="md-nav__link" for="__nav_5_9">
  383. Oracle
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  387. <label class="md-nav__title" for="__nav_5_9">
  388. <span class="md-nav__icon md-icon"></span>
  389. Oracle
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="../provider-oracle-vault/" class="md-nav__link">
  394. Oracle Vault
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--active">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  402. <label class="md-nav__link md-nav__link--active" for="__toc">
  403. Webhook
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <a href="./" class="md-nav__link md-nav__link--active">
  407. Webhook
  408. </a>
  409. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  410. <label class="md-nav__title" for="__toc">
  411. <span class="md-nav__icon md-icon"></span>
  412. Table of contents
  413. </label>
  414. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  415. <li class="md-nav__item">
  416. <a href="#generic-webhook" class="md-nav__link">
  417. Generic Webhook
  418. </a>
  419. <nav class="md-nav" aria-label="Generic Webhook">
  420. <ul class="md-nav__list">
  421. <li class="md-nav__item">
  422. <a href="#example" class="md-nav__link">
  423. Example
  424. </a>
  425. <nav class="md-nav" aria-label="Example">
  426. <ul class="md-nav__list">
  427. <li class="md-nav__item">
  428. <a href="#limitations" class="md-nav__link">
  429. Limitations
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="#templating" class="md-nav__link">
  437. Templating
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="#all-parameters" class="md-nav__link">
  442. All Parameters
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. </ul>
  449. </nav>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="../provider-fake/" class="md-nav__link">
  453. Fake
  454. </a>
  455. </li>
  456. </ul>
  457. </nav>
  458. </li>
  459. <li class="md-nav__item md-nav__item--nested">
  460. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  461. <label class="md-nav__link" for="__nav_6">
  462. References
  463. <span class="md-nav__icon md-icon"></span>
  464. </label>
  465. <nav class="md-nav" aria-label="References" data-md-level="1">
  466. <label class="md-nav__title" for="__nav_6">
  467. <span class="md-nav__icon md-icon"></span>
  468. References
  469. </label>
  470. <ul class="md-nav__list" data-md-scrollfix>
  471. <li class="md-nav__item">
  472. <a href="../spec/" class="md-nav__link">
  473. API specification
  474. </a>
  475. </li>
  476. </ul>
  477. </nav>
  478. </li>
  479. <li class="md-nav__item md-nav__item--nested">
  480. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  481. <label class="md-nav__link" for="__nav_7">
  482. Contributing
  483. <span class="md-nav__icon md-icon"></span>
  484. </label>
  485. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  486. <label class="md-nav__title" for="__nav_7">
  487. <span class="md-nav__icon md-icon"></span>
  488. Contributing
  489. </label>
  490. <ul class="md-nav__list" data-md-scrollfix>
  491. <li class="md-nav__item">
  492. <a href="../contributing-devguide/" class="md-nav__link">
  493. Developer guide
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="../contributing-process/" class="md-nav__link">
  498. Contributing Process
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../contributing-coc/" class="md-nav__link">
  503. Code of Conduct
  504. </a>
  505. </li>
  506. </ul>
  507. </nav>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../deprecation-policy/" class="md-nav__link">
  511. Deprecation Policy
  512. </a>
  513. </li>
  514. </ul>
  515. </nav>
  516. </div>
  517. </div>
  518. </div>
  519. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  520. <div class="md-sidebar__scrollwrap">
  521. <div class="md-sidebar__inner">
  522. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  523. <label class="md-nav__title" for="__toc">
  524. <span class="md-nav__icon md-icon"></span>
  525. Table of contents
  526. </label>
  527. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  528. <li class="md-nav__item">
  529. <a href="#generic-webhook" class="md-nav__link">
  530. Generic Webhook
  531. </a>
  532. <nav class="md-nav" aria-label="Generic Webhook">
  533. <ul class="md-nav__list">
  534. <li class="md-nav__item">
  535. <a href="#example" class="md-nav__link">
  536. Example
  537. </a>
  538. <nav class="md-nav" aria-label="Example">
  539. <ul class="md-nav__list">
  540. <li class="md-nav__item">
  541. <a href="#limitations" class="md-nav__link">
  542. Limitations
  543. </a>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="#templating" class="md-nav__link">
  550. Templating
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="#all-parameters" class="md-nav__link">
  555. All Parameters
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. </ul>
  562. </nav>
  563. </div>
  564. </div>
  565. </div>
  566. <div class="md-content" data-md-component="content">
  567. <article class="md-content__inner md-typeset">
  568. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/provider-webhook.md" title="Edit this page" class="md-content__button md-icon">
  569. <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>
  570. </a>
  571. <h1>Webhook</h1>
  572. <h2 id="generic-webhook">Generic Webhook</h2>
  573. <p>External Secrets Operator can integrate with simple web apis by specifying the endpoint</p>
  574. <h3 id="example">Example</h3>
  575. <p>First, create a SecretStore with a webhook backend. We'll use a static user/password <code>root</code>:</p>
  576. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  577. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  578. <span class="nt">metadata</span><span class="p">:</span>
  579. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">webhook-backend</span>
  580. <span class="nt">spec</span><span class="p">:</span>
  581. <span class="nt">provider</span><span class="p">:</span>
  582. <span class="nt">webhook</span><span class="p">:</span>
  583. <span class="nt">url</span><span class="p">:</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>
  584. <span class="nt">result</span><span class="p">:</span>
  585. <span class="nt">jsonPath</span><span class="p">:</span> <span class="s">&quot;$.args.parameter&quot;</span>
  586. <span class="nt">headers</span><span class="p">:</span>
  587. <span class="nt">Content-Type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">application/json</span>
  588. <span class="nt">Authorization</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Basic {{ print .auth.username &quot;:&quot; .auth.password | b64enc }}</span>
  589. <span class="nt">secrets</span><span class="p">:</span>
  590. <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">auth</span>
  591. <span class="nt">secretRef</span><span class="p">:</span>
  592. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">webhook-credentials</span>
  593. <span class="nn">---</span>
  594. <span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
  595. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  596. <span class="nt">metadata</span><span class="p">:</span>
  597. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">webhook-credentials</span>
  598. <span class="nt">data</span><span class="p">:</span>
  599. <span class="nt">username</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span> <span class="c1"># &quot;test&quot;</span>
  600. <span class="nt">password</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">dGVzdA==</span> <span class="c1"># &quot;test&quot;</span>
  601. </code></pre></div>
  602. <p>NB: This is obviously not practical because it just returns the key as the result, but it shows how it works</p>
  603. <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>
  604. <p>Now create an ExternalSecret that uses the above SecretStore:</p>
  605. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  606. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  607. <span class="nt">metadata</span><span class="p">:</span>
  608. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">webhook-example</span>
  609. <span class="nt">spec</span><span class="p">:</span>
  610. <span class="nt">refreshInterval</span><span class="p">:</span> <span class="s">&quot;15s&quot;</span>
  611. <span class="nt">secretStoreRef</span><span class="p">:</span>
  612. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">webhook-backend</span>
  613. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  614. <span class="nt">target</span><span class="p">:</span>
  615. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  616. <span class="nt">data</span><span class="p">:</span>
  617. <span class="p p-Indicator">-</span> <span class="nt">secretKey</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">foobar</span>
  618. <span class="nt">remoteRef</span><span class="p">:</span>
  619. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">secret</span>
  620. <span class="nn">---</span>
  621. <span class="c1"># will create a secret with:</span>
  622. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret</span>
  623. <span class="nt">metadata</span><span class="p">:</span>
  624. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-sync</span>
  625. <span class="nt">data</span><span class="p">:</span>
  626. <span class="nt">foobar</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">c2VjcmV0</span>
  627. </code></pre></div>
  628. <h4 id="limitations">Limitations</h4>
  629. <p>Webhook does not support authorization, other than what can be sent by generating http headers</p>
  630. <h3 id="templating">Templating</h3>
  631. <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>
  632. <p>The provider inserts the secret to be retrieved in the object named <code>remoteRef</code>.</p>
  633. <p>In addition, secrets can be added as named objects, for example to use in authorization headers.
  634. Each secret has a <code>name</code> property which determines the name of the object in the templating engine.</p>
  635. <h3 id="all-parameters">All Parameters</h3>
  636. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  637. <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  638. <span class="nt">metadata</span><span class="p">:</span>
  639. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">statervault</span>
  640. <span class="nt">spec</span><span class="p">:</span>
  641. <span class="nt">provider</span><span class="p">:</span>
  642. <span class="nt">webhook</span><span class="p">:</span>
  643. <span class="c1"># Url to call. Use templating engine to fill in the request parameters</span>
  644. <span class="nt">url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;url&gt;</span>
  645. <span class="c1"># http method, defaults to GET</span>
  646. <span class="nt">method</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;method&gt;</span>
  647. <span class="c1"># Timeout in duration (1s, 1m, etc)</span>
  648. <span class="nt">timeout</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1s</span>
  649. <span class="nt">result</span><span class="p">:</span>
  650. <span class="c1"># [jsonPath](https://jsonpath.com) syntax, which also can be templated</span>
  651. <span class="nt">jsonPath</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;jsonPath&gt;</span>
  652. <span class="c1"># Map of headers, can be templated</span>
  653. <span class="nt">headers</span><span class="p">:</span>
  654. <span class="nt">&lt;Header-Name&gt;</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;header contents&gt;</span>
  655. <span class="c1"># Body to sent as request, can be templated (optional)</span>
  656. <span class="nt">body</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;body&gt;</span>
  657. <span class="c1"># List of secrets to expose to the templating engine</span>
  658. <span class="nt">secrets</span><span class="p">:</span>
  659. <span class="c1"># Use this name to refer to this secret in templating, above</span>
  660. <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;name&gt;</span>
  661. <span class="nt">secretRef</span><span class="p">:</span>
  662. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span> <span class="c1"># Only used in ClusterSecretStores</span>
  663. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;name&gt;</span>
  664. <span class="c1"># Add CAs here for the TLS handshake</span>
  665. <span class="nt">caBundle</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;base64 encoded cabundle&gt;</span>
  666. <span class="nt">caProvider</span><span class="p">:</span>
  667. <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Secret or COnfigMap</span>
  668. <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;name of secret or configmap&gt;</span>
  669. <span class="nt">namespace</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;namespace&gt;</span> <span class="c1"># Only used in ClusterSecretStores</span>
  670. <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">&lt;key inside secret&gt;</span>
  671. </code></pre></div>
  672. </article>
  673. </div>
  674. </div>
  675. </main>
  676. <footer class="md-footer">
  677. <nav class="md-footer__inner md-grid" aria-label="Footer">
  678. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Oracle Vault" rel="prev">
  679. <div class="md-footer__button md-icon">
  680. <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>
  681. </div>
  682. <div class="md-footer__title">
  683. <div class="md-ellipsis">
  684. <span class="md-footer__direction">
  685. Previous
  686. </span>
  687. Oracle Vault
  688. </div>
  689. </div>
  690. </a>
  691. <a href="../provider-fake/" class="md-footer__link md-footer__link--next" aria-label="Next: Fake" rel="next">
  692. <div class="md-footer__title">
  693. <div class="md-ellipsis">
  694. <span class="md-footer__direction">
  695. Next
  696. </span>
  697. Fake
  698. </div>
  699. </div>
  700. <div class="md-footer__button md-icon">
  701. <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>
  702. </div>
  703. </a>
  704. </nav>
  705. <div class="md-footer-meta md-typeset">
  706. <div class="md-footer-meta__inner md-grid">
  707. <div class="md-copyright">
  708. Made with
  709. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  710. Material for MkDocs
  711. </a>
  712. </div>
  713. </div>
  714. </div>
  715. </footer>
  716. </div>
  717. <div class="md-dialog" data-md-component="dialog">
  718. <div class="md-dialog__inner md-typeset"></div>
  719. </div>
  720. <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.22074ed6.min.js", "version": {"provider": "mike"}}</script>
  721. <script src="../assets/javascripts/bundle.960e086b.min.js"></script>
  722. </body>
  723. </html>