index.html 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018
  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.AkeylessAuth">AkeylessAuth
  667. </h3>
  668. <p>
  669. (<em>Appears on:</em>
  670. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider</a>)
  671. </p>
  672. <p>
  673. </p>
  674. <table>
  675. <thead>
  676. <tr>
  677. <th>Field</th>
  678. <th>Description</th>
  679. </tr>
  680. </thead>
  681. <tbody>
  682. <tr>
  683. <td>
  684. <code>secretRef</code></br>
  685. <em>
  686. <a href="#external-secrets.io/v1alpha1.AkeylessAuthSecretRef">
  687. AkeylessAuthSecretRef
  688. </a>
  689. </em>
  690. </td>
  691. <td>
  692. </td>
  693. </tr>
  694. </tbody>
  695. </table>
  696. <h3 id="external-secrets.io/v1alpha1.AkeylessAuthSecretRef">AkeylessAuthSecretRef
  697. </h3>
  698. <p>
  699. (<em>Appears on:</em>
  700. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">AkeylessAuth</a>)
  701. </p>
  702. <p>
  703. <p>AkeylessAuthSecretRef
  704. AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.</p>
  705. </p>
  706. <table>
  707. <thead>
  708. <tr>
  709. <th>Field</th>
  710. <th>Description</th>
  711. </tr>
  712. </thead>
  713. <tbody>
  714. <tr>
  715. <td>
  716. <code>accessID</code></br>
  717. <em>
  718. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  719. </em>
  720. </td>
  721. <td>
  722. <p>The SecretAccessID is used for authentication</p>
  723. </td>
  724. </tr>
  725. <tr>
  726. <td>
  727. <code>accessType</code></br>
  728. <em>
  729. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  730. </em>
  731. </td>
  732. <td>
  733. </td>
  734. </tr>
  735. <tr>
  736. <td>
  737. <code>accessTypeParam</code></br>
  738. <em>
  739. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  740. </em>
  741. </td>
  742. <td>
  743. </td>
  744. </tr>
  745. </tbody>
  746. </table>
  747. <h3 id="external-secrets.io/v1alpha1.AkeylessProvider">AkeylessProvider
  748. </h3>
  749. <p>
  750. (<em>Appears on:</em>
  751. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  752. </p>
  753. <p>
  754. <p>AkeylessProvider Configures an store to sync secrets using Akeyless KV.</p>
  755. </p>
  756. <table>
  757. <thead>
  758. <tr>
  759. <th>Field</th>
  760. <th>Description</th>
  761. </tr>
  762. </thead>
  763. <tbody>
  764. <tr>
  765. <td>
  766. <code>akeylessGWApiURL</code></br>
  767. <em>
  768. string
  769. </em>
  770. </td>
  771. <td>
  772. <p>Akeyless GW API Url from which the secrets to be fetched from.</p>
  773. </td>
  774. </tr>
  775. <tr>
  776. <td>
  777. <code>authSecretRef</code></br>
  778. <em>
  779. <a href="#external-secrets.io/v1alpha1.AkeylessAuth">
  780. AkeylessAuth
  781. </a>
  782. </em>
  783. </td>
  784. <td>
  785. <p>Auth configures how the operator authenticates with Akeyless.</p>
  786. </td>
  787. </tr>
  788. </tbody>
  789. </table>
  790. <h3 id="external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth
  791. </h3>
  792. <p>
  793. (<em>Appears on:</em>
  794. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider</a>)
  795. </p>
  796. <p>
  797. <p>AlibabaAuth contains a secretRef for credentials.</p>
  798. </p>
  799. <table>
  800. <thead>
  801. <tr>
  802. <th>Field</th>
  803. <th>Description</th>
  804. </tr>
  805. </thead>
  806. <tbody>
  807. <tr>
  808. <td>
  809. <code>secretRef</code></br>
  810. <em>
  811. <a href="#external-secrets.io/v1alpha1.AlibabaAuthSecretRef">
  812. AlibabaAuthSecretRef
  813. </a>
  814. </em>
  815. </td>
  816. <td>
  817. </td>
  818. </tr>
  819. </tbody>
  820. </table>
  821. <h3 id="external-secrets.io/v1alpha1.AlibabaAuthSecretRef">AlibabaAuthSecretRef
  822. </h3>
  823. <p>
  824. (<em>Appears on:</em>
  825. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">AlibabaAuth</a>)
  826. </p>
  827. <p>
  828. <p>AlibabaAuthSecretRef holds secret references for Alibaba credentials.</p>
  829. </p>
  830. <table>
  831. <thead>
  832. <tr>
  833. <th>Field</th>
  834. <th>Description</th>
  835. </tr>
  836. </thead>
  837. <tbody>
  838. <tr>
  839. <td>
  840. <code>accessKeyIDSecretRef</code></br>
  841. <em>
  842. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  843. </em>
  844. </td>
  845. <td>
  846. <p>The AccessKeyID is used for authentication</p>
  847. </td>
  848. </tr>
  849. <tr>
  850. <td>
  851. <code>accessKeySecretSecretRef</code></br>
  852. <em>
  853. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  854. </em>
  855. </td>
  856. <td>
  857. <p>The AccessKeySecret is used for authentication</p>
  858. </td>
  859. </tr>
  860. </tbody>
  861. </table>
  862. <h3 id="external-secrets.io/v1alpha1.AlibabaProvider">AlibabaProvider
  863. </h3>
  864. <p>
  865. (<em>Appears on:</em>
  866. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  867. </p>
  868. <p>
  869. <p>AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.</p>
  870. </p>
  871. <table>
  872. <thead>
  873. <tr>
  874. <th>Field</th>
  875. <th>Description</th>
  876. </tr>
  877. </thead>
  878. <tbody>
  879. <tr>
  880. <td>
  881. <code>auth</code></br>
  882. <em>
  883. <a href="#external-secrets.io/v1alpha1.AlibabaAuth">
  884. AlibabaAuth
  885. </a>
  886. </em>
  887. </td>
  888. <td>
  889. </td>
  890. </tr>
  891. <tr>
  892. <td>
  893. <code>endpoint</code></br>
  894. <em>
  895. string
  896. </em>
  897. </td>
  898. <td>
  899. <em>(Optional)</em>
  900. </td>
  901. </tr>
  902. <tr>
  903. <td>
  904. <code>regionID</code></br>
  905. <em>
  906. string
  907. </em>
  908. </td>
  909. <td>
  910. <p>Alibaba Region to be used for the provider</p>
  911. </td>
  912. </tr>
  913. </tbody>
  914. </table>
  915. <h3 id="external-secrets.io/v1alpha1.AzureKVAuth">AzureKVAuth
  916. </h3>
  917. <p>
  918. (<em>Appears on:</em>
  919. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider</a>)
  920. </p>
  921. <p>
  922. <p>Configuration used to authenticate with Azure.</p>
  923. </p>
  924. <table>
  925. <thead>
  926. <tr>
  927. <th>Field</th>
  928. <th>Description</th>
  929. </tr>
  930. </thead>
  931. <tbody>
  932. <tr>
  933. <td>
  934. <code>clientId</code></br>
  935. <em>
  936. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  937. </em>
  938. </td>
  939. <td>
  940. <p>The Azure clientId of the service principle used for authentication.</p>
  941. </td>
  942. </tr>
  943. <tr>
  944. <td>
  945. <code>clientSecret</code></br>
  946. <em>
  947. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  948. </em>
  949. </td>
  950. <td>
  951. <p>The Azure ClientSecret of the service principle used for authentication.</p>
  952. </td>
  953. </tr>
  954. </tbody>
  955. </table>
  956. <h3 id="external-secrets.io/v1alpha1.AzureKVProvider">AzureKVProvider
  957. </h3>
  958. <p>
  959. (<em>Appears on:</em>
  960. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  961. </p>
  962. <p>
  963. <p>Configures an store to sync secrets using Azure KV.</p>
  964. </p>
  965. <table>
  966. <thead>
  967. <tr>
  968. <th>Field</th>
  969. <th>Description</th>
  970. </tr>
  971. </thead>
  972. <tbody>
  973. <tr>
  974. <td>
  975. <code>vaultUrl</code></br>
  976. <em>
  977. string
  978. </em>
  979. </td>
  980. <td>
  981. <p>Vault Url from which the secrets to be fetched from.</p>
  982. </td>
  983. </tr>
  984. <tr>
  985. <td>
  986. <code>tenantId</code></br>
  987. <em>
  988. string
  989. </em>
  990. </td>
  991. <td>
  992. <p>TenantID configures the Azure Tenant to send requests to.</p>
  993. </td>
  994. </tr>
  995. <tr>
  996. <td>
  997. <code>authSecretRef</code></br>
  998. <em>
  999. <a href="#external-secrets.io/v1alpha1.AzureKVAuth">
  1000. AzureKVAuth
  1001. </a>
  1002. </em>
  1003. </td>
  1004. <td>
  1005. <p>Auth configures how the operator authenticates with Azure.</p>
  1006. </td>
  1007. </tr>
  1008. </tbody>
  1009. </table>
  1010. <h3 id="external-secrets.io/v1alpha1.CAProvider">CAProvider
  1011. </h3>
  1012. <p>
  1013. (<em>Appears on:</em>
  1014. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  1015. </p>
  1016. <p>
  1017. <p>Defines a location to fetch the cert for the vault provider from.</p>
  1018. </p>
  1019. <table>
  1020. <thead>
  1021. <tr>
  1022. <th>Field</th>
  1023. <th>Description</th>
  1024. </tr>
  1025. </thead>
  1026. <tbody>
  1027. <tr>
  1028. <td>
  1029. <code>type</code></br>
  1030. <em>
  1031. <a href="#external-secrets.io/v1alpha1.CAProviderType">
  1032. CAProviderType
  1033. </a>
  1034. </em>
  1035. </td>
  1036. <td>
  1037. <p>The type of provider to use such as &ldquo;Secret&rdquo;, or &ldquo;ConfigMap&rdquo;.</p>
  1038. </td>
  1039. </tr>
  1040. <tr>
  1041. <td>
  1042. <code>name</code></br>
  1043. <em>
  1044. string
  1045. </em>
  1046. </td>
  1047. <td>
  1048. <p>The name of the object located at the provider type.</p>
  1049. </td>
  1050. </tr>
  1051. <tr>
  1052. <td>
  1053. <code>key</code></br>
  1054. <em>
  1055. string
  1056. </em>
  1057. </td>
  1058. <td>
  1059. <p>The key the value inside of the provider type to use, only used with &ldquo;Secret&rdquo; type</p>
  1060. </td>
  1061. </tr>
  1062. <tr>
  1063. <td>
  1064. <code>namespace</code></br>
  1065. <em>
  1066. string
  1067. </em>
  1068. </td>
  1069. <td>
  1070. <p>The namespace the Provider type is in.</p>
  1071. </td>
  1072. </tr>
  1073. </tbody>
  1074. </table>
  1075. <h3 id="external-secrets.io/v1alpha1.CAProviderType">CAProviderType
  1076. (<code>string</code> alias)</p></h3>
  1077. <p>
  1078. (<em>Appears on:</em>
  1079. <a href="#external-secrets.io/v1alpha1.CAProvider">CAProvider</a>)
  1080. </p>
  1081. <p>
  1082. </p>
  1083. <table>
  1084. <thead>
  1085. <tr>
  1086. <th>Value</th>
  1087. <th>Description</th>
  1088. </tr>
  1089. </thead>
  1090. <tbody><tr><td><p>&#34;ConfigMap&#34;</p></td>
  1091. <td></td>
  1092. </tr><tr><td><p>&#34;Secret&#34;</p></td>
  1093. <td></td>
  1094. </tr></tbody>
  1095. </table>
  1096. <h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
  1097. </h3>
  1098. <p>
  1099. <p>ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  1100. </p>
  1101. <table>
  1102. <thead>
  1103. <tr>
  1104. <th>Field</th>
  1105. <th>Description</th>
  1106. </tr>
  1107. </thead>
  1108. <tbody>
  1109. <tr>
  1110. <td>
  1111. <code>metadata</code></br>
  1112. <em>
  1113. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1114. Kubernetes meta/v1.ObjectMeta
  1115. </a>
  1116. </em>
  1117. </td>
  1118. <td>
  1119. Refer to the Kubernetes API documentation for the fields of the
  1120. <code>metadata</code> field.
  1121. </td>
  1122. </tr>
  1123. <tr>
  1124. <td>
  1125. <code>spec</code></br>
  1126. <em>
  1127. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  1128. SecretStoreSpec
  1129. </a>
  1130. </em>
  1131. </td>
  1132. <td>
  1133. <br/>
  1134. <br/>
  1135. <table>
  1136. <tr>
  1137. <td>
  1138. <code>controller</code></br>
  1139. <em>
  1140. string
  1141. </em>
  1142. </td>
  1143. <td>
  1144. <em>(Optional)</em>
  1145. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  1146. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  1147. </td>
  1148. </tr>
  1149. <tr>
  1150. <td>
  1151. <code>provider</code></br>
  1152. <em>
  1153. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  1154. SecretStoreProvider
  1155. </a>
  1156. </em>
  1157. </td>
  1158. <td>
  1159. <p>Used to configure the provider. Only one provider may be set</p>
  1160. </td>
  1161. </tr>
  1162. </table>
  1163. </td>
  1164. </tr>
  1165. <tr>
  1166. <td>
  1167. <code>status</code></br>
  1168. <em>
  1169. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  1170. SecretStoreStatus
  1171. </a>
  1172. </em>
  1173. </td>
  1174. <td>
  1175. </td>
  1176. </tr>
  1177. </tbody>
  1178. </table>
  1179. <h3 id="external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret
  1180. </h3>
  1181. <p>
  1182. <p>ExternalSecret is the Schema for the external-secrets API.</p>
  1183. </p>
  1184. <table>
  1185. <thead>
  1186. <tr>
  1187. <th>Field</th>
  1188. <th>Description</th>
  1189. </tr>
  1190. </thead>
  1191. <tbody>
  1192. <tr>
  1193. <td>
  1194. <code>metadata</code></br>
  1195. <em>
  1196. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  1197. Kubernetes meta/v1.ObjectMeta
  1198. </a>
  1199. </em>
  1200. </td>
  1201. <td>
  1202. Refer to the Kubernetes API documentation for the fields of the
  1203. <code>metadata</code> field.
  1204. </td>
  1205. </tr>
  1206. <tr>
  1207. <td>
  1208. <code>spec</code></br>
  1209. <em>
  1210. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">
  1211. ExternalSecretSpec
  1212. </a>
  1213. </em>
  1214. </td>
  1215. <td>
  1216. <br/>
  1217. <br/>
  1218. <table>
  1219. <tr>
  1220. <td>
  1221. <code>secretStoreRef</code></br>
  1222. <em>
  1223. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1224. SecretStoreRef
  1225. </a>
  1226. </em>
  1227. </td>
  1228. <td>
  1229. </td>
  1230. </tr>
  1231. <tr>
  1232. <td>
  1233. <code>target</code></br>
  1234. <em>
  1235. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1236. ExternalSecretTarget
  1237. </a>
  1238. </em>
  1239. </td>
  1240. <td>
  1241. </td>
  1242. </tr>
  1243. <tr>
  1244. <td>
  1245. <code>refreshInterval</code></br>
  1246. <em>
  1247. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1248. Kubernetes meta/v1.Duration
  1249. </a>
  1250. </em>
  1251. </td>
  1252. <td>
  1253. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1254. 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;
  1255. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1256. </td>
  1257. </tr>
  1258. <tr>
  1259. <td>
  1260. <code>data</code></br>
  1261. <em>
  1262. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1263. []ExternalSecretData
  1264. </a>
  1265. </em>
  1266. </td>
  1267. <td>
  1268. <em>(Optional)</em>
  1269. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1270. </td>
  1271. </tr>
  1272. <tr>
  1273. <td>
  1274. <code>dataFrom</code></br>
  1275. <em>
  1276. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1277. []ExternalSecretDataRemoteRef
  1278. </a>
  1279. </em>
  1280. </td>
  1281. <td>
  1282. <em>(Optional)</em>
  1283. <p>DataFrom is used to fetch all properties from a specific Provider data
  1284. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1285. </td>
  1286. </tr>
  1287. </table>
  1288. </td>
  1289. </tr>
  1290. <tr>
  1291. <td>
  1292. <code>status</code></br>
  1293. <em>
  1294. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">
  1295. ExternalSecretStatus
  1296. </a>
  1297. </em>
  1298. </td>
  1299. <td>
  1300. </td>
  1301. </tr>
  1302. </tbody>
  1303. </table>
  1304. <h3 id="external-secrets.io/v1alpha1.ExternalSecretConditionType">ExternalSecretConditionType
  1305. (<code>string</code> alias)</p></h3>
  1306. <p>
  1307. (<em>Appears on:</em>
  1308. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition</a>)
  1309. </p>
  1310. <p>
  1311. </p>
  1312. <table>
  1313. <thead>
  1314. <tr>
  1315. <th>Value</th>
  1316. <th>Description</th>
  1317. </tr>
  1318. </thead>
  1319. <tbody><tr><td><p>&#34;Deleted&#34;</p></td>
  1320. <td></td>
  1321. </tr><tr><td><p>&#34;Ready&#34;</p></td>
  1322. <td></td>
  1323. </tr></tbody>
  1324. </table>
  1325. <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
  1326. (<code>string</code> alias)</p></h3>
  1327. <p>
  1328. (<em>Appears on:</em>
  1329. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1330. </p>
  1331. <p>
  1332. <p>ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.</p>
  1333. </p>
  1334. <table>
  1335. <thead>
  1336. <tr>
  1337. <th>Value</th>
  1338. <th>Description</th>
  1339. </tr>
  1340. </thead>
  1341. <tbody><tr><td><p>&#34;Merge&#34;</p></td>
  1342. <td><p>Merge does not create the Secret, but merges the data fields to the Secret.</p>
  1343. </td>
  1344. </tr><tr><td><p>&#34;None&#34;</p></td>
  1345. <td><p>None does not create a Secret (future use with injector).</p>
  1346. </td>
  1347. </tr><tr><td><p>&#34;Owner&#34;</p></td>
  1348. <td><p>Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.</p>
  1349. </td>
  1350. </tr></tbody>
  1351. </table>
  1352. <h3 id="external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData
  1353. </h3>
  1354. <p>
  1355. (<em>Appears on:</em>
  1356. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1357. </p>
  1358. <p>
  1359. <p>ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.</p>
  1360. </p>
  1361. <table>
  1362. <thead>
  1363. <tr>
  1364. <th>Field</th>
  1365. <th>Description</th>
  1366. </tr>
  1367. </thead>
  1368. <tbody>
  1369. <tr>
  1370. <td>
  1371. <code>secretKey</code></br>
  1372. <em>
  1373. string
  1374. </em>
  1375. </td>
  1376. <td>
  1377. </td>
  1378. </tr>
  1379. <tr>
  1380. <td>
  1381. <code>remoteRef</code></br>
  1382. <em>
  1383. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1384. ExternalSecretDataRemoteRef
  1385. </a>
  1386. </em>
  1387. </td>
  1388. <td>
  1389. </td>
  1390. </tr>
  1391. </tbody>
  1392. </table>
  1393. <h3 id="external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef
  1394. </h3>
  1395. <p>
  1396. (<em>Appears on:</em>
  1397. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">ExternalSecretData</a>,
  1398. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1399. </p>
  1400. <p>
  1401. <p>ExternalSecretDataRemoteRef defines Provider data location.</p>
  1402. </p>
  1403. <table>
  1404. <thead>
  1405. <tr>
  1406. <th>Field</th>
  1407. <th>Description</th>
  1408. </tr>
  1409. </thead>
  1410. <tbody>
  1411. <tr>
  1412. <td>
  1413. <code>key</code></br>
  1414. <em>
  1415. string
  1416. </em>
  1417. </td>
  1418. <td>
  1419. <p>Key is the key used in the Provider, mandatory</p>
  1420. </td>
  1421. </tr>
  1422. <tr>
  1423. <td>
  1424. <code>version</code></br>
  1425. <em>
  1426. string
  1427. </em>
  1428. </td>
  1429. <td>
  1430. <em>(Optional)</em>
  1431. <p>Used to select a specific version of the Provider value, if supported</p>
  1432. </td>
  1433. </tr>
  1434. <tr>
  1435. <td>
  1436. <code>property</code></br>
  1437. <em>
  1438. string
  1439. </em>
  1440. </td>
  1441. <td>
  1442. <em>(Optional)</em>
  1443. <p>Used to select a specific property of the Provider value (if a map), if supported</p>
  1444. </td>
  1445. </tr>
  1446. </tbody>
  1447. </table>
  1448. <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
  1449. </h3>
  1450. <p>
  1451. (<em>Appears on:</em>
  1452. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1453. </p>
  1454. <p>
  1455. <p>ExternalSecretSpec defines the desired state of ExternalSecret.</p>
  1456. </p>
  1457. <table>
  1458. <thead>
  1459. <tr>
  1460. <th>Field</th>
  1461. <th>Description</th>
  1462. </tr>
  1463. </thead>
  1464. <tbody>
  1465. <tr>
  1466. <td>
  1467. <code>secretStoreRef</code></br>
  1468. <em>
  1469. <a href="#external-secrets.io/v1alpha1.SecretStoreRef">
  1470. SecretStoreRef
  1471. </a>
  1472. </em>
  1473. </td>
  1474. <td>
  1475. </td>
  1476. </tr>
  1477. <tr>
  1478. <td>
  1479. <code>target</code></br>
  1480. <em>
  1481. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">
  1482. ExternalSecretTarget
  1483. </a>
  1484. </em>
  1485. </td>
  1486. <td>
  1487. </td>
  1488. </tr>
  1489. <tr>
  1490. <td>
  1491. <code>refreshInterval</code></br>
  1492. <em>
  1493. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
  1494. Kubernetes meta/v1.Duration
  1495. </a>
  1496. </em>
  1497. </td>
  1498. <td>
  1499. <p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
  1500. 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;
  1501. May be set to zero to fetch and create it once. Defaults to 1h.</p>
  1502. </td>
  1503. </tr>
  1504. <tr>
  1505. <td>
  1506. <code>data</code></br>
  1507. <em>
  1508. <a href="#external-secrets.io/v1alpha1.ExternalSecretData">
  1509. []ExternalSecretData
  1510. </a>
  1511. </em>
  1512. </td>
  1513. <td>
  1514. <em>(Optional)</em>
  1515. <p>Data defines the connection between the Kubernetes Secret keys and the Provider data</p>
  1516. </td>
  1517. </tr>
  1518. <tr>
  1519. <td>
  1520. <code>dataFrom</code></br>
  1521. <em>
  1522. <a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">
  1523. []ExternalSecretDataRemoteRef
  1524. </a>
  1525. </em>
  1526. </td>
  1527. <td>
  1528. <em>(Optional)</em>
  1529. <p>DataFrom is used to fetch all properties from a specific Provider data
  1530. If multiple entries are specified, the Secret keys are merged in the specified order</p>
  1531. </td>
  1532. </tr>
  1533. </tbody>
  1534. </table>
  1535. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus
  1536. </h3>
  1537. <p>
  1538. (<em>Appears on:</em>
  1539. <a href="#external-secrets.io/v1alpha1.ExternalSecret">ExternalSecret</a>)
  1540. </p>
  1541. <p>
  1542. </p>
  1543. <table>
  1544. <thead>
  1545. <tr>
  1546. <th>Field</th>
  1547. <th>Description</th>
  1548. </tr>
  1549. </thead>
  1550. <tbody>
  1551. <tr>
  1552. <td>
  1553. <code>refreshTime</code></br>
  1554. <em>
  1555. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1556. Kubernetes meta/v1.Time
  1557. </a>
  1558. </em>
  1559. </td>
  1560. <td>
  1561. <p>refreshTime is the time and date the external secret was fetched and
  1562. the target secret updated</p>
  1563. </td>
  1564. </tr>
  1565. <tr>
  1566. <td>
  1567. <code>syncedResourceVersion</code></br>
  1568. <em>
  1569. string
  1570. </em>
  1571. </td>
  1572. <td>
  1573. <p>SyncedResourceVersion keeps track of the last synced version</p>
  1574. </td>
  1575. </tr>
  1576. <tr>
  1577. <td>
  1578. <code>conditions</code></br>
  1579. <em>
  1580. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatusCondition">
  1581. []ExternalSecretStatusCondition
  1582. </a>
  1583. </em>
  1584. </td>
  1585. <td>
  1586. <em>(Optional)</em>
  1587. </td>
  1588. </tr>
  1589. </tbody>
  1590. </table>
  1591. <h3 id="external-secrets.io/v1alpha1.ExternalSecretStatusCondition">ExternalSecretStatusCondition
  1592. </h3>
  1593. <p>
  1594. (<em>Appears on:</em>
  1595. <a href="#external-secrets.io/v1alpha1.ExternalSecretStatus">ExternalSecretStatus</a>)
  1596. </p>
  1597. <p>
  1598. </p>
  1599. <table>
  1600. <thead>
  1601. <tr>
  1602. <th>Field</th>
  1603. <th>Description</th>
  1604. </tr>
  1605. </thead>
  1606. <tbody>
  1607. <tr>
  1608. <td>
  1609. <code>type</code></br>
  1610. <em>
  1611. <a href="#external-secrets.io/v1alpha1.ExternalSecretConditionType">
  1612. ExternalSecretConditionType
  1613. </a>
  1614. </em>
  1615. </td>
  1616. <td>
  1617. </td>
  1618. </tr>
  1619. <tr>
  1620. <td>
  1621. <code>status</code></br>
  1622. <em>
  1623. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  1624. Kubernetes core/v1.ConditionStatus
  1625. </a>
  1626. </em>
  1627. </td>
  1628. <td>
  1629. </td>
  1630. </tr>
  1631. <tr>
  1632. <td>
  1633. <code>reason</code></br>
  1634. <em>
  1635. string
  1636. </em>
  1637. </td>
  1638. <td>
  1639. <em>(Optional)</em>
  1640. </td>
  1641. </tr>
  1642. <tr>
  1643. <td>
  1644. <code>message</code></br>
  1645. <em>
  1646. string
  1647. </em>
  1648. </td>
  1649. <td>
  1650. <em>(Optional)</em>
  1651. </td>
  1652. </tr>
  1653. <tr>
  1654. <td>
  1655. <code>lastTransitionTime</code></br>
  1656. <em>
  1657. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  1658. Kubernetes meta/v1.Time
  1659. </a>
  1660. </em>
  1661. </td>
  1662. <td>
  1663. <em>(Optional)</em>
  1664. </td>
  1665. </tr>
  1666. </tbody>
  1667. </table>
  1668. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget
  1669. </h3>
  1670. <p>
  1671. (<em>Appears on:</em>
  1672. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  1673. </p>
  1674. <p>
  1675. <p>ExternalSecretTarget defines the Kubernetes Secret to be created
  1676. There can be only one target per ExternalSecret.</p>
  1677. </p>
  1678. <table>
  1679. <thead>
  1680. <tr>
  1681. <th>Field</th>
  1682. <th>Description</th>
  1683. </tr>
  1684. </thead>
  1685. <tbody>
  1686. <tr>
  1687. <td>
  1688. <code>name</code></br>
  1689. <em>
  1690. string
  1691. </em>
  1692. </td>
  1693. <td>
  1694. <em>(Optional)</em>
  1695. <p>Name defines the name of the Secret resource to be managed
  1696. This field is immutable
  1697. Defaults to the .metadata.name of the ExternalSecret resource</p>
  1698. </td>
  1699. </tr>
  1700. <tr>
  1701. <td>
  1702. <code>creationPolicy</code></br>
  1703. <em>
  1704. <a href="#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">
  1705. ExternalSecretCreationPolicy
  1706. </a>
  1707. </em>
  1708. </td>
  1709. <td>
  1710. <em>(Optional)</em>
  1711. <p>CreationPolicy defines rules on how to create the resulting Secret
  1712. Defaults to &lsquo;Owner&rsquo;</p>
  1713. </td>
  1714. </tr>
  1715. <tr>
  1716. <td>
  1717. <code>template</code></br>
  1718. <em>
  1719. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">
  1720. ExternalSecretTemplate
  1721. </a>
  1722. </em>
  1723. </td>
  1724. <td>
  1725. <em>(Optional)</em>
  1726. <p>Template defines a blueprint for the created Secret resource.</p>
  1727. </td>
  1728. </tr>
  1729. <tr>
  1730. <td>
  1731. <code>immutable</code></br>
  1732. <em>
  1733. bool
  1734. </em>
  1735. </td>
  1736. <td>
  1737. <em>(Optional)</em>
  1738. <p>Immutable defines if the final secret will be immutable</p>
  1739. </td>
  1740. </tr>
  1741. </tbody>
  1742. </table>
  1743. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate
  1744. </h3>
  1745. <p>
  1746. (<em>Appears on:</em>
  1747. <a href="#external-secrets.io/v1alpha1.ExternalSecretTarget">ExternalSecretTarget</a>)
  1748. </p>
  1749. <p>
  1750. <p>ExternalSecretTemplate defines a blueprint for the created Secret resource.
  1751. 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>
  1752. </p>
  1753. <table>
  1754. <thead>
  1755. <tr>
  1756. <th>Field</th>
  1757. <th>Description</th>
  1758. </tr>
  1759. </thead>
  1760. <tbody>
  1761. <tr>
  1762. <td>
  1763. <code>type</code></br>
  1764. <em>
  1765. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core">
  1766. Kubernetes core/v1.SecretType
  1767. </a>
  1768. </em>
  1769. </td>
  1770. <td>
  1771. <em>(Optional)</em>
  1772. </td>
  1773. </tr>
  1774. <tr>
  1775. <td>
  1776. <code>metadata</code></br>
  1777. <em>
  1778. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">
  1779. ExternalSecretTemplateMetadata
  1780. </a>
  1781. </em>
  1782. </td>
  1783. <td>
  1784. <em>(Optional)</em>
  1785. </td>
  1786. </tr>
  1787. <tr>
  1788. <td>
  1789. <code>data</code></br>
  1790. <em>
  1791. map[string]string
  1792. </em>
  1793. </td>
  1794. <td>
  1795. <em>(Optional)</em>
  1796. </td>
  1797. </tr>
  1798. <tr>
  1799. <td>
  1800. <code>templateFrom</code></br>
  1801. <em>
  1802. <a href="#external-secrets.io/v1alpha1.TemplateFrom">
  1803. []TemplateFrom
  1804. </a>
  1805. </em>
  1806. </td>
  1807. <td>
  1808. <em>(Optional)</em>
  1809. </td>
  1810. </tr>
  1811. </tbody>
  1812. </table>
  1813. <h3 id="external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata">ExternalSecretTemplateMetadata
  1814. </h3>
  1815. <p>
  1816. (<em>Appears on:</em>
  1817. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  1818. </p>
  1819. <p>
  1820. <p>ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.</p>
  1821. </p>
  1822. <table>
  1823. <thead>
  1824. <tr>
  1825. <th>Field</th>
  1826. <th>Description</th>
  1827. </tr>
  1828. </thead>
  1829. <tbody>
  1830. <tr>
  1831. <td>
  1832. <code>annotations</code></br>
  1833. <em>
  1834. map[string]string
  1835. </em>
  1836. </td>
  1837. <td>
  1838. <em>(Optional)</em>
  1839. </td>
  1840. </tr>
  1841. <tr>
  1842. <td>
  1843. <code>labels</code></br>
  1844. <em>
  1845. map[string]string
  1846. </em>
  1847. </td>
  1848. <td>
  1849. <em>(Optional)</em>
  1850. </td>
  1851. </tr>
  1852. </tbody>
  1853. </table>
  1854. <h3 id="external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth
  1855. </h3>
  1856. <p>
  1857. (<em>Appears on:</em>
  1858. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider</a>)
  1859. </p>
  1860. <p>
  1861. </p>
  1862. <table>
  1863. <thead>
  1864. <tr>
  1865. <th>Field</th>
  1866. <th>Description</th>
  1867. </tr>
  1868. </thead>
  1869. <tbody>
  1870. <tr>
  1871. <td>
  1872. <code>secretRef</code></br>
  1873. <em>
  1874. <a href="#external-secrets.io/v1alpha1.GCPSMAuthSecretRef">
  1875. GCPSMAuthSecretRef
  1876. </a>
  1877. </em>
  1878. </td>
  1879. <td>
  1880. </td>
  1881. </tr>
  1882. </tbody>
  1883. </table>
  1884. <h3 id="external-secrets.io/v1alpha1.GCPSMAuthSecretRef">GCPSMAuthSecretRef
  1885. </h3>
  1886. <p>
  1887. (<em>Appears on:</em>
  1888. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">GCPSMAuth</a>)
  1889. </p>
  1890. <p>
  1891. </p>
  1892. <table>
  1893. <thead>
  1894. <tr>
  1895. <th>Field</th>
  1896. <th>Description</th>
  1897. </tr>
  1898. </thead>
  1899. <tbody>
  1900. <tr>
  1901. <td>
  1902. <code>secretAccessKeySecretRef</code></br>
  1903. <em>
  1904. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  1905. </em>
  1906. </td>
  1907. <td>
  1908. <em>(Optional)</em>
  1909. <p>The SecretAccessKey is used for authentication</p>
  1910. </td>
  1911. </tr>
  1912. </tbody>
  1913. </table>
  1914. <h3 id="external-secrets.io/v1alpha1.GCPSMProvider">GCPSMProvider
  1915. </h3>
  1916. <p>
  1917. (<em>Appears on:</em>
  1918. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1919. </p>
  1920. <p>
  1921. <p>GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.</p>
  1922. </p>
  1923. <table>
  1924. <thead>
  1925. <tr>
  1926. <th>Field</th>
  1927. <th>Description</th>
  1928. </tr>
  1929. </thead>
  1930. <tbody>
  1931. <tr>
  1932. <td>
  1933. <code>auth</code></br>
  1934. <em>
  1935. <a href="#external-secrets.io/v1alpha1.GCPSMAuth">
  1936. GCPSMAuth
  1937. </a>
  1938. </em>
  1939. </td>
  1940. <td>
  1941. <em>(Optional)</em>
  1942. <p>Auth defines the information necessary to authenticate against GCP</p>
  1943. </td>
  1944. </tr>
  1945. <tr>
  1946. <td>
  1947. <code>projectID</code></br>
  1948. <em>
  1949. string
  1950. </em>
  1951. </td>
  1952. <td>
  1953. <p>ProjectID project where secret is located</p>
  1954. </td>
  1955. </tr>
  1956. </tbody>
  1957. </table>
  1958. <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore
  1959. </h3>
  1960. <p>
  1961. <p>GenericStore is a common interface for interacting with ClusterSecretStore
  1962. or a namespaced SecretStore.</p>
  1963. </p>
  1964. <h3 id="external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth
  1965. </h3>
  1966. <p>
  1967. (<em>Appears on:</em>
  1968. <a href="#external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider</a>)
  1969. </p>
  1970. <p>
  1971. </p>
  1972. <table>
  1973. <thead>
  1974. <tr>
  1975. <th>Field</th>
  1976. <th>Description</th>
  1977. </tr>
  1978. </thead>
  1979. <tbody>
  1980. <tr>
  1981. <td>
  1982. <code>SecretRef</code></br>
  1983. <em>
  1984. <a href="#external-secrets.io/v1alpha1.GitlabSecretRef">
  1985. GitlabSecretRef
  1986. </a>
  1987. </em>
  1988. </td>
  1989. <td>
  1990. </td>
  1991. </tr>
  1992. </tbody>
  1993. </table>
  1994. <h3 id="external-secrets.io/v1alpha1.GitlabProvider">GitlabProvider
  1995. </h3>
  1996. <p>
  1997. (<em>Appears on:</em>
  1998. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  1999. </p>
  2000. <p>
  2001. <p>Configures a store to sync secrets with a GitLab instance.</p>
  2002. </p>
  2003. <table>
  2004. <thead>
  2005. <tr>
  2006. <th>Field</th>
  2007. <th>Description</th>
  2008. </tr>
  2009. </thead>
  2010. <tbody>
  2011. <tr>
  2012. <td>
  2013. <code>url</code></br>
  2014. <em>
  2015. string
  2016. </em>
  2017. </td>
  2018. <td>
  2019. <p>URL configures the GitLab instance URL. Defaults to <a href="https://gitlab.com/">https://gitlab.com/</a>.</p>
  2020. </td>
  2021. </tr>
  2022. <tr>
  2023. <td>
  2024. <code>auth</code></br>
  2025. <em>
  2026. <a href="#external-secrets.io/v1alpha1.GitlabAuth">
  2027. GitlabAuth
  2028. </a>
  2029. </em>
  2030. </td>
  2031. <td>
  2032. <p>Auth configures how secret-manager authenticates with a GitLab instance.</p>
  2033. </td>
  2034. </tr>
  2035. <tr>
  2036. <td>
  2037. <code>projectID</code></br>
  2038. <em>
  2039. string
  2040. </em>
  2041. </td>
  2042. <td>
  2043. <p>ProjectID specifies a project where secrets are located.</p>
  2044. </td>
  2045. </tr>
  2046. </tbody>
  2047. </table>
  2048. <h3 id="external-secrets.io/v1alpha1.GitlabSecretRef">GitlabSecretRef
  2049. </h3>
  2050. <p>
  2051. (<em>Appears on:</em>
  2052. <a href="#external-secrets.io/v1alpha1.GitlabAuth">GitlabAuth</a>)
  2053. </p>
  2054. <p>
  2055. </p>
  2056. <table>
  2057. <thead>
  2058. <tr>
  2059. <th>Field</th>
  2060. <th>Description</th>
  2061. </tr>
  2062. </thead>
  2063. <tbody>
  2064. <tr>
  2065. <td>
  2066. <code>accessToken</code></br>
  2067. <em>
  2068. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2069. </em>
  2070. </td>
  2071. <td>
  2072. <p>AccessToken is used for authentication.</p>
  2073. </td>
  2074. </tr>
  2075. </tbody>
  2076. </table>
  2077. <h3 id="external-secrets.io/v1alpha1.IBMAuth">IBMAuth
  2078. </h3>
  2079. <p>
  2080. (<em>Appears on:</em>
  2081. <a href="#external-secrets.io/v1alpha1.IBMProvider">IBMProvider</a>)
  2082. </p>
  2083. <p>
  2084. </p>
  2085. <table>
  2086. <thead>
  2087. <tr>
  2088. <th>Field</th>
  2089. <th>Description</th>
  2090. </tr>
  2091. </thead>
  2092. <tbody>
  2093. <tr>
  2094. <td>
  2095. <code>secretRef</code></br>
  2096. <em>
  2097. <a href="#external-secrets.io/v1alpha1.IBMAuthSecretRef">
  2098. IBMAuthSecretRef
  2099. </a>
  2100. </em>
  2101. </td>
  2102. <td>
  2103. </td>
  2104. </tr>
  2105. </tbody>
  2106. </table>
  2107. <h3 id="external-secrets.io/v1alpha1.IBMAuthSecretRef">IBMAuthSecretRef
  2108. </h3>
  2109. <p>
  2110. (<em>Appears on:</em>
  2111. <a href="#external-secrets.io/v1alpha1.IBMAuth">IBMAuth</a>)
  2112. </p>
  2113. <p>
  2114. </p>
  2115. <table>
  2116. <thead>
  2117. <tr>
  2118. <th>Field</th>
  2119. <th>Description</th>
  2120. </tr>
  2121. </thead>
  2122. <tbody>
  2123. <tr>
  2124. <td>
  2125. <code>secretApiKeySecretRef</code></br>
  2126. <em>
  2127. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2128. </em>
  2129. </td>
  2130. <td>
  2131. <em>(Optional)</em>
  2132. <p>The SecretAccessKey is used for authentication</p>
  2133. </td>
  2134. </tr>
  2135. </tbody>
  2136. </table>
  2137. <h3 id="external-secrets.io/v1alpha1.IBMProvider">IBMProvider
  2138. </h3>
  2139. <p>
  2140. (<em>Appears on:</em>
  2141. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2142. </p>
  2143. <p>
  2144. <p>Configures an store to sync secrets using a IBM Cloud Secrets Manager
  2145. backend.</p>
  2146. </p>
  2147. <table>
  2148. <thead>
  2149. <tr>
  2150. <th>Field</th>
  2151. <th>Description</th>
  2152. </tr>
  2153. </thead>
  2154. <tbody>
  2155. <tr>
  2156. <td>
  2157. <code>auth</code></br>
  2158. <em>
  2159. <a href="#external-secrets.io/v1alpha1.IBMAuth">
  2160. IBMAuth
  2161. </a>
  2162. </em>
  2163. </td>
  2164. <td>
  2165. <p>Auth configures how secret-manager authenticates with the IBM secrets manager.</p>
  2166. </td>
  2167. </tr>
  2168. <tr>
  2169. <td>
  2170. <code>serviceUrl</code></br>
  2171. <em>
  2172. string
  2173. </em>
  2174. </td>
  2175. <td>
  2176. <p>ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance</p>
  2177. </td>
  2178. </tr>
  2179. </tbody>
  2180. </table>
  2181. <h3 id="external-secrets.io/v1alpha1.OracleAuth">OracleAuth
  2182. </h3>
  2183. <p>
  2184. (<em>Appears on:</em>
  2185. <a href="#external-secrets.io/v1alpha1.OracleProvider">OracleProvider</a>)
  2186. </p>
  2187. <p>
  2188. </p>
  2189. <table>
  2190. <thead>
  2191. <tr>
  2192. <th>Field</th>
  2193. <th>Description</th>
  2194. </tr>
  2195. </thead>
  2196. <tbody>
  2197. <tr>
  2198. <td>
  2199. <code>secretRef</code></br>
  2200. <em>
  2201. <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
  2202. OracleSecretRef
  2203. </a>
  2204. </em>
  2205. </td>
  2206. <td>
  2207. <p>SecretRef to pass through sensitive information.</p>
  2208. </td>
  2209. </tr>
  2210. </tbody>
  2211. </table>
  2212. <h3 id="external-secrets.io/v1alpha1.OracleProvider">OracleProvider
  2213. </h3>
  2214. <p>
  2215. (<em>Appears on:</em>
  2216. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  2217. </p>
  2218. <p>
  2219. <p>Configures an store to sync secrets using a Oracle Vault
  2220. backend.</p>
  2221. </p>
  2222. <table>
  2223. <thead>
  2224. <tr>
  2225. <th>Field</th>
  2226. <th>Description</th>
  2227. </tr>
  2228. </thead>
  2229. <tbody>
  2230. <tr>
  2231. <td>
  2232. <code>auth</code></br>
  2233. <em>
  2234. <a href="#external-secrets.io/v1alpha1.OracleAuth">
  2235. OracleAuth
  2236. </a>
  2237. </em>
  2238. </td>
  2239. <td>
  2240. <p>Auth configures how secret-manager authenticates with the Oracle Vault.</p>
  2241. </td>
  2242. </tr>
  2243. <tr>
  2244. <td>
  2245. <code>user</code></br>
  2246. <em>
  2247. string
  2248. </em>
  2249. </td>
  2250. <td>
  2251. <p>User is an access OCID specific to the account.</p>
  2252. </td>
  2253. </tr>
  2254. <tr>
  2255. <td>
  2256. <code>tenancy</code></br>
  2257. <em>
  2258. string
  2259. </em>
  2260. </td>
  2261. <td>
  2262. <p>projectID is an access token specific to the secret.</p>
  2263. </td>
  2264. </tr>
  2265. <tr>
  2266. <td>
  2267. <code>region</code></br>
  2268. <em>
  2269. string
  2270. </em>
  2271. </td>
  2272. <td>
  2273. <p>projectID is an access token specific to the secret.</p>
  2274. </td>
  2275. </tr>
  2276. </tbody>
  2277. </table>
  2278. <h3 id="external-secrets.io/v1alpha1.OracleSecretRef">OracleSecretRef
  2279. </h3>
  2280. <p>
  2281. (<em>Appears on:</em>
  2282. <a href="#external-secrets.io/v1alpha1.OracleAuth">OracleAuth</a>)
  2283. </p>
  2284. <p>
  2285. </p>
  2286. <table>
  2287. <thead>
  2288. <tr>
  2289. <th>Field</th>
  2290. <th>Description</th>
  2291. </tr>
  2292. </thead>
  2293. <tbody>
  2294. <tr>
  2295. <td>
  2296. <code>privatekey</code></br>
  2297. <em>
  2298. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2299. </em>
  2300. </td>
  2301. <td>
  2302. <p>The Access Token is used for authentication</p>
  2303. </td>
  2304. </tr>
  2305. <tr>
  2306. <td>
  2307. <code>fingerprint</code></br>
  2308. <em>
  2309. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2310. </em>
  2311. </td>
  2312. <td>
  2313. <p>projectID is an access token specific to the secret.</p>
  2314. </td>
  2315. </tr>
  2316. </tbody>
  2317. </table>
  2318. <h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
  2319. </h3>
  2320. <p>
  2321. <p>SecretStore represents a secure external location for storing secrets, which can be referenced as part of <code>storeRef</code> fields.</p>
  2322. </p>
  2323. <table>
  2324. <thead>
  2325. <tr>
  2326. <th>Field</th>
  2327. <th>Description</th>
  2328. </tr>
  2329. </thead>
  2330. <tbody>
  2331. <tr>
  2332. <td>
  2333. <code>metadata</code></br>
  2334. <em>
  2335. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
  2336. Kubernetes meta/v1.ObjectMeta
  2337. </a>
  2338. </em>
  2339. </td>
  2340. <td>
  2341. Refer to the Kubernetes API documentation for the fields of the
  2342. <code>metadata</code> field.
  2343. </td>
  2344. </tr>
  2345. <tr>
  2346. <td>
  2347. <code>spec</code></br>
  2348. <em>
  2349. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">
  2350. SecretStoreSpec
  2351. </a>
  2352. </em>
  2353. </td>
  2354. <td>
  2355. <br/>
  2356. <br/>
  2357. <table>
  2358. <tr>
  2359. <td>
  2360. <code>controller</code></br>
  2361. <em>
  2362. string
  2363. </em>
  2364. </td>
  2365. <td>
  2366. <em>(Optional)</em>
  2367. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2368. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2369. </td>
  2370. </tr>
  2371. <tr>
  2372. <td>
  2373. <code>provider</code></br>
  2374. <em>
  2375. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2376. SecretStoreProvider
  2377. </a>
  2378. </em>
  2379. </td>
  2380. <td>
  2381. <p>Used to configure the provider. Only one provider may be set</p>
  2382. </td>
  2383. </tr>
  2384. </table>
  2385. </td>
  2386. </tr>
  2387. <tr>
  2388. <td>
  2389. <code>status</code></br>
  2390. <em>
  2391. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">
  2392. SecretStoreStatus
  2393. </a>
  2394. </em>
  2395. </td>
  2396. <td>
  2397. </td>
  2398. </tr>
  2399. </tbody>
  2400. </table>
  2401. <h3 id="external-secrets.io/v1alpha1.SecretStoreConditionType">SecretStoreConditionType
  2402. (<code>string</code> alias)</p></h3>
  2403. <p>
  2404. (<em>Appears on:</em>
  2405. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition</a>)
  2406. </p>
  2407. <p>
  2408. </p>
  2409. <table>
  2410. <thead>
  2411. <tr>
  2412. <th>Value</th>
  2413. <th>Description</th>
  2414. </tr>
  2415. </thead>
  2416. <tbody><tr><td><p>&#34;Ready&#34;</p></td>
  2417. <td></td>
  2418. </tr></tbody>
  2419. </table>
  2420. <h3 id="external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider
  2421. </h3>
  2422. <p>
  2423. (<em>Appears on:</em>
  2424. <a href="#external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec</a>)
  2425. </p>
  2426. <p>
  2427. <p>SecretStoreProvider contains the provider-specific configration.</p>
  2428. </p>
  2429. <table>
  2430. <thead>
  2431. <tr>
  2432. <th>Field</th>
  2433. <th>Description</th>
  2434. </tr>
  2435. </thead>
  2436. <tbody>
  2437. <tr>
  2438. <td>
  2439. <code>aws</code></br>
  2440. <em>
  2441. <a href="#external-secrets.io/v1alpha1.AWSProvider">
  2442. AWSProvider
  2443. </a>
  2444. </em>
  2445. </td>
  2446. <td>
  2447. <em>(Optional)</em>
  2448. <p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
  2449. </td>
  2450. </tr>
  2451. <tr>
  2452. <td>
  2453. <code>azurekv</code></br>
  2454. <em>
  2455. <a href="#external-secrets.io/v1alpha1.AzureKVProvider">
  2456. AzureKVProvider
  2457. </a>
  2458. </em>
  2459. </td>
  2460. <td>
  2461. <em>(Optional)</em>
  2462. <p>AzureKV configures this store to sync secrets using Azure Key Vault provider</p>
  2463. </td>
  2464. </tr>
  2465. <tr>
  2466. <td>
  2467. <code>akeyless</code></br>
  2468. <em>
  2469. <a href="#external-secrets.io/v1alpha1.AkeylessProvider">
  2470. AkeylessProvider
  2471. </a>
  2472. </em>
  2473. </td>
  2474. <td>
  2475. <em>(Optional)</em>
  2476. <p>Akeyless configures this store to sync secrets using Akeyless Vault provider</p>
  2477. </td>
  2478. </tr>
  2479. <tr>
  2480. <td>
  2481. <code>vault</code></br>
  2482. <em>
  2483. <a href="#external-secrets.io/v1alpha1.VaultProvider">
  2484. VaultProvider
  2485. </a>
  2486. </em>
  2487. </td>
  2488. <td>
  2489. <em>(Optional)</em>
  2490. <p>Vault configures this store to sync secrets using Hashi provider</p>
  2491. </td>
  2492. </tr>
  2493. <tr>
  2494. <td>
  2495. <code>gcpsm</code></br>
  2496. <em>
  2497. <a href="#external-secrets.io/v1alpha1.GCPSMProvider">
  2498. GCPSMProvider
  2499. </a>
  2500. </em>
  2501. </td>
  2502. <td>
  2503. <em>(Optional)</em>
  2504. <p>GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider</p>
  2505. </td>
  2506. </tr>
  2507. <tr>
  2508. <td>
  2509. <code>oracle</code></br>
  2510. <em>
  2511. <a href="#external-secrets.io/v1alpha1.OracleProvider">
  2512. OracleProvider
  2513. </a>
  2514. </em>
  2515. </td>
  2516. <td>
  2517. <em>(Optional)</em>
  2518. <p>Oracle configures this store to sync secrets using Oracle Vault provider</p>
  2519. </td>
  2520. </tr>
  2521. <tr>
  2522. <td>
  2523. <code>ibm</code></br>
  2524. <em>
  2525. <a href="#external-secrets.io/v1alpha1.IBMProvider">
  2526. IBMProvider
  2527. </a>
  2528. </em>
  2529. </td>
  2530. <td>
  2531. <em>(Optional)</em>
  2532. <p>IBM configures this store to sync secrets using IBM Cloud provider</p>
  2533. </td>
  2534. </tr>
  2535. <tr>
  2536. <td>
  2537. <code>yandexlockbox</code></br>
  2538. <em>
  2539. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">
  2540. YandexLockboxProvider
  2541. </a>
  2542. </em>
  2543. </td>
  2544. <td>
  2545. <em>(Optional)</em>
  2546. <p>YandexLockbox configures this store to sync secrets using Yandex Lockbox provider</p>
  2547. </td>
  2548. </tr>
  2549. <tr>
  2550. <td>
  2551. <code>gitlab</code></br>
  2552. <em>
  2553. <a href="#external-secrets.io/v1alpha1.GitlabProvider">
  2554. GitlabProvider
  2555. </a>
  2556. </em>
  2557. </td>
  2558. <td>
  2559. <em>(Optional)</em>
  2560. <p>GItlab configures this store to sync secrets using Gitlab Variables provider</p>
  2561. </td>
  2562. </tr>
  2563. <tr>
  2564. <td>
  2565. <code>alibaba</code></br>
  2566. <em>
  2567. <a href="#external-secrets.io/v1alpha1.AlibabaProvider">
  2568. AlibabaProvider
  2569. </a>
  2570. </em>
  2571. </td>
  2572. <td>
  2573. <em>(Optional)</em>
  2574. <p>Alibaba configures this store to sync secrets using Alibaba Cloud provider</p>
  2575. </td>
  2576. </tr>
  2577. </tbody>
  2578. </table>
  2579. <h3 id="external-secrets.io/v1alpha1.SecretStoreRef">SecretStoreRef
  2580. </h3>
  2581. <p>
  2582. (<em>Appears on:</em>
  2583. <a href="#external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec</a>)
  2584. </p>
  2585. <p>
  2586. <p>SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.</p>
  2587. </p>
  2588. <table>
  2589. <thead>
  2590. <tr>
  2591. <th>Field</th>
  2592. <th>Description</th>
  2593. </tr>
  2594. </thead>
  2595. <tbody>
  2596. <tr>
  2597. <td>
  2598. <code>name</code></br>
  2599. <em>
  2600. string
  2601. </em>
  2602. </td>
  2603. <td>
  2604. <p>Name of the SecretStore resource</p>
  2605. </td>
  2606. </tr>
  2607. <tr>
  2608. <td>
  2609. <code>kind</code></br>
  2610. <em>
  2611. string
  2612. </em>
  2613. </td>
  2614. <td>
  2615. <em>(Optional)</em>
  2616. <p>Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
  2617. Defaults to <code>SecretStore</code></p>
  2618. </td>
  2619. </tr>
  2620. </tbody>
  2621. </table>
  2622. <h3 id="external-secrets.io/v1alpha1.SecretStoreSpec">SecretStoreSpec
  2623. </h3>
  2624. <p>
  2625. (<em>Appears on:</em>
  2626. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2627. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2628. </p>
  2629. <p>
  2630. <p>SecretStoreSpec defines the desired state of SecretStore.</p>
  2631. </p>
  2632. <table>
  2633. <thead>
  2634. <tr>
  2635. <th>Field</th>
  2636. <th>Description</th>
  2637. </tr>
  2638. </thead>
  2639. <tbody>
  2640. <tr>
  2641. <td>
  2642. <code>controller</code></br>
  2643. <em>
  2644. string
  2645. </em>
  2646. </td>
  2647. <td>
  2648. <em>(Optional)</em>
  2649. <p>Used to select the correct KES controller (think: ingress.ingressClassName)
  2650. The KES controller is instantiated with a specific controller name and filters ES based on this property</p>
  2651. </td>
  2652. </tr>
  2653. <tr>
  2654. <td>
  2655. <code>provider</code></br>
  2656. <em>
  2657. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">
  2658. SecretStoreProvider
  2659. </a>
  2660. </em>
  2661. </td>
  2662. <td>
  2663. <p>Used to configure the provider. Only one provider may be set</p>
  2664. </td>
  2665. </tr>
  2666. </tbody>
  2667. </table>
  2668. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus
  2669. </h3>
  2670. <p>
  2671. (<em>Appears on:</em>
  2672. <a href="#external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore</a>,
  2673. <a href="#external-secrets.io/v1alpha1.SecretStore">SecretStore</a>)
  2674. </p>
  2675. <p>
  2676. <p>SecretStoreStatus defines the observed state of the SecretStore.</p>
  2677. </p>
  2678. <table>
  2679. <thead>
  2680. <tr>
  2681. <th>Field</th>
  2682. <th>Description</th>
  2683. </tr>
  2684. </thead>
  2685. <tbody>
  2686. <tr>
  2687. <td>
  2688. <code>conditions</code></br>
  2689. <em>
  2690. <a href="#external-secrets.io/v1alpha1.SecretStoreStatusCondition">
  2691. []SecretStoreStatusCondition
  2692. </a>
  2693. </em>
  2694. </td>
  2695. <td>
  2696. <em>(Optional)</em>
  2697. </td>
  2698. </tr>
  2699. </tbody>
  2700. </table>
  2701. <h3 id="external-secrets.io/v1alpha1.SecretStoreStatusCondition">SecretStoreStatusCondition
  2702. </h3>
  2703. <p>
  2704. (<em>Appears on:</em>
  2705. <a href="#external-secrets.io/v1alpha1.SecretStoreStatus">SecretStoreStatus</a>)
  2706. </p>
  2707. <p>
  2708. </p>
  2709. <table>
  2710. <thead>
  2711. <tr>
  2712. <th>Field</th>
  2713. <th>Description</th>
  2714. </tr>
  2715. </thead>
  2716. <tbody>
  2717. <tr>
  2718. <td>
  2719. <code>type</code></br>
  2720. <em>
  2721. <a href="#external-secrets.io/v1alpha1.SecretStoreConditionType">
  2722. SecretStoreConditionType
  2723. </a>
  2724. </em>
  2725. </td>
  2726. <td>
  2727. </td>
  2728. </tr>
  2729. <tr>
  2730. <td>
  2731. <code>status</code></br>
  2732. <em>
  2733. <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
  2734. Kubernetes core/v1.ConditionStatus
  2735. </a>
  2736. </em>
  2737. </td>
  2738. <td>
  2739. </td>
  2740. </tr>
  2741. <tr>
  2742. <td>
  2743. <code>reason</code></br>
  2744. <em>
  2745. string
  2746. </em>
  2747. </td>
  2748. <td>
  2749. <em>(Optional)</em>
  2750. </td>
  2751. </tr>
  2752. <tr>
  2753. <td>
  2754. <code>message</code></br>
  2755. <em>
  2756. string
  2757. </em>
  2758. </td>
  2759. <td>
  2760. <em>(Optional)</em>
  2761. </td>
  2762. </tr>
  2763. <tr>
  2764. <td>
  2765. <code>lastTransitionTime</code></br>
  2766. <em>
  2767. <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time">
  2768. Kubernetes meta/v1.Time
  2769. </a>
  2770. </em>
  2771. </td>
  2772. <td>
  2773. <em>(Optional)</em>
  2774. </td>
  2775. </tr>
  2776. </tbody>
  2777. </table>
  2778. <h3 id="external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom
  2779. </h3>
  2780. <p>
  2781. (<em>Appears on:</em>
  2782. <a href="#external-secrets.io/v1alpha1.ExternalSecretTemplate">ExternalSecretTemplate</a>)
  2783. </p>
  2784. <p>
  2785. </p>
  2786. <table>
  2787. <thead>
  2788. <tr>
  2789. <th>Field</th>
  2790. <th>Description</th>
  2791. </tr>
  2792. </thead>
  2793. <tbody>
  2794. <tr>
  2795. <td>
  2796. <code>configMap</code></br>
  2797. <em>
  2798. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2799. TemplateRef
  2800. </a>
  2801. </em>
  2802. </td>
  2803. <td>
  2804. </td>
  2805. </tr>
  2806. <tr>
  2807. <td>
  2808. <code>secret</code></br>
  2809. <em>
  2810. <a href="#external-secrets.io/v1alpha1.TemplateRef">
  2811. TemplateRef
  2812. </a>
  2813. </em>
  2814. </td>
  2815. <td>
  2816. </td>
  2817. </tr>
  2818. </tbody>
  2819. </table>
  2820. <h3 id="external-secrets.io/v1alpha1.TemplateRef">TemplateRef
  2821. </h3>
  2822. <p>
  2823. (<em>Appears on:</em>
  2824. <a href="#external-secrets.io/v1alpha1.TemplateFrom">TemplateFrom</a>)
  2825. </p>
  2826. <p>
  2827. </p>
  2828. <table>
  2829. <thead>
  2830. <tr>
  2831. <th>Field</th>
  2832. <th>Description</th>
  2833. </tr>
  2834. </thead>
  2835. <tbody>
  2836. <tr>
  2837. <td>
  2838. <code>name</code></br>
  2839. <em>
  2840. string
  2841. </em>
  2842. </td>
  2843. <td>
  2844. </td>
  2845. </tr>
  2846. <tr>
  2847. <td>
  2848. <code>items</code></br>
  2849. <em>
  2850. <a href="#external-secrets.io/v1alpha1.TemplateRefItem">
  2851. []TemplateRefItem
  2852. </a>
  2853. </em>
  2854. </td>
  2855. <td>
  2856. </td>
  2857. </tr>
  2858. </tbody>
  2859. </table>
  2860. <h3 id="external-secrets.io/v1alpha1.TemplateRefItem">TemplateRefItem
  2861. </h3>
  2862. <p>
  2863. (<em>Appears on:</em>
  2864. <a href="#external-secrets.io/v1alpha1.TemplateRef">TemplateRef</a>)
  2865. </p>
  2866. <p>
  2867. </p>
  2868. <table>
  2869. <thead>
  2870. <tr>
  2871. <th>Field</th>
  2872. <th>Description</th>
  2873. </tr>
  2874. </thead>
  2875. <tbody>
  2876. <tr>
  2877. <td>
  2878. <code>key</code></br>
  2879. <em>
  2880. string
  2881. </em>
  2882. </td>
  2883. <td>
  2884. </td>
  2885. </tr>
  2886. </tbody>
  2887. </table>
  2888. <h3 id="external-secrets.io/v1alpha1.VaultAppRole">VaultAppRole
  2889. </h3>
  2890. <p>
  2891. (<em>Appears on:</em>
  2892. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  2893. </p>
  2894. <p>
  2895. <p>VaultAppRole authenticates with Vault using the App Role auth mechanism,
  2896. with the role and secret stored in a Kubernetes Secret resource.</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>path</code></br>
  2909. <em>
  2910. string
  2911. </em>
  2912. </td>
  2913. <td>
  2914. <p>Path where the App Role authentication backend is mounted
  2915. in Vault, e.g: &ldquo;approle&rdquo;</p>
  2916. </td>
  2917. </tr>
  2918. <tr>
  2919. <td>
  2920. <code>roleId</code></br>
  2921. <em>
  2922. string
  2923. </em>
  2924. </td>
  2925. <td>
  2926. <p>RoleID configured in the App Role authentication backend when setting
  2927. up the authentication backend in Vault.</p>
  2928. </td>
  2929. </tr>
  2930. <tr>
  2931. <td>
  2932. <code>secretRef</code></br>
  2933. <em>
  2934. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2935. </em>
  2936. </td>
  2937. <td>
  2938. <p>Reference to a key in a Secret that contains the App Role secret used
  2939. to authenticate with Vault.
  2940. The <code>key</code> field must be specified and denotes which entry within the Secret
  2941. resource is used as the app role secret.</p>
  2942. </td>
  2943. </tr>
  2944. </tbody>
  2945. </table>
  2946. <h3 id="external-secrets.io/v1alpha1.VaultAuth">VaultAuth
  2947. </h3>
  2948. <p>
  2949. (<em>Appears on:</em>
  2950. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  2951. </p>
  2952. <p>
  2953. <p>VaultAuth is the configuration used to authenticate with a Vault server.
  2954. Only one of <code>tokenSecretRef</code>, <code>appRole</code>, <code>kubernetes</code>, <code>ldap</code>, <code>jwt</code> or <code>cert</code>
  2955. can be specified.</p>
  2956. </p>
  2957. <table>
  2958. <thead>
  2959. <tr>
  2960. <th>Field</th>
  2961. <th>Description</th>
  2962. </tr>
  2963. </thead>
  2964. <tbody>
  2965. <tr>
  2966. <td>
  2967. <code>tokenSecretRef</code></br>
  2968. <em>
  2969. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  2970. </em>
  2971. </td>
  2972. <td>
  2973. <em>(Optional)</em>
  2974. <p>TokenSecretRef authenticates with Vault by presenting a token.</p>
  2975. </td>
  2976. </tr>
  2977. <tr>
  2978. <td>
  2979. <code>appRole</code></br>
  2980. <em>
  2981. <a href="#external-secrets.io/v1alpha1.VaultAppRole">
  2982. VaultAppRole
  2983. </a>
  2984. </em>
  2985. </td>
  2986. <td>
  2987. <em>(Optional)</em>
  2988. <p>AppRole authenticates with Vault using the App Role auth mechanism,
  2989. with the role and secret stored in a Kubernetes Secret resource.</p>
  2990. </td>
  2991. </tr>
  2992. <tr>
  2993. <td>
  2994. <code>kubernetes</code></br>
  2995. <em>
  2996. <a href="#external-secrets.io/v1alpha1.VaultKubernetesAuth">
  2997. VaultKubernetesAuth
  2998. </a>
  2999. </em>
  3000. </td>
  3001. <td>
  3002. <em>(Optional)</em>
  3003. <p>Kubernetes authenticates with Vault by passing the ServiceAccount
  3004. token stored in the named Secret resource to the Vault server.</p>
  3005. </td>
  3006. </tr>
  3007. <tr>
  3008. <td>
  3009. <code>ldap</code></br>
  3010. <em>
  3011. <a href="#external-secrets.io/v1alpha1.VaultLdapAuth">
  3012. VaultLdapAuth
  3013. </a>
  3014. </em>
  3015. </td>
  3016. <td>
  3017. <em>(Optional)</em>
  3018. <p>Ldap authenticates with Vault by passing username/password pair using
  3019. the LDAP authentication method</p>
  3020. </td>
  3021. </tr>
  3022. <tr>
  3023. <td>
  3024. <code>jwt</code></br>
  3025. <em>
  3026. <a href="#external-secrets.io/v1alpha1.VaultJwtAuth">
  3027. VaultJwtAuth
  3028. </a>
  3029. </em>
  3030. </td>
  3031. <td>
  3032. <em>(Optional)</em>
  3033. <p>Jwt authenticates with Vault by passing role and JWT token using the
  3034. JWT/OIDC authentication method</p>
  3035. </td>
  3036. </tr>
  3037. <tr>
  3038. <td>
  3039. <code>cert</code></br>
  3040. <em>
  3041. <a href="#external-secrets.io/v1alpha1.VaultCertAuth">
  3042. VaultCertAuth
  3043. </a>
  3044. </em>
  3045. </td>
  3046. <td>
  3047. <em>(Optional)</em>
  3048. <p>Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  3049. Cert authentication method</p>
  3050. </td>
  3051. </tr>
  3052. </tbody>
  3053. </table>
  3054. <h3 id="external-secrets.io/v1alpha1.VaultCertAuth">VaultCertAuth
  3055. </h3>
  3056. <p>
  3057. (<em>Appears on:</em>
  3058. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3059. </p>
  3060. <p>
  3061. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3062. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3063. </p>
  3064. <table>
  3065. <thead>
  3066. <tr>
  3067. <th>Field</th>
  3068. <th>Description</th>
  3069. </tr>
  3070. </thead>
  3071. <tbody>
  3072. <tr>
  3073. <td>
  3074. <code>clientCert</code></br>
  3075. <em>
  3076. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3077. </em>
  3078. </td>
  3079. <td>
  3080. <em>(Optional)</em>
  3081. <p>ClientCert is a certificate to authenticate using the Cert Vault
  3082. authentication method</p>
  3083. </td>
  3084. </tr>
  3085. <tr>
  3086. <td>
  3087. <code>secretRef</code></br>
  3088. <em>
  3089. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3090. </em>
  3091. </td>
  3092. <td>
  3093. <p>SecretRef to a key in a Secret resource containing client private key to
  3094. authenticate with Vault using the Cert authentication method</p>
  3095. </td>
  3096. </tr>
  3097. </tbody>
  3098. </table>
  3099. <h3 id="external-secrets.io/v1alpha1.VaultJwtAuth">VaultJwtAuth
  3100. </h3>
  3101. <p>
  3102. (<em>Appears on:</em>
  3103. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3104. </p>
  3105. <p>
  3106. <p>VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
  3107. method, with the role name and token stored in a Kubernetes Secret resource.</p>
  3108. </p>
  3109. <table>
  3110. <thead>
  3111. <tr>
  3112. <th>Field</th>
  3113. <th>Description</th>
  3114. </tr>
  3115. </thead>
  3116. <tbody>
  3117. <tr>
  3118. <td>
  3119. <code>role</code></br>
  3120. <em>
  3121. string
  3122. </em>
  3123. </td>
  3124. <td>
  3125. <em>(Optional)</em>
  3126. <p>Role is a JWT role to authenticate using the JWT/OIDC Vault
  3127. authentication method</p>
  3128. </td>
  3129. </tr>
  3130. <tr>
  3131. <td>
  3132. <code>secretRef</code></br>
  3133. <em>
  3134. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3135. </em>
  3136. </td>
  3137. <td>
  3138. <p>SecretRef to a key in a Secret resource containing JWT token to
  3139. authenticate with Vault using the JWT/OIDC authentication method</p>
  3140. </td>
  3141. </tr>
  3142. </tbody>
  3143. </table>
  3144. <h3 id="external-secrets.io/v1alpha1.VaultKVStoreVersion">VaultKVStoreVersion
  3145. (<code>string</code> alias)</p></h3>
  3146. <p>
  3147. (<em>Appears on:</em>
  3148. <a href="#external-secrets.io/v1alpha1.VaultProvider">VaultProvider</a>)
  3149. </p>
  3150. <p>
  3151. </p>
  3152. <table>
  3153. <thead>
  3154. <tr>
  3155. <th>Value</th>
  3156. <th>Description</th>
  3157. </tr>
  3158. </thead>
  3159. <tbody><tr><td><p>&#34;v1&#34;</p></td>
  3160. <td></td>
  3161. </tr><tr><td><p>&#34;v2&#34;</p></td>
  3162. <td></td>
  3163. </tr></tbody>
  3164. </table>
  3165. <h3 id="external-secrets.io/v1alpha1.VaultKubernetesAuth">VaultKubernetesAuth
  3166. </h3>
  3167. <p>
  3168. (<em>Appears on:</em>
  3169. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3170. </p>
  3171. <p>
  3172. <p>Authenticate against Vault using a Kubernetes ServiceAccount token stored in
  3173. a Secret.</p>
  3174. </p>
  3175. <table>
  3176. <thead>
  3177. <tr>
  3178. <th>Field</th>
  3179. <th>Description</th>
  3180. </tr>
  3181. </thead>
  3182. <tbody>
  3183. <tr>
  3184. <td>
  3185. <code>mountPath</code></br>
  3186. <em>
  3187. string
  3188. </em>
  3189. </td>
  3190. <td>
  3191. <p>Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  3192. &ldquo;kubernetes&rdquo;</p>
  3193. </td>
  3194. </tr>
  3195. <tr>
  3196. <td>
  3197. <code>serviceAccountRef</code></br>
  3198. <em>
  3199. github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
  3200. </em>
  3201. </td>
  3202. <td>
  3203. <em>(Optional)</em>
  3204. <p>Optional service account field containing the name of a kubernetes ServiceAccount.
  3205. If the service account is specified, the service account secret token JWT will be used
  3206. for authenticating with Vault. If the service account selector is not supplied,
  3207. the secretRef will be used instead.</p>
  3208. </td>
  3209. </tr>
  3210. <tr>
  3211. <td>
  3212. <code>secretRef</code></br>
  3213. <em>
  3214. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3215. </em>
  3216. </td>
  3217. <td>
  3218. <em>(Optional)</em>
  3219. <p>Optional secret field containing a Kubernetes ServiceAccount JWT used
  3220. for authenticating with Vault. If a name is specified without a key,
  3221. <code>token</code> is the default. If one is not specified, the one bound to
  3222. the controller will be used.</p>
  3223. </td>
  3224. </tr>
  3225. <tr>
  3226. <td>
  3227. <code>role</code></br>
  3228. <em>
  3229. string
  3230. </em>
  3231. </td>
  3232. <td>
  3233. <p>A required field containing the Vault Role to assume. A Role binds a
  3234. Kubernetes ServiceAccount with a set of Vault policies.</p>
  3235. </td>
  3236. </tr>
  3237. </tbody>
  3238. </table>
  3239. <h3 id="external-secrets.io/v1alpha1.VaultLdapAuth">VaultLdapAuth
  3240. </h3>
  3241. <p>
  3242. (<em>Appears on:</em>
  3243. <a href="#external-secrets.io/v1alpha1.VaultAuth">VaultAuth</a>)
  3244. </p>
  3245. <p>
  3246. <p>VaultLdapAuth authenticates with Vault using the LDAP authentication method,
  3247. with the username and password stored in a Kubernetes Secret resource.</p>
  3248. </p>
  3249. <table>
  3250. <thead>
  3251. <tr>
  3252. <th>Field</th>
  3253. <th>Description</th>
  3254. </tr>
  3255. </thead>
  3256. <tbody>
  3257. <tr>
  3258. <td>
  3259. <code>username</code></br>
  3260. <em>
  3261. string
  3262. </em>
  3263. </td>
  3264. <td>
  3265. <p>Username is a LDAP user name used to authenticate using the LDAP Vault
  3266. authentication method</p>
  3267. </td>
  3268. </tr>
  3269. <tr>
  3270. <td>
  3271. <code>secretRef</code></br>
  3272. <em>
  3273. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3274. </em>
  3275. </td>
  3276. <td>
  3277. <p>SecretRef to a key in a Secret resource containing password for the LDAP
  3278. user used to authenticate with Vault using the LDAP authentication
  3279. method</p>
  3280. </td>
  3281. </tr>
  3282. </tbody>
  3283. </table>
  3284. <h3 id="external-secrets.io/v1alpha1.VaultProvider">VaultProvider
  3285. </h3>
  3286. <p>
  3287. (<em>Appears on:</em>
  3288. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3289. </p>
  3290. <p>
  3291. <p>Configures an store to sync secrets using a HashiCorp Vault
  3292. KV backend.</p>
  3293. </p>
  3294. <table>
  3295. <thead>
  3296. <tr>
  3297. <th>Field</th>
  3298. <th>Description</th>
  3299. </tr>
  3300. </thead>
  3301. <tbody>
  3302. <tr>
  3303. <td>
  3304. <code>auth</code></br>
  3305. <em>
  3306. <a href="#external-secrets.io/v1alpha1.VaultAuth">
  3307. VaultAuth
  3308. </a>
  3309. </em>
  3310. </td>
  3311. <td>
  3312. <p>Auth configures how secret-manager authenticates with the Vault server.</p>
  3313. </td>
  3314. </tr>
  3315. <tr>
  3316. <td>
  3317. <code>server</code></br>
  3318. <em>
  3319. string
  3320. </em>
  3321. </td>
  3322. <td>
  3323. <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>
  3324. </td>
  3325. </tr>
  3326. <tr>
  3327. <td>
  3328. <code>path</code></br>
  3329. <em>
  3330. string
  3331. </em>
  3332. </td>
  3333. <td>
  3334. <p>Path is the mount path of the Vault KV backend endpoint, e.g:
  3335. &ldquo;secret&rdquo;. The v2 KV secret engine version specific &ldquo;/data&rdquo; path suffix
  3336. for fetching secrets from Vault is optional and will be appended
  3337. if not present in specified path.</p>
  3338. </td>
  3339. </tr>
  3340. <tr>
  3341. <td>
  3342. <code>version</code></br>
  3343. <em>
  3344. <a href="#external-secrets.io/v1alpha1.VaultKVStoreVersion">
  3345. VaultKVStoreVersion
  3346. </a>
  3347. </em>
  3348. </td>
  3349. <td>
  3350. <p>Version is the Vault KV secret engine version. This can be either &ldquo;v1&rdquo; or
  3351. &ldquo;v2&rdquo;. Version defaults to &ldquo;v2&rdquo;.</p>
  3352. </td>
  3353. </tr>
  3354. <tr>
  3355. <td>
  3356. <code>namespace</code></br>
  3357. <em>
  3358. string
  3359. </em>
  3360. </td>
  3361. <td>
  3362. <em>(Optional)</em>
  3363. <p>Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  3364. Vault environments to support Secure Multi-tenancy. e.g: &ldquo;ns1&rdquo;.
  3365. 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>
  3366. </td>
  3367. </tr>
  3368. <tr>
  3369. <td>
  3370. <code>caBundle</code></br>
  3371. <em>
  3372. []byte
  3373. </em>
  3374. </td>
  3375. <td>
  3376. <em>(Optional)</em>
  3377. <p>PEM encoded CA bundle used to validate Vault server certificate. Only used
  3378. if the Server URL is using HTTPS protocol. This parameter is ignored for
  3379. plain HTTP protocol connection. If not set the system root certificates
  3380. are used to validate the TLS connection.</p>
  3381. </td>
  3382. </tr>
  3383. <tr>
  3384. <td>
  3385. <code>caProvider</code></br>
  3386. <em>
  3387. <a href="#external-secrets.io/v1alpha1.CAProvider">
  3388. CAProvider
  3389. </a>
  3390. </em>
  3391. </td>
  3392. <td>
  3393. <em>(Optional)</em>
  3394. <p>The provider for the CA bundle to use to validate Vault server certificate.</p>
  3395. </td>
  3396. </tr>
  3397. </tbody>
  3398. </table>
  3399. <h3 id="external-secrets.io/v1alpha1.YandexLockboxAuth">YandexLockboxAuth
  3400. </h3>
  3401. <p>
  3402. (<em>Appears on:</em>
  3403. <a href="#external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider</a>)
  3404. </p>
  3405. <p>
  3406. </p>
  3407. <table>
  3408. <thead>
  3409. <tr>
  3410. <th>Field</th>
  3411. <th>Description</th>
  3412. </tr>
  3413. </thead>
  3414. <tbody>
  3415. <tr>
  3416. <td>
  3417. <code>authorizedKeySecretRef</code></br>
  3418. <em>
  3419. github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
  3420. </em>
  3421. </td>
  3422. <td>
  3423. <em>(Optional)</em>
  3424. <p>The authorized key used for authentication</p>
  3425. </td>
  3426. </tr>
  3427. </tbody>
  3428. </table>
  3429. <h3 id="external-secrets.io/v1alpha1.YandexLockboxProvider">YandexLockboxProvider
  3430. </h3>
  3431. <p>
  3432. (<em>Appears on:</em>
  3433. <a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
  3434. </p>
  3435. <p>
  3436. <p>YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.</p>
  3437. </p>
  3438. <table>
  3439. <thead>
  3440. <tr>
  3441. <th>Field</th>
  3442. <th>Description</th>
  3443. </tr>
  3444. </thead>
  3445. <tbody>
  3446. <tr>
  3447. <td>
  3448. <code>apiEndpoint</code></br>
  3449. <em>
  3450. string
  3451. </em>
  3452. </td>
  3453. <td>
  3454. <em>(Optional)</em>
  3455. <p>Yandex.Cloud API endpoint (e.g. &lsquo;api.cloud.yandex.net:443&rsquo;)</p>
  3456. </td>
  3457. </tr>
  3458. <tr>
  3459. <td>
  3460. <code>auth</code></br>
  3461. <em>
  3462. <a href="#external-secrets.io/v1alpha1.YandexLockboxAuth">
  3463. YandexLockboxAuth
  3464. </a>
  3465. </em>
  3466. </td>
  3467. <td>
  3468. <p>Auth defines the information necessary to authenticate against Yandex Lockbox</p>
  3469. </td>
  3470. </tr>
  3471. </tbody>
  3472. </table>
  3473. <hr/>
  3474. <p><em>
  3475. Generated with <code>gen-crd-api-reference-docs</code>.
  3476. </em></p></p>
  3477. </article>
  3478. </div>
  3479. </div>
  3480. </main>
  3481. <footer class="md-footer">
  3482. <nav class="md-footer__inner md-grid" aria-label="Footer">
  3483. <a href="../provider-oracle-vault/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Oracle Vault" rel="prev">
  3484. <div class="md-footer__button md-icon">
  3485. <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>
  3486. </div>
  3487. <div class="md-footer__title">
  3488. <div class="md-ellipsis">
  3489. <span class="md-footer__direction">
  3490. Previous
  3491. </span>
  3492. Oracle Vault
  3493. </div>
  3494. </div>
  3495. </a>
  3496. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide" rel="next">
  3497. <div class="md-footer__title">
  3498. <div class="md-ellipsis">
  3499. <span class="md-footer__direction">
  3500. Next
  3501. </span>
  3502. Developer guide
  3503. </div>
  3504. </div>
  3505. <div class="md-footer__button md-icon">
  3506. <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>
  3507. </div>
  3508. </a>
  3509. </nav>
  3510. <div class="md-footer-meta md-typeset">
  3511. <div class="md-footer-meta__inner md-grid">
  3512. <div class="md-footer-copyright">
  3513. Made with
  3514. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  3515. Material for MkDocs
  3516. </a>
  3517. </div>
  3518. </div>
  3519. </div>
  3520. </footer>
  3521. </div>
  3522. <div class="md-dialog" data-md-component="dialog">
  3523. <div class="md-dialog__inner md-typeset"></div>
  3524. </div>
  3525. <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": null}</script>
  3526. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  3527. </body>
  3528. </html>