index.html 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478
  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.1, mkdocs-material-7.1.8">
  8. <title>API specification - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.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-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  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. </div>
  24. <div data-md-component="announce">
  25. </div>
  26. <header class="md-header" data-md-component="header">
  27. <nav class="md-header__inner md-grid" aria-label="Header">
  28. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  29. <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>
  30. </a>
  31. <label class="md-header__button md-icon" for="__drawer">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  33. </label>
  34. <div class="md-header__title" data-md-component="header-title">
  35. <div class="md-header__ellipsis">
  36. <div class="md-header__topic">
  37. <span class="md-ellipsis">
  38. External Secrets Operator
  39. </span>
  40. </div>
  41. <div class="md-header__topic" data-md-component="header-topic">
  42. <span class="md-ellipsis">
  43. API specification
  44. </span>
  45. </div>
  46. </div>
  47. </div>
  48. <label class="md-header__button md-icon" for="__search">
  49. <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>
  50. </label>
  51. <div class="md-search" data-md-component="search" role="dialog">
  52. <label class="md-search__overlay" for="__search"></label>
  53. <div class="md-search__inner" role="search">
  54. <form class="md-search__form" name="search">
  55. <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" data-md-state="active" required>
  56. <label class="md-search__icon md-icon" for="__search">
  57. <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>
  58. <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>
  59. </label>
  60. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  61. <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>
  62. </button>
  63. </form>
  64. <div class="md-search__output">
  65. <div class="md-search__scrollwrap" data-md-scrollfix>
  66. <div class="md-search-result" data-md-component="search-result">
  67. <div class="md-search-result__meta">
  68. Initializing search
  69. </div>
  70. <ol class="md-search-result__list"></ol>
  71. </div>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="md-header__source">
  77. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  78. <div class="md-source__icon md-icon">
  79. <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>
  80. </div>
  81. <div class="md-source__repository">
  82. External Secrets Operator
  83. </div>
  84. </a>
  85. </div>
  86. </nav>
  87. </header>
  88. <div class="md-container" data-md-component="container">
  89. <main class="md-main" data-md-component="main">
  90. <div class="md-main__inner md-grid">
  91. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  92. <div class="md-sidebar__scrollwrap">
  93. <div class="md-sidebar__inner">
  94. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  95. <label class="md-nav__title" for="__drawer">
  96. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  97. <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>
  98. </a>
  99. External Secrets Operator
  100. </label>
  101. <div class="md-nav__source">
  102. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <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>
  105. </div>
  106. <div class="md-source__repository">
  107. External Secrets Operator
  108. </div>
  109. </a>
  110. </div>
  111. <ul class="md-nav__list" data-md-scrollfix>
  112. <li class="md-nav__item">
  113. <a href=".." class="md-nav__link">
  114. Introduction
  115. </a>
  116. </li>
  117. <li class="md-nav__item">
  118. <a href="../api-overview/" class="md-nav__link">
  119. Overview
  120. </a>
  121. </li>
  122. <li class="md-nav__item md-nav__item--nested">
  123. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  124. <label class="md-nav__link" for="__nav_3">
  125. API Types
  126. <span class="md-nav__icon md-icon"></span>
  127. </label>
  128. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  129. <label class="md-nav__title" for="__nav_3">
  130. <span class="md-nav__icon md-icon"></span>
  131. API Types
  132. </label>
  133. <ul class="md-nav__list" data-md-scrollfix>
  134. <li class="md-nav__item">
  135. <a href="../api-externalsecret/" class="md-nav__link">
  136. ExternalSecret
  137. </a>
  138. </li>
  139. <li class="md-nav__item">
  140. <a href="../api-secretstore/" class="md-nav__link">
  141. SecretStore
  142. </a>
  143. </li>
  144. <li class="md-nav__item">
  145. <a href="../api-clustersecretstore/" class="md-nav__link">
  146. ClusterSecretStore
  147. </a>
  148. </li>
  149. </ul>
  150. </nav>
  151. </li>
  152. <li class="md-nav__item md-nav__item--nested">
  153. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  154. <label class="md-nav__link" for="__nav_4">
  155. Guides
  156. <span class="md-nav__icon md-icon"></span>
  157. </label>
  158. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  159. <label class="md-nav__title" for="__nav_4">
  160. <span class="md-nav__icon md-icon"></span>
  161. Guides
  162. </label>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item">
  165. <a href="../guides-introduction/" class="md-nav__link">
  166. Introduction
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="../guides-getting-started/" class="md-nav__link">
  171. Getting started
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="../guides-templating/" class="md-nav__link">
  176. Advanced Templating
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  181. All keys, One secret
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  186. Common K8S Secret Types
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="../guides-multi-tenancy/" class="md-nav__link">
  191. Multi Tenancy
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../guides-metrics/" class="md-nav__link">
  196. Metrics
  197. </a>
  198. </li>
  199. </ul>
  200. </nav>
  201. </li>
  202. <li class="md-nav__item md-nav__item--nested">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  204. <label class="md-nav__link" for="__nav_5">
  205. Provider
  206. <span class="md-nav__icon md-icon"></span>
  207. </label>
  208. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  209. <label class="md-nav__title" for="__nav_5">
  210. <span class="md-nav__icon md-icon"></span>
  211. Provider
  212. </label>
  213. <ul class="md-nav__list" data-md-scrollfix>
  214. <li class="md-nav__item md-nav__item--nested">
  215. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  216. <label class="md-nav__link" for="__nav_5_1">
  217. AWS
  218. <span class="md-nav__icon md-icon"></span>
  219. </label>
  220. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  221. <label class="md-nav__title" for="__nav_5_1">
  222. <span class="md-nav__icon md-icon"></span>
  223. AWS
  224. </label>
  225. <ul class="md-nav__list" data-md-scrollfix>
  226. <li class="md-nav__item">
  227. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  228. Secrets Manager
  229. </a>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  233. Parameter Store
  234. </a>
  235. </li>
  236. </ul>
  237. </nav>
  238. </li>
  239. <li class="md-nav__item md-nav__item--nested">
  240. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  241. <label class="md-nav__link" for="__nav_5_2">
  242. Azure
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  246. <label class="md-nav__title" for="__nav_5_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. Azure
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../provider-azure-key-vault/" class="md-nav__link">
  253. Key Vault
  254. </a>
  255. </li>
  256. </ul>
  257. </nav>
  258. </li>
  259. <li class="md-nav__item md-nav__item--nested">
  260. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  261. <label class="md-nav__link" for="__nav_5_3">
  262. Google
  263. <span class="md-nav__icon md-icon"></span>
  264. </label>
  265. <nav class="md-nav" aria-label="Google" data-md-level="2">
  266. <label class="md-nav__title" for="__nav_5_3">
  267. <span class="md-nav__icon md-icon"></span>
  268. Google
  269. </label>
  270. <ul class="md-nav__list" data-md-scrollfix>
  271. <li class="md-nav__item">
  272. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  273. Secrets Manager
  274. </a>
  275. </li>
  276. </ul>
  277. </nav>
  278. </li>
  279. <li class="md-nav__item md-nav__item--nested">
  280. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  281. <label class="md-nav__link" for="__nav_5_4">
  282. IBM
  283. <span class="md-nav__icon md-icon"></span>
  284. </label>
  285. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  286. <label class="md-nav__title" for="__nav_5_4">
  287. <span class="md-nav__icon md-icon"></span>
  288. IBM
  289. </label>
  290. <ul class="md-nav__list" data-md-scrollfix>
  291. <li class="md-nav__item">
  292. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  293. Secrets Manager
  294. </a>
  295. </li>
  296. </ul>
  297. </nav>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../provider-akeyless/" class="md-nav__link">
  301. Akeyless
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  306. HashiCorp Vault
  307. </a>
  308. </li>
  309. <li class="md-nav__item md-nav__item--nested">
  310. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  311. <label class="md-nav__link" for="__nav_5_7">
  312. Yandex
  313. <span class="md-nav__icon md-icon"></span>
  314. </label>
  315. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  316. <label class="md-nav__title" for="__nav_5_7">
  317. <span class="md-nav__icon md-icon"></span>
  318. Yandex
  319. </label>
  320. <ul class="md-nav__list" data-md-scrollfix>
  321. <li class="md-nav__item">
  322. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  323. Lockbox
  324. </a>
  325. </li>
  326. </ul>
  327. </nav>
  328. </li>
  329. <li class="md-nav__item md-nav__item--nested">
  330. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  331. <label class="md-nav__link" for="__nav_5_8">
  332. Gitlab
  333. <span class="md-nav__icon md-icon"></span>
  334. </label>
  335. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  336. <label class="md-nav__title" for="__nav_5_8">
  337. <span class="md-nav__icon md-icon"></span>
  338. Gitlab
  339. </label>
  340. <ul class="md-nav__list" data-md-scrollfix>
  341. <li class="md-nav__item">
  342. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  343. Gitlab Project Variables
  344. </a>
  345. </li>
  346. </ul>
  347. </nav>
  348. </li>
  349. <li class="md-nav__item md-nav__item--nested">
  350. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  351. <label class="md-nav__link" for="__nav_5_9">
  352. Oracle
  353. <span class="md-nav__icon md-icon"></span>
  354. </label>
  355. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  356. <label class="md-nav__title" for="__nav_5_9">
  357. <span class="md-nav__icon md-icon"></span>
  358. Oracle
  359. </label>
  360. <ul class="md-nav__list" data-md-scrollfix>
  361. <li class="md-nav__item">
  362. <a href="../provider-oracle-vault/" class="md-nav__link">
  363. Oracle Vault
  364. </a>
  365. </li>
  366. </ul>
  367. </nav>
  368. </li>
  369. </ul>
  370. </nav>
  371. </li>
  372. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  373. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  374. <label class="md-nav__link" for="__nav_6">
  375. References
  376. <span class="md-nav__icon md-icon"></span>
  377. </label>
  378. <nav class="md-nav" aria-label="References" data-md-level="1">
  379. <label class="md-nav__title" for="__nav_6">
  380. <span class="md-nav__icon md-icon"></span>
  381. References
  382. </label>
  383. <ul class="md-nav__list" data-md-scrollfix>
  384. <li class="md-nav__item md-nav__item--active">
  385. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  386. <a href="./" class="md-nav__link md-nav__link--active">
  387. API specification
  388. </a>
  389. </li>
  390. </ul>
  391. </nav>
  392. </li>
  393. <li class="md-nav__item md-nav__item--nested">
  394. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  395. <label class="md-nav__link" for="__nav_7">
  396. Contributing
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  400. <label class="md-nav__title" for="__nav_7">
  401. <span class="md-nav__icon md-icon"></span>
  402. Contributing
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../contributing-devguide/" class="md-nav__link">
  407. Developer guide
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../contributing-process/" class="md-nav__link">
  412. Contributing Process
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../contributing-coc/" class="md-nav__link">
  417. Code of Conduct
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../deprecation-policy/" class="md-nav__link">
  425. Deprecation Policy
  426. </a>
  427. </li>
  428. </ul>
  429. </nav>
  430. </div>
  431. </div>
  432. </div>
  433. <div class="md-content" data-md-component="content">
  434. <article class="md-content__inner md-typeset">
  435. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/spec.md" title="Edit this page" class="md-content__button md-icon">
  436. <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>
  437. </a>
  438. <h1>API specification</h1>
  439. <p>Packages:</p>
  440. <ul>
  441. <li>
  442. <a href="#external-secrets.io%2fv1alpha1">external-secrets.io/v1alpha1</a>
  443. </li>
  444. </ul>
  445. <h2 id="external-secrets.io/v1alpha1">external-secrets.io/v1alpha1</h2>
  446. <p>
  447. <p>Package v1alpha1 contains resources for external-secrets</p>
  448. </p>
  449. <p>Resource Types:
  450. <ul></ul>
  451. <h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
  452. </h3>
  453. <p>
  454. (<em>Appears on:</em>
  455. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  456. </p>
  457. <p>
  458. <p>AWSAuth tells the controller how to do authentication with aws.
  459. Only one of secretRef or jwt can be specified.
  460. if none is specified the controller will load credentials using the aws sdk defaults.</p>
  461. </p>
  462. <table>
  463. <thead>
  464. <tr>
  465. <th>Field</th>
  466. <th>Description</th>
  467. </tr>
  468. </thead>
  469. <tbody>
  470. <tr>
  471. <td>
  472. <code>secretRef</code></br>
  473. <em>
  474. <a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
  475. AWSAuthSecretRef
  476. </a>
  477. </em>
  478. </td>
  479. <td>
  480. <em>(Optional)</em>
  481. </td>
  482. </tr>
  483. <tr>
  484. <td>
  485. <code>jwt</code></br>
  486. <em>
  487. <a href="#external-secrets.io/v1alpha1.AWSJWTAuth">
  488. AWSJWTAuth
  489. </a>
  490. </em>
  491. </td>
  492. <td>
  493. <em>(Optional)</em>
  494. </td>
  495. </tr>
  496. </tbody>
  497. </table>
  498. <h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
  499. </h3>
  500. <p>
  501. (<em>Appears on:</em>
  502. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  503. </p>
  504. <p>
  505. <p>AWSAuthSecretRef holds secret references for AWS credentials
  506. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
  507. </p>
  508. <table>
  509. <thead>
  510. <tr>
  511. <th>Field</th>
  512. <th>Description</th>
  513. </tr>
  514. </thead>
  515. <tbody>
  516. <tr>
  517. <td>
  518. <code>accessKeyIDSecretRef</code></br>
  519. <em>
  520. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  521. </em>
  522. </td>
  523. <td>
  524. <p>The AccessKeyID is used for authentication</p>
  525. </td>
  526. </tr>
  527. <tr>
  528. <td>
  529. <code>secretAccessKeySecretRef</code></br>
  530. <em>
  531. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  532. </em>
  533. </td>
  534. <td>
  535. <p>The SecretAccessKey is used for authentication</p>
  536. </td>
  537. </tr>
  538. </tbody>
  539. </table>
  540. <h3 id="external-secrets.io/v1alpha1.AWSJWTAuth">AWSJWTAuth
  541. </h3>
  542. <p>
  543. (<em>Appears on:</em>
  544. <a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
  545. </p>
  546. <p>
  547. <p>Authenticate against AWS using service account tokens.</p>
  548. </p>
  549. <table>
  550. <thead>
  551. <tr>
  552. <th>Field</th>
  553. <th>Description</th>
  554. </tr>
  555. </thead>
  556. <tbody>
  557. <tr>
  558. <td>
  559. <code>serviceAccountRef</code></br>
  560. <em>
  561. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  562. </em>
  563. </td>
  564. <td>
  565. </td>
  566. </tr>
  567. </tbody>
  568. </table>
  569. <h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
  570. </h3>
  571. <p>
  572. (<em>Appears on:</em>
  573. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  574. </p>
  575. <p>
  576. <p>AWSProvider configures a store to sync secrets with AWS.</p>
  577. </p>
  578. <table>
  579. <thead>
  580. <tr>
  581. <th>Field</th>
  582. <th>Description</th>
  583. </tr>
  584. </thead>
  585. <tbody>
  586. <tr>
  587. <td>
  588. <code>service</code></br>
  589. <em>
  590. <a href="#external-secrets.io/v1alpha1.AWSServiceType">
  591. AWSServiceType
  592. </a>
  593. </em>
  594. </td>
  595. <td>
  596. <p>Service defines which service should be used to fetch the secrets</p>
  597. </td>
  598. </tr>
  599. <tr>
  600. <td>
  601. <code>auth</code></br>
  602. <em>
  603. <a href="#external-secrets.io/v1alpha1.AWSAuth">
  604. AWSAuth
  605. </a>
  606. </em>
  607. </td>
  608. <td>
  609. <em>(Optional)</em>
  610. <p>Auth defines the information necessary to authenticate against AWS
  611. if not set aws sdk will infer credentials from your environment
  612. see: <a href="https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials">https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials</a></p>
  613. </td>
  614. </tr>
  615. <tr>
  616. <td>
  617. <code>role</code></br>
  618. <em>
  619. string
  620. </em>
  621. </td>
  622. <td>
  623. <em>(Optional)</em>
  624. <p>Role is a Role ARN which the SecretManager provider will assume</p>
  625. </td>
  626. </tr>
  627. <tr>
  628. <td>
  629. <code>region</code></br>
  630. <em>
  631. string
  632. </em>
  633. </td>
  634. <td>
  635. <p>AWS Region to be used for the provider</p>
  636. </td>
  637. </tr>
  638. </tbody>
  639. </table>
  640. <h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
  641. (<code>string</code> alias)</p></h3>
  642. <p>
  643. (<em>Appears on:</em>
  644. <a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
  645. </p>
  646. <p>
  647. <p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.</p>
  648. </p>
  649. <table>
  650. <thead>
  651. <tr>
  652. <th>Value</th>
  653. <th>Description</th>
  654. </tr>
  655. </thead>
  656. <tbody><tr><td><p>&#34;ParameterStore&#34;</p></td>
  657. <td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
  658. see: <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html">https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html</a></p>
  659. </td>
  660. </tr><tr><td><p>&#34;SecretsManager&#34;</p></td>
  661. <td><p>AWSServiceSecretsManager is the AWS SecretsManager.
  662. see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</a></p>
  663. </td>
  664. </tr></tbody>
  665. </table>
  666. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  667. </h3>
  668. <p>
  669. (<em>Appears on:</em>
  670. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  671. </p>
  672. <p>
  673. <p>Configuration used to authenticate with Azure.</p>
  674. </p>
  675. <table>
  676. <thead>
  677. <tr>
  678. <th>Field</th>
  679. <th>Description</th>
  680. </tr>
  681. </thead>
  682. <tbody>
  683. <tr>
  684. <td>
  685. <code>clientId</code></br>
  686. <em>
  687. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  688. </em>
  689. </td>
  690. <td>
  691. <p>The Azure clientId of the service principle used for authentication.</p>
  692. </td>
  693. </tr>
  694. <tr>
  695. <td>
  696. <code>clientSecret</code></br>
  697. <em>
  698. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  699. </em>
  700. </td>
  701. <td>
  702. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  703. </td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  708. </h3>
  709. <p>
  710. (<em>Appears on:</em>
  711. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  712. </p>
  713. <p>
  714. <p>Configures an store to sync secrets using Azure KV.</p>
  715. </p>
  716. <table>
  717. <thead>
  718. <tr>
  719. <th>Field</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td>
  726. <code>vaultUrl</code></br>
  727. <em>
  728. string
  729. </em>
  730. </td>
  731. <td>
  732. <p>Vault Url from which the secrets to be fetched from.</p>
  733. </td>
  734. </tr>
  735. <tr>
  736. <td>
  737. <code>tenantId</code></br>
  738. <em>
  739. string
  740. </em>
  741. </td>
  742. <td>
  743. <p>TenantID configures the Azure Tenant to send requests to.</p>
  744. </td>
  745. </tr>
  746. <tr>
  747. <td>
  748. <code>authSecretRef</code></br>
  749. <em>
  750. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  751. AzureKVAuth
  752. </a>
  753. </em>
  754. </td>
  755. <td>
  756. <p>Auth configures how the operator authenticates with Azure.</p>
  757. </td>
  758. </tr>
  759. </tbody>
  760. </table>
  761. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  762. </h3>
  763. <p>
  764. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  765. </p>
  766. <table>
  767. <thead>
  768. <tr>
  769. <th>Field</th>
  770. <th>Description</th>
  771. </tr>
  772. </thead>
  773. <tbody>
  774. <tr>
  775. <td>
  776. <code>metadata</code></br>
  777. <em>
  778. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  779. Kubernetes meta/v1.ObjectMeta
  780. </a>
  781. </em>
  782. </td>
  783. <td>
  784. Refer to the Kubernetes API documentation for the fields of the
  785. <code>metadata</code> field.
  786. </td>
  787. </tr>
  788. <tr>
  789. <td>
  790. <code>spec</code></br>
  791. <em>
  792. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  793. SecretStoreSpec
  794. </a>
  795. </em>
  796. </td>
  797. <td>
  798. <br/>
  799. <br/>
  800. <table>
  801. <tr>
  802. <td>
  803. <code>controller</code></br>
  804. <em>
  805. string
  806. </em>
  807. </td>
  808. <td>
  809. <em>(Optional)</em>
  810. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  811. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  812. </td>
  813. </tr>
  814. <tr>
  815. <td>
  816. <code>provider</code></br>
  817. <em>
  818. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  819. SecretStoreProvider
  820. </a>
  821. </em>
  822. </td>
  823. <td>
  824. <p>Used to configure the provider. Only one provider may be set</p>
  825. </td>
  826. </tr>
  827. </table>
  828. </td>
  829. </tr>
  830. <tr>
  831. <td>
  832. <code>status</code></br>
  833. <em>
  834. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  835. SecretStoreStatus
  836. </a>
  837. </em>
  838. </td>
  839. <td>
  840. </td>
  841. </tr>
  842. </tbody>
  843. </table>
  844. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  845. </h3>
  846. <p>
  847. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  848. </p>
  849. <table>
  850. <thead>
  851. <tr>
  852. <th>Field</th>
  853. <th>Description</th>
  854. </tr>
  855. </thead>
  856. <tbody>
  857. <tr>
  858. <td>
  859. <code>metadata</code></br>
  860. <em>
  861. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  862. Kubernetes meta/v1.ObjectMeta
  863. </a>
  864. </em>
  865. </td>
  866. <td>
  867. Refer to the Kubernetes API documentation for the fields of the
  868. <code>metadata</code> field.
  869. </td>
  870. </tr>
  871. <tr>
  872. <td>
  873. <code>spec</code></br>
  874. <em>
  875. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  876. ExternalSecretSpec
  877. </a>
  878. </em>
  879. </td>
  880. <td>
  881. <br/>
  882. <br/>
  883. <table>
  884. <tr>
  885. <td>
  886. <code>secretStoreRef</code></br>
  887. <em>
  888. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  889. SecretStoreRef
  890. </a>
  891. </em>
  892. </td>
  893. <td>
  894. </td>
  895. </tr>
  896. <tr>
  897. <td>
  898. <code>target</code></br>
  899. <em>
  900. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  901. ExternalSecretTarget
  902. </a>
  903. </em>
  904. </td>
  905. <td>
  906. </td>
  907. </tr>
  908. <tr>
  909. <td>
  910. <code>refreshInterval</code></br>
  911. <em>
  912. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  913. Kubernetes meta/v1.Duration
  914. </a>
  915. </em>
  916. </td>
  917. <td>
  918. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  919. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  920. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  921. </td>
  922. </tr>
  923. <tr>
  924. <td>
  925. <code>data</code></br>
  926. <em>
  927. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  928. []ExternalSecretData
  929. </a>
  930. </em>
  931. </td>
  932. <td>
  933. <em>(Optional)</em>
  934. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  935. </td>
  936. </tr>
  937. <tr>
  938. <td>
  939. <code>dataFrom</code></br>
  940. <em>
  941. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  942. []ExternalSecretDataRemoteRef
  943. </a>
  944. </em>
  945. </td>
  946. <td>
  947. <em>(Optional)</em>
  948. <p>DataFrom is used to fetch all properties from a specific Provider data
  949. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  950. </td>
  951. </tr>
  952. </table>
  953. </td>
  954. </tr>
  955. <tr>
  956. <td>
  957. <code>status</code></br>
  958. <em>
  959. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  960. ExternalSecretStatus
  961. </a>
  962. </em>
  963. </td>
  964. <td>
  965. </td>
  966. </tr>
  967. </tbody>
  968. </table>
  969. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  970. (<code>string</code> alias)</p></h3>
  971. <p>
  972. (<em>Appears on:</em>
  973. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  974. </p>
  975. <p>
  976. </p>
  977. <table>
  978. <thead>
  979. <tr>
  980. <th>Value</th>
  981. <th>Description</th>
  982. </tr>
  983. </thead>
  984. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  985. <td></td>
  986. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  987. <td></td>
  988. </tr></tbody>
  989. </table>
  990. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  991. (<code>string</code> alias)</p></h3>
  992. <p>
  993. (<em>Appears on:</em>
  994. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  995. </p>
  996. <p>
  997. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  998. </p>
  999. <table>
  1000. <thead>
  1001. <tr>
  1002. <th>Value</th>
  1003. <th>Description</th>
  1004. </tr>
  1005. </thead>
  1006. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  1007. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  1008. </td>
  1009. </tr><tr><td><p>&#34;None&#34;</p></td>
  1010. <td><p>None does not create a Secret (future use with injector).</p>
  1011. </td>
  1012. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  1013. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  1014. </td>
  1015. </tr></tbody>
  1016. </table>
  1017. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  1018. </h3>
  1019. <p>
  1020. (<em>Appears on:</em>
  1021. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1022. </p>
  1023. <p>
  1024. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  1025. </p>
  1026. <table>
  1027. <thead>
  1028. <tr>
  1029. <th>Field</th>
  1030. <th>Description</th>
  1031. </tr>
  1032. </thead>
  1033. <tbody>
  1034. <tr>
  1035. <td>
  1036. <code>secretKey</code></br>
  1037. <em>
  1038. string
  1039. </em>
  1040. </td>
  1041. <td>
  1042. </td>
  1043. </tr>
  1044. <tr>
  1045. <td>
  1046. <code>remoteRef</code></br>
  1047. <em>
  1048. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1049. ExternalSecretDataRemoteRef
  1050. </a>
  1051. </em>
  1052. </td>
  1053. <td>
  1054. </td>
  1055. </tr>
  1056. </tbody>
  1057. </table>
  1058. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  1059. </h3>
  1060. <p>
  1061. (<em>Appears on:</em>
  1062. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  1063. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1064. </p>
  1065. <p>
  1066. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  1067. </p>
  1068. <table>
  1069. <thead>
  1070. <tr>
  1071. <th>Field</th>
  1072. <th>Description</th>
  1073. </tr>
  1074. </thead>
  1075. <tbody>
  1076. <tr>
  1077. <td>
  1078. <code>key</code></br>
  1079. <em>
  1080. string
  1081. </em>
  1082. </td>
  1083. <td>
  1084. <p>Key is the key used in the Provider, mandatory</p>
  1085. </td>
  1086. </tr>
  1087. <tr>
  1088. <td>
  1089. <code>version</code></br>
  1090. <em>
  1091. string
  1092. </em>
  1093. </td>
  1094. <td>
  1095. <em>(Optional)</em>
  1096. <p>Used to select a specific version of the Provider value, if supported</p>
  1097. </td>
  1098. </tr>
  1099. <tr>
  1100. <td>
  1101. <code>property</code></br>
  1102. <em>
  1103. string
  1104. </em>
  1105. </td>
  1106. <td>
  1107. <em>(Optional)</em>
  1108. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  1109. </td>
  1110. </tr>
  1111. </tbody>
  1112. </table>
  1113. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  1114. </h3>
  1115. <p>
  1116. (<em>Appears on:</em>
  1117. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1118. </p>
  1119. <p>
  1120. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  1121. </p>
  1122. <table>
  1123. <thead>
  1124. <tr>
  1125. <th>Field</th>
  1126. <th>Description</th>
  1127. </tr>
  1128. </thead>
  1129. <tbody>
  1130. <tr>
  1131. <td>
  1132. <code>secretStoreRef</code></br>
  1133. <em>
  1134. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1135. SecretStoreRef
  1136. </a>
  1137. </em>
  1138. </td>
  1139. <td>
  1140. </td>
  1141. </tr>
  1142. <tr>
  1143. <td>
  1144. <code>target</code></br>
  1145. <em>
  1146. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1147. ExternalSecretTarget
  1148. </a>
  1149. </em>
  1150. </td>
  1151. <td>
  1152. </td>
  1153. </tr>
  1154. <tr>
  1155. <td>
  1156. <code>refreshInterval</code></br>
  1157. <em>
  1158. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1159. Kubernetes meta/v1.Duration
  1160. </a>
  1161. </em>
  1162. </td>
  1163. <td>
  1164. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1165. Valid time units are &ldquo;ns&rdquo;, &ldquo;us&rdquo; (or &ldquo;µs&rdquo;), &ldquo;ms&rdquo;, &ldquo;s&rdquo;, &ldquo;m&rdquo;, &ldquo;h&rdquo;
  1166. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1167. </td>
  1168. </tr>
  1169. <tr>
  1170. <td>
  1171. <code>data</code></br>
  1172. <em>
  1173. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1174. []ExternalSecretData
  1175. </a>
  1176. </em>
  1177. </td>
  1178. <td>
  1179. <em>(Optional)</em>
  1180. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1181. </td>
  1182. </tr>
  1183. <tr>
  1184. <td>
  1185. <code>dataFrom</code></br>
  1186. <em>
  1187. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1188. []ExternalSecretDataRemoteRef
  1189. </a>
  1190. </em>
  1191. </td>
  1192. <td>
  1193. <em>(Optional)</em>
  1194. <p>DataFrom is used to fetch all properties from a specific Provider data
  1195. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1196. </td>
  1197. </tr>
  1198. </tbody>
  1199. </table>
  1200. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1201. </h3>
  1202. <p>
  1203. (<em>Appears on:</em>
  1204. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1205. </p>
  1206. <p>
  1207. </p>
  1208. <table>
  1209. <thead>
  1210. <tr>
  1211. <th>Field</th>
  1212. <th>Description</th>
  1213. </tr>
  1214. </thead>
  1215. <tbody>
  1216. <tr>
  1217. <td>
  1218. <code>refreshTime</code></br>
  1219. <em>
  1220. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1221. Kubernetes meta/v1.Time
  1222. </a>
  1223. </em>
  1224. </td>
  1225. <td>
  1226. <p>refreshTime is the time and date the external secret was fetched and
  1227. the target secret updated</p>
  1228. </td>
  1229. </tr>
  1230. <tr>
  1231. <td>
  1232. <code>syncedResourceVersion</code></br>
  1233. <em>
  1234. string
  1235. </em>
  1236. </td>
  1237. <td>
  1238. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1239. </td>
  1240. </tr>
  1241. <tr>
  1242. <td>
  1243. <code>conditions</code></br>
  1244. <em>
  1245. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1246. []ExternalSecretStatusCondition
  1247. </a>
  1248. </em>
  1249. </td>
  1250. <td>
  1251. <em>(Optional)</em>
  1252. </td>
  1253. </tr>
  1254. </tbody>
  1255. </table>
  1256. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1257. </h3>
  1258. <p>
  1259. (<em>Appears on:</em>
  1260. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1261. </p>
  1262. <p>
  1263. </p>
  1264. <table>
  1265. <thead>
  1266. <tr>
  1267. <th>Field</th>
  1268. <th>Description</th>
  1269. </tr>
  1270. </thead>
  1271. <tbody>
  1272. <tr>
  1273. <td>
  1274. <code>type</code></br>
  1275. <em>
  1276. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1277. ExternalSecretConditionType
  1278. </a>
  1279. </em>
  1280. </td>
  1281. <td>
  1282. </td>
  1283. </tr>
  1284. <tr>
  1285. <td>
  1286. <code>status</code></br>
  1287. <em>
  1288. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1289. Kubernetes core/v1.ConditionStatus
  1290. </a>
  1291. </em>
  1292. </td>
  1293. <td>
  1294. </td>
  1295. </tr>
  1296. <tr>
  1297. <td>
  1298. <code>reason</code></br>
  1299. <em>
  1300. string
  1301. </em>
  1302. </td>
  1303. <td>
  1304. <em>(Optional)</em>
  1305. </td>
  1306. </tr>
  1307. <tr>
  1308. <td>
  1309. <code>message</code></br>
  1310. <em>
  1311. string
  1312. </em>
  1313. </td>
  1314. <td>
  1315. <em>(Optional)</em>
  1316. </td>
  1317. </tr>
  1318. <tr>
  1319. <td>
  1320. <code>lastTransitionTime</code></br>
  1321. <em>
  1322. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1323. Kubernetes meta/v1.Time
  1324. </a>
  1325. </em>
  1326. </td>
  1327. <td>
  1328. <em>(Optional)</em>
  1329. </td>
  1330. </tr>
  1331. </tbody>
  1332. </table>
  1333. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1334. </h3>
  1335. <p>
  1336. (<em>Appears on:</em>
  1337. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1338. </p>
  1339. <p>
  1340. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1341. There can be only one target per ExternalSecret.</p>
  1342. </p>
  1343. <table>
  1344. <thead>
  1345. <tr>
  1346. <th>Field</th>
  1347. <th>Description</th>
  1348. </tr>
  1349. </thead>
  1350. <tbody>
  1351. <tr>
  1352. <td>
  1353. <code>name</code></br>
  1354. <em>
  1355. string
  1356. </em>
  1357. </td>
  1358. <td>
  1359. <em>(Optional)</em>
  1360. <p>Name defines the name of the Secret resource to be managed
  1361. This field is immutable
  1362. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1363. </td>
  1364. </tr>
  1365. <tr>
  1366. <td>
  1367. <code>creationPolicy</code></br>
  1368. <em>
  1369. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1370. ExternalSecretCreationPolicy
  1371. </a>
  1372. </em>
  1373. </td>
  1374. <td>
  1375. <em>(Optional)</em>
  1376. <p>CreationPolicy defines rules on how to create the resulting Secret
  1377. Defaults to &lsquo;Owner&rsquo;</p>
  1378. </td>
  1379. </tr>
  1380. <tr>
  1381. <td>
  1382. <code>template</code></br>
  1383. <em>
  1384. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  1385. ExternalSecretTemplate
  1386. </a>
  1387. </em>
  1388. </td>
  1389. <td>
  1390. <em>(Optional)</em>
  1391. <p>Template defines a blueprint for the created Secret resource.</p>
  1392. </td>
  1393. </tr>
  1394. </tbody>
  1395. </table>
  1396. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1397. </h3>
  1398. <p>
  1399. (<em>Appears on:</em>
  1400. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1401. </p>
  1402. <p>
  1403. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  1404. we can not use native corev1.Secret, it will have empty ObjectMeta values: <a href="https://github.com/kubernetes-sigs/controller-tools/issues/448">https://github.com/kubernetes-sigs/controller-tools/issues/448</a></p>
  1405. </p>
  1406. <table>
  1407. <thead>
  1408. <tr>
  1409. <th>Field</th>
  1410. <th>Description</th>
  1411. </tr>
  1412. </thead>
  1413. <tbody>
  1414. <tr>
  1415. <td>
  1416. <code>type</code></br>
  1417. <em>
  1418. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1419. Kubernetes core/v1.SecretType
  1420. </a>
  1421. </em>
  1422. </td>
  1423. <td>
  1424. <em>(Optional)</em>
  1425. </td>
  1426. </tr>
  1427. <tr>
  1428. <td>
  1429. <code>metadata</code></br>
  1430. <em>
  1431. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1432. ExternalSecretTemplateMetadata
  1433. </a>
  1434. </em>
  1435. </td>
  1436. <td>
  1437. <em>(Optional)</em>
  1438. </td>
  1439. </tr>
  1440. <tr>
  1441. <td>
  1442. <code>data</code></br>
  1443. <em>
  1444. map[string]string
  1445. </em>
  1446. </td>
  1447. <td>
  1448. <em>(Optional)</em>
  1449. </td>
  1450. </tr>
  1451. <tr>
  1452. <td>
  1453. <code>templateFrom</code></br>
  1454. <em>
  1455. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
  1456. []TemplateFrom
  1457. </a>
  1458. </em>
  1459. </td>
  1460. <td>
  1461. <em>(Optional)</em>
  1462. </td>
  1463. </tr>
  1464. </tbody>
  1465. </table>
  1466. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1467. </h3>
  1468. <p>
  1469. (<em>Appears on:</em>
  1470. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1471. </p>
  1472. <p>
  1473. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1474. </p>
  1475. <table>
  1476. <thead>
  1477. <tr>
  1478. <th>Field</th>
  1479. <th>Description</th>
  1480. </tr>
  1481. </thead>
  1482. <tbody>
  1483. <tr>
  1484. <td>
  1485. <code>annotations</code></br>
  1486. <em>
  1487. map[string]string
  1488. </em>
  1489. </td>
  1490. <td>
  1491. <em>(Optional)</em>
  1492. </td>
  1493. </tr>
  1494. <tr>
  1495. <td>
  1496. <code>labels</code></br>
  1497. <em>
  1498. map[string]string
  1499. </em>
  1500. </td>
  1501. <td>
  1502. <em>(Optional)</em>
  1503. </td>
  1504. </tr>
  1505. </tbody>
  1506. </table>
  1507. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  1508. </h3>
  1509. <p>
  1510. (<em>Appears on:</em>
  1511. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  1512. </p>
  1513. <p>
  1514. </p>
  1515. <table>
  1516. <thead>
  1517. <tr>
  1518. <th>Field</th>
  1519. <th>Description</th>
  1520. </tr>
  1521. </thead>
  1522. <tbody>
  1523. <tr>
  1524. <td>
  1525. <code>secretRef</code></br>
  1526. <em>
  1527. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  1528. GCPSMAuthSecretRef
  1529. </a>
  1530. </em>
  1531. </td>
  1532. <td>
  1533. </td>
  1534. </tr>
  1535. </tbody>
  1536. </table>
  1537. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  1538. </h3>
  1539. <p>
  1540. (<em>Appears on:</em>
  1541. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  1542. </p>
  1543. <p>
  1544. </p>
  1545. <table>
  1546. <thead>
  1547. <tr>
  1548. <th>Field</th>
  1549. <th>Description</th>
  1550. </tr>
  1551. </thead>
  1552. <tbody>
  1553. <tr>
  1554. <td>
  1555. <code>secretAccessKeySecretRef</code></br>
  1556. <em>
  1557. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1558. </em>
  1559. </td>
  1560. <td>
  1561. <em>(Optional)</em>
  1562. <p>The SecretAccessKey is used for authentication</p>
  1563. </td>
  1564. </tr>
  1565. </tbody>
  1566. </table>
  1567. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  1568. </h3>
  1569. <p>
  1570. (<em>Appears on:</em>
  1571. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1572. </p>
  1573. <p>
  1574. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  1575. </p>
  1576. <table>
  1577. <thead>
  1578. <tr>
  1579. <th>Field</th>
  1580. <th>Description</th>
  1581. </tr>
  1582. </thead>
  1583. <tbody>
  1584. <tr>
  1585. <td>
  1586. <code>auth</code></br>
  1587. <em>
  1588. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  1589. GCPSMAuth
  1590. </a>
  1591. </em>
  1592. </td>
  1593. <td>
  1594. <em>(Optional)</em>
  1595. <p>Auth defines the information necessary to authenticate against GCP</p>
  1596. </td>
  1597. </tr>
  1598. <tr>
  1599. <td>
  1600. <code>projectID</code></br>
  1601. <em>
  1602. string
  1603. </em>
  1604. </td>
  1605. <td>
  1606. <p>ProjectID project where secret is located</p>
  1607. </td>
  1608. </tr>
  1609. </tbody>
  1610. </table>
  1611. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1612. </h3>
  1613. <p>
  1614. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1615. or a namespaced SecretStore.</p>
  1616. </p>
  1617. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
  1618. </h3>
  1619. <p>
  1620. (<em>Appears on:</em>
  1621. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
  1622. </p>
  1623. <p>
  1624. </p>
  1625. <table>
  1626. <thead>
  1627. <tr>
  1628. <th>Field</th>
  1629. <th>Description</th>
  1630. </tr>
  1631. </thead>
  1632. <tbody>
  1633. <tr>
  1634. <td>
  1635. <code>SecretRef</code></br>
  1636. <em>
  1637. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
  1638. GitlabSecretRef
  1639. </a>
  1640. </em>
  1641. </td>
  1642. <td>
  1643. </td>
  1644. </tr>
  1645. </tbody>
  1646. </table>
  1647. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
  1648. </h3>
  1649. <p>
  1650. (<em>Appears on:</em>
  1651. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1652. </p>
  1653. <p>
  1654. <p>Configures a store to sync secrets with a GitLab instance.</p>
  1655. </p>
  1656. <table>
  1657. <thead>
  1658. <tr>
  1659. <th>Field</th>
  1660. <th>Description</th>
  1661. </tr>
  1662. </thead>
  1663. <tbody>
  1664. <tr>
  1665. <td>
  1666. <code>url</code></br>
  1667. <em>
  1668. string
  1669. </em>
  1670. </td>
  1671. <td>
  1672. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  1673. </td>
  1674. </tr>
  1675. <tr>
  1676. <td>
  1677. <code>auth</code></br>
  1678. <em>
  1679. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
  1680. GitlabAuth
  1681. </a>
  1682. </em>
  1683. </td>
  1684. <td>
  1685. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  1686. </td>
  1687. </tr>
  1688. <tr>
  1689. <td>
  1690. <code>projectID</code></br>
  1691. <em>
  1692. string
  1693. </em>
  1694. </td>
  1695. <td>
  1696. <p>ProjectID specifies a project where secrets are located.</p>
  1697. </td>
  1698. </tr>
  1699. </tbody>
  1700. </table>
  1701. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
  1702. </h3>
  1703. <p>
  1704. (<em>Appears on:</em>
  1705. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
  1706. </p>
  1707. <p>
  1708. </p>
  1709. <table>
  1710. <thead>
  1711. <tr>
  1712. <th>Field</th>
  1713. <th>Description</th>
  1714. </tr>
  1715. </thead>
  1716. <tbody>
  1717. <tr>
  1718. <td>
  1719. <code>accessToken</code></br>
  1720. <em>
  1721. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1722. </em>
  1723. </td>
  1724. <td>
  1725. <p>AccessToken is used for authentication.</p>
  1726. </td>
  1727. </tr>
  1728. </tbody>
  1729. </table>
  1730. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
  1731. </h3>
  1732. <p>
  1733. (<em>Appears on:</em>
  1734. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
  1735. </p>
  1736. <p>
  1737. </p>
  1738. <table>
  1739. <thead>
  1740. <tr>
  1741. <th>Field</th>
  1742. <th>Description</th>
  1743. </tr>
  1744. </thead>
  1745. <tbody>
  1746. <tr>
  1747. <td>
  1748. <code>secretRef</code></br>
  1749. <em>
  1750. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
  1751. IBMAuthSecretRef
  1752. </a>
  1753. </em>
  1754. </td>
  1755. <td>
  1756. </td>
  1757. </tr>
  1758. </tbody>
  1759. </table>
  1760. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
  1761. </h3>
  1762. <p>
  1763. (<em>Appears on:</em>
  1764. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
  1765. </p>
  1766. <p>
  1767. </p>
  1768. <table>
  1769. <thead>
  1770. <tr>
  1771. <th>Field</th>
  1772. <th>Description</th>
  1773. </tr>
  1774. </thead>
  1775. <tbody>
  1776. <tr>
  1777. <td>
  1778. <code>secretApiKeySecretRef</code></br>
  1779. <em>
  1780. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1781. </em>
  1782. </td>
  1783. <td>
  1784. <em>(Optional)</em>
  1785. <p>The SecretAccessKey is used for authentication</p>
  1786. </td>
  1787. </tr>
  1788. </tbody>
  1789. </table>
  1790. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
  1791. </h3>
  1792. <p>
  1793. (<em>Appears on:</em>
  1794. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1795. </p>
  1796. <p>
  1797. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  1798. backend.</p>
  1799. </p>
  1800. <table>
  1801. <thead>
  1802. <tr>
  1803. <th>Field</th>
  1804. <th>Description</th>
  1805. </tr>
  1806. </thead>
  1807. <tbody>
  1808. <tr>
  1809. <td>
  1810. <code>auth</code></br>
  1811. <em>
  1812. <a href="#external-secrets.io/v1alpha1.IBMAuth">
  1813. IBMAuth
  1814. </a>
  1815. </em>
  1816. </td>
  1817. <td>
  1818. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  1819. </td>
  1820. </tr>
  1821. <tr>
  1822. <td>
  1823. <code>serviceUrl</code></br>
  1824. <em>
  1825. string
  1826. </em>
  1827. </td>
  1828. <td>
  1829. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  1830. </td>
  1831. </tr>
  1832. </tbody>
  1833. </table>
  1834. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  1835. </h3>
  1836. <p>
  1837. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1838. </p>
  1839. <table>
  1840. <thead>
  1841. <tr>
  1842. <th>Field</th>
  1843. <th>Description</th>
  1844. </tr>
  1845. </thead>
  1846. <tbody>
  1847. <tr>
  1848. <td>
  1849. <code>metadata</code></br>
  1850. <em>
  1851. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1852. Kubernetes meta/v1.ObjectMeta
  1853. </a>
  1854. </em>
  1855. </td>
  1856. <td>
  1857. Refer to the Kubernetes API documentation for the fields of the
  1858. <code>metadata</code> field.
  1859. </td>
  1860. </tr>
  1861. <tr>
  1862. <td>
  1863. <code>spec</code></br>
  1864. <em>
  1865. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1866. SecretStoreSpec
  1867. </a>
  1868. </em>
  1869. </td>
  1870. <td>
  1871. <br/>
  1872. <br/>
  1873. <table>
  1874. <tr>
  1875. <td>
  1876. <code>controller</code></br>
  1877. <em>
  1878. string
  1879. </em>
  1880. </td>
  1881. <td>
  1882. <em>(Optional)</em>
  1883. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1884. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1885. </td>
  1886. </tr>
  1887. <tr>
  1888. <td>
  1889. <code>provider</code></br>
  1890. <em>
  1891. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1892. SecretStoreProvider
  1893. </a>
  1894. </em>
  1895. </td>
  1896. <td>
  1897. <p>Used to configure the provider. Only one provider may be set</p>
  1898. </td>
  1899. </tr>
  1900. </table>
  1901. </td>
  1902. </tr>
  1903. <tr>
  1904. <td>
  1905. <code>status</code></br>
  1906. <em>
  1907. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1908. SecretStoreStatus
  1909. </a>
  1910. </em>
  1911. </td>
  1912. <td>
  1913. </td>
  1914. </tr>
  1915. </tbody>
  1916. </table>
  1917. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  1918. (<code>string</code> alias)</p></h3>
  1919. <p>
  1920. (<em>Appears on:</em>
  1921. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  1922. </p>
  1923. <p>
  1924. </p>
  1925. <table>
  1926. <thead>
  1927. <tr>
  1928. <th>Value</th>
  1929. <th>Description</th>
  1930. </tr>
  1931. </thead>
  1932. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  1933. <td></td>
  1934. </tr></tbody>
  1935. </table>
  1936. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  1937. </h3>
  1938. <p>
  1939. (<em>Appears on:</em>
  1940. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  1941. </p>
  1942. <p>
  1943. <p>SecretStoreProvider contains the provider-specific configration.</p>
  1944. </p>
  1945. <table>
  1946. <thead>
  1947. <tr>
  1948. <th>Field</th>
  1949. <th>Description</th>
  1950. </tr>
  1951. </thead>
  1952. <tbody>
  1953. <tr>
  1954. <td>
  1955. <code>aws</code></br>
  1956. <em>
  1957. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  1958. AWSProvider
  1959. </a>
  1960. </em>
  1961. </td>
  1962. <td>
  1963. <em>(Optional)</em>
  1964. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  1965. </td>
  1966. </tr>
  1967. <tr>
  1968. <td>
  1969. <code>azurekv</code></br>
  1970. <em>
  1971. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  1972. AzureKVProvider
  1973. </a>
  1974. </em>
  1975. </td>
  1976. <td>
  1977. <em>(Optional)</em>
  1978. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  1979. </td>
  1980. </tr>
  1981. <tr>
  1982. <td>
  1983. <code>vault</code></br>
  1984. <em>
  1985. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  1986. VaultProvider
  1987. </a>
  1988. </em>
  1989. </td>
  1990. <td>
  1991. <em>(Optional)</em>
  1992. <p>Vault configures this store to sync secrets using Hashi provider</p>
  1993. </td>
  1994. </tr>
  1995. <tr>
  1996. <td>
  1997. <code>gcpsm</code></br>
  1998. <em>
  1999. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  2000. GCPSMProvider
  2001. </a>
  2002. </em>
  2003. </td>
  2004. <td>
  2005. <em>(Optional)</em>
  2006. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  2007. </td>
  2008. </tr>
  2009. <tr>
  2010. <td>
  2011. <code>ibm</code></br>
  2012. <em>
  2013. <a href="#external-secrets.io/v1alpha1.IBMProvider">
  2014. IBMProvider
  2015. </a>
  2016. </em>
  2017. </td>
  2018. <td>
  2019. <em>(Optional)</em>
  2020. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  2021. </td>
  2022. </tr>
  2023. <tr>
  2024. <td>
  2025. <code>yandexlockbox</code></br>
  2026. <em>
  2027. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
  2028. YandexLockboxProvider
  2029. </a>
  2030. </em>
  2031. </td>
  2032. <td>
  2033. <em>(Optional)</em>
  2034. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  2035. </td>
  2036. </tr>
  2037. <tr>
  2038. <td>
  2039. <code>gitlab</code></br>
  2040. <em>
  2041. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
  2042. GitlabProvider
  2043. </a>
  2044. </em>
  2045. </td>
  2046. <td>
  2047. <em>(Optional)</em>
  2048. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  2049. </td>
  2050. </tr>
  2051. </tbody>
  2052. </table>
  2053. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  2054. </h3>
  2055. <p>
  2056. (<em>Appears on:</em>
  2057. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2058. </p>
  2059. <p>
  2060. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  2061. </p>
  2062. <table>
  2063. <thead>
  2064. <tr>
  2065. <th>Field</th>
  2066. <th>Description</th>
  2067. </tr>
  2068. </thead>
  2069. <tbody>
  2070. <tr>
  2071. <td>
  2072. <code>name</code></br>
  2073. <em>
  2074. string
  2075. </em>
  2076. </td>
  2077. <td>
  2078. <p>Name of the SecretStore resource</p>
  2079. </td>
  2080. </tr>
  2081. <tr>
  2082. <td>
  2083. <code>kind</code></br>
  2084. <em>
  2085. string
  2086. </em>
  2087. </td>
  2088. <td>
  2089. <em>(Optional)</em>
  2090. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  2091. Defaults to <code>SecretStore</code></p>
  2092. </td>
  2093. </tr>
  2094. </tbody>
  2095. </table>
  2096. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  2097. </h3>
  2098. <p>
  2099. (<em>Appears on:</em>
  2100. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2101. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2102. </p>
  2103. <p>
  2104. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  2105. </p>
  2106. <table>
  2107. <thead>
  2108. <tr>
  2109. <th>Field</th>
  2110. <th>Description</th>
  2111. </tr>
  2112. </thead>
  2113. <tbody>
  2114. <tr>
  2115. <td>
  2116. <code>controller</code></br>
  2117. <em>
  2118. string
  2119. </em>
  2120. </td>
  2121. <td>
  2122. <em>(Optional)</em>
  2123. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2124. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2125. </td>
  2126. </tr>
  2127. <tr>
  2128. <td>
  2129. <code>provider</code></br>
  2130. <em>
  2131. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2132. SecretStoreProvider
  2133. </a>
  2134. </em>
  2135. </td>
  2136. <td>
  2137. <p>Used to configure the provider. Only one provider may be set</p>
  2138. </td>
  2139. </tr>
  2140. </tbody>
  2141. </table>
  2142. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  2143. </h3>
  2144. <p>
  2145. (<em>Appears on:</em>
  2146. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2147. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2148. </p>
  2149. <p>
  2150. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  2151. </p>
  2152. <table>
  2153. <thead>
  2154. <tr>
  2155. <th>Field</th>
  2156. <th>Description</th>
  2157. </tr>
  2158. </thead>
  2159. <tbody>
  2160. <tr>
  2161. <td>
  2162. <code>conditions</code></br>
  2163. <em>
  2164. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  2165. []SecretStoreStatusCondition
  2166. </a>
  2167. </em>
  2168. </td>
  2169. <td>
  2170. <em>(Optional)</em>
  2171. </td>
  2172. </tr>
  2173. </tbody>
  2174. </table>
  2175. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  2176. </h3>
  2177. <p>
  2178. (<em>Appears on:</em>
  2179. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  2180. </p>
  2181. <p>
  2182. </p>
  2183. <table>
  2184. <thead>
  2185. <tr>
  2186. <th>Field</th>
  2187. <th>Description</th>
  2188. </tr>
  2189. </thead>
  2190. <tbody>
  2191. <tr>
  2192. <td>
  2193. <code>type</code></br>
  2194. <em>
  2195. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  2196. SecretStoreConditionType
  2197. </a>
  2198. </em>
  2199. </td>
  2200. <td>
  2201. </td>
  2202. </tr>
  2203. <tr>
  2204. <td>
  2205. <code>status</code></br>
  2206. <em>
  2207. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2208. Kubernetes core/v1.ConditionStatus
  2209. </a>
  2210. </em>
  2211. </td>
  2212. <td>
  2213. </td>
  2214. </tr>
  2215. <tr>
  2216. <td>
  2217. <code>reason</code></br>
  2218. <em>
  2219. string
  2220. </em>
  2221. </td>
  2222. <td>
  2223. <em>(Optional)</em>
  2224. </td>
  2225. </tr>
  2226. <tr>
  2227. <td>
  2228. <code>message</code></br>
  2229. <em>
  2230. string
  2231. </em>
  2232. </td>
  2233. <td>
  2234. <em>(Optional)</em>
  2235. </td>
  2236. </tr>
  2237. <tr>
  2238. <td>
  2239. <code>lastTransitionTime</code></br>
  2240. <em>
  2241. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2242. Kubernetes meta/v1.Time
  2243. </a>
  2244. </em>
  2245. </td>
  2246. <td>
  2247. <em>(Optional)</em>
  2248. </td>
  2249. </tr>
  2250. </tbody>
  2251. </table>
  2252. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
  2253. </h3>
  2254. <p>
  2255. (<em>Appears on:</em>
  2256. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2257. </p>
  2258. <p>
  2259. </p>
  2260. <table>
  2261. <thead>
  2262. <tr>
  2263. <th>Field</th>
  2264. <th>Description</th>
  2265. </tr>
  2266. </thead>
  2267. <tbody>
  2268. <tr>
  2269. <td>
  2270. <code>configMap</code></br>
  2271. <em>
  2272. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2273. TemplateRef
  2274. </a>
  2275. </em>
  2276. </td>
  2277. <td>
  2278. </td>
  2279. </tr>
  2280. <tr>
  2281. <td>
  2282. <code>secret</code></br>
  2283. <em>
  2284. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2285. TemplateRef
  2286. </a>
  2287. </em>
  2288. </td>
  2289. <td>
  2290. </td>
  2291. </tr>
  2292. </tbody>
  2293. </table>
  2294. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
  2295. </h3>
  2296. <p>
  2297. (<em>Appears on:</em>
  2298. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
  2299. </p>
  2300. <p>
  2301. </p>
  2302. <table>
  2303. <thead>
  2304. <tr>
  2305. <th>Field</th>
  2306. <th>Description</th>
  2307. </tr>
  2308. </thead>
  2309. <tbody>
  2310. <tr>
  2311. <td>
  2312. <code>name</code></br>
  2313. <em>
  2314. string
  2315. </em>
  2316. </td>
  2317. <td>
  2318. </td>
  2319. </tr>
  2320. <tr>
  2321. <td>
  2322. <code>items</code></br>
  2323. <em>
  2324. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
  2325. []TemplateRefItem
  2326. </a>
  2327. </em>
  2328. </td>
  2329. <td>
  2330. </td>
  2331. </tr>
  2332. </tbody>
  2333. </table>
  2334. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
  2335. </h3>
  2336. <p>
  2337. (<em>Appears on:</em>
  2338. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
  2339. </p>
  2340. <p>
  2341. </p>
  2342. <table>
  2343. <thead>
  2344. <tr>
  2345. <th>Field</th>
  2346. <th>Description</th>
  2347. </tr>
  2348. </thead>
  2349. <tbody>
  2350. <tr>
  2351. <td>
  2352. <code>key</code></br>
  2353. <em>
  2354. string
  2355. </em>
  2356. </td>
  2357. <td>
  2358. </td>
  2359. </tr>
  2360. </tbody>
  2361. </table>
  2362. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  2363. </h3>
  2364. <p>
  2365. (<em>Appears on:</em>
  2366. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2367. </p>
  2368. <p>
  2369. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  2370. with the role and secret stored in a Kubernetes Secret resource.</p>
  2371. </p>
  2372. <table>
  2373. <thead>
  2374. <tr>
  2375. <th>Field</th>
  2376. <th>Description</th>
  2377. </tr>
  2378. </thead>
  2379. <tbody>
  2380. <tr>
  2381. <td>
  2382. <code>path</code></br>
  2383. <em>
  2384. string
  2385. </em>
  2386. </td>
  2387. <td>
  2388. <p>Path where the App Role authentication backend is mounted
  2389. in Vault, e.g: &ldquo;approle&rdquo;</p>
  2390. </td>
  2391. </tr>
  2392. <tr>
  2393. <td>
  2394. <code>roleId</code></br>
  2395. <em>
  2396. string
  2397. </em>
  2398. </td>
  2399. <td>
  2400. <p>RoleID configured in the App Role authentication backend when setting
  2401. up the authentication backend in Vault.</p>
  2402. </td>
  2403. </tr>
  2404. <tr>
  2405. <td>
  2406. <code>secretRef</code></br>
  2407. <em>
  2408. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2409. </em>
  2410. </td>
  2411. <td>
  2412. <p>Reference to a key in a Secret that contains the App Role secret used
  2413. to authenticate with Vault.
  2414. The <code>key</code> field must be specified and denotes which entry within the Secret
  2415. resource is used as the app role secret.</p>
  2416. </td>
  2417. </tr>
  2418. </tbody>
  2419. </table>
  2420. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  2421. </h3>
  2422. <p>
  2423. (<em>Appears on:</em>
  2424. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2425. </p>
  2426. <p>
  2427. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  2428. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  2429. can be specified.</p>
  2430. </p>
  2431. <table>
  2432. <thead>
  2433. <tr>
  2434. <th>Field</th>
  2435. <th>Description</th>
  2436. </tr>
  2437. </thead>
  2438. <tbody>
  2439. <tr>
  2440. <td>
  2441. <code>tokenSecretRef</code></br>
  2442. <em>
  2443. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2444. </em>
  2445. </td>
  2446. <td>
  2447. <em>(Optional)</em>
  2448. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  2449. </td>
  2450. </tr>
  2451. <tr>
  2452. <td>
  2453. <code>appRole</code></br>
  2454. <em>
  2455. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  2456. VaultAppRole
  2457. </a>
  2458. </em>
  2459. </td>
  2460. <td>
  2461. <em>(Optional)</em>
  2462. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  2463. with the role and secret stored in a Kubernetes Secret resource.</p>
  2464. </td>
  2465. </tr>
  2466. <tr>
  2467. <td>
  2468. <code>kubernetes</code></br>
  2469. <em>
  2470. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  2471. VaultKubernetesAuth
  2472. </a>
  2473. </em>
  2474. </td>
  2475. <td>
  2476. <em>(Optional)</em>
  2477. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  2478. token stored in the named Secret resource to the Vault server.</p>
  2479. </td>
  2480. </tr>
  2481. <tr>
  2482. <td>
  2483. <code>ldap</code></br>
  2484. <em>
  2485. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  2486. VaultLdapAuth
  2487. </a>
  2488. </em>
  2489. </td>
  2490. <td>
  2491. <em>(Optional)</em>
  2492. <p>Ldap authenticates with Vault by passing username/password pair using
  2493. the LDAP authentication method</p>
  2494. </td>
  2495. </tr>
  2496. <tr>
  2497. <td>
  2498. <code>jwt</code></br>
  2499. <em>
  2500. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  2501. VaultJwtAuth
  2502. </a>
  2503. </em>
  2504. </td>
  2505. <td>
  2506. <em>(Optional)</em>
  2507. <p>Jwt authenticates with Vault by passing role and JWT token using the
  2508. JWT/OIDC authentication method</p>
  2509. </td>
  2510. </tr>
  2511. <tr>
  2512. <td>
  2513. <code>cert</code></br>
  2514. <em>
  2515. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
  2516. VaultCertAuth
  2517. </a>
  2518. </em>
  2519. </td>
  2520. <td>
  2521. <em>(Optional)</em>
  2522. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  2523. Cert authentication method</p>
  2524. </td>
  2525. </tr>
  2526. </tbody>
  2527. </table>
  2528. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
  2529. </h3>
  2530. <p>
  2531. (<em>Appears on:</em>
  2532. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2533. </p>
  2534. <p>
  2535. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  2536. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  2537. </p>
  2538. <table>
  2539. <thead>
  2540. <tr>
  2541. <th>Field</th>
  2542. <th>Description</th>
  2543. </tr>
  2544. </thead>
  2545. <tbody>
  2546. <tr>
  2547. <td>
  2548. <code>clientCert</code></br>
  2549. <em>
  2550. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2551. </em>
  2552. </td>
  2553. <td>
  2554. <em>(Optional)</em>
  2555. <p>ClientCert is a certificate to authenticate using the Cert Vault
  2556. authentication method</p>
  2557. </td>
  2558. </tr>
  2559. <tr>
  2560. <td>
  2561. <code>secretRef</code></br>
  2562. <em>
  2563. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2564. </em>
  2565. </td>
  2566. <td>
  2567. <p>SecretRef to a key in a Secret resource containing client private key to
  2568. authenticate with Vault using the Cert authentication method</p>
  2569. </td>
  2570. </tr>
  2571. </tbody>
  2572. </table>
  2573. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  2574. </h3>
  2575. <p>
  2576. (<em>Appears on:</em>
  2577. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2578. </p>
  2579. <p>
  2580. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  2581. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  2582. </p>
  2583. <table>
  2584. <thead>
  2585. <tr>
  2586. <th>Field</th>
  2587. <th>Description</th>
  2588. </tr>
  2589. </thead>
  2590. <tbody>
  2591. <tr>
  2592. <td>
  2593. <code>role</code></br>
  2594. <em>
  2595. string
  2596. </em>
  2597. </td>
  2598. <td>
  2599. <em>(Optional)</em>
  2600. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  2601. authentication method</p>
  2602. </td>
  2603. </tr>
  2604. <tr>
  2605. <td>
  2606. <code>secretRef</code></br>
  2607. <em>
  2608. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2609. </em>
  2610. </td>
  2611. <td>
  2612. <p>SecretRef to a key in a Secret resource containing JWT token to
  2613. authenticate with Vault using the JWT/OIDC authentication method</p>
  2614. </td>
  2615. </tr>
  2616. </tbody>
  2617. </table>
  2618. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  2619. (<code>string</code> alias)</p></h3>
  2620. <p>
  2621. (<em>Appears on:</em>
  2622. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2623. </p>
  2624. <p>
  2625. </p>
  2626. <table>
  2627. <thead>
  2628. <tr>
  2629. <th>Value</th>
  2630. <th>Description</th>
  2631. </tr>
  2632. </thead>
  2633. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  2634. <td></td>
  2635. </tr><tr><td><p>&#34;v2&#34;</p></td>
  2636. <td></td>
  2637. </tr></tbody>
  2638. </table>
  2639. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  2640. </h3>
  2641. <p>
  2642. (<em>Appears on:</em>
  2643. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2644. </p>
  2645. <p>
  2646. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  2647. a Secret.</p>
  2648. </p>
  2649. <table>
  2650. <thead>
  2651. <tr>
  2652. <th>Field</th>
  2653. <th>Description</th>
  2654. </tr>
  2655. </thead>
  2656. <tbody>
  2657. <tr>
  2658. <td>
  2659. <code>mountPath</code></br>
  2660. <em>
  2661. string
  2662. </em>
  2663. </td>
  2664. <td>
  2665. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  2666. &ldquo;kubernetes&rdquo;</p>
  2667. </td>
  2668. </tr>
  2669. <tr>
  2670. <td>
  2671. <code>serviceAccountRef</code></br>
  2672. <em>
  2673. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  2674. </em>
  2675. </td>
  2676. <td>
  2677. <em>(Optional)</em>
  2678. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  2679. If the service account is specified, the service account secret token JWT will be used
  2680. for authenticating with Vault. If the service account selector is not supplied,
  2681. the secretRef will be used instead.</p>
  2682. </td>
  2683. </tr>
  2684. <tr>
  2685. <td>
  2686. <code>secretRef</code></br>
  2687. <em>
  2688. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2689. </em>
  2690. </td>
  2691. <td>
  2692. <em>(Optional)</em>
  2693. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  2694. for authenticating with Vault. If a name is specified without a key,
  2695. <code>token</code> is the default. If one is not specified, the one bound to
  2696. the controller will be used.</p>
  2697. </td>
  2698. </tr>
  2699. <tr>
  2700. <td>
  2701. <code>role</code></br>
  2702. <em>
  2703. string
  2704. </em>
  2705. </td>
  2706. <td>
  2707. <p>A required field containing the Vault Role to assume. A Role binds a
  2708. Kubernetes ServiceAccount with a set of Vault policies.</p>
  2709. </td>
  2710. </tr>
  2711. </tbody>
  2712. </table>
  2713. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  2714. </h3>
  2715. <p>
  2716. (<em>Appears on:</em>
  2717. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2718. </p>
  2719. <p>
  2720. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  2721. with the username and password stored in a Kubernetes Secret resource.</p>
  2722. </p>
  2723. <table>
  2724. <thead>
  2725. <tr>
  2726. <th>Field</th>
  2727. <th>Description</th>
  2728. </tr>
  2729. </thead>
  2730. <tbody>
  2731. <tr>
  2732. <td>
  2733. <code>username</code></br>
  2734. <em>
  2735. string
  2736. </em>
  2737. </td>
  2738. <td>
  2739. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  2740. authentication method</p>
  2741. </td>
  2742. </tr>
  2743. <tr>
  2744. <td>
  2745. <code>secretRef</code></br>
  2746. <em>
  2747. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2748. </em>
  2749. </td>
  2750. <td>
  2751. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  2752. user used to authenticate with Vault using the LDAP authentication
  2753. method</p>
  2754. </td>
  2755. </tr>
  2756. </tbody>
  2757. </table>
  2758. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  2759. </h3>
  2760. <p>
  2761. (<em>Appears on:</em>
  2762. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2763. </p>
  2764. <p>
  2765. <p>Configures an store to sync secrets using a HashiCorp Vault
  2766. KV backend.</p>
  2767. </p>
  2768. <table>
  2769. <thead>
  2770. <tr>
  2771. <th>Field</th>
  2772. <th>Description</th>
  2773. </tr>
  2774. </thead>
  2775. <tbody>
  2776. <tr>
  2777. <td>
  2778. <code>auth</code></br>
  2779. <em>
  2780. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  2781. VaultAuth
  2782. </a>
  2783. </em>
  2784. </td>
  2785. <td>
  2786. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  2787. </td>
  2788. </tr>
  2789. <tr>
  2790. <td>
  2791. <code>server</code></br>
  2792. <em>
  2793. string
  2794. </em>
  2795. </td>
  2796. <td>
  2797. <p>Server is the connection address for the Vault server, e.g: &ldquo;<a href="https://vault.example.com:8200&quot;">https://vault.example.com:8200&rdquo;</a>.</p>
  2798. </td>
  2799. </tr>
  2800. <tr>
  2801. <td>
  2802. <code>path</code></br>
  2803. <em>
  2804. string
  2805. </em>
  2806. </td>
  2807. <td>
  2808. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  2809. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  2810. for fetching secrets from Vault is optional and will be appended
  2811. if not present in specified path.</p>
  2812. </td>
  2813. </tr>
  2814. <tr>
  2815. <td>
  2816. <code>version</code></br>
  2817. <em>
  2818. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  2819. VaultKVStoreVersion
  2820. </a>
  2821. </em>
  2822. </td>
  2823. <td>
  2824. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  2825. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  2826. </td>
  2827. </tr>
  2828. <tr>
  2829. <td>
  2830. <code>namespace</code></br>
  2831. <em>
  2832. string
  2833. </em>
  2834. </td>
  2835. <td>
  2836. <em>(Optional)</em>
  2837. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  2838. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  2839. More about namespaces can be found here <a href="https://www.vaultproject.io/docs/enterprise/namespaces">https://www.vaultproject.io/docs/enterprise/namespaces</a></p>
  2840. </td>
  2841. </tr>
  2842. <tr>
  2843. <td>
  2844. <code>caBundle</code></br>
  2845. <em>
  2846. []byte
  2847. </em>
  2848. </td>
  2849. <td>
  2850. <em>(Optional)</em>
  2851. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  2852. if the Server URL is using HTTPS protocol. This parameter is ignored for
  2853. plain HTTP protocol connection. If not set the system root certificates
  2854. are used to validate the TLS connection.</p>
  2855. </td>
  2856. </tr>
  2857. </tbody>
  2858. </table>
  2859. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
  2860. </h3>
  2861. <p>
  2862. (<em>Appears on:</em>
  2863. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  2864. </p>
  2865. <p>
  2866. </p>
  2867. <table>
  2868. <thead>
  2869. <tr>
  2870. <th>Field</th>
  2871. <th>Description</th>
  2872. </tr>
  2873. </thead>
  2874. <tbody>
  2875. <tr>
  2876. <td>
  2877. <code>authorizedKeySecretRef</code></br>
  2878. <em>
  2879. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2880. </em>
  2881. </td>
  2882. <td>
  2883. <em>(Optional)</em>
  2884. <p>The authorized key used for authentication</p>
  2885. </td>
  2886. </tr>
  2887. </tbody>
  2888. </table>
  2889. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
  2890. </h3>
  2891. <p>
  2892. (<em>Appears on:</em>
  2893. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2894. </p>
  2895. <p>
  2896. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  2897. </p>
  2898. <table>
  2899. <thead>
  2900. <tr>
  2901. <th>Field</th>
  2902. <th>Description</th>
  2903. </tr>
  2904. </thead>
  2905. <tbody>
  2906. <tr>
  2907. <td>
  2908. <code>apiEndpoint</code></br>
  2909. <em>
  2910. string
  2911. </em>
  2912. </td>
  2913. <td>
  2914. <em>(Optional)</em>
  2915. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  2916. </td>
  2917. </tr>
  2918. <tr>
  2919. <td>
  2920. <code>auth</code></br>
  2921. <em>
  2922. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
  2923. YandexLockboxAuth
  2924. </a>
  2925. </em>
  2926. </td>
  2927. <td>
  2928. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  2929. </td>
  2930. </tr>
  2931. </tbody>
  2932. </table>
  2933. <hr/>
  2934. <p><em>
  2935. Generated with <code>gen-crd-api-reference-docs</code>.
  2936. </em></p></p>
  2937. </article>
  2938. </div>
  2939. </div>
  2940. </main>
  2941. <footer class="md-footer">
  2942. <nav class="md-footer__inner md-grid" aria-label="Footer">
  2943. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Oracle Vault" rel="prev">
  2944. <div class="md-footer__button md-icon">
  2945. <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>
  2946. </div>
  2947. <div class="md-footer__title">
  2948. <div class="md-ellipsis">
  2949. <span class="md-footer__direction">
  2950. Previous
  2951. </span>
  2952. Oracle Vault
  2953. </div>
  2954. </div>
  2955. </a>
  2956. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  2957. <div class="md-footer__title">
  2958. <div class="md-ellipsis">
  2959. <span class="md-footer__direction">
  2960. Next
  2961. </span>
  2962. Developer guide
  2963. </div>
  2964. </div>
  2965. <div class="md-footer__button md-icon">
  2966. <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>
  2967. </div>
  2968. </a>
  2969. </nav>
  2970. <div class="md-footer-meta md-typeset">
  2971. <div class="md-footer-meta__inner md-grid">
  2972. <div class="md-footer-copyright">
  2973. Made with
  2974. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  2975. Material for MkDocs
  2976. </a>
  2977. </div>
  2978. </div>
  2979. </div>
  2980. </footer>
  2981. </div>
  2982. <div class="md-dialog" data-md-component="dialog">
  2983. <div class="md-dialog__inner md-typeset"></div>
  2984. </div>
  2985. <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.b0710199.min.js", "version": {"provider": "mike"}}</script>
  2986. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  2987. </body>
  2988. </html>