index.html 82 KB

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